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

List locations

Lists fulfillment locations by cursor, with name or code search and an active filter.

GET/v1/fulfillment/locations

Lists fulfillment locations by cursor, with name or code search and an active filter.

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"
isActive?boolean

Only active items.

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/locations" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "storeId": "7204558912004325301",      "name": "Example resource",      "code": "example_code",      "type": "warehouse",      "isActive": false,      "isDefault": false,      "useForFulfillment": false,      "supportsShipping": false,      "supportsLocalDelivery": false,      "supportsPickup": false,      "isPhysicalStore": false,      "supportsPos": false,      "priority": 1,      "localDeliveryPostalCodes": [        "example"      ],      "localDeliveryZones": [        {          "name": "Example resource",          "postalCodes": [            "example"          ],          "radiusKm": 1,          "fee": 1,          "freeFromAmount": 1,          "minHours": 1,          "maxHours": 1        }      ],      "schedules": [        {          "id": "7204558912004325301",          "openTime": "09:00:00Z",          "closeTime": "09:00:00Z",          "name": "Example resource",          "dayOfWeek": "monday",          "enabled": false,          "isOpen": false,          "type": "delivery"        }      ],      "createdOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}