Kajabi Orders API

The Orders API from Kajabi — 4 operation(s) for orders.

Operations 4

GET /v1/order_items List order items #
GET /v1/order_items/{id} Order item details #
GET /v1/orders List orders #
GET /v1/orders/{id} Order details #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/kajabi-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kajabi-orders-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Kajabi API V1 Orders API
  version: 1.1.0
  description: '## Public API

    * Server URL `https://api.kajabi.com`

    * Endpoint paths are prefixed with `/v1`

    * Version endpoint `GET https://api.kajabi.com/v1/version`

    * See the Developers Site for documentation and examples.'
  contact:
    email: support@kajabi.com
    name: Support
    url: https://help.kajabi.com/hc/en-us/articles/4404549690523-How-to-Get-Help-From-Kajabi-Live-Agents
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.kajabi.com
  description: Production
tags:
- name: Orders
paths:
  /v1/order_items:
    get:
      summary: List order items
      description: '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:

        ```json

        {

        "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`'
      tags:
      - Orders
      security:
      - Bearer: []
      parameters:
      - name: sort
        in: query
        required: false
        description: 'Sort order, use: created_at, quantity, fulfilled_at. For descending order use ''-'' e.g. &sort=-created_at'
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
      - name: page[size]
        in: query
        required: false
        description: Number of documents
        schema:
          type: integer
      - name: fields[order_items]
        in: query
        required: false
        description: Partial attributes as specified, e.g. fields[order_items]=quantity,title,total_price_in_cents
        schema:
          type: string
      - name: filter[site_id]
        in: query
        required: false
        description: Filter by site_id, for example ?filter[site_id]=111
        schema:
          type: string
      - name: filter[item_type_eq]
        in: query
        required: false
        description: Filter by item type, for example ?filter[item_type_eq]=Offer
        schema:
          type: string
      - name: filter[item_id_eq]
        in: query
        required: false
        description: Filter by item ID, for example ?filter[item_id_eq]=123
        schema:
          type: string
      - name: filter[fulfilled_at_null]
        in: query
        required: false
        description: Filter by fulfillment status, for example ?filter[fulfilled_at_null]=true
        schema:
          type: boolean
      responses:
        '200':
          description: Success, list of order items which the current user may access
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/order_items_index_response'
        '401':
          description: Unauthorized, Authorization header is missing or invalid
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_unauthorized'
        '403':
          description: Forbidden, insufficient permission to access the resource
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_forbidden'
      operationId: getV1OrderItems
      x-operation-id-source: derived
  /v1/order_items/{id}:
    get:
      summary: Order item details
      description: 'Shows details of an order item


        Order items represent individual products or offers within an order and contain:

        * Product/offer information

        * Pricing details

        * Quantity information

        * Fulfillment status


        ## Order Item Attributes

        * `quantity` (integer) - Number of items purchased

        * `currency_code` (string) - The ISO currency code for the item

        * `item_type` (string) - Type of item (e.g., "Offer")

        * `item_id` (integer) - ID of the associated item

        * `title` (string) - Title of the item

        * `total_price_in_cents` (integer) - Total price for this line item

        * `subtotal_in_cents` (integer) - Subtotal before taxes and discounts

        * `sales_tax_amount_in_cents` (integer) - Sales tax amount for this item

        * `discount_amount_in_cents` (integer) - Discount amount for this item

        * `fulfilled_at` (string) - Timestamp when the item was fulfilled

        * `created_at` (string) - Timestamp when the order item was created


        ## Include Related Resources

        Use the `include` parameter to load related resources:

        ### Include order

        * `GET /v1/order_items/123?include=order`'
      tags:
      - Orders
      security:
      - Bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: include
        in: query
        required: false
        description: Load the related resources, for example ?include=order
        schema:
          type: string
      - name: fields[order_items]
        in: query
        required: false
        description: Partial attributes as specified, e.g. fields[order_items]=quantity,title,total_price_in_cents
        schema:
          type: string
      responses:
        '200':
          description: Success, shows details of an order item
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/order_items_show_response'
        '401':
          description: Unauthorized, Authorization header is missing or invalid
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_unauthorized'
        '403':
          description: Forbidden, insufficient permission to access the resource
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_forbidden'
        '404':
          description: order item not found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_not_found'
      operationId: getV1OrderItemsById
      x-operation-id-source: derived
  /v1/orders:
    get:
      summary: List orders
      description: '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:

        ```json

        {

        "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`'
      tags:
      - Orders
      security:
      - Bearer: []
      parameters:
      - name: sort
        in: query
        required: false
        description: 'Sort order, use: order_number, created_at, fulfilled_at. For descending order use ''-'' e.g. &sort=-created_at'
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
      - name: page[size]
        in: query
        required: false
        description: Number of documents
        schema:
          type: integer
      - name: fields[orders]
        in: query
        required: false
        description: Partial attributes as specified, e.g. fields[orders]=order_number,total_price_in_cents
        schema:
          type: string
      - name: filter[site_id]
        in: query
        required: false
        description: Filter by site_id, for example ?filter[site_id]=111
        schema:
          type: string
      - name: filter[customer_id]
        in: query
        required: false
        description: Filter by customer_id, for example ?filter[customer_id]=456789
        schema:
          type: string
      - name: filter[order_number_eq]
        in: query
        required: false
        description: Filter by order number, for example ?filter[order_number_eq]=12345
        schema:
          type: string
      - name: filter[fulfilled_at_null]
        in: query
        required: false
        description: Filter by fulfillment status, for example ?filter[fulfilled_at_null]=true
        schema:
          type: boolean
      responses:
        '200':
          description: Success, list of orders which the current user may access
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/orders_index_response'
        '401':
          description: Unauthorized, Authorization header is missing or invalid
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_unauthorized'
        '403':
          description: Forbidden, insufficient permission to access the resource
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_forbidden'
      operationId: getV1Orders
      x-operation-id-source: derived
  /v1/orders/{id}:
    get:
      summary: Order details
      description: '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`'
      tags:
      - Orders
      security:
      - Bearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: include
        in: query
        required: false
        description: Load the related resources, for example ?include=order_items,customer,site
        schema:
          type: string
      - name: fields[orders]
        in: query
        required: false
        description: Partial attributes as specified, e.g. fields[orders]=order_number,total_price_in_cents
        schema:
          type: string
      responses:
        '200':
          description: Success, shows details of an order
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/orders_show_response'
        '401':
          description: Unauthorized, Authorization header is missing or invalid
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_unauthorized'
        '403':
          description: Forbidden, insufficient permission to access the resource
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_forbidden'
        '404':
          description: order not found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_not_found'
      operationId: getV1OrdersById
      x-operation-id-source: derived
