Create Order / Confirm Reservation / Checkout Cart

POST {{baseUrl}}/orders

This API is called to book / confirm product(s) and get a barcode / QR-code in response.

Creating an order triggers a payment obligation. Make sure that you received the money from the guest and please note that some products are non-refundable. Do not create an order if its not certain that the product will be purchased.

Make sure that you cross-check the order_pricing.price_total with the amount charged to the guest. Mismatches might indicate missing fees or discounts, causing financial mismatches between our systems. We recommend aborting the booking process in case this happens.

---

Booking Options

Direct Booking

• Direct booking of a product without availability (product_availability:false) and no traveldate (product_traveldate_required:false) (non-dated, no capacity ticket)

• Direct booking of a product without availability (product_availability:false) and required traveldate (product_traveldate_required:true) (dated, unlimited capacity ticket)

• Direct booking of a product with availability (product_availability:true) and with or without capacity (product_capacity:true/false).

• Adding a promotional code to a Direct Booking is not supported.
• Direct payment settlement with a Direct Booking is not supported.

Confirm Reservation / Checkout Cart

• Booking of product(s) with a reservation_reference (Confirmation of an active reservation (Confirm and Order)). This can be any product with any configuration.

Please note that multiple types of Direct Booking can be made at once, but only a single Confirm Reservation at a time is supported. Would you wish to confirm multiple reserved products at once, please put multiple bookings in a single reservation (Cart). You can not mix different booking options (Direct Booking && Confirm Reservation) in the same request. Therefore only multiple entries of the Direct Booking option is being supported.

• In case multiple products are to be booked, if any of them are unavailable, the whole order will be declined.
• You are unable to combine products with different base currencies in the same order.

Request Body

{"data"=>{"order"=>{"order_distributor_id"=>"{{distributorID}}", "order_external_reference"=>"{{$randomUUID}}", "order_language"=>"EN", "order_settlement_type"=>"EXTERNAL", "order_bookings"=>[{"booking_option_type"=>"CONFIRM_RESERVATION", "reservation_reference"=>"{{reservation_reference}}"}], "order_contacts"=>[{"contact_external_uid"=>"{{$randomUUID}}", "contact_name_first"=>"{{$randomFirstName}}", "contact_name_last"=>"{{$randomLastName}}", "contact_email"=>"{{$randomExampleEmail}}", "contact_phone"=>"{{$randomPhoneNumber}}", "contact_mobile"=>"{{$randomPhoneNumber}}", "contact_language"=>"{{$randomLocale}}", "contact_age"=>19, "contact_address"=>{"name"=>"Start of the walking Tour / My house / Office", "street"=>"{{$randomStreetName}}", "city"=>"{{$randomCity}}", "postal_code"=>"1011 PN", "region"=>"Noord-Holland", "country"=>"{{$randomCountry}}", "country_code"=>"{{$randomCountryCode}}", "latitude"=>"{{$randomLatitude}}", "longitude"=>"{{$randomLongitude}}", "notes"=>"It's on the fourth floor"}}]}}}

HEADERS

RESPONSES

status: Created

{"api_version":"3.4.0","data":{"kind":"location","order":{"order_bookings":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_channel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"order_created":"1950-04-19T12:44:51.849Z","order_created_email":"cashier@prioticket.com","order_created_name":"Demo Cashier","order_distributor_id":"501","order_distributor_name":"Demo Distributor","order_external_reference":"EXTERNALREF123","order_language":"en","order_modified":"2013-01-10T02:21:30.404Z","order_platform_id":"1","order_platform_name":"Platform Name","order_pricing":{"price_variations":[{"variation_label":"Peak Hour","variation_amount":"2.50","variation_type":"PRODUCT_DYNAMIC"}],"eab47":81802886.5524266,"ullamcof1":"velit consequat aliqua pariatur in"},"order_reference":"ORDRREF123456","order_reseller_id":"1300","order_reseller_name":"Demo reseller","order_status":"ORDER_CONFIRMED","order_version":1,"order_view_type":"DISTRIBUTOR","order_partner_id":"4534543543","order_partner_name":"Partner Name","order_settlement_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"order_contacts":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_promocodes":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_payments":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_invoices":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_options":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"order_flags":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_custom_fields":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_notes":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"order_activity_url":"https://activity.prioticket.com/orders/ORDRREF123456","order_customer_url":"https://customer.prioticket.com/orders/ORDRREF123456","order_confirmed":"2012-01-17T05:13:54.503Z","order_cancellation_date_time":"2014-03-20T12:49:04.405Z"}}}