PUT
/
wms
/
orders
/
{order_id}

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).

Path Parameters

order_id
string
required

Body

application/json
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.

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.

order_number
string

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

channel
string

Deprecated in favor of channel_object.

channel_object
object

The channel the order was placed on.

trading_partner
string

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

shipping_method
string

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

invoice_currency_code
string

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

total_price
number

The total price a customer paid for the order.

total_tax
number

The total tax on the order.

total_discount
number

The total amount discounted from the order.

total_shipping
number

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

ship_to_address
object
line_items
object[]

List of the products included in the order.

status
enum<string>

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

Available options:
open,
confirmed,
processing,
picked,
packed,
partially_fulfilled,
fulfilled,
exception,
cancelled,
backordered,
other

Response

200 - application/json
data
object
unused_fields
string[]

Unused fields

Create OrderCancel Order