Create Order Shipment

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

carrier

string

The carrier used to ship the order to the customer.

measurements

object

shipped_date

string

The date the shipment was sent.

shipping_cost

number

The cost incurred by the warehouse to ship the package.

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.

tracking_number

string

The tracking number for the package.

tracking_url

string

The URL for the tracking number.

warehouse_id

string

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.

Response

200 - application/json

data

object

data.channel

string | null

Deprecated in favor of channel_object.

data.channel_object

object | null

data.created_date

string

The date the order was created.

data.external_system_url

string | null

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

data.first_party_freight_account_number

string | null

The first party freight account number used to ship the order.

data.id

string

The unique ID of the order.

data.international_duty_paid_by

enum<string> | null

The party responsible for paying international duties.

Available options:

sender,

recipient,

third_party

data.invoice_currency_code

string

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

data.is_third_party_freight

boolean | null

True if the order was shipped using a third party freight account.

data.line_items

object[]

List of the products included in the order.

data.order_number

string

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

data.raw_status

string | null

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

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

data.required_ship_date

string | null

The date the order must be shipped by.

data.saturday_delivery

boolean | null

True if the order requires Saturday delivery.

data.ship_to_address

object

data.shipments

object[]

List of the shipments sent out to the customer.

data.shipments.line_items

object[]

required

List of the inventory items listed in the shipment.

data.shipments.packages

object[]

required

A list of the packages included in the shipment.

data.shipments.packages.carrier

string | null

required

The carrier used to ship the package.

data.shipments.packages.line_items

object[]

required

A list of the inventory items included in the package.

data.shipments.packages.measurements

object

required

data.shipments.packages.package_id

string

required

The ID of the package.

data.shipments.packages.package_name

string | null

required

The name of the package. (e.g. 12x9x4)

data.shipments.packages.scac

string | null

required

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

data.shipments.packages.shipping_cost

number | null

required

The cost incurred by the warehouse to ship the package.

data.shipments.packages.shipping_method

string | null

required

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

data.shipments.packages.tracking_number

string | null

required

The tracking number for the package.

data.shipments.packages.tracking_url

string | null

required

The URL for the tracking number.

data.shipments.raw_status

string | null

required

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

data.shipments.ship_from_address

object

required

data.shipments.ship_to_address

object

required

data.shipments.shipment_id

string

required

The ID of the shipment.

data.shipments.shipped_date

string

required

The date the shipment was sent.

data.shipments.shipping_method

string | null

required

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

data.shipments.status

enum<string>

required

The status of the shipment.

Available options:

open,

shipped,

cancelled,

other

data.shipments.warehouse_id

string

required

The warehouse this order was shipped from. Can be passed into the Warehouse endpoint for more details.

data.shipping_method

string | null

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

data.signature_required

boolean | null

True if the order requires a signature upon delivery.

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

data.tags

string[]

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.

data.third_party_freight_account_number

string | null

The third party freight account number used to ship the order.

data.total_discount

number | null

The total amount discounted from the order.

data.total_price

number | null

The total price a customer paid for the order.

data.total_shipping

number | null

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

data.total_tax

number | null

The total tax on the order.

data.trackstar_tags

any[] | null

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'}]

data.trading_partner

string | null

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

data.type

enum<string> | null

The type of order, such as d2c or b2b.

Available options:

d2c,

b2b,

dropship

data.updated_date

string

The date the order was last updated.

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

data.warehouse_id

string | null

unused_fields

string[]

Unused fields

API Documentation

Headers

Path Parameters

Body

Response