Outbound Shipments
Making calls to the outbound shipments API
Index
Get a list of all outbound shipments, using Pagination.
GET
/shipments/outboundExample Response
Index (Archived Shipments)
Get a list of all archived outbound shipments, using Pagination.
GET
/shipments/outbound/archivedExample Response
Show
Retrieve a specific shipment
GET
/shipments/outbound/{SHIPMENT_ID}Example Response
Create
Create a new outbound shipment
POST
/shipments/outbound| 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. |
Example Response
Attachments
Attach a document to an Outbound Shipment
The Content-Type header must be set to multipart/form-data
POST
/shipments/outbound/{OUTBOUND_SHIPMENT_ID}/attachment| Parameter | Type | Examples | Description |
|---|---|---|---|
file Required | binary | Manifest.xml | The contents of the file |
name Required | string | Manifest | The name of the file |
