POST

Checkout


Checkout reserved tickets. Creates order and associates it with a site contact. Guest details must be sent according to Registration Form input fields. (To change an existing "INITIATED, "PENDING", or "OFFLINE_PENDING" order, call the Update Checkout endpoint).

Permissions
Manage Events - all permissions
Manage Orders
Manage Events
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v1/checkout

Body Params
eventIdstringRequiredformat GUID

Event ID.


reservationIdstringformat GUID

Ticket reservation ID.


memberIdstring

Member ID (if empty - no site member is associated to this order).


discountDiscount

Discount to apply on the invoice.


buyerBuyer

Buyer details.


guestsArray <Guest>minItems 1maxItems 50

Guest details.


paidPlanBenefitPaidPlanBenefit

Benefit granted by the pricing plan.


optionsOptions

Options controlling the checkout process.


marketingConsentboolean

Whether marketing consent was given

Response Object
orderOrder

Created order.


expiresstringformat date-time

Time when the order expires, applies to orders with status = INITIATED.


reservationsArray <TicketReservation>

Ticket reservations.


orderPageUrlstring

Order page url.

A simple checkout when the guest is the buyer.

Request
cURL
curl -X POST 'https://www.wixapis.com/events/v1/events/419d52c0-c93b-4155-a55c-108048f20be/tickets/checkout' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ --data-binary '{ "reservationId": "106348fb-2a70-4e6e-b6c1-7aa48752efb4", "discount": { "couponCode": "SUMMER" }, "guests": [ { "form": { "inputValues": [ { "inputName": "firstName", "value": "John" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "john.doe@wix.com" } ] } } ] }'
Response
JSON
{ "order": { "orderNumber": "FOIK-XNX7-MX", "reservationId": "106348fb-2a70-4e6e-b6c1-7aa48752efb4", "snapshotId": "ff95a725-a58c-4c38-b636-b90d3d216432", "eventId": "419d52c0-c93b-4155-a55c-108048f20be", "contactId": "", "memberId": "", "created": "2020-06-19T10:21:54.082Z", "firstName": "John", "lastName": "Doe", "email": "john.doe@wix.com", "checkoutForm": { "inputValues": [ { "inputName": "firstName", "value": "John" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "john.doe@wix.com" } ] }, "confirmed": false, "status": "INITIATED", "method": "", "ticketsQuantity": 3, "totalPrice": { "amount": "10.00", "currency": "EUR" }, "ticketsPdf": "<url_to_pdf>", "tickets": [], "archived": false, "anonymized": false, "fullName": "John Doe", "invoice": { "items": [ { "id": "210db14c-c339-4ce3-b07a-4c0032a6fc79", "quantity": 1, "name": "Nice ticket", "price": { "amount": "0.00", "currency": "EUR" }, "total": { "amount": "0.00", "currency": "EUR" }, "fees": [] }, { "id": "1d4083ae-e8cf-4bb7-8e2a-0ad011f12b93", "quantity": 2, "name": "Early Bird", "price": { "amount": "10.00", "currency": "EUR" }, "total": { "amount": "20.00", "currency": "EUR" }, "discount": { "amount": { "amount": "10.00", "currency": "EUR" }, "afterDiscount": { "amount": "10.00", "currency": "EUR" }, "code": "SUMMER", "name": "SUMMER", "couponId": "7a022172-f0c6-48f7-b4ad-8554697048aa", "discounts": [ { "amount": { "amount": "10.00", "currency": "EUR" }, "coupon": { "name": "SUMMER", "code": "SUMMER", "couponId": "7a022172-f0c6-48f7-b4ad-8554697048aa" } } ] }, "fees": [] } ], "total": { "amount": "20.00", "currency": "EUR" }, "discount": { "amount": { "amount": "10.00", "currency": "EUR" }, "afterDiscount": { "amount": "10.00", "currency": "EUR" }, "code": "SUMMER", "name": "SUMMER", "couponId": "7a022172-f0c6-48f7-b4ad-8554697048aa", "discounts": [ { "amount": { "amount": "10.00", "currency": "EUR" }, "coupon": { "name": "SUMMER", "code": "SUMMER", "couponId": "7a022172-f0c6-48f7-b4ad-8554697048aa" } } ] }, "subTotal": { "amount": "20.00", "currency": "EUR" }, "grandTotal": { "amount": "10.00", "currency": "EUR" }, "fees": [], "revenue": { "amount": "10.00", "currency": "EUR" } }, "fullyCheckedIn": false, "transactionId": "" }, "expires": "2020-06-19T10:41:33.147Z", "reservations": [ { "quantity": 1, "ticket": { "id": "210db14c-c339-4ce3-b07a-4c0032a6fc79", "price": { "amount": "0.00", "currency": "EUR" }, "free": true, "name": "Nice ticket", "description": "", "limitPerCheckout": 0, "orderIndex": 0, "policy": "", "eventId": "" } }, { "quantity": 2, "ticket": { "id": "1d4083ae-e8cf-4bb7-8e2a-0ad011f12b93", "price": { "amount": "10.00", "currency": "EUR" }, "free": false, "name": "Early Bird", "description": "", "limitPerCheckout": 0, "orderIndex": 0, "policy": "", "eventId": "" } } ] }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Did this help?