ShopEazydevelopers
API referenceMerchant API BetaBookings

Tick a traveller on a tour as there (or not)

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.
PUT
/v1/merchant/stores/{storeId}/orders/{orderId}/lines/{lineId}/travellers/{index}/attendance

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.

orderId*string
lineId*string
index*integer

The traveller's place in the booking (from getTourManifest).

Range0 <= value

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
attended*boolean

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/orders/<orderId>/lines/<lineId>/travellers/<index>/attendance' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{  "attended": false}'
Example Response
{  "data": {    "orderId": "string",    "lineId": "string",    "index": 0,    "attended": true  }}

Move a booking to another open time POST

Frees the old place and holds the new one in one step, then emails the customer. Access: OAuth scope `bookings:write`; write-gated by the subscription.

The design as it stands in the draft GET

Look, colours, hero, home sections and announcement; whether the draft differs from live; a preview link (null when this deployment cannot sign one). Access: OAuth scope `store:read`; not write-gated.