Inbound Shipments
Get Inbound Shipment
WMS API Reference
- Inventory
- Products
- Orders
- Inbound Shipments
- Shipping Methods
- Returns
- Billing
- Warehouses
- Warehouse Customers
Inbound Shipments
Get Inbound Shipment
Returns a single Inbound Shipment for the WMS connection with the associated inbound shipment id.
GET
/
wms
/
inbound-shipments
/
{inbound_shipment_id}
curl --request GET \
--url https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id} \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
"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",
"supplier_object": {},
"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_sku"
}
],
"receipts": [
{
"id": "receipt_id",
"arrived_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"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"
],
"notes": [
"note_1",
"note_2"
],
"external_system_url": "https://example.com/inboundshipment/123",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
]
}
}
Headers
Your organization-level Trackstar API key.
Example:
"<x-trackstar-api-key>"
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Example:
"<x-trackstar-access-token>"
Path Parameters
Response
200
application/json
Successful response
The response is of type object
.
curl --request GET \
--url https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id} \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
"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",
"supplier_object": {},
"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_sku"
}
],
"receipts": [
{
"id": "receipt_id",
"arrived_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"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"
],
"notes": [
"note_1",
"note_2"
],
"external_system_url": "https://example.com/inboundshipment/123",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
]
}
}