Skip to main content
GET
/
orders
List all orders
curl --request GET \
  --url https://{domain}/api/site/orders \
  --header 'Authorization: Bearer <token>'
{
  "totalCount": 1,
  "limit": 25,
  "skip": 0,
  "items": [
    {
      "id": 1234,
      "invoiceNo": 15,
      "created": 1573397217,
      "customerName": "John Doe",
      "customerEmail": "john@email.com",
      "contactId": 123,
      "memberId": 123,
      "shippingAddress": {
        "name": "<string>",
        "phone": "<string>",
        "companyName": "<string>",
        "companyId": "<string>",
        "country": "<string>",
        "state": "<string>",
        "city": "<string>",
        "zipCode": "<string>",
        "address": "<string>",
        "address2": "<string>"
      },
      "billingAddress": {
        "name": "<string>",
        "phone": "<string>",
        "companyName": "<string>",
        "companyId": "<string>",
        "country": "<string>",
        "state": "<string>",
        "city": "<string>",
        "zipCode": "<string>",
        "address": "<string>",
        "address2": "<string>"
      },
      "shippingRequired": true,
      "weight": 0,
      "weightUnit": "kg",
      "subTotal": 49,
      "total": 49,
      "discountCode": "<string>",
      "discountAmount": 0,
      "shippingName": "<string>",
      "shippingAmount": 0,
      "paid": true,
      "paymentMethod": "stripe",
      "transactionId": "<string>",
      "status": "completed",
      "taxes": [
        {
          "name": "Sales Tax",
          "total": 20,
          "applyToShipping": true,
          "rate": 10,
          "type": "PERCENT",
          "appliedToItems": [
            0,
            1,
            2
          ]
        }
      ],
      "items": [
        {
          "id": 123,
          "name": "Running Shoes",
          "url": "running-shoes",
          "productId": 24,
          "sku": "<string>",
          "quantity": 1,
          "total": 49,
          "weight": 0,
          "width": 0,
          "height": 0,
          "length": 0,
          "shippingRequired": true,
          "images": [
            "https://path-to-image.jpg"
          ],
          "variation": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "additions": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "tags": [
        "<string>"
      ],
      "additionalFields": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ],
      "notes": [
        {
          "time": 1686043751,
          "value": "Order Note Text Sample"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Pass your API key as: Authorization: Bearer <API KEY>.

Query Parameters

created_at_min
integer<int64>

List only orders created after the specified timestamp (inclusive, in seconds since the Unix epoch).

Example:

1573251649

created_at_max
integer<int64>

List only orders created before the specified timestamp (inclusive, in seconds since the Unix epoch).

Example:

1573251649

limit
integer
default:30

A limit on the number of objects to be returned. Between 1 and 50.

Required range: 1 <= x <= 50
Example:

25

skip
integer
default:0

The number of items to skip (offset). Defaults to 0, i.e. the first page.

Required range: x >= 0
Example:

25

Response

200 - application/json

A paginated list of orders.

Common pagination envelope shared by list endpoints.

totalCount
integer
required

The total size of the result set without any pagination.

Example:

1

limit
integer
required

The currently used limit.

Example:

25

skip
integer
required

The current offset in the list.

Example:

0

items
object[]
Last modified on June 20, 2026