List orders

List orders placed against products in a specific business.

Query Parameters

Name	Type	Required	Description
`businessId`	string	Required	Business to query.
`limit`	number	Optional	Maximum number of items to return (1-100).Default: `20`
`offset`	number	Optional	Number of items to skip before starting to collect the result set.Default: `0`
`sortBy`	string	Optional	Field to sort by. Allowed values vary by endpoint.Default: `createdAt`
`sortOrder`	string asc desc	Optional	Sort direction.Default: `desc`
`search`	string	Optional	Free-text search across the resource’s primary fields.
`createdAfter`	string	Optional	ISO 8601 timestamp — only return items created after this time.
`createdBefore`	string	Optional	ISO 8601 timestamp — only return items created before this time.
`updatedAfter`	string	Optional	ISO 8601 timestamp — only return items updated after this time.
`status`	string PAYMENT_PENDING PAID FAILED	Optional	Filter by order status.

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/orders" \
  -H "X-Organization-Id: your_org_id" \
  -H "X-API-Key: your_api_key"

200Example response

json

{
  "message": "Orders retrieved successfully!",
  "content": {
    "orders": [
      {
        "id": "ord_1",
        "status": "PAID",
        "totalAmount": 12000,
        "items": [
          {
            "id": "oi_1",
            "productName": "Annual Subscription",
            "quantity": 1,
            "totalPrice": 12000
          }
        ]
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}