components:
  schemas:
    errors_attributes:
      type: object
      properties:
        status:
          type: string
        source:
          type:
          - object
          - 'null'
          properties:
            pointer:
              type: string
        title:
          type: string
        detail:
          type: string
    order_items_attributes:
      type: object
      properties:
        quantity:
          type: integer
        currency_code:
          type: string
        item_type:
          type: string
        item_id:
          type: integer
        title:
          type: string
        fulfilled_at:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: ISO 8601 date-time, read only
        total_price_in_cents:
          type: integer
        subtotal_in_cents:
          type: integer
        sales_tax_amount_in_cents:
          type: integer
        discount_amount_in_cents:
          type: integer
        formatted_total_price:
          type: string
        formatted_subtotal:
          type: string
        currency_symbol:
          type: string
    errors_not_found:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errors_attributes'
    resource_identifiers:
      type: array
      items:
        $ref: '#/components/schemas/resource_identifier'
    resource_identifier:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
      required:
      - id
      - type
    order_items_show_response:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
              enum:
              - order_items
            attributes:
              $ref: '#/components/schemas/order_items_attributes'
            relationships:
              type: object
              properties:
                order:
                  type: object
                  properties:
                    data:
                      $ref: '#/components/schemas/resource_identifier'
        links:
          type: object
          properties:
            self:
              type: string
            current:
              type: string
    errors_unauthorized:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errors_attributes'
    orders_index_response:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              type:
                type: string
                enum:
                - orders
              attributes:
                $ref: '#/components/schemas/orders_attributes'
              relationships:
                type: object
                properties:
                  site:
                    type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/resource_identifier'
                  customer:
                    type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/resource_identifier'
                  order_items:
                    type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/resource_identifiers'
        links:
          type: object
          properties:
            self:
              type: string
            current:
              type: string
    errors_forbidden:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errors_attributes'
    order_items_index_response:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              type:
                type: string
                enum:
                - order_items
              attributes:
                $ref: '#/components/schemas/order_items_attributes'
              relationships:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/resource_identifier'
        links:
          type: object
          properties:
            self:
              type: string
            current:
              type: string
    orders_show_response:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
              enum:
              - orders
            attributes:
              $ref: '#/components/schemas/orders_attributes'
            relationships:
              type: object
              properties:
                site:
                  type: object
                  properties:
                    data:
                      $ref: '#/components/schemas/resource_identifier'
                customer:
                  type: object
                  properties:
                    data:
                      $ref: '#/components/schemas/resource_identifier'
                order_items:
                  type: object
                  properties:
                    data:
                      $ref: '#/components/schemas/resource_identifiers'
        links:
          type: object
          properties:
            self:
              type: string
            current:
              type: string
    orders_attributes:
      type: object
      properties:
        order_number:
          type: integer
        currency_code:
          type: string
        fulfilled_at:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: ISO 8601 date-time, read only
        total_price_in_cents:
          type: integer
        subtotal_in_cents:
          type: integer
        sales_tax_amount_in_cents:
          type: integer
        discount_amount_in_cents:
          type: integer
        formatted_total_price:
          type: string
        formatted_subtotal:
          type: string
        currency_symbol:
          type: string
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
x-mint:
  mcp:
    enabled: true