Skip to main content
PUT
Receive 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>"

Idempotency-Key
string

Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.

Required string length: 1 - 255
Example:

"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"

Path Parameters

inbound_shipment_id
string
required

Body

application/json
line_items
CreateInboundReceiptLineItem · object[]
required

List of line items included in the receiving event.

Example:
warehouse_location_id
string
required

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

Example:

"location"

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"

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