Fulfillment orders
A fulfillment order is the part of a sales order routed to one location. The per-stage queues (pending_accept, pending_allocation, …) described in the integration guides return only the orders waiting for your next action. To see every fulfillment order that is still in play, whatever its stage, use the list of all active fulfillment orders.
This endpoint is read-only.
| Endpoint | Purpose | ACL resource |
|---|---|---|
GET /V1/fulfillmentOrders/all | List all active fulfillment orders, 100 per page | Shipper_FulfillmentOrder::api_list_all |
List all active fulfillment orders
Section titled “List all active fulfillment orders”GET /rest/{store_code}/V1/fulfillmentOrders/all?page=1&date=2026-10-30%2000:00:00Authorization: Bearer <your-token>Accept: application/jsonQuery parameters — both optional:
| Parameter | Description |
|---|---|
page | Page number, starting at 1. Page size is fixed at 100; iterate until you receive an empty array. |
date | yyyy-mm-dd hh:mm:ss — only fulfillment orders updated at or after this time. |
An invalid page or date returns 400.
What the list contains:
- Every fulfillment order that is not
rejected,canceledorclosed— frompending(awaiting accept) throughaccepted,processingtocomplete. - Per order, only the items that are still active: rejected and canceled items are left out.
- Prices and totals on the order and its items, plus
cod_amountandpackage_value. - When an item is fulfilled from another location than the order’s (an inter-warehouse transfer), the item carries its own
warehouse_code.
See GET /V1/fulfillmentOrders/all for the full schema. The response has the same shape as the per-stage queues.
Linking fulfillment orders to sales orders
Section titled “Linking fulfillment orders to sales orders”Each fulfillment order references the sales order it was created from:
sales_order_id— theidof the sales order.sales_order_number— the order number in the sales channel (the sales order’ssales_order_number).
Each fulfillment order item carries sales_order_item_id — the id of the matching sales order item. Use it to match lines between the two; do not rely on sku, which can repeat across lines.
One sales order may have several fulfillment orders — one per location, plus new ones when rejected items are rerouted. Summing the item quantities of a sales order’s fulfillment orders per sales_order_item_id gives the quantity in fulfillment for that line; the sales order item’s qty_ship_requested gives the same figure directly.
Typical uses
Section titled “Typical uses”- Reconciliation — compare the active fulfillment orders with your own records, e.g. after an outage, instead of replaying every per-stage queue.
- Reporting — follow how many orders are in each stage (
status,allocated_at,shipped_at,invoiced_at). - Customer service — show, per sales order, which location is handling which items.