API Reference

Base URL

All API requests should be made to:

Common Headers

Response Format

All API responses follow a consistent JSON structure:

Success Response

{
  "data": {
    // Response data here
  },
  "meta": {
    "page": 1,
    "page_size": 20,
    "total": 100,
    "total_pages": 5
  }
}

Error Response

{
  "error": "bad_request",
  "message": "Invalid product UUID format",
  "code": "INVALID_UUID",
  "details": {
    "field": "product_uuid",
    "received": "invalid-uuid"
  }
}

Pagination

List endpoints support pagination using query parameters:

The meta object in the response contains pagination information:

• • page - Current page number
• • page_size - Items per page
• • total - Total number of items
• • total_pages - Total number of pages

HTTP Status Codes