ShopEazydevelopers
API referenceMerchant API BetaBookings

Book a service time or tour seats for a customer

Beta
Credentials
  • OAuth access token
Scopes
bookings:write
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
POST
/v1/merchant/stores/{storeId}/bookings

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.

Authorization

merchantOAuth bookings:write
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: bookings:write

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
listingId*string
at*integer

Epoch millis of the slot or departure start, from getAvailability.

customer*
seats?integer
Range1 <= value <= 50
Default1
pay?string
Value in"now""later""free"
fare?string

Tour price band by name or id.

meetingPoint?string

Tour pickup point by name or id.

travellers?array<>
note?string

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/bookings' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "listingId": "string",  "at": 1,  "customer": {    "name": "string"  }}'
Example Response
{  "data": {    "orderId": "string",    "number": "string",    "listing": "string",    "lineId": "string",    "at": 0,    "total": {      "amount": 0,      "currency": "ZAR"    },    "pay": "now",    "payUrl": "string"  }}

Upcoming appointments and tour departures, soonest first GET

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.

Check a booking and price it, without making it POST

Validates the booking as `bookAppointment` would and says what it costs, so waiving the price can be put to the merchant first. Creates nothing. Access: OAuth scope `bookings:write`; not write-gated.