- Documentation
- Request an API Key
- Login to Dashboard
Authentication
Sandbox
Inventory
Products
Orders
Inbound Shipments
Shipping Methods
Returns
Billing
Warehouses
Warehouse Customers
API Documentation
Create Inbound Shipment
Get the request body shape by calling the meta endpoint.
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Placeholder - variable based on integration. Read about the meta endpoint for more information.
Placeholder - variable based on integration. Read about the meta endpoint for more information.
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",
"raw_status": "raw_status",
"supplier": "supplier",
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"expected_quantity": 2,
"received_quantity": 1,
"unit_cost": 1,
"external_id": "external_id"
}
],
"receipts": [
{
"id": "receipt_id",
"arrived_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"inventory_item_id": "item_id",
"quantity": 1
}
]
}
],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"tracking_numbers": [
"tracking_number_1",
"tracking_number_2"
]
}
}Headers
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Body
Placeholder - variable based on integration. Read about the meta endpoint for more information.
Placeholder - variable based on integration. Read about the meta endpoint for more information.
Response
The unique ID of the inbound shipment.
The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the Warehouse Customer endpoint for more details.
The date the inbound shipment was created.
The date the inbound shipment was last updated.
The number of the purchase order associated with the inbound shipment.
The status of the inbound shipment. See the inbound shipment information for more details.
open, in-transit, receiving, received, cancelled, other The raw status (if available) returned directly from the WMS.
The supplier from which the shipment is being sent.
Date the shipment is expected to reach the warehouse.
ID of the warehouse that will be receiving the shipment. Can be passed into the Warehouse endpoint for more details.
List of line items included in the shipment.
Can be passed into the Inventory endpoint for more details.
Total quantity of the item expected to be received.
Total quantity of the item that has been received.
The cost per product that is charged by the manufacturer.
An identifier from an external system. e.g. vendor sku, external id, reference number, etc..
List of receiving events associated with the inbound shipment.
The unique ID of the receiving event.
Date the items arrived.
List of line items included in the receiving event.
Can be passed into the Inventory endpoint for more details.
Total quantity of the item that has been received.
List of tracking numbers associated with the inbound shipment.
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",
"raw_status": "raw_status",
"supplier": "supplier",
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"expected_quantity": 2,
"received_quantity": 1,
"unit_cost": 1,
"external_id": "external_id"
}
],
"receipts": [
{
"id": "receipt_id",
"arrived_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"inventory_item_id": "item_id",
"quantity": 1
}
]
}
],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"tracking_numbers": [
"tracking_number_1",
"tracking_number_2"
]
}
}