Inbound Shipments
List inbound shipments
Get a paginated list of active (non-archived) inbound shipments.
GET
/shipments/inbound| Parameter | Type | Examples | Description |
|---|---|---|---|
filters[not_received] Optional | boolean | | When true, only return shipments that have not yet been received |
page Optional | integer | 1 | The page number to retrieve (1-indexed) |
per_page Optional | integer | 15 | The number of items per page |
Example Response
Create an inbound shipment
Create a new inbound shipment for the current merchant.
POST
/shipments/inbound| Parameter | Type | Examples | Description |
|---|---|---|---|
name Required | string | January Restock 2024 | The name of the shipment |
warehouse_id Required | integer | 5 | The ID of the destination warehouse |
notes Optional | string | Handle with care | Optional notes about the shipment |
Example Response
List archived inbound shipments
Get a paginated list of archived inbound shipments.
GET
/shipments/inbound/archived| Parameter | Type | Examples | Description |
|---|---|---|---|
page Optional | integer | 1 | The page number to retrieve (1-indexed) |
per_page Optional | integer | 15 | The number of items per page |
Show an inbound shipment
Get a single inbound shipment by its ID, including attachments, service lines, warehouse, and tags.
GET
/shipments/inbound/{inbound_shipment}| Parameter | Type | Examples | Description |
|---|---|---|---|
inbound_shipment Required | integer | 1001 | The ID of the inbound shipment |
Example Response
Update an inbound shipment
Update an existing inbound shipment.
PUT
/shipments/inbound/{inbound_shipment}| Parameter | Type | Examples | Description |
|---|---|---|---|
inbound_shipment Required | integer | 1001 | The ID of the inbound shipment |
name Optional | string | January Restock 2024 (Updated) | The name of the shipment |
notes Optional | string | Handle with care | Notes about the shipment |
internal_notes Optional | string | Priority processing requested | Internal notes visible only to staff |
eta Optional | string | 2024-01-24T00:00:00Z | The estimated time of arrival |
Example Response
Submit an inbound shipment
Mark an inbound shipment as shipped. Optionally include a carrier and tracking numbers.
POST
/shipments/inbound/{inbound_shipment}/submit| Parameter | Type | Examples | Description |
|---|---|---|---|
inbound_shipment Required | integer | 1001 | The ID of the inbound shipment |
carrier Optional | string | ups | The carrier used for shipping |
tracking_numbers Optional | array<string> | | List of tracking numbers. Required when carrier is provided. |
Example Response
Receive an inbound shipment
Mark an inbound shipment as received at the warehouse.
POST
/shipments/inbound/{inbound_shipment}/receive| Parameter | Type | Examples | Description |
|---|---|---|---|
inbound_shipment Required | integer | 1001 | The ID of the inbound shipment |
Example Response
Batch archive inbound shipments
Archive multiple inbound shipments at once.
POST
/shipments/inbound/batch/archive| Parameter | Type | Examples | Description |
|---|---|---|---|
shipment_ids Required | array<integer> | | The IDs of the shipments to archive |