Skip to content
Guides
Fulfillment & ShippingCoverage
settings:read

List shipping coverage

GET/v1/shipping/coverage

List shipping coverage. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

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/shipping/coverage" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "locations": [    {      "id": "7204558912004325301",      "name": "Example resource",      "code": "example_code",      "address": "example",      "city": "example",      "state": "example",      "country": "PE",      "postalCode": "example_code",      "isActive": false,      "isDefault": false,      "supportsShipping": false,      "supportsLocalDelivery": false,      "supportsPickup": false,      "localDeliveryPostalCodes": [        "example"      ],      "localDeliveryZones": [        {          "name": "Example resource",          "postalCodes": [            "example"          ],          "radiusKm": 1,          "fee": 1,          "freeFromAmount": 1,          "minHours": 1,          "maxHours": 1        }      ],      "profiles": [        {          "id": "7204558912004325301",          "name": "Example resource",          "isDefault": false,          "isActive": false        }      ],      "pickupPoints": [        {          "id": "7204558912004325301",          "name": "Example resource",          "city": "example",          "state": "example",          "postalCode": "example_code",          "address": "example",          "isExternal": false,          "status": "inactive"        }      ]    }  ],  "zones": [    {      "id": "7204558912004325301",      "code": "example_code",      "name": "Example resource",      "description": "Example description.",      "countryCodes": [        "example"      ],      "provinceCodes": [        "example"      ],      "cityNames": [        "example"      ],      "districtNames": [        "example"      ],      "postalCodes": [        "example"      ],      "isActive": false    }  ]}