Change the business details
- Credentials
- OAuth access token
- Scopes
settings:write- Role
- Owners and admins only. Staff get
403 forbidden. - Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
The business behind the shops: name, legal and trading names, registration and VAT numbers, email, phone and address. Only what is sent changes, and every shop's policies pick up the new contact details.
Access: OAuth scope settings:write; owner/admin only; write-gated by the subscription.
merchantOAuth settings:writeAuthorizationBearer <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: settings:write
storeId*stringA store the person can reach. Any other id answers 404, never 403.
Idempotency-Key*stringRequired on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.
^[A-Za-z0-9_-]{8,128}$application/json- body
name?stringlength <= 80legalName?stringlength <= 120tradingName?stringlength <= 120registrationNumber?stringlength <= 40vatNumber?stringlength <= 20email?stringlength <= 200phone?stringlength <= 30address?OK
application/json- response
data*curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/business-details' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "name": "string", "business": { "legalName": "string", "tradingName": "string", "registrationNumber": "string", "vatNumber": "string", "email": "string", "phone": "string", "addressLine": "string", "city": "string", "province": "string", "postalCode": "string", "country": "string" } }}Set the shop's Google Business link PUT
The Google Business Profile link shown on the shop. An empty `url` removes it. Access: OAuth scope `settings:write`; owner/admin only; write-gated by the subscription.
List or search orders GET
Access: OAuth scope `orders:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 30, at most 100) and an opaque `cursor`.