Skip to content
docs
Guides
ES
Fulfillment & ShippingFulfillment
shipment:read

List fulfillment orders

Lists the work to be fulfilled. One customer order becomes several fulfillment orders when its items ship from different locations.

GET/v1/fulfillment/orders

Lists the work to be fulfilled. One customer order becomes several fulfillment orders when its items ship from different locations.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
orderId?string

Identifier of the order.

locationId?string

Identifier of the location.

status?array<>

Only items in these statuses.

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/fulfillment/orders" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "orderId": "7204558912004325301",      "orderNumber": "ORD-2026-0001",      "locationId": "7204558912004325301",      "locationName": "Example resource",      "status": "pendingAssignment",      "itemCount": 1,      "totalQuantity": 1,      "createdOn": "2026-08-01T15:30:00Z",      "updatedOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}