API Documentation
- Management
- Sandbox
- Inventory
- Products
- Orders
- Inbound Shipments
- Shipping Methods
- Returns
- Billing
- Warehouses
- Warehouse Customers
Create Order
Get the required, optional, and integration specific fields by calling the integrations endpoint.
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
The ID of the merchant/tenant/customer that owns the order. Can be passed into the Warehouse Customer endpoint for more details.
An external unique identifier for the order, such as a Shopify order id. Defaults to id if client has not defined one.
A user-friendly identifier for their order. Defaults to reference_id if not provided.
Deprecated in favor of channel_object.
The channel the order was placed on.
The ID of the channel.
For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).
The method by which the warehouse will ship the order to the customer. Can be passed into the Shipping Method endpoint for more details.
The currency used for this order. If not provided explicitly, defaults to USD.
The total price a customer paid for the order.
The total tax on the order.
The total amount discounted from the order.
The total shipping cost for the order incurred by the customer.
List of the products included in the order.
A list of custom tags associated with the orders. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]
Headers
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Body
The ID of the merchant/tenant/customer that owns the order. Can be passed into the Warehouse Customer endpoint for more details.
An external unique identifier for the order, such as a Shopify order id. Defaults to id if client has not defined one.
A user-friendly identifier for their order. Defaults to reference_id if not provided.
Deprecated in favor of channel_object.
The channel the order was placed on.
The ID of the channel.
For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).
The method by which the warehouse will ship the order to the customer. Can be passed into the Shipping Method endpoint for more details.
The currency used for this order. If not provided explicitly, defaults to USD.
The total price a customer paid for the order.
The total tax on the order.
The total amount discounted from the order.
The total shipping cost for the order incurred by the customer.
List of the products included in the order.
The price of the product in the currency specified by invoice_currency_code.
The amount per unit discounted from the product for this order.
A list of custom tags associated with the orders. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]
Response
The unique ID of the order.
The ID of the merchant/tenant/customer that owns the order. Can be passed into the Warehouse Customer 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 endpoint for more details.
The date the order was created.
The date the order was last updated.
An external unique identifier for the order, such as a Shopify order id. Defaults to id if client has not defined one.
A user-friendly identifier for their order. Defaults to reference_id if not provided.
The status of the order. See the order information for more details.
open, confirmed, processing, picked, packed, partially_fulfilled, fulfilled, exception, cancelled, backordered, other The raw status (if available) returned directly from the WMS.
Deprecated in favor of channel_object.
The type of order, such as d2c or b2b.
d2c, b2b, dropship For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).
The method by which the warehouse will ship the order to the customer. Can be passed into the Shipping Method endpoint for more details.
True if the order was shipped using a third party freight account.
The currency used for this order. If not provided explicitly, defaults to USD.
The total price a customer paid for the order.
The total tax on the order.
The total amount discounted from the order.
The total shipping cost for the order incurred by the customer.
List of the products included in the order.
The price of the product in the currency specified by invoice_currency_code.
Whether the product has been picked in the warehouse.
The amount discounted from the product for this order.
A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as key:value.
The date the order must be shipped by.
List of the shipments sent out to the customer.
The ID of the shipment.
The warehouse this order was shipped from. Can be passed into the Warehouse endpoint for more details.
The raw status (if available) of the shipment returned directly from the WMS.
The status of the shipment.
open, shipped, cancelled, other The date the shipment was sent.
The method by which the warehouse will ship the order to the customer. Can be passed into the Shipping Method endpoint for more details.
List of the inventory items listed in the shipment.
A list of the packages included in the shipment.
The ID of the package.
The name of the package. (e.g. 12x9x4)
The tracking number for the package.
The URL for the tracking number.
The method by which the warehouse will ship the order to the customer. Can be passed into the Shipping Method endpoint for more details.
The carrier used to ship 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 unit of measurement for the size of the package.
cm, in The unit of measurement for the weight of the package.
kg, oz, lb A list of the inventory items included in the package.
The ID of the inventory item. Can be passed into the Inventory endpoint for more details.
The ID of the lot the inventory item was picked from.
The expiration date of the lot the inventory item was picked from.
URL link to the order in the external system (WMS/Freight etc).
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'}]
Unused fields