Skip to content
Guides
ES
API reference
stablesettings:read

List locations

Retrieve a paginated list of fulfillment locations

GET/v1/fulfillment/locations

Retrieve a paginated list of fulfillment 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"
isActive?boolean
sellerId?null|string

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"
{  "data": [    {      "id": "string",      "storeId": "string",      "sellerId": null,      "name": "string",      "code": "string",      "type": "warehouse",      "address": null,      "city": null,      "state": null,      "country": null,      "postalCode": null,      "latitude": null,      "longitude": null,      "phone": null,      "email": null,      "description": null,      "isActive": true,      "isDefault": true,      "useForFulfillment": true,      "supportsShipping": true,      "supportsLocalDelivery": true,      "supportsPickup": true,      "isPhysicalStore": true,      "supportsPos": true,      "priority": 0,      "pickupInstructions": null,      "pickupLeadTimeInMinutes": null,      "pickupSlotInMinutes": null,      "pickupDailyCapacity": null,      "localDeliveryInstructions": null,      "localDeliveryLeadTimeInMinutes": null,      "localDeliverySlotInMinutes": null,      "localDeliveryDailyCapacity": null,      "localDeliveryFee": null,      "localDeliveryFreeFromAmount": null,      "localDeliveryMinHours": null,      "localDeliveryMaxHours": null,      "localDeliveryPostalCodes": [        "string"      ],      "localDeliveryZones": [        {          "name": "string",          "postalCodes": [            "string"          ],          "radiusKm": null,          "fee": null,          "freeFromAmount": null,          "minHours": null,          "maxHours": null        }      ],      "schedules": [        {          "id": "string",          "openTime": "14:15:22Z",          "closeTime": "14:15:22Z",          "name": "string",          "dayOfWeek": "monday",          "enabled": true,          "isOpen": true,          "type": "delivery"        }      ],      "status": "active",      "createdOn": "2019-08-24T14:15:22Z",      "updatedOn": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}