Orders
List orders
GET
/orders| Parameter | Type | Examples | Description |
|---|---|---|---|
fulfillable Optional | boolean | | Filter to only return fulfillable orders |
Example Response
Upload orders
POST
/orders/upload| Parameter | Type | Examples | Description |
|---|---|---|---|
channel_id Optional | integer | 1 | The ID of the channel to upload orders for |
orders Required | array<Order> | | The list of orders to upload |
Example Response
Get an order
GET
/orders/{order}| Parameter | Type | Examples | Description |
|---|---|---|---|
order Required | integer | 1 | The ID of the order |
Example Response
Upload a shipping label for an order
POST
/orders/{order}/uploadShippingLabel| Parameter | Type | Examples | Description |
|---|---|---|---|
order Required | integer | 1 | The ID of the order |
Example Response
Mark an order as shipped
POST
/orders/{order}/markAsShipped| Parameter | Type | Examples | Description |
|---|---|---|---|
order Required | integer | 1 | The ID of the order |
tracking_number Optional | string | 1Z999AA10123456784 | The tracking number for the shipment |
carrier Optional | string | ups | The carrier for the shipment |
fulfillment_request_id Optional | string | | The ID of the fulfillment request |