Skip to main content
PUT
Update Order

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token
string
required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Path Parameters

order_id
string
required

Body

application/json
warehouse_customer_id
string | null
required

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

Example:

"warehouse_customer_id"

reference_id
string
required

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

Example:

"order_reference_id"

order_number
string
required

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

Example:

"order_number"

channel_object
ChannelId · object
required

The channel the order was placed on.

trading_partner
string
required

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

Example:

"Target"

shipping_method_id
string
required

The ID of the actual shipping method used to ship the order. Can be passed into the Shipping Method endpoint for more details.. If shipping_method_name is also provided, this will take precedence.

Example:

"fedex_ground"

service_level
string
required

The type of shipping method requested by the customer.

Example:

"Standard"

invoice_currency_code
string
required

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

Example:

"USD"

total_price
number
required

The total price a customer paid for the order.

Example:

13.49

total_tax
number
required

The total tax on the order.

Example:

1.5

total_discount
number
required

The total amount discounted from the order.

Example:

2.5

total_shipping
number
required

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

Example:

3.5

ship_to_address
UpdateOWmsrderShipToAddress · object
required
status
enum<string>
required

The status of the order. See the order information [blocked] for more details.

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

"open"

trackstar_tags
any[] | null

A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.

Example:
line_items
UpdateWmsOrderLineItems · object[]

List of the products included in the order.

Example:

Response

Successful response

id
string
required

The ID of the object that has been created or modified

Example:

"id"

unused_fields
string[]
required

Unused fields

data
WmsOrderApiItemSchema · object