Upcoming appointments and tour departures, soonest first
- Credentials
- OAuth access token
- Scopes
orders:read
Access: OAuth scope orders:read; not write-gated.
Paged: { items, nextCursor }, limit (default 50, at most 250) and an opaque cursor. It pages through the newest 250.
merchantOAuth orders:readAuthorizationBearer <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
storeId*stringA store the person can reach. Any other id answers 404, never 403.
cursor?stringThe nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.
limit?integerPage size: default 50, at most 250 (more is 250; a missing or unusable value is 50).
1 <= value <= 25050OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/bookings' \ -H 'Authorization: Bearer <access_token>'{ "data": { "items": [], "nextCursor": null }}Shoot a product: N takes of one brief POST
Takes of the same brief, one after another (the image model rate-limits, and four good takes beat three rejected at once), each metered and saved on its own: a failure half way leaves the takes that came out in the Library and charges only for those (`creditsSpent`, `failed`). Running out of credits after the first take stops the rest; before the first it is 403 `insufficient_credits`. A `strict` fidelity cuts the product out once first (`studio.removeBg`), charged with the first take that comes out; a shoot that gives nothing costs nothing. If none came out: 422 `validation_error`. It answers when all takes are done, which can be a few minutes at `variants: 4`; clients use a long timeout. The `Idempotency-Key` keeps a retry from shooting, and paying for, the brief again. Make the follow-ups with `refineShot` and put a take on a listing with `addLibraryAssetToProduct`. Costs are in `getStudioCosts`. Access: OAuth scope `ai:spend`; write-gated by the subscription.
Book a service time or tour seats for a customer POST
Makes an order that holds the place (the capacity pool is shared with the storefront). `pay`: `now` returns a pay link, `later` pays on the day, `free` charges nothing (ask the merchant first). `at` must be a start from `getAvailability`. Access: OAuth scope `bookings:write`; write-gated by the subscription.