Request an API Key

Login to Dashboard

Trackstar

API Reference

Get an API Key

Returns a single Order for the WMS connection with the associated order id.

Get Order

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

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

List of the products included in the order.

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

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

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

List of the shipments sent out to the customer.

The method by which the warehouse will ship the order to the customer. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.

The status of the order. See the [order information](info) for more details.

The total amount discounted from the order.

The total price a customer paid for the order.

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

A list of custom tags associated with the order. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

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

The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.

If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.

List of the inventory items listed in the shipment.

A list of the packages included in the shipment.

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

The warehouse this order was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.

A list of the inventory items included in the package.

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

The cost incurred by the warehouse to ship the package.

The expiration date of the lot the inventory item was picked from.

The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.

The ID of the lot the inventory item was picked from.

The ID of the parent product if the line item is part of a kit. Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details.

The unit of measurement for the size of the package.

The unit of measurement for the weight of the package.

The amount discounted from the product for this order.

Whether the product has been picked in the warehouse.

Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details.

The price of the product in the currency specified by `invoice_currency_code`.

Welcome to Trackstar!

Getting Started

Structures and paradigms for the Trackstar API

About the API

Trackstar Link

Integrations

Connection Permissions

Sandbox

Webhooks

Writing Data

Trackstar Tags

Creates a temporary link token that is required to initiate the `react-trackstar-link` component.
See the [Getting Started guide](/how-to-guides/getting-started) for more details.

Create Link Token

Exchanges a temporary authorization code for a permanent access token.
See the [Getting Started guide](/how-to-guides/getting-started) for more details.

Exchange Auth Code

Returns connected integrations for your organization.

Get Connections

Get Connection

Manually trigger a sync for the connection associated with your access token.

Sync Connection

Deletes the connection associated with your access token.

Delete Connection

Information about the data provided by each integration.

Integration Info

Information about the data provided by a single integration.

Integration Info for Single Integration

Generates a sandbox with mocked out data.
Uses the same connection ID every time, and will reset any existing sandbox.
See the [walkthrough](/how-to-guides/sandbox) for more information.

Generate Sandbox

Inventory

Returns all Inventory for the WMS connection associated with the provided access token.

Get All Inventory Items

Returns a single Inventory Item for the WMS connection with the associated inventory id.

Get Inventory Item

Adjust the inventory for the specified inventory item.

Adjust Inventory Item

Update the trackstar tags for the specified inventory item.

Update Inventory Trackstar Tags

Products

Returns all Products for the WMS connection associated with the provided access token.

Get All Products

Returns a single Product for the WMS connection with the associated product ID.

Get Product

Get the required, optional, and integration specific fields by calling the [integrations](/mgmt/integrations) endpoint.

Create Product

Update Product

Create a Kit Product

Update a Kit Product

Update the trackstar tags for the specified product.

Update Product Trackstar Tags

Orders

Returns all Orders for the WMS connection associated with the provided access token.

Get All Orders

Create Order

Update Order

Cancel an order for the WMS connection with the associated order id.

Cancel Order

Create Order Shipment

Returns all Order Channels for the WMS connection associated with the provided access token.

Get All Order Channels

Update the trackstar tags for the specified order.

Update Order Trackstar Tags

Inbound Shipments

Returns all Inbound Shipments for the WMS connection associated with the provided access token.

Get All Inbound Shipments

Returns a single Inbound Shipment for the WMS connection with the associated inbound shipment id.

Get Inbound Shipment

Create Inbound Shipment

Update Inbound Shipment

Receive an inbound shipment for the WMS connection with the associated inbound shipment id.

Receive Inbound Shipment

Get All Inbound Shipment Suppliers

Update the trackstar tags for the specified inbound shipment.

Update Inbound Shipment Trackstar Tags

Shipping Methods

Returns all Shipping Methods for the WMS connection associated with the provided access token.

Get All Shipping Methods

Returns a single Shipping Method for the WMS connection with the associated shipping method id.

Get Shipping Method

Returns

Returns all Returns for the WMS connection associated with the provided access token.

Get All Returns

Returns a single Return for the WMS connection with the associated return id.

Get Return

Create Return

Update Return

Update the trackstar tags for the specified return.

Update Return Trackstar Tags

Billing

Returns all Bills for the WMS connection associated with the provided access token.

Get All Bills

Returns a single Bill for the WMS connection with the associated bill id.

Get Bill

Warehouses

Returns all Warehouses for the WMS connection associated with the provided access token.

Get All Warehouses

Returns a single Warehouse for the WMS connection with the associated warehouse id.

Get Warehouse

Returns all Warehouse Locations for the WMS connection with the associated warehouse id.

Get All Warehouse Locations

Returns a single Warehouse Location for the WMS connection with the associated warehouse and location id.

Get Warehouse Location

Warehouse Customers

Returns all Warehouse Customers for the WMS connection associated with the provided access token.

Get All Warehouse Customers

Returns a single Warehouse Customer for the WMS connection with the associated warehouse customer id.

API Documentation

Get Order

Headers

Path Parameters

Response