List orders

curl --request GET \
  --url https://api.kajabi.com/v1/orders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kajabi.com/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "type": "orders",
      "attributes": {
        "order_number": 123,
        "currency_code": "<string>",
        "fulfilled_at": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "total_price_in_cents": 123,
        "subtotal_in_cents": 123,
        "sales_tax_amount_in_cents": 123,
        "discount_amount_in_cents": 123,
        "formatted_total_price": "<string>",
        "formatted_subtotal": "<string>",
        "currency_symbol": "<string>"
      },
      "relationships": {
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "customer": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "order_items": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Orders

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

GET

orders

List orders

curl --request GET \
  --url https://api.kajabi.com/v1/orders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kajabi.com/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "type": "orders",
      "attributes": {
        "order_number": 123,
        "currency_code": "<string>",
        "fulfilled_at": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "total_price_in_cents": 123,
        "subtotal_in_cents": 123,
        "sales_tax_amount_in_cents": 123,
        "discount_amount_in_cents": 123,
        "formatted_total_price": "<string>",
        "formatted_subtotal": "<string>",
        "currency_symbol": "<string>"
      },
      "relationships": {
        "site": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "customer": {
          "data": {
            "id": "<string>",
            "type": "<string>"
          }
        },
        "order_items": {
          "data": [
            {
              "id": "<string>",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort

string

Sort order, use: order_number, created_at, fulfilled_at. For descending order use '-' e.g. &sort=-created_at

page[number]

integer

page[size]

integer

Number of documents

fields[orders]

string

Partial attributes as specified, e.g. fields[orders]=order_number,total_price_in_cents

filter[site_id]

string

Filter by site_id, for example ?filter[site_id]=111

filter[customer_id]

string

Filter by customer_id, for example ?filter[customer_id]=456789

filter[order_number_eq]

string

Filter by order number, for example ?filter[order_number_eq]=12345

filter[fulfilled_at_null]

boolean

Filter by fulfillment status, for example ?filter[fulfilled_at_null]=true

Response

Success, list of orders which the current user may access

data

object[]

Show child attributes

links

object

Show child attributes