Skip to main content
PUT
/
wms
/
inbound-shipments
/
{inbound_shipment_id}
/
receive
Receive Inbound Shipment
curl --request PUT \
  --url https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}/receive \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '
{
  "line_items": [
    {
      "sku": "item_id",
      "quantity": 1
    }
  ],
  "warehouse_location_id": "location",
  "warehouse_id": "warehouse_id123"
}
'
{
  "id": "id",
  "unused_fields": [
    "<string>"
  ]
}

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

​
inbound_shipment_id
string
required

Body

application/json
​
line_items
CreateInboundReceiptLineItem · object[]
required

List of line items included in the receiving event.

Example:
[{ "sku": "item_id", "quantity": 1 }]
​
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