ShopEazydevelopers
API referenceMerchant API BetaStore

Is this shop web address free?

Beta
Credentials
  • OAuth access token
Scopes
store:read
GET
/v1/merchant/stores/{storeId}/web-address/check

The same policy and availability provisioning uses. When it is not free, the closest address that is.

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

Authorization

merchantOAuth store: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: store:read

Path Parameters

storeId*string

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

Query Parameters

name*string

The part before .shopeazy.co.

Length1 <= length <= 63

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/web-address/check?name=%3Cname%3E' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "address": "jabus-plant-shop.shopeazy.co",    "free": true,    "reason": null,    "suggestion": null,    "current": "https://jabus-plant-shop.shopeazy.co"  }}