Bring a cancelled order back

Internal order id, use this for GET /api/v1/orders/{id}.

Display/reference id shown to the customer, a random 8-digit number without a leading zero (e.g. 48291375), unique per studio; it is also the payment variable symbol. Look an order up by it with GET /api/v1/orders/by-public-id/{publicId}.

ORDER: an ordinary booking. INSPECTION: the studio's free inspection (price 0, no deposit), booked with inspection: true in POST /orders; finish it with POST /orders/{id}/inspection/complete.

PENDING: a deposit above zero is owed and unpaid on a live order. PAID: the deposit was received. REFUNDED: it was given back. NOT_REQUIRED: no deposit is owed, either because the order never had one (deposit 0, free inspection) or because the order was cancelled before the deposit was paid. A cancelled order whose deposit was already PAID or REFUNDED keeps that state, so depositState=PENDING lists only deposits that still have to be collected.

ISO 4217 code of the studio currency every amount on this order (lines, payments, discount included) is denominated in.

Amount in minor units of currency (hellers for CZK).

When the order last changed, state, time, price, lines, payments, assignment. Poll key for GET /api/v1/orders?updatedSince=; of two snapshots of the same order (two webhook deliveries, or a delivery and a read) the one with the later updatedAt is the newer.

Your own id of the order (set by externalRef on POST /orders), unique per studio; find the order with GET /orders?externalRef=. Null when none.

GDPR erasure sentinel values (e.g. redacted placeholders) pass through as-is post-erasure, v1 does not otherwise redact this data.

Code of the variant the order was priced as (for detailing, the vehicle size, e.g. MEDIUM).

The subject the order is for; null when the order carries no data about it.

Amount in minor units of currency (hellers for CZK).

Amount in minor units of currency (hellers for CZK).

Amount in minor units of currency (hellers for CZK). Negative on overpayment.

Free text given on cancel, or NO_SHOW when the order was cancelled through POST /orders/{id}/no-show.

Where the order came from. STOREFRONT, EMBED and QR are claimed by the customer's browser; BOOKING_LINK, RETURN_REMINDER, ADMIN and API are decided by the server.

Sanitized campaign or integration label ([a-z0-9-], max 40).

Host name of the page that referred the customer, never a full URL.

The attribution stored on the order. Every field is null when it was not sent (all orders before this field existed, and orders from the booking page for the click ids and utmTerm / utmContent).

The flat string map sent as metadata when the order was created through POST /api/v1/orders; {} when none. Free-form keys, see the request schema for the caps.

The company billing details sent as billing when the order was created through POST /api/v1/orders; null when none were sent, and after the customer's data was erased.

Who cancelled the order; HOLD_EXPIRY = the deposit hold elapsed. Null while the order is not cancelled.

Id of the team member the order is assigned to; null when nobody is.

The studio terms version sent as acceptedTermsVersion when the order was created; absent when none was sent.

Day-policy surcharge the studio waived on this order (minor units, waiveDayAdjustment on create); absent when nothing was waived.

The customer's open request to move the order, null when there is none. Its id is the {requestId} of POST /api/v1/orders/{id}/reschedule-requests/{requestId}/approve and .../reject.

The customer's newest reschedule request when the studio rejected it (the order never moved), null otherwise; a newer request, an approval or a cancellation replaces it. The window the customer asked for stays readable here, so an integration can tell the customer which time was declined (webhook order.reschedule_rejected).

The studio's verdict on a free inspection (kind INSPECTION); null for an ordinary order. Its reply stays null until the studio answers (POST /api/v1/orders/{id}/inspection/reply).