Receive Inbound 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

inbound_shipment_id

string

required

Body

application/json

line_items

object[]

List of line items included in the receiving event.

warehouse_location_id

string

Location where the item is being received. Can be passed into the Warehouse Location endpoint for more details.

warehouse_id

string

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

Response

200 - application/json

data

object

data.id

string

The unique ID of the inbound shipment.

data.warehouse_customer_id

string | null

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

data.created_date

string

The date the inbound shipment was created.

data.updated_date

string

The date the inbound shipment was last updated.

data.purchase_order_number

string | null

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

data.status

enum<string>

The status of the inbound shipment. See the inbound shipment information for more details.

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

data.raw_status

string | null

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

data.supplier

string | null

Deprecated in favor of supplier_object

data.supplier_object

object | null

data.expected_arrival_date

string | null

Date the shipment is expected to reach the warehouse.

data.warehouse_id

string | null

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

data.line_items

object[]

List of line items included in the shipment.

data.receipts

object[]

List of receiving events associated with the inbound shipment.

data.ship_from_address

object

data.tracking_numbers

string[]

List of tracking numbers associated with the inbound shipment.

data.notes

string[]

List of notes associated with the inbound shipment.

data.external_system_url

string | null

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

data.trackstar_tags

any[] | null

A list of custom tags associated with the inbound shipment. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

unused_fields

string[]

Unused fields

API Documentation

Headers

Path Parameters

Body

Response