Get All Orders

GET

wms

orders

page_token

string

created_date

string

created_date[eq]

string

created_date[neq]

string

created_date[gt]

string

created_date[gte]

string

created_date[lt]

string

created_date[lte]

string

created_date[in]

array

created_date[nin]

array

updated_date

string

updated_date[eq]

string

updated_date[neq]

string

updated_date[gt]

string

updated_date[gte]

string

updated_date[lt]

string

updated_date[lte]

string

updated_date[in]

array

updated_date[nin]

array

limit

integer

status

enum<string>

status[eq]

enum<string>

status[neq]

enum<string>

status[in]

array

status[nin]

array

warehouse_customer_id

string

warehouse_customer_id[eq]

string

warehouse_customer_id[neq]

string

warehouse_customer_id[in]

array

warehouse_customer_id[nin]

array

channel

string

channel[eq]

string

channel[neq]

string

channel[in]

array

channel[nin]

array

order_number

string

order_number[eq]

string

order_number[in]

array

order_number[nin]

array

reference_id

string

reference_id[eq]

string

reference_id[in]

array

reference_id[nin]

array

required_ship_date

string

required_ship_date[eq]

string

required_ship_date[neq]

string

required_ship_date[gt]

string

required_ship_date[gte]

string

required_ship_date[lt]

string

required_ship_date[lte]

