List orders

Orders for a site

Pagination

Use page[number] and page[size] parameters to paginate results:

Get first page of 10 items

• GET /v1/orders?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/orders?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://api.kajabi.com/v1/orders?page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/orders?page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/orders?page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/orders?page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/orders?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Sorting

Use the sort parameter to sort the results:

Sort by order_number in ascending order

• GET /v1/orders?sort=order_number

Sort by created_at in descending order

• GET /v1/orders?sort=-created_at

Filtering

Use filter parameters to narrow down results:

Filter by site

Use the filter[site_id] parameter to get orders for a specific site:

• GET /v1/orders?filter[site_id]=123

Filter by customer

Use the filter[customer_id] parameter to get orders for a specific customer:

• GET /v1/orders?filter[customer_id]=456789

Filter by order number

• GET /v1/orders?filter[order_number_eq]=12345

Filter by fulfilled status

• GET /v1/orders?filter[fulfilled_at_null]=true (unfulfilled orders)
• GET /v1/orders?filter[fulfilled_at_null]=false (fulfilled orders)

Advanced Filtering Examples

Range queries

• GET /v1/orders?filter[site_id]=123&filter[created_at_gteq]=2024-01-01&filter[created_at_lteq]=2024-12-31
• GET /v1/orders?filter[site_id]=123&filter[total_price_in_cents_gt]=5000

Pattern matching

• GET /v1/orders?filter[site_id]=123&filter[order_number_cont]=2024
• GET /v1/orders?filter[site_id]=123&filter[currency_code_start]=US

Array filters

• GET /v1/orders?filter[site_id]=123&filter[currency_code_in]=USD,EUR,GBP