Inbound Shipments

Making calls to the inbound shipments API

Index

Get a list of all inbound shipments, using Pagination.

GET/shipments/inbound

Get a list of all archived inbound shipments, using Pagination.

GET/shipments/inbound/archived

Retrieve a specific shipment

GET/shipments/inbound/{SHIPMENT_ID}

Create a new inbound shipment

POST/shipments/inbound

Parameter	Type	Examples	Description
`notes` Optional	string	`Inventore iusto facilis aperiam modi est.`	Shipment notes
`name` Required	string	`Walmart Oct 26`	The name of the shipment
`warehouse_id` Required	integer	`12`	The ID of the warehouse that you are sending the shipment from.

Update a shipment name and notes

PUT/shipments/inbound/{SHIPMENT_ID}

Parameter	Type	Examples	Description
`notes` Optional	string	`Inventore iusto facilis aperiam modi est.`	Shipment notes
`internal_notes` Optional	string	`Inventore iusto facilis aperiam modi est.`	Warehouse / staff notes
`name` Required	string	`Walmart Oct 26`	The name of the shipment

Add tracking numbers to a shipment and change the status to shipped

POST/shipments/inbound/{SHIPMENT_ID}/submit

Parameter	Type	Examples	Description
`tracking_numbers` Required	array<string>	`[9405500205903080427328]`	An array of alphanumeric strings. Required unless carrier is set to no_tracking
`carrier` Optional	string	`usps`	Valid values: canada_post, dhl_express, fedex, usps,ups,shippo,no_tracking,other

Change the status of the shipment to received. No parameters are required.

POST/shipments/inbound/{SHIPMENT_ID}/receive

Archive one or more shipments.

POST/shipments/inbound/batch/archive

Parameter	Type	Examples	Description
`shipment_ids` Required	array	`See shipment_ids.* parameters`	An array of shipment IDS
`shipment_ids.*` Optional	int	`21`	The ID of the shipment