- Documentation
- Request an API Key
- Login to Dashboard
Authentication
Sandbox
Inventory
Products
Orders
- Orders
- GETGet All Orders
- GETGet Order
- GETGet Order Create/Update Schema for Integration
- GETGet Order Create/Update Schema for Connection
- POSTCreate Order
- PUTUpdate Order
- PUTCancel Order
- GETGet Order Fulfillment Schema for Connection
- GETGet Order Fulfill Schema for Integration
- PUTFulfill Order
- GETGet All Order Channels
Inbound Shipments
Shipping Methods
Returns
Billing
Warehouses
Warehouse Customers
API Documentation
Get Order
Returns a single Order for the WMS connection with the associated order id.
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
curl --request GET \
--url https://production.trackstarhq.com/wms/orders/{order_id} \
--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
}
]
}
]
}
]
}
}Headers
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Path Parameters
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.
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, allocated, fulfilled, exception, cancelled, backordered, other The raw status (if available) returned directly from the WMS.
The channel the order was placed through, such as Shopify or wholesale.
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.
Can be passed into the Product endpoint for more details.
The price of the product in the currency specified by invoice_currency_code.
Whether the product has been picked in the warehouse.
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 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.
The ID of the inventory item. Can be passed into the Inventory endpoint for more details.
The ID of the parent product if the line item is part of a kit. Can be passed into the Product endpoint for more details.
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 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, 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.
The ID of the parent product if the line item is part of a kit. Can be passed into the Product endpoint for more details.
curl --request GET \
--url https://production.trackstarhq.com/wms/orders/{order_id} \
--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
}
]
}
]
}
]
}
}