ShopEazydevelopers
API referenceMerchant API BetaDelivery

Find courier lockers and counters

Beta
Credentials
  • OAuth access token
Scopes
orders:read
GET
/v1/merchant/stores/{storeId}/delivery/lockers

Neither q nor a point returns lockers: []. A read, so it is not write-gated: a store whose plan has lapsed can still search.

Access: OAuth scope orders:read; not write-gated.

Authorization

merchantOAuth orders:read
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: orders:read

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Query Parameters

q?string

Free-text search.

lat?number

With lng: search near a point (0,0 is ignored).

lng?number

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/delivery/lockers' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "lockers": [      {        "id": "string",        "name": "string",        "courier": "string",        "provider": "string",        "type": "locker",        "addressLine": "string",        "localArea": "string",        "city": "string",        "province": "string",        "postalCode": "string",        "openingHours": "string",        "distanceM": 0      }    ]  }}