API Reference

Complete REST API documentation for BareCommerce Core. All endpoints are store-scoped and require authentication.

Base URL

https://api.barecommercecore.com

Authentication

Include your API key in the request header:

Authorization: Bearer sk_live_your_key_here

Or use the X-API-Key header:

X-API-Key: sk_live_your_key_here

See Authentication for details on creating and managing API keys.

Store-Scoped Endpoints

All resource endpoints are scoped to a store:

/stores/{storeId}/products
/stores/{storeId}/orders
/stores/{storeId}/customers
/stores/{storeId}/categories
/stores/{storeId}/media
/stores/{storeId}/webhooks

Response Format

Success Response (Single Item)

{
  "item": {
    "id": "prod_abc123",
    "title": "Product Name",
    ...
  }
}

Success Response (List)

{
  "items": [
    { "id": "prod_abc123", ... },
    { "id": "prod_def456", ... }
  ],
  "total": 100
}

Error Response

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "details": [
      { "field": "price", "reason": "Must be a positive number" }
    ]
  }
}

Pagination

All list endpoints support pagination:

Parameter	Type	Default	Max	Description
limit	integer	50	200	Results per page
offset	integer	0	—	Number of items to skip

GET /stores/{storeId}/products?limit=20&offset=40

HTTP Status Codes

Status	Description
200	Success
201	Created
204	No Content (successful delete)
400	Bad Request / Validation Error
401	Unauthorized (missing/invalid API key)
403	Forbidden (insufficient scopes)
404	Not Found
409	Conflict (duplicate, invalid state)
429	Rate Limited
500	Internal Server Error