string

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",
      "raw_status": "raw_status",
      "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": [
        {
          "product_id": "product_id",
          "sku": "sku",
          "quantity": 1,
          "unit_price": 10.99,
          "is_picked": false
        }
      ],
      "required_ship_date": "2021-01-01T12:00:00Z",
      "shipments": [
        {
          "shipment_id": "shipment_id",
          "warehouse_id": "wh_id",
          "shipped_date": "2022-05-06T01:02:03Z",
          "shipping_method": "shipping_method_id",
          "line_items": [
            {
              "inventory_item_id": "item_id",
              "sku": "sku",
              "quantity": 1,
              "parent_product_id": null
            }
          ],
          "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": [
            {
              "package_id": "package_id",
              "package_name": "package_name",
              "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"
              },
              "line_items": [
                {
                  "inventory_item_id": "item_id",
                  "sku": "sku",
                  "quantity": 1,
                  "lot_id": "lot_id",
                  "expiration_date": "2022-06-06T01:02:03Z",
                  "parent_product_id": null
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "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.

created_date[eq]

string

created_date[neq]

string

created_date[gt]

string

created_date[gte]

string

created_date[lt]

string

created_date[lte]

string

created_date[in]

string[]

Comma-separated.

created_date[nin]

string[]

Comma-separated.

updated_date

string

Same syntax as created_date.

updated_date[eq]

string

updated_date[neq]

string

updated_date[gt]

string

updated_date[gte]

string

updated_date[lt]

string

updated_date[lte]

string

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.

status

enum<string>

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

Available options:

open,

confirmed,

processing,

allocated,

fulfilled,

exception,

cancelled,

backordered,

other

status[eq]

enum<string>

Available options:

open,

confirmed,

processing,

allocated,

fulfilled,

exception,

cancelled,

backordered,

other

status[neq]

enum<string>

Available options:

open,

confirmed,

processing,

allocated,

fulfilled,

exception,

cancelled,

backordered,

other

status[in]

enum<string>[]

Comma-separated.

Available options:

open,

confirmed,

processing,

allocated,

fulfilled,

exception,

cancelled,

backordered,

other

status[nin]

enum<string>[]

Comma-separated.

Available options:

open,

confirmed,

processing,

allocated,

fulfilled,

exception,

cancelled,

backordered,

other

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[]

Comma-separated.

warehouse_customer_id[nin]

string[]

Comma-separated.

channel

string

The channel the order was placed on

channel[eq]

string

channel[neq]

string

channel[in]

string[]

Comma-separated.

channel[nin]

string[]

Comma-separated.

order_number

string

A user-friendly identifier for the order

order_number[eq]

string

order_number[in]

string[]

Comma-separated.

order_number[nin]

string[]

Comma-separated.

reference_id

string

An external unique identifier for the order

reference_id[eq]

string

reference_id[in]

string[]

Comma-separated.

reference_id[nin]

string[]

Comma-separated.

required_ship_date

string

The date the order must be shipped by. Same query syntax as created_date/updated_date

required_ship_date[eq]

string

required_ship_date[neq]

string

required_ship_date[gt]

string

required_ship_date[gte]

string

required_ship_date[lt]

string

required_ship_date[lte]

string

Response

200 - application/json

data

object[]

data.id

string

The unique ID of the order.

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the order. Can be passed into the Warehouse Customer endpoint for more details.

data.created_date

string

The date the order was created.

data.updated_date

string

The date the order was last updated.

data.reference_id

string

An external unique identifier for the order, such as a Shopify order id. Defaults to id if client has not defined one.

data.order_number

string

A user-friendly identifier for their order. Defaults to reference_id if not provided.

data.status

enum<string>

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

Available options:

open,

confirmed,

processing,

allocated,

fulfilled,

exception,

cancelled,

backordered,

other

data.raw_status

string | null

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

data.channel

string | null

The channel the order was placed through, such as Shopify or wholesale.

data.trading_partner

string | null

For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).

data.shipping_method

string | null

The method by which the warehouse will ship the order to the customer. Can be passed into the Shipping Method endpoint for more details.

data.invoice_currency_code

string

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

data.total_price

number | null

The total price a customer paid for the order.

data.total_tax

number | null

The total tax on the order.

data.total_discount

number | null

The total amount discounted from the order.

data.total_shipping

number | null

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

data.ship_to_address

object

data.line_items

object[]

List of the products included in the order.

data.required_ship_date

string | null

The date the order must be shipped by.

data.shipments

object[]

List of the shipments sent out to the customer.

data.shipments.shipment_id

string

required

The ID of the shipment.

data.shipments.warehouse_id

string

required

The warehouse this order was shipped from. Can be passed into the Warehouse endpoint for more details.

data.shipments.shipped_date

string

required

The date the shipment was sent.

data.shipments.shipping_method

string | null

required

The method by which the warehouse will ship the order to the customer. Can be passed into the Shipping Method endpoint for more details.

data.shipments.line_items

object[]

required

List of the inventory items listed in the shipment.

data.shipments.ship_to_address

object

required

data.shipments.ship_from_address

object

required

data.shipments.packages

object[]

required

A list of the packages included in the shipment.

data.shipments.packages.package_id

string

required

The ID of the package.

data.shipments.packages.package_name

string | null

required

The name of the package. (e.g. 12x9x4)

data.shipments.packages.tracking_number

string | null

required

The tracking number for the package.

data.shipments.packages.tracking_url

string | null

required

The URL for the tracking number.

data.shipments.packages.carrier

string | null

required

The carrier used to ship the package.

data.shipments.packages.scac

string | null

required

The Standard Carrier Alpha Code for the carrier used to ship the package.

data.shipments.packages.shipping_cost

number | null

required

The cost incurred by the warehouse to ship the package.

data.shipments.packages.measurements

object

required

data.shipments.packages.line_items

object[]

required

A list of the inventory items included in the package.

next_token

string | null

See pagination for more details.

total_count

integer

The number of items returned.

Orders Get Order

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",
      "raw_status": "raw_status",
      "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": [
        {
          "product_id": "product_id",
          "sku": "sku",
          "quantity": 1,
          "unit_price": 10.99,
          "is_picked": false
        }
      ],
      "required_ship_date": "2021-01-01T12:00:00Z",
      "shipments": [
        {
          "shipment_id": "shipment_id",
          "warehouse_id": "wh_id",
          "shipped_date": "2022-05-06T01:02:03Z",
          "shipping_method": "shipping_method_id",
          "line_items": [
            {
              "inventory_item_id": "item_id",
              "sku": "sku",
              "quantity": 1,
              "parent_product_id": null
            }
          ],
          "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": [
            {
              "package_id": "package_id",
              "package_name": "package_name",
              "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"
              },
              "line_items": [
                {
                  "inventory_item_id": "item_id",
                  "sku": "sku",
                  "quantity": 1,
                  "lot_id": "lot_id",
                  "expiration_date": "2022-06-06T01:02:03Z",
                  "parent_product_id": null
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Home

How-To Guides

API Documentation

Headers

Query Parameters

Response