List order items

Order items represent individual products or offers within an order.

Pagination

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

Get first page of 10 items

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

Get second page of 25 items

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

The response includes pagination links and meta data:

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

Filtering

Use filter parameters to narrow down results:

Filter by site

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

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

Filter by item type

• GET /v1/order_items?filter[item_type_eq]=Offer

Filter by item ID

• GET /v1/order_items?filter[item_id_eq]=123

Filter by fulfilled status

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

Advanced Filtering Examples

Range queries

• GET /v1/order_items?filter[site_id]=123&filter[quantity_gt]=1
• GET /v1/order_items?filter[site_id]=123&filter[total_price_in_cents_gteq]=1000&filter[total_price_in_cents_lteq]=10000

Pattern matching

• GET /v1/order_items?filter[site_id]=123&filter[item_type_cont]=Off
• GET /v1/order_items?filter[site_id]=123&filter[title_i_cont]=course (case insensitive)

Array filters

• GET /v1/order_items?filter[site_id]=123&filter[item_id_in]=123,456,789
• GET /v1/order_items?filter[site_id]=123&filter[item_type_not_in]=Bundle,Subscription

Sorting

Use the sort parameter to sort the results:

Sort by fulfilled_at in ascending order

• GET /v1/order_items?filter[site_id]=123&sort=fulfilled_at