Skip to content
Guides
ES
API reference
stableshipment: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?null|string
locationId?null|string
status?array<>

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"
{  "data": [    {      "id": "string",      "orderId": "string",      "orderNumber": "string",      "locationId": null,      "locationName": null,      "status": "pendingAssignment",      "itemCount": 0,      "totalQuantity": 0.1,      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}