Order details

Shows details of an order

Orders represent completed purchase transactions and contain:

• Order items (products/offers purchased)
• Payment information
• Customer information
• Fulfillment status

Order Attributes

• order_number (integer) - A unique identifier for the order within the site
• currency_code (string) - The ISO currency code for the order (e.g., “USD”)
• total_price_in_cents (integer) - Total price including taxes and discounts
• subtotal_in_cents (integer) - Subtotal before taxes and discounts
• sales_tax_amount_in_cents (integer) - Total sales tax amount
• discount_amount_in_cents (integer) - Total discount amount
• fulfilled_at (string) - Timestamp when the order was fulfilled
• created_at (string) - Timestamp when the order was created

Include Related Resources

Use the include parameter to load related resources:

Include order items, customer

• GET /v1/orders/123?include=order_items,customer

GET /v1/orders/{id}

Order details

cURL

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

200

{
  "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>"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Query Parameters

include · string

Load the related resources, for example ?include=order_items,customer,site

fields[orders] · string

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

Response

200

application/vnd.api+json

Success, shows details of an order

data · object

Show child attributes

links · object

Show child attributes