ShopEazydevelopers
API referenceMerchant API BetaA I

Improve a photo or draw a new image

Beta
Credentials
  • OAuth access token
Scopes
ai:spend
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Daily limit
AI generations, 300 a day per store. Over the limit is 429 rate_limited.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
POST
/v1/merchant/stores/{storeId}/ai/image

Spends credits.

Plan: adset and week are Marketing Plus tools (included with Growth and Scale), like "Advert copy" and "Plan my week" in the console's Marketing tools: without it they are refused with 403 plan_limit before anything is charged. Every other make is open to every plan.

Storage: refused with 403 plan_limit when it would take the Library over the plan's storage. What is already stored stays.

Access: OAuth scope ai:spend; write-gated by the subscription.

Authorization

merchantOAuth ai:spend
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: ai:spend

Path Parameters

storeId*string

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

Header Parameters

Idempotency-Key*string

Required 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.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body

sourceUrl (+ action) improves a photo; otherwise prompt (+ aspect) draws one. One of the two is required.

sourceUrl?string
action?string

An imageActions[].id from GET .../ai.

prompt?string
Lengthlength <= 1000
aspect?string
itemId?string

Response Body

Created

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/ai/image' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "url": "string",    "kind": "string",    "creditsSpent": 0,    "creditsRemaining": 0  }}

Write a name and description POST

Spends credits. Saves nothing. Access: OAuth scope `ai:spend`; write-gated by the subscription.

List or search customers GET

Access: OAuth scope `customers:read`; not write-gated. Paged: `{ items, nextCursor }`, `limit` (default 50, at most 200) and an opaque `cursor`.