Inbound Shipments
Create Inbound Shipment
Get the request body shape by calling the meta endpoint.
POST
/
wms
/
inbound-shipments
Header
Body
curl --request POST \
--url https://production.trackstarhq.com/wms/inbound-shipments \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '{
"field1": "some_value",
"field2": {
"key": "value"
}
}'
{
"data": {
"id": "inbound_id",
"warehouse_customer_id": "warehouse_customer_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"purchase_order_number": "po_number",
"status": "open",
"supplier": "supplier",
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"line_items": [],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
}
}
}
Headers
x-trackstar-api-key
string
requiredYour organization-level Trackstar API key.
x-trackstar-access-token
string
requiredYour user's access token for a specific integration (ShipHero, Extensiv, etc).
Body
application/json
field1
string
Placeholder - variable based on integration. Read about the meta endpoint for more information.
field2
object
Placeholder - variable based on integration. Read about the meta endpoint for more information.
Response
200 - application/json
data
object
curl --request POST \
--url https://production.trackstarhq.com/wms/inbound-shipments \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '{
"field1": "some_value",
"field2": {
"key": "value"
}
}'
{
"data": {
"id": "inbound_id",
"warehouse_customer_id": "warehouse_customer_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"purchase_order_number": "po_number",
"status": "open",
"supplier": "supplier",
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"line_items": [],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
}
}
}