Update / Amend Order

PUT {{baseUrl}}/orders/:order_reference

This API is called to update an order or booking. Regular users should only update basic order details such as contact information. For requesting other timeslots or changing the booking count, we recommend that you cancel the current order and rebook.

Make sure that you provide the complete top-level order object and that all original fields with either the current or amended values (e.g. order_distributor_id, order_external_reference, all order_contacts etc) are sent, missing (optional) fields will be removed from our records. Note that the opposite is true for order_bookings, only the bookings you would like to amend should be provided (see advanced functionality below).

Advanced Functionality

Amending confirmed orders

Request Body

{"api_version"=>"3.2.0", "data"=>{"kind"=>"order", "order"=>{"order_external_reference"=>"{{$randomUUID}}", "order_language"=>"NL", "order_channel"=>"WPOS", "order_contact"=>{"contact_external_uid"=>"{{$randomUUID}}", "contact_type"=>"CONTACT", "contact_name"=>"Test", "contact_name_first"=>"Prio", "contact_name_last"=>"Test", "contact_email"=>"priotest@example.com"}}}}

HEADERS

RESPONSES

status: OK

{"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"}}}