Skip to main content
POST
Create Inbound Shipment

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>"

Body

application/json
supplier_object
SupplierId · object
required

The supplier from which the shipment is being sent.

purchase_order_number
string
required

The number of the purchase order associated with the inbound shipment.

Example:

"po_number_123"

expected_arrival_date
string<date-time>
required

Date the shipment is expected to reach the warehouse.

Example:

"2022-10-10T01:02:03Z"

warehouse_id
string
required

ID of the warehouse that will be receiving the shipment. Can be passed into the Warehouse endpoint for more details.

Example:

"warehouse_id123"

tracking_number
string
required

Tracking number associated with the inbound shipment.

Example:

"tracking_number"

line_items
CreateInboundShipmentLineItemSchema · object[]
required

List of line items included in the shipment.

Example:
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:

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
CreateInboundShipmentResponseDataSchema · object