GET
/
wms
/
orders
Header
Query
curl --request GET \
  --url https://production.trackstarhq.com/wms/orders \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
  "data": [
    {
      "id": "order_id",
      "warehouse_customer_id": "warehouse_customer_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "reference_id": "order_reference_id",
      "order_number": "order_number",
      "status": "open",
      "channel": "channel_id",
      "trading_partner": "Target",
      "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"
      },
      "line_items": [],
      "shipments": [
        {
          "shipment_id": "shipment_id",
          "warehouse_id": "wh_id",
          "shipped_date": "2022-05-06T01:02:03Z",
          "line_items": [
            {
              "inventory_item_id": "item_id",
              "sku": "sku",
              "quantity": 1
            }
          ],
          "ship_to_address": {
            "full_name": "John Doe",
            "company": "company",
            "address1": "address1",
            "address2": "address2",
            "address3": "address3",
            "city": "city",
            "state": "state",
            "postal_code": "postal_code",
            "country": "country"
          },
          "ship_from_address": {
            "address1": "address1",
            "address2": "address2",
            "address3": "address3",
            "city": "city",
            "state": "state",
            "postal_code": "postal_code",
            "country": "country"
          },
          "packages": [
            {
              "tracking_number": "tracking_number",
              "tracking_url": "tracking_url",
              "carrier": "carrier",
              "scac": "scac",
              "shipping_cost": 1,
              "measurements": {
                "length": 1,
                "width": 1,
                "height": 1,
                "unit": "in",
                "weight": 1,
                "weight_unit": "lb"
              },
              "boxes": [
                {
                  "box_id": "box_id",
                  "measurements": {
                    "length": 1,
                    "width": 1,
                    "height": 1,
                    "unit": "in",
                    "weight": 1,
                    "weight_unit": "lb"
                  },
                  "line_items": [
                    {
                      "inventory_item_id": "item_id",
                      "sku": "sku",
                      "quantity": 1,
                      "lot_id": "lot_id",
                      "expiration_date": "2022-06-06T01:02:03Z"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

x-trackstar-access-token
string
required

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

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.

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. (Format: %Y-%m-%dT%H:%M:%SZ)

created_date[eq]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[neq]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[gt]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[gte]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[lt]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[lte]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[in]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[nin]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date
string

Same syntax as created_date. (Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[eq]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[neq]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[gt]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[gte]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[lt]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[lte]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[in]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[nin]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

limit
integer

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

status
enum<string>

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

Available options:
open,
confirmed,
processing,
allocated,
fulfilled,
exception,
cancelled
status[eq]
enum<string>
Available options:
open,
confirmed,
processing,
allocated,
fulfilled,
exception,
cancelled
status[neq]
enum<string>
Available options:
open,
confirmed,
processing,
allocated,
fulfilled,
exception,
cancelled
status[in]
enum<string>
Available options:
open,
confirmed,
processing,
allocated,
fulfilled,
exception,
cancelled
status[nin]
enum<string>
Available options:
open,
confirmed,
processing,
allocated,
fulfilled,
exception,
cancelled
warehouse_customer_id
string

The ID of the customer associated with the resource

warehouse_customer_id[eq]
string
warehouse_customer_id[neq]
string
warehouse_customer_id[in]
string
warehouse_customer_id[nin]
string
channel
string

The channel the order was placed on

channel[eq]
string
channel[neq]
string
channel[in]
string
channel[nin]
string
order_number
string

A user-friendly identifier for the order

order_number[eq]
string
order_number[in]
string
order_number[nin]
string
reference_id
string

An external unique identifier for the order

reference_id[eq]
string
reference_id[in]
string
reference_id[nin]
string

Response

200 - application/json
data
object[]
next_token
string | null

See pagination for more details.

total_count
integer

The number of items returned.