Create an order

Service and/or package ids from GET /api/v1/services.

Start of the window, the start of an entry from GET /api/v1/availability/starts.

End of the window, the end of the SAME entry.

Code of the variant the order is priced as and scheduled with (for detailing, the vehicle size: SMALL, MEDIUM, LARGE, XL, SUV, XXL, MOTO). Take it from the variants of the services in GET /api/v1/services. Required; an unknown code is 400 INVALID_INPUT with field variant (for a GENERIC studio the codes of GET /catalog/variants). The variant's extraMinutes lengthen the work: pass the same variant to GET /api/v1/availability/starts so the scheduledEnd you send matches.

What the customer brings, checked against the studio's subject type (GET /subject-types). Optional for a studio that defines no type. A refusal is 400 INVALID_SUBJECT with field naming the attribute key (or subject.type).

Your own id of the order (e.g. your system's booking number), at most 64 characters, unique per studio: reusing one is 409 CONFLICT with field externalRef. Another studio may use the same value. Read back on the order and searchable with GET /orders?externalRef=.

A gift voucher or discount code, applied exactly as on the booking page.

Configurator answers, for services that ask questions: questionId and optionId come from questions of the service in GET /api/v1/services.

Optional name of your integration, stored on the order as its source label. Sanitized to [a-z0-9-], max 40 characters (Partner Web! becomes partner-web). The order's channel is always API; it cannot be set here.

Where the customer came from, for conversion measurement on your side. Every field is an optional string; a value over its cap is 400 INVALID_INPUT with field attribution.<name> (nothing is cut silently). An unknown key is 400 UNKNOWN_FIELD with field attribution.<key>. The order list and webhooks return the same values in attribution.

Your own flat key-value data, kept on the order and returned unchanged by GET /api/v1/orders/{id}, the order list and the order.* webhooks. Free-form: any key that follows the rules below is accepted (this is the one request object where unknown keys are expected). Caps: at most 20 keys; a key is 1-40 characters of A-Z a-z 0-9 _ . -; a value is a string of at most 500 characters (a number, boolean, null, array or object value is 400 INVALID_INPUT with field metadata.<key>; too many keys is 400 with field metadata). It may be seen by the studio: do not put secrets in it.

Optional company to invoice. company is required whenever any other key is sent (400 INVALID_INPUT, field billing.company); company is at most 160 characters, ico and dic at most 16, address at most 255 (400 with field billing.<key>). An unknown key is 400 UNKNOWN_FIELD. Stored on the order and returned as billing by the order endpoints and order.* webhooks; deleted when the customer is erased. Shyni does not issue invoices from it.

true books the studio's free inspection instead of the order: kind INSPECTION, totalPrice 0, no deposit (so no paymentUrl), the window as long as the studio's inspection length (take it from GET /availability/starts?inspection=true). serviceIds must hold a service whose group offers an inspection, else 400 INVALID_INPUT (field: serviceIds); a voucherCode is refused. A contact (same e-mail or same phone) can have one upcoming inspection: a second booking is 409 INSPECTION_ALREADY_BOOKED. Quoted (from-price or on-request) services can be inspected. Add the customer's photos with POST /orders/{id}/inspection-photos.

The studio terms version you showed the customer (terms.version from GET /studio). Send it when your site shows the studio's terms; omit it when you do not (nothing is recorded then). A version other than the studio's current one is 409 TERMS_VERSION_STALE (field: acceptedTermsVersion). A studio without terms accepts any value and records nothing.

Proof of a known car for services with orderAudience KNOWN_CARS: the token of a return-reminder link, or the token a storefront customer gets by confirming a code sent to their e-mail (the studio's storefront only, not an API endpoint). It must belong to the car in subject, and that car must have a completed order at the studio. Anything else (absent, invalid, expired, another studio, a car without a completed order) is the same 422 SERVICE_KNOWN_CARS_ONLY.

Secret key only. Waives the day-policy surcharge (a VIP day) of this one order; the waived amount comes back as waivedDayAdjustment. A day discount is never waived. A publishable key sending true is 403 FORBIDDEN with field waiveDayAdjustment and nothing is created; false or absent is fine for both key kinds.

Secret key only. No deposit for this order: depositState NOT_REQUIRED, depositAmount 0, no hold and no paymentUrl. A publishable key sending true is 403 FORBIDDEN with field skipDeposit and nothing is created; false or absent is fine for both key kinds.