Get All Cart Orders

GET

cart

orders

curl --request GET \
  --url https://production.trackstarhq.com/cart/orders \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "data": [
    {
      "id": "order_id",
      "order_number": "order_number",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "status": "open",
      "raw_status": "raw_status",
      "shipping_method": "shipping_method_id",
      "invoice_currency_code": "USD",
      "total_price": 13.49,
      "total_tax": 1.5,
      "total_discount": 2.5,
      "total_shipping": 3.5,
      "ship_to_address": {
        "full_name": "John Doe",
        "company": "Company",
        "address1": "123 Main St",
        "address2": "Apt 2",
        "address3": "Floor 3",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "United States"
      },
      "bill_to_address": {
        "full_name": "John Doe",
        "address1": "123 Main St",
        "address2": "Apt 2",
        "address3": "Floor 3",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "United States"
      },
      "line_items": [
        {
          "line_item_id": "line_item_id",
          "product_id": "",
          "product_sku": "",
          "parent_product_id": "",
          "parent_product_sku": "",
          "quantity": 1,
          "unit_price": 10.99,
          "discount": 1.5,
          "tax": 0.5
        }
      ],
      "shipping_groups": [
        {
          "shipping_group_id": "shipping_group_id",
          "line_items": [
            {
              "line_item_id": "shipping_group_line_item_id",
              "product_id": "",
              "product_sku": "",
              "parent_product_id": "",
              "quantity": 0
            }
          ]
        }
      ],
      "shipments": [
        {
          "shipment_id": "shipment_id",
          "carrier": "carrier_name",
          "shipping_method": "shipping_method_id",
          "tracking_number": "",
          "tracking_url": "https://www.example.com/tracking",
          "line_items": [
            {
              "product_id": "",
              "product_sku": "",
              "parent_product_id": "",
              "parent_product_sku": "",
              "quantity": 0
            }
          ]
        }
      ],
      "external_system_url": "https://example.com/order/123"
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token

string

required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Query Parameters

page_token

string | null

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

Example:

"page_token"

created_date

string

Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send created_date[gt]=2023-03-10T00:00:00Z&created_date[lt]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-03-10T13:00:00Z"

created_date[eq]

string

Example:

"2022-03-10T13:00:00Z"

created_date[neq]

string

Example:

"2022-03-10T13:00:00Z"

created_date[gt]

string

Example:

"2022-03-10T13:00:00Z"

created_date[gte]

string

Example:

"2022-03-10T13:00:00Z"

created_date[lt]

string

Example:

"2022-03-10T13:00:00Z"

created_date[lte]

string

Example:

"2022-03-10T13:00:00Z"

created_date[in]

string[]

Comma-separated.

created_date[nin]

string[]

Comma-separated.

updated_date

string

Same syntax as created_date.

Example:

"2022-03-11T13:00:00Z"

updated_date[eq]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[neq]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[gt]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[gte]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[lt]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[lte]

string

Example:

"2022-03-11T13:00:00Z"

updated_date[in]

string[]

Comma-separated.

updated_date[nin]

string[]

Comma-separated.

limit

integer

The maximum number of items to return. The default is 1000.

Example:

1000

ids[in]

string[]

A comma-separated list of resource IDs. If provided, all other query params are ignored.

status

enum<string>

The status of the order. See the order information for more details.

Available options:

open,

confirmed,

processing,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

Example:

"open"

status[eq]

enum<string>

Available options:

open,

confirmed,

processing,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

Example:

"open"

status[neq]

enum<string>

Available options:

open,

confirmed,

processing,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

Example:

"open"

status[in]

enum<string>[]

Comma-separated.

Available options:

open,

confirmed,

processing,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

status[nin]

enum<string>[]

Comma-separated.

Available options:

open,

confirmed,

processing,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

warehouse_customer_id

string

The ID of the customer associated with the resource

Example:

"warehouse_cust_id"

warehouse_customer_id[eq]

string

Example:

"warehouse_cust_id"

warehouse_customer_id[neq]

string

Example:

"warehouse_cust_id"

warehouse_customer_id[in]

string[]

Comma-separated.

warehouse_customer_id[nin]

string[]

Comma-separated.

Response

200

application/json

Successful response

data

object[]

data.id

string

The unique ID of the order.

Example:

"order_id"

data.order_number

string

The order number assigned by the platform. Defaults to order ID.

Example:

"order_number"

data.created_date

string

The date the order was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string

The date the order was last updated.

Example:

"2022-01-02T05:05:05Z"

data.status

enum<string>

The status of the order. See the order information for more details.

Available options:

open,

confirmed,

processing,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

Example:

"open"

data.raw_status

string | null

The raw status (if available) returned directly from the platform.

Example:

"raw_status"

data.shipping_method

string | null

The method by which the carrier will ship the order to the customer.

Example:

"shipping_method_id"

data.invoice_currency_code

string

The currency used for this order. If not provided explicitly, defaults to USD.

Example:

"USD"

data.total_price

number | null

The total price a customer paid for the order.

Example:

13.49

data.total_tax

number | null

The total tax on the order.

Example:

1.5

data.total_discount

number | null

The total amount discounted from the order.

Example:

2.5

data.total_shipping

number | null

The total shipping cost for the order incurred by the customer.

Example:

3.5

data.ship_to_address

object

data.bill_to_address

object

data.line_items

object[]

List of the products included in the order.

Example:

[
  {
    "line_item_id": "line_item_id",
    "product_id": "",
    "product_sku": "",
    "parent_product_id": "",
    "parent_product_sku": "",
    "quantity": 1,
    "unit_price": 10.99,
    "discount": 1.5,
    "tax": 0.5
  }
]

data.shipping_groups

object[]

Sets of line items that will be fulfilled together from the same locations. Only applies in Shopify, as fulfillmentOrders.

data.shipments

object[]

List of the shipments sent out to the customer.

data.external_system_url

string | null

URL link to the order in the external system (WMS/Freight etc).

Example:

"https://example.com/order/123"

next_token

string | null

See pagination for more details.

Example:

"next_token"

total_count

integer

The number of items returned.

Example:

1

Cart Orders Get Cart Order

curl --request GET \
  --url https://production.trackstarhq.com/cart/orders \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "data": [
    {
      "id": "order_id",
      "order_number": "order_number",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "status": "open",
      "raw_status": "raw_status",
      "shipping_method": "shipping_method_id",
      "invoice_currency_code": "USD",
      "total_price": 13.49,
      "total_tax": 1.5,
      "total_discount": 2.5,
      "total_shipping": 3.5,
      "ship_to_address": {
        "full_name": "John Doe",
        "company": "Company",
        "address1": "123 Main St",
        "address2": "Apt 2",
        "address3": "Floor 3",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "United States"
      },
      "bill_to_address": {
        "full_name": "John Doe",
        "address1": "123 Main St",
        "address2": "Apt 2",
        "address3": "Floor 3",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "United States"
      },
      "line_items": [
        {
          "line_item_id": "line_item_id",
          "product_id": "",
          "product_sku": "",
          "parent_product_id": "",
          "parent_product_sku": "",
          "quantity": 1,
          "unit_price": 10.99,
          "discount": 1.5,
          "tax": 0.5
        }
      ],
      "shipping_groups": [
        {
          "shipping_group_id": "shipping_group_id",
          "line_items": [
            {
              "line_item_id": "shipping_group_line_item_id",
              "product_id": "",
              "product_sku": "",
              "parent_product_id": "",
              "quantity": 0
            }
          ]
        }
      ],
      "shipments": [
        {
          "shipment_id": "shipment_id",
          "carrier": "carrier_name",
          "shipping_method": "shipping_method_id",
          "tracking_number": "",
          "tracking_url": "https://www.example.com/tracking",
          "line_items": [
            {
              "product_id": "",
              "product_sku": "",
              "parent_product_id": "",
              "parent_product_sku": "",
              "quantity": 0
            }
          ]
        }
      ],
      "external_system_url": "https://example.com/order/123"
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Cart API Reference

Headers

Query Parameters

Response