Email the customer a reminder to pay
- Credentials
- OAuth access token
- Scopes
orders:write- Subscription
- Needs an active plan. Otherwise
403 subscription_locked. - Daily limit
- Email sends, 100 a day per store. Over the limit is
429 rate_limited. - Idempotency
- Send an
Idempotency-Keyheader. A retry with the same key does the work once.
Access: OAuth scope orders:write; write-gated by the subscription.
merchantOAuth orders: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: orders:write
storeId*stringA store the person can reach. Any other id answers 404, never 403.
orderId*stringIdempotency-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}$OK
application/json- response
data*curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/orders/<orderId>/remind' \ -H 'Authorization: Bearer <access_token>' \ -H 'Idempotency-Key: <unique_key>'{ "data": { "sent": true }}Refund an order POST
Moves money. `orders:refund` is opt-in on the OAuth consent screen and never in a preset. Access: OAuth scope `orders:refund`; owner/admin only; write-gated by the subscription.
The link a customer pays an order at GET
`route` is `shop` (the shop's own pay page, `payUrl`), `provider` (only the card partner's hosted link can be made, which needs the order page) or null (nothing can take this payment online yet). A paid order has `paid: true` and no link. Access: OAuth scope `orders:write`; not write-gated.