PATCH

Update Checkout


Updates order and tickets (supported only for unconfirmed orders). Guest details must be sent according to Registration Form input fields.

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

Path Params
orderNumberstringRequired

Unique order number.

Body Params
eventIdstringRequiredformat GUID

Event ID.


buyerBuyer

Buyer details.


guestsArray <Guest>minItems 1maxItems 20

Guest details.


memberIdstring

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


discountDiscount

Discount to apply on the invoice.


paidPlanBenefitPaidPlanBenefit

Benefit granted by the pricing plan.

Response Object
orderOrder

Updated order.


orderPageUrlstring

Order page url.

Update Checkout Example 1
Request
cURL
curl -X PATCH 'https://www.wixapis.com/events/v1/events/fd56076c-38f4-4705-b9eb-ec322b85c745/tickets/checkout/FM9X-EHKF-ZO' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ --data-binary '{ "buyer": { "firstName": "Ms Sarah", "lastName": "Doe", "email": "john.doe@wix.com" }, "guests": [ { "form": { "inputValues": [ { "inputName": "firstName", "value": "John" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "john.doe@wix.com" } ] } }, { "form": { "inputValues": [ { "inputName": "firstName", "value": "Sarah" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "sarah.doe@wix.com" } ] } }, { "form": { "inputValues": [ { "inputName": "firstName", "value": "Mathew" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "mathew.doe@wix.com" } ] } } ] }'
Response
JSON
{ "order": { "orderNumber": "FNNU-XRQ9-QR", "reservationId": "1fe76e20-efa0-4330-be44-2a8b2ca3c208", "snapshotId": "ed37fbec-e065-473e-b079-6dbde2dff218", "eventId": "619d52c0-c93b-4155-a55c-108048f20b3f", "contactId": "", "memberId": "", "created": "2020-05-22T13:36:39.158Z", "firstName": "John", "lastName": "Doe", "email": "john.doe@wix.com", "checkoutForm": { "inputValues": [ { "inputName": "firstName", "value": "Ms Sarah" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "john.doe@wix.com" } ] }, "confirmed": false, "status": "INITIATED", "method": "", "ticketsQuantity": 3, "totalPrice": { "amount": "190.00", "currency": "EUR" }, "ticketsPdf": "<url_to_pdf>", "tickets": [], "archived": false, "anonymized": false, "fullName": "John Doe", "invoice": { "items": [ { "id": "48da25d2-afb2-4955-92a0-b820635ac321", "quantity": 1, "name": "Nice ticket", "price": { "amount": "0.00", "currency": "EUR" }, "total": { "amount": "0.00", "currency": "EUR" }, "fees": [] }, { "id": "9c13fb37-f2c6-4c9c-8950-41c49b0a5c84", "quantity": 2, "name": "VIP ticket", "price": { "amount": "100.00", "currency": "EUR" }, "total": { "amount": "200.00", "currency": "EUR" }, "discount": { "amount": { "amount": "10.00", "currency": "EUR" }, "afterDiscount": { "amount": "190.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": "200.00", "currency": "EUR" }, "discount": { "amount": { "amount": "10.00", "currency": "EUR" }, "afterDiscount": { "amount": "190.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": "200.00", "currency": "EUR" }, "grandTotal": { "amount": "190.00", "currency": "EUR" }, "fees": [], "revenue": { "amount": "190.00", "currency": "EUR" } }, "fullyCheckedIn": false, "transactionId": "" }, "expires": "2020-05-22T13:12:54.804Z", "reservations": [ { "quantity": 1, "ticket": { "id": "48da25d2-afb2-4955-92a0-b820635ac321", "price": { "amount": "0.00", "currency": "EUR" }, "free": true, "name": "Nice ticket", "description": "", "limitPerCheckout": 0, "orderIndex": 0 } }, { "quantity": 2, "ticket": { "id": "9c13fb37-f2c6-4c9c-8950-41c49b0a5c84", "price": { "amount": "100.00", "currency": "EUR" }, "free": false, "name": "VIP ticket", "description": "", "limitPerCheckout": 0, "orderIndex": 0 } } ] }
Errors

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

Did this help?