Orders
Manage your orders
Manage the complete order lifecycle:
Confirm reservations.
Make direct bookings.
Amend existing orders.
List all orders and bookings.
(Partial) cancel orders.
Get pre-generated vouchers.
This API is meant to return a small subset of orders. By default the last 3 months are returned.
If you would like to retrieve all orders for Reporting / BI purposes we recommended a different approach, please contact your account manager for more information.
By default only the latest revision will be returned.
Authorizations
Query parameters
reseller_idstringOptionalExample:
[FILTER] on reseller_id.
501distributor_idstringOptionalExample:
[FILTER] on distributor_id.
501market_admin_idstringOptionalDeprecatedExample:
[FILTER] on market_admin_id.
567565856supplier_idstringOptionalExample:
[FILTER] on supplier_id.
145order_referencestring · min: 8OptionalExample:
[FILTER] on order_reference.
ORDRREF123456order_external_referencestringOptionalExample:
[FILTER] on order_external_reference.
EXTERNALREF123order_contact_uidstring · uuidOptionalExample:
[FILTER] on order_contact_uid.
f44226c0-e142-11ea-86d2-83036af9991eorder_contact_namestringOptionalExample:
[FILTER] on order_contact_name, contact_name_first and contact_name_last.
John Doeorder_contact_emailstring · emailOptionalExample:
[FILTER] on order_contact_email.
JohnDoe@example.comorder_created_fromstring · date-timeOptional
[FILTER] on order_created. Only the orders created from this specific date will be returned. A longer time range might increase response times.
order_created_tostring · date-timeOptional
[FILTER] on order_created. Only the orders created till this specific date will be returned. A longer time range might increase response times.
order_modifiedstring · date-timeOptional
[FILTER] on order_modified. Only the orders modified after the given date will be returned. This includes newly created orders.
For caching purposes we recommend using the If-Modified-Since header instead.
booking_referencestring · min: 8OptionalExample:
[FILTER] on booking_reference.
BOOKINGREF123booking_external_referencestringOptionalExample:
[FILTER] on booking_external_reference.
EXTERNALREF123booking_travel_date_fromstring · date-timeOptional
[FILTER] on booking_travel_date. Only the bookings with a travel date from this specific date will be returned. A longer time range might increase response times.
booking_travel_date_tostring · date-timeOptional
[FILTER] on booking_travel_date. Only the bookings with a travel date till this specific date will be returned. A longer time range might increase response times.
booking_redemption_date_fromstring · date-timeOptional
[FILTER] on booking_redemption_date. Only the bookings redeemed from this specific date will be returned. A longer time range might increase response times.
booking_redemption_date_tostring · date-timeOptional
[FILTER] on booking_redemption_date. Only the bookings redeemed till this specific date will be returned. A longer time range might increase response times.
product_idstring[]OptionalExample:
[FILTER] on product_id.
["PRODUCT_ID_123"]product_type_codestring · min: 8OptionalExample:
[FILTER] on product_type_code.
1539762088951995product_availability_idstringOptionalExample:
[FILTER] on product_availability_id.
20191026090010006526product_availability_capacity_idstringOptionalExample:
[FILTER] on product_availability_capacity_id.
20191026090010006526order_created_emailstringOptionalExample:
[FILTER] on order_created_email. Only the orders made by this user / cashier will be returned.
examplecashier@prioticket.comorder_search_querystringOptional
[SEARCH] on keywords. This API provides full-text (wildcard) search capabilities.
Only results linked to your account will be returned and searching is only available in case cache is enabled (cache:true)
filter_bookingsbooleanOptionalDefault:
[CONFIG] Filter (sub) bookings from response.
Whether to include all bookings belonging to the same order or only those matching the defined filters. By default the system will return every booking of an order, regardless whether some of those bookings do not match the defined filters.
For example. when a filter for product_id is set, only orders which contain that product will be returned, but additional bookings (for different product IDs) of that same order might be listed as well.
By enabling this filter, only bookings for that product_id would be returned.
falseExample: falsepartner_salesbooleanOptionalDefault:
[FILTER] on partner sales.
falseExample: falseorder_view_typestring · enumOptionalExample:
[CONFIG] (ADVANCED) account view type.
This value defaults and is limited to the scope of your credentials.
DISTRIBUTORPossible values: order_sort_bystring · enumOptionalDefault:
Method of sorting.
ORDER_CREATEDExample: ORDER_CREATEDPossible values: order_sort_orderstring · enumOptionalDefault:
Order of sorting.
DESCExample: ASCPossible values: items_per_pageinteger · min: 1 · max: 200OptionalDefault:
[PAGING] Items Per Page - Allows user's to configure the items_per_page value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.
This parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.
Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page response element in calculating actual page size.
10Example: 5start_indexinteger · min: 1 · max: 10000OptionalDefault:
[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.
1Example: 1pageinteger · min: 1OptionalDefault:
[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items.
This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index and total_pages properties are used for this style of paging.
1Example: 1cachebooleanOptionalDefault:
[CACHE] Whether the results should be loaded from the caching server. This will significantly improve performance and disabling this functionality is not recommended.
trueExample: trueHeader parameters
If-Modified-SincestringOptionalExample:
[CACHE] The If-Modified-Since request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.
If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified response header of a previous request will contain the date of last modification.
Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.
Wed, 21 Jan 2022 07:28:00 GMTResponses
200
Get Orders Response
application/json
304
Not Modified
The HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a `If-None-Match` or a `If-Modified-Since` header.
400
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
application/json
401
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
application/json
403
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.
application/json
405
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested
resource; for example, a GET request on a form that
requires data to be presented via POST, or a PUT request
on a read-only resource.
application/json
406
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
application/json
422
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
application/json
429
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
application/json
500
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
application/json
501
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
application/json
502
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
503
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
application/json
504
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
get
GET /v3.8/distributor/orders HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"api_version": "3.8.0",
"data": {
"kind": "location",
"current_item_count": 10,
"items_per_page": 10,
"start_index": 1,
"total_items": 200,
"page_index": 1,
"total_pages": 20,
"items": [
{
"order_platform_id": "1",
"order_platform_name": "Platform Name",
"order_reseller_id": "1300",
"order_reseller_name": "Demo reseller",
"order_distributor_id": "501",
"order_distributor_name": "Demo Distributor",
"order_merchant_id": "55201",
"order_merchant_name": "Demo Merchant",
"order_partner_id": "4534543543",
"order_partner_name": "Partner Name",
"order_reference": "ORDRREF123456",
"order_external_reference": "EXTERNALREF123",
"order_status": "ORDER_CONFIRMED",
"order_settlement_type": "EXTERNAL",
"order_channel": "PARTNER",
"order_language": "en",
"order_version": 1,
"order_contacts": [
{
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
}
],
"order_promocodes": [
{
"promo_title": "Christmas Sale 2019",
"promo_description": "20 percent discount during the Christmas days.",
"promo_code": "PROMOCODE_123"
}
],
"order_payments": [
{
"payment_id": "f44226c0-e142-11ea-86d2-83036af9991e",
"payment_original_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
"payment_partner_id": "PAYMENT_PARTNER_ID",
"payment_merchant_reference": "1478349849927_771663371",
"payment_external_reference": "SHOPPER_REFERENCE",
"payment_order_reference": "ORDRREF123456",
"payment_booking_references": [
"BKNGREF123456"
],
"payment_order_version": 2,
"payment_status": "PAID",
"payment_method": "EXTERNAL",
"payment_scheme": "VISA",
"payment_type": "CAPTURE",
"payment_link": "https://customer.prioticket.com/s?q=K0U2VmVNRGo0SEhGdFVUZ09IK2ViZkdtK1NjPQ==",
"payment_link_expires_at": "2025-06-28T19:40:22.573Z",
"payment_recurring": false,
"payment_recurring_type": "STORE",
"payment_refund_type": "SYSTEM",
"payment_refund_reason": "Guest reimbursement",
"payment_currency_code": "EUR",
"payment_currency_rate": "2.5263",
"payment_currency_amount": "10.25",
"payment_amount": "10.00",
"payment_total": "100.00",
"payment_gateway_details": {
"payment_merchant_account_name": "PrioticketECOM",
"payment_service_provider_reference": "852596799876396F",
"payment_service_provider_original_reference": "882596799845511E",
"payment_gateway_type": "ADYEN",
"payment_gateway_additional_values": {
"psp_shopper_name": "Checkout Shopper PlaceHolder",
"psp_shopper_cardnumber": "1111",
"psp_issuer_country": "NL",
"psp_fraudscore": "63",
"psp_payment_status": "Settled"
}
},
"payment_contact": {
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
},
"payment_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"payment_created": "2025-06-28T19:40:22.573Z",
"payment_created_name": "Cashier Name",
"payment_created_email": "cashier@prioticket.com"
}
],
"order_checkout_fields": [
{
"checkout_field_id": "CHECKOUT_FIELD_ID",
"checkout_field_title": "First Name",
"checkout_field_label": "Please provide your first name",
"checkout_field_place_holder": "Some text",
"checkout_field_help_text": "Custom Field",
"checkout_field_account_type": "DISTRIBUTOR",
"checkout_field_booking_reference": [
"text"
],
"checkout_field_restriction": "REQUIRED",
"checkout_field_level": "PRODUCT",
"checkout_field_unit": "text",
"checkout_field_input_type": "SINGLE",
"checkout_field_type": "contact_title",
"checkout_field_options": [
"AIR",
"RAIL",
"SEA",
"OTHER"
],
"checkout_field_values": [
{
"checkout_field_value_product_type": "ADULT",
"checkout_field_value": [
"AIR"
],
"checkout_field_value_transaction_reference": "TRANSACTION_REFERENCE"
}
],
"checkout_field_created": "2025-06-28T19:40:22.573Z"
}
],
"order_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"order_options": {
"email_options": {
"email_types": {
"send_tickets": false
}
}
},
"order_flags": [
{
"flag_id": "223425262",
"flag_name": "Stock Code",
"flag_type": "FLAG",
"flag_value_id": "123BCa1",
"flag_value": "123BCa1"
}
],
"order_event_details": [
{
"event_order_version": 2,
"event_note": "Change of timeslot on request of customer.",
"event_type": "ORDER_CREATE",
"event_created": "2025-06-28T19:40:22.573Z",
"event_creator_user_name": "Andrew",
"event_creator_user_email": "supervisor@prioticket.com",
"event_creator_user_role": "Supervisor"
}
],
"order_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"order_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"order_activity_url": "https://activity.prioticket.com/orders/ORDRREF123456",
"order_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"order_voucher_url": "https://emails.prioticket.com",
"order_created": "2025-06-28T19:40:22.573Z",
"order_created_name": "Demo Cashier",
"order_created_email": "cashier@prioticket.com",
"order_modified": "2025-06-28T19:40:22.573Z",
"order_modified_name": "Demo Cashier",
"order_modified_email": "cashier@prioticket.com",
"order_cancellation_date_time": "2025-06-28T19:40:22.573Z",
"order_cancellation_reason": "Payment declined",
"order_bookings": [
{
"booking_external_reference": "BOOKING_EXTERNALREF123",
"booking_status": "BOOKING_RESERVED",
"booking_version": 1,
"booking_voucher_released": true,
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_valid_until": "2025-06-28T19:40:22.573Z",
"booking_language": "en",
"booking_addon_reference": "BOOKING_ADDON_REFERENCE_123",
"booking_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"booking_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"booking_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"booking_voucher_url": "https://emails.prioticket.com",
"booking_created": "2025-06-28T19:40:22.573Z",
"booking_modified": "2025-06-28T19:40:22.573Z",
"booking_confirmed": "2025-06-28T19:40:22.573Z",
"booking_cancelled": "2025-06-28T19:40:22.573Z",
"booking_cancellation_reason": "Payment declined",
"product_id": "PRODUCT_ID_123",
"product_relation_id": "MAIN_PRODUCT_ID_123",
"product_pickup_point_id": "PICKUP_POINT_ID_123",
"product_pickup_point": {
"pickup_point_id": "PICKUP_POINT_ID_123",
"pickup_point_name": "Walkingtour at the Wyndham Apollo Hotel",
"pickup_point_type": "FIXED",
"pickup_point_description": "Meet at the Wyndham Apollo hotel.",
"pickup_point_location": "LOCATION_ID_123",
"pickup_point_time": "10:00",
"pickup_point_times": [
"10:00"
],
"pickup_point_duration": 30,
"pickup_point_availability_dependency": false
},
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_supplier_admin_id": "PRODUCT_SUPPLIER_ADMIN_ID",
"product_supplier_admin_name": "Supplier Admin Name",
"product_market_admin_id": "345345342",
"product_market_admin_name": "Market Admin Name",
"product_source_id": "34564574",
"product_source_name": "Prioticket",
"product_entry_notes": "Reconfirmation: Please call or email atleast 72 hour in advance to reconfirm your arrival.",
"product_admission_type": "TIME_PERIOD",
"product_class": "STANDARD",
"product_currency_code": "USD",
"product_cancellation_allowed": true,
"product_combi_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_bundle_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_addon_details": [
{
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_order_reference": "BOOKING_ORDER_REFERENCE",
"booking_reference": "BOOKING_REF123",
"booking_status": "BOOKING_RESERVED"
}
],
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"product_cancellation_policies": [
{
"cancellation_description": "Please cancel any booking 1 hour in advance.",
"cancellation_type": "TRAVEL_DATE",
"cancellation_fee_threshold": 3600,
"cancellation_fee_percentage": 20.5,
"cancellation_fee_amount": "5.00"
}
],
"booking_reference": "BOOKING_REFERENCE_123",
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
]
}
]
}
}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.
Authorizations
Body
Create order request model.
api_versionstringRead-onlyRequiredExample:
Represents the version of the service API that's served in the response.
3.8.0Responses
201
Order Created
application/json
400
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
application/json
401
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
application/json
402
Payment Required
The current payment state is invalid or the credit limit has been reached.
application/json
403
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.
application/json
405
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested
resource; for example, a GET request on a form that
requires data to be presented via POST, or a PUT request
on a read-only resource.
application/json
406
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
application/json
409
Conflict
The HTTP 409 Conflict response status code indicates a request conflict with current state of the server.
Conflicts are most likely to occur in response to a PUT request. For example, you may get a 409 response when trying to pay an order which is already cancelled on the server, resulting in a version control conflict.
application/json
422
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
application/json
429
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
application/json
500
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
application/json
501
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
application/json
502
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
503
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
application/json
504
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
post
POST /v3.8/distributor/orders HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2765
{
"data": {
"order": {
"order_distributor_id": "501",
"order_merchant_id": "55201",
"order_merchant_name": "Demo Merchant",
"order_partner_id": "4534543543",
"order_external_reference": "EXTERNALREF123",
"order_settlement_type": "EXTERNAL",
"order_language": "en",
"order_contacts": [
{
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
]
}
],
"order_checkout_fields": [
{
"checkout_field_id": "CHECKOUT_FIELD_ID",
"checkout_field_booking_reference": [
"text"
],
"checkout_field_unit": "text",
"checkout_field_options": [
"AIR",
"RAIL",
"SEA",
"OTHER"
],
"checkout_field_values": [
{
"checkout_field_value_product_type": "ADULT",
"checkout_field_value": [
"AIR"
],
"checkout_field_value_transaction_reference": "TRANSACTION_REFERENCE"
}
]
}
],
"order_pricing": {
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
]
},
"order_options": {
"email_options": {
"email_types": {
"send_tickets": false
}
}
},
"order_flags": [
{
"flag_id": "223425262",
"flag_name": "Stock Code",
"flag_type": "FLAG",
"flag_value_id": "123BCa1",
"flag_value": "123BCa1"
}
],
"order_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"order_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR"
}
],
"order_bookings": [
{
"booking_option_type": "CONFIRM_RESERVATION",
"reservation_reference": "RESERVATION_REFERENCE_123"
}
]
}
}
}{
"api_version": "3.8.0",
"data": {
"kind": "location",
"order": {
"order_platform_id": "1",
"order_platform_name": "Platform Name",
"order_reseller_id": "1300",
"order_reseller_name": "Demo reseller",
"order_distributor_id": "501",
"order_distributor_name": "Demo Distributor",
"order_merchant_id": "55201",
"order_merchant_name": "Demo Merchant",
"order_partner_id": "4534543543",
"order_partner_name": "Partner Name",
"order_reference": "ORDRREF123456",
"order_external_reference": "EXTERNALREF123",
"order_status": "ORDER_CONFIRMED",
"order_settlement_type": "EXTERNAL",
"order_channel": "PARTNER",
"order_language": "en",
"order_version": 1,
"order_contacts": [
{
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
}
],
"order_promocodes": [
{
"promo_title": "Christmas Sale 2019",
"promo_description": "20 percent discount during the Christmas days.",
"promo_code": "PROMOCODE_123"
}
],
"order_payments": [
{
"payment_id": "f44226c0-e142-11ea-86d2-83036af9991e",
"payment_original_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
"payment_partner_id": "PAYMENT_PARTNER_ID",
"payment_merchant_reference": "1478349849927_771663371",
"payment_external_reference": "SHOPPER_REFERENCE",
"payment_order_reference": "ORDRREF123456",
"payment_booking_references": [
"BKNGREF123456"
],
"payment_order_version": 2,
"payment_status": "PAID",
"payment_method": "EXTERNAL",
"payment_scheme": "VISA",
"payment_type": "CAPTURE",
"payment_link": "https://customer.prioticket.com/s?q=K0U2VmVNRGo0SEhGdFVUZ09IK2ViZkdtK1NjPQ==",
"payment_link_expires_at": "2025-06-28T19:40:22.573Z",
"payment_recurring": false,
"payment_recurring_type": "STORE",
"payment_refund_type": "SYSTEM",
"payment_refund_reason": "Guest reimbursement",
"payment_currency_code": "EUR",
"payment_currency_rate": "2.5263",
"payment_currency_amount": "10.25",
"payment_amount": "10.00",
"payment_total": "100.00",
"payment_gateway_details": {
"payment_merchant_account_name": "PrioticketECOM",
"payment_service_provider_reference": "852596799876396F",
"payment_service_provider_original_reference": "882596799845511E",
"payment_gateway_type": "ADYEN",
"payment_gateway_additional_values": {
"psp_shopper_name": "Checkout Shopper PlaceHolder",
"psp_shopper_cardnumber": "1111",
"psp_issuer_country": "NL",
"psp_fraudscore": "63",
"psp_payment_status": "Settled"
}
},
"payment_contact": {
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
},
"payment_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"payment_created": "2025-06-28T19:40:22.573Z",
"payment_created_name": "Cashier Name",
"payment_created_email": "cashier@prioticket.com"
}
],
"order_checkout_fields": [
{
"checkout_field_id": "CHECKOUT_FIELD_ID",
"checkout_field_title": "First Name",
"checkout_field_label": "Please provide your first name",
"checkout_field_place_holder": "Some text",
"checkout_field_help_text": "Custom Field",
"checkout_field_account_type": "DISTRIBUTOR",
"checkout_field_booking_reference": [
"text"
],
"checkout_field_restriction": "REQUIRED",
"checkout_field_level": "PRODUCT",
"checkout_field_unit": "text",
"checkout_field_input_type": "SINGLE",
"checkout_field_type": "contact_title",
"checkout_field_options": [
"AIR",
"RAIL",
"SEA",
"OTHER"
],
"checkout_field_values": [
{
"checkout_field_value_product_type": "ADULT",
"checkout_field_value": [
"AIR"
],
"checkout_field_value_transaction_reference": "TRANSACTION_REFERENCE"
}
],
"checkout_field_created": "2025-06-28T19:40:22.573Z"
}
],
"order_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"order_options": {
"email_options": {
"email_types": {
"send_tickets": false
}
}
},
"order_flags": [
{
"flag_id": "223425262",
"flag_name": "Stock Code",
"flag_type": "FLAG",
"flag_value_id": "123BCa1",
"flag_value": "123BCa1"
}
],
"order_event_details": [
{
"event_order_version": 2,
"event_note": "Change of timeslot on request of customer.",
"event_type": "ORDER_CREATE",
"event_created": "2025-06-28T19:40:22.573Z",
"event_creator_user_name": "Andrew",
"event_creator_user_email": "supervisor@prioticket.com",
"event_creator_user_role": "Supervisor"
}
],
"order_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"order_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"order_activity_url": "https://activity.prioticket.com/orders/ORDRREF123456",
"order_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"order_voucher_url": "https://emails.prioticket.com",
"order_created": "2025-06-28T19:40:22.573Z",
"order_created_name": "Demo Cashier",
"order_created_email": "cashier@prioticket.com",
"order_modified": "2025-06-28T19:40:22.573Z",
"order_modified_name": "Demo Cashier",
"order_modified_email": "cashier@prioticket.com",
"order_cancellation_date_time": "2025-06-28T19:40:22.573Z",
"order_cancellation_reason": "Payment declined",
"order_bookings": [
{
"booking_external_reference": "BOOKING_EXTERNALREF123",
"booking_status": "BOOKING_RESERVED",
"booking_version": 1,
"booking_voucher_released": true,
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_valid_until": "2025-06-28T19:40:22.573Z",
"booking_language": "en",
"booking_addon_reference": "BOOKING_ADDON_REFERENCE_123",
"booking_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"booking_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"booking_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"booking_voucher_url": "https://emails.prioticket.com",
"booking_created": "2025-06-28T19:40:22.573Z",
"booking_modified": "2025-06-28T19:40:22.573Z",
"booking_confirmed": "2025-06-28T19:40:22.573Z",
"booking_cancelled": "2025-06-28T19:40:22.573Z",
"booking_cancellation_reason": "Payment declined",
"product_id": "PRODUCT_ID_123",
"product_relation_id": "MAIN_PRODUCT_ID_123",
"product_pickup_point_id": "PICKUP_POINT_ID_123",
"product_pickup_point": {
"pickup_point_id": "PICKUP_POINT_ID_123",
"pickup_point_name": "Walkingtour at the Wyndham Apollo Hotel",
"pickup_point_type": "FIXED",
"pickup_point_description": "Meet at the Wyndham Apollo hotel.",
"pickup_point_location": "LOCATION_ID_123",
"pickup_point_time": "10:00",
"pickup_point_times": [
"10:00"
],
"pickup_point_duration": 30,
"pickup_point_availability_dependency": false
},
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_supplier_admin_id": "PRODUCT_SUPPLIER_ADMIN_ID",
"product_supplier_admin_name": "Supplier Admin Name",
"product_market_admin_id": "345345342",
"product_market_admin_name": "Market Admin Name",
"product_source_id": "34564574",
"product_source_name": "Prioticket",
"product_entry_notes": "Reconfirmation: Please call or email atleast 72 hour in advance to reconfirm your arrival.",
"product_admission_type": "TIME_PERIOD",
"product_class": "STANDARD",
"product_currency_code": "USD",
"product_cancellation_allowed": true,
"product_combi_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_bundle_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_addon_details": [
{
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_order_reference": "BOOKING_ORDER_REFERENCE",
"booking_reference": "BOOKING_REF123",
"booking_status": "BOOKING_RESERVED"
}
],
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"product_cancellation_policies": [
{
"cancellation_description": "Please cancel any booking 1 hour in advance.",
"cancellation_type": "TRAVEL_DATE",
"cancellation_fee_threshold": 3600,
"cancellation_fee_percentage": 20.5,
"cancellation_fee_amount": "5.00"
}
],
"booking_reference": "BOOKING_REFERENCE_123",
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
]
}
}
}This API is called to get order details and status.
Authorizations
Path parameters
order_referencestring · min: 8RequiredExample:
A unique identifier got in response of booking API.
ORDRREF123456Query parameters
order_versionintegerOptionalExample:
Order Version / Revision number. By default the latest revision will be returned.
If set, the cache value will be ignored.
1cachebooleanOptionalDefault:
[CACHE] Whether the results should be loaded from the caching server. This will significantly improve performance and disabling this functionality is not recommended.
trueExample: trueResponses
200
Get Order Detail Response
400
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
application/json
401
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
application/json
403
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.
application/json
405
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested
resource; for example, a GET request on a form that
requires data to be presented via POST, or a PUT request
on a read-only resource.
application/json
406
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
application/json
422
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
application/json
429
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
application/json
500
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
application/json
501
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
application/json
502
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
503
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
application/json
504
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
get
GET /v3.8/distributor/orders/{order_reference} HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"api_version": "3.8.0",
"data": {
"kind": "location",
"order": {
"order_platform_id": "1",
"order_platform_name": "Platform Name",
"order_reseller_id": "1300",
"order_reseller_name": "Demo reseller",
"order_distributor_id": "501",
"order_distributor_name": "Demo Distributor",
"order_merchant_id": "55201",
"order_merchant_name": "Demo Merchant",
"order_partner_id": "4534543543",
"order_partner_name": "Partner Name",
"order_reference": "ORDRREF123456",
"order_external_reference": "EXTERNALREF123",
"order_status": "ORDER_CONFIRMED",
"order_settlement_type": "EXTERNAL",
"order_channel": "PARTNER",
"order_language": "en",
"order_version": 1,
"order_contacts": [
{
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
}
],
"order_promocodes": [
{
"promo_title": "Christmas Sale 2019",
"promo_description": "20 percent discount during the Christmas days.",
"promo_code": "PROMOCODE_123"
}
],
"order_payments": [
{
"payment_id": "f44226c0-e142-11ea-86d2-83036af9991e",
"payment_original_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
"payment_partner_id": "PAYMENT_PARTNER_ID",
"payment_merchant_reference": "1478349849927_771663371",
"payment_external_reference": "SHOPPER_REFERENCE",
"payment_order_reference": "ORDRREF123456",
"payment_booking_references": [
"BKNGREF123456"
],
"payment_order_version": 2,
"payment_status": "PAID",
"payment_method": "EXTERNAL",
"payment_scheme": "VISA",
"payment_type": "CAPTURE",
"payment_link": "https://customer.prioticket.com/s?q=K0U2VmVNRGo0SEhGdFVUZ09IK2ViZkdtK1NjPQ==",
"payment_link_expires_at": "2025-06-28T19:40:22.573Z",
"payment_recurring": false,
"payment_recurring_type": "STORE",
"payment_refund_type": "SYSTEM",
"payment_refund_reason": "Guest reimbursement",
"payment_currency_code": "EUR",
"payment_currency_rate": "2.5263",
"payment_currency_amount": "10.25",
"payment_amount": "10.00",
"payment_total": "100.00",
"payment_gateway_details": {
"payment_merchant_account_name": "PrioticketECOM",
"payment_service_provider_reference": "852596799876396F",
"payment_service_provider_original_reference": "882596799845511E",
"payment_gateway_type": "ADYEN",
"payment_gateway_additional_values": {
"psp_shopper_name": "Checkout Shopper PlaceHolder",
"psp_shopper_cardnumber": "1111",
"psp_issuer_country": "NL",
"psp_fraudscore": "63",
"psp_payment_status": "Settled"
}
},
"payment_contact": {
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
},
"payment_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"payment_created": "2025-06-28T19:40:22.573Z",
"payment_created_name": "Cashier Name",
"payment_created_email": "cashier@prioticket.com"
}
],
"order_checkout_fields": [
{
"checkout_field_id": "CHECKOUT_FIELD_ID",
"checkout_field_title": "First Name",
"checkout_field_label": "Please provide your first name",
"checkout_field_place_holder": "Some text",
"checkout_field_help_text": "Custom Field",
"checkout_field_account_type": "DISTRIBUTOR",
"checkout_field_booking_reference": [
"text"
],
"checkout_field_restriction": "REQUIRED",
"checkout_field_level": "PRODUCT",
"checkout_field_unit": "text",
"checkout_field_input_type": "SINGLE",
"checkout_field_type": "contact_title",
"checkout_field_options": [
"AIR",
"RAIL",
"SEA",
"OTHER"
],
"checkout_field_values": [
{
"checkout_field_value_product_type": "ADULT",
"checkout_field_value": [
"AIR"
],
"checkout_field_value_transaction_reference": "TRANSACTION_REFERENCE"
}
],
"checkout_field_created": "2025-06-28T19:40:22.573Z"
}
],
"order_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"order_options": {
"email_options": {
"email_types": {
"send_tickets": false
}
}
},
"order_flags": [
{
"flag_id": "223425262",
"flag_name": "Stock Code",
"flag_type": "FLAG",
"flag_value_id": "123BCa1",
"flag_value": "123BCa1"
}
],
"order_event_details": [
{
"event_order_version": 2,
"event_note": "Change of timeslot on request of customer.",
"event_type": "ORDER_CREATE",
"event_created": "2025-06-28T19:40:22.573Z",
"event_creator_user_name": "Andrew",
"event_creator_user_email": "supervisor@prioticket.com",
"event_creator_user_role": "Supervisor"
}
],
"order_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"order_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"order_activity_url": "https://activity.prioticket.com/orders/ORDRREF123456",
"order_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"order_voucher_url": "https://emails.prioticket.com",
"order_created": "2025-06-28T19:40:22.573Z",
"order_created_name": "Demo Cashier",
"order_created_email": "cashier@prioticket.com",
"order_modified": "2025-06-28T19:40:22.573Z",
"order_modified_name": "Demo Cashier",
"order_modified_email": "cashier@prioticket.com",
"order_cancellation_date_time": "2025-06-28T19:40:22.573Z",
"order_cancellation_reason": "Payment declined",
"order_bookings": [
{
"booking_external_reference": "BOOKING_EXTERNALREF123",
"booking_status": "BOOKING_RESERVED",
"booking_version": 1,
"booking_voucher_released": true,
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_valid_until": "2025-06-28T19:40:22.573Z",
"booking_language": "en",
"booking_addon_reference": "BOOKING_ADDON_REFERENCE_123",
"booking_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"booking_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"booking_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"booking_voucher_url": "https://emails.prioticket.com",
"booking_created": "2025-06-28T19:40:22.573Z",
"booking_modified": "2025-06-28T19:40:22.573Z",
"booking_confirmed": "2025-06-28T19:40:22.573Z",
"booking_cancelled": "2025-06-28T19:40:22.573Z",
"booking_cancellation_reason": "Payment declined",
"product_id": "PRODUCT_ID_123",
"product_relation_id": "MAIN_PRODUCT_ID_123",
"product_pickup_point_id": "PICKUP_POINT_ID_123",
"product_pickup_point": {
"pickup_point_id": "PICKUP_POINT_ID_123",
"pickup_point_name": "Walkingtour at the Wyndham Apollo Hotel",
"pickup_point_type": "FIXED",
"pickup_point_description": "Meet at the Wyndham Apollo hotel.",
"pickup_point_location": "LOCATION_ID_123",
"pickup_point_time": "10:00",
"pickup_point_times": [
"10:00"
],
"pickup_point_duration": 30,
"pickup_point_availability_dependency": false
},
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_supplier_admin_id": "PRODUCT_SUPPLIER_ADMIN_ID",
"product_supplier_admin_name": "Supplier Admin Name",
"product_market_admin_id": "345345342",
"product_market_admin_name": "Market Admin Name",
"product_source_id": "34564574",
"product_source_name": "Prioticket",
"product_entry_notes": "Reconfirmation: Please call or email atleast 72 hour in advance to reconfirm your arrival.",
"product_admission_type": "TIME_PERIOD",
"product_class": "STANDARD",
"product_currency_code": "USD",
"product_cancellation_allowed": true,
"product_combi_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_bundle_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_addon_details": [
{
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_order_reference": "BOOKING_ORDER_REFERENCE",
"booking_reference": "BOOKING_REF123",
"booking_status": "BOOKING_RESERVED"
}
],
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"product_cancellation_policies": [
{
"cancellation_description": "Please cancel any booking 1 hour in advance.",
"cancellation_type": "TRAVEL_DATE",
"cancellation_fee_threshold": 3600,
"cancellation_fee_percentage": 20.5,
"cancellation_fee_amount": "5.00"
}
],
"booking_reference": "BOOKING_REFERENCE_123",
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
]
}
}
}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, allorder_contactsetc) are sent, missing (optional) fields will be removed from our records. Note that the opposite is true fororder_bookings, only the bookings you would like to amend should be provided (see advanced functionality below).
Advanced Functionality
Authorizations
Path parameters
order_referencestring · min: 8RequiredExample:
A unique identifier got in response of booking API.
ORDRREF123456Query parameters
price_adjustmentbooleanOptionalDefault:
The system will adjust the price, either increasing it (AMENDMENT_DISCOUNT) or decreasing it (AMENDMENT_SURCHARGE). When set to false the price will not be adjusted and a pending payment record will be inserted.
falseExample: falseprice_adjustment_applicable_on_resellerbooleanOptionalDefault:
Whether to solely allocate the price adjustment to the reseller.
falseExample: falsepreviewbooleanOptionalDefault:
The system will not process the order, instead it will return a preview of the requested amendment allowing for review.
falseExample: falseBody
Request for updating / amending an existing order.
api_versionstringRead-onlyRequiredExample:
Represents the version of the service API that's served in the response.
3.8.0Responses
200
Successfully updated order
application/json
400
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
application/json
401
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
application/json
403
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.
application/json
405
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested
resource; for example, a GET request on a form that
requires data to be presented via POST, or a PUT request
on a read-only resource.
application/json
406
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
application/json
409
Conflict
The HTTP 409 Conflict response status code indicates a request conflict with current state of the server.
Conflicts are most likely to occur in response to a PUT request. For example, you may get a 409 response when trying to pay an order which is already cancelled on the server, resulting in a version control conflict.
application/json
422
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
application/json
429
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
application/json
500
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
application/json
501
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
application/json
502
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
503
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
application/json
504
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
put
PUT /v3.8/distributor/orders/{order_reference} HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5090
{
"data": {
"order": {
"order_distributor_id": "501",
"order_merchant_id": "55201",
"order_merchant_name": "Demo Merchant",
"order_partner_id": "4534543543",
"order_external_reference": "EXTERNALREF123",
"order_settlement_type": "EXTERNAL",
"order_language": "en",
"order_contacts": [
{
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
]
}
],
"order_checkout_fields": [
{
"checkout_field_id": "CHECKOUT_FIELD_ID",
"checkout_field_booking_reference": [
"text"
],
"checkout_field_unit": "text",
"checkout_field_options": [
"AIR",
"RAIL",
"SEA",
"OTHER"
],
"checkout_field_values": [
{
"checkout_field_value_product_type": "ADULT",
"checkout_field_value": [
"AIR"
],
"checkout_field_value_transaction_reference": "TRANSACTION_REFERENCE"
}
]
}
],
"order_pricing": {
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
]
},
"order_options": {
"email_options": {
"email_types": {
"send_tickets": false
}
}
},
"order_flags": [
{
"flag_id": "223425262",
"flag_name": "Stock Code",
"flag_type": "FLAG",
"flag_value_id": "123BCa1",
"flag_value": "123BCa1"
}
],
"order_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"order_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR"
}
],
"order_bookings": [
{
"booking_option_type": "DIRECT_BOOKING",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_language": "en",
"booking_addon_reference": "BOOKING_ADDON_REFERENCE_123",
"booking_pricing": {
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
]
},
"booking_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR"
}
],
"product_id": "PRODUCT_ID_123",
"product_relation_id": "MAIN_PRODUCT_ID_123",
"product_pickup_point_id": "PICKUP_POINT_ID_123",
"product_pickup_point": {
"pickup_point_id": "PICKUP_POINT_ID_123",
"pickup_point_type": "FIXED",
"pickup_point_time": "10:00",
"pickup_point_times": [
"10:00"
]
},
"product_availability_id": "20191026090010006526",
"product_combi_details": [
{
"product_id": "PRODUCT_COMBI_ID_123",
"product_availability_id": "20191026090010006526",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_count": 1,
"product_type_spots": [
{
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_external_reference": "BOOKING_EXTERNALREF123"
}
],
"product_bundle_details": [
{
"product_id": "PRODUCT_COMBI_ID_123",
"product_availability_id": "20191026090010006526",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_count": 1,
"product_type_spots": [
{
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_external_reference": "BOOKING_EXTERNALREF123"
}
],
"product_type_details": [
{
"product_type": "ADULT",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_count": 1,
"product_type_spots": [
{
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
]
}
}
],
"booking_reference": "BOOKING_REFERENCE_123"
}
]
}
}
}{
"api_version": "3.8.0",
"data": {
"kind": "location",
"order": {
"order_platform_id": "1",
"order_platform_name": "Platform Name",
"order_reseller_id": "1300",
"order_reseller_name": "Demo reseller",
"order_distributor_id": "501",
"order_distributor_name": "Demo Distributor",
"order_merchant_id": "55201",
"order_merchant_name": "Demo Merchant",
"order_partner_id": "4534543543",
"order_partner_name": "Partner Name",
"order_reference": "ORDRREF123456",
"order_external_reference": "EXTERNALREF123",
"order_status": "ORDER_CONFIRMED",
"order_settlement_type": "EXTERNAL",
"order_channel": "PARTNER",
"order_language": "en",
"order_version": 1,
"order_contacts": [
{
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
}
],
"order_promocodes": [
{
"promo_title": "Christmas Sale 2019",
"promo_description": "20 percent discount during the Christmas days.",
"promo_code": "PROMOCODE_123"
}
],
"order_payments": [
{
"payment_id": "f44226c0-e142-11ea-86d2-83036af9991e",
"payment_original_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
"payment_partner_id": "PAYMENT_PARTNER_ID",
"payment_merchant_reference": "1478349849927_771663371",
"payment_external_reference": "SHOPPER_REFERENCE",
"payment_order_reference": "ORDRREF123456",
"payment_booking_references": [
"BKNGREF123456"
],
"payment_order_version": 2,
"payment_status": "PAID",
"payment_method": "EXTERNAL",
"payment_scheme": "VISA",
"payment_type": "CAPTURE",
"payment_link": "https://customer.prioticket.com/s?q=K0U2VmVNRGo0SEhGdFVUZ09IK2ViZkdtK1NjPQ==",
"payment_link_expires_at": "2025-06-28T19:40:22.573Z",
"payment_recurring": false,
"payment_recurring_type": "STORE",
"payment_refund_type": "SYSTEM",
"payment_refund_reason": "Guest reimbursement",
"payment_currency_code": "EUR",
"payment_currency_rate": "2.5263",
"payment_currency_amount": "10.25",
"payment_amount": "10.00",
"payment_total": "100.00",
"payment_gateway_details": {
"payment_merchant_account_name": "PrioticketECOM",
"payment_service_provider_reference": "852596799876396F",
"payment_service_provider_original_reference": "882596799845511E",
"payment_gateway_type": "ADYEN",
"payment_gateway_additional_values": {
"psp_shopper_name": "Checkout Shopper PlaceHolder",
"psp_shopper_cardnumber": "1111",
"psp_issuer_country": "NL",
"psp_fraudscore": "63",
"psp_payment_status": "Settled"
}
},
"payment_contact": {
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
},
"payment_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"payment_created": "2025-06-28T19:40:22.573Z",
"payment_created_name": "Cashier Name",
"payment_created_email": "cashier@prioticket.com"
}
],
"order_checkout_fields": [
{
"checkout_field_id": "CHECKOUT_FIELD_ID",
"checkout_field_title": "First Name",
"checkout_field_label": "Please provide your first name",
"checkout_field_place_holder": "Some text",
"checkout_field_help_text": "Custom Field",
"checkout_field_account_type": "DISTRIBUTOR",
"checkout_field_booking_reference": [
"text"
],
"checkout_field_restriction": "REQUIRED",
"checkout_field_level": "PRODUCT",
"checkout_field_unit": "text",
"checkout_field_input_type": "SINGLE",
"checkout_field_type": "contact_title",
"checkout_field_options": [
"AIR",
"RAIL",
"SEA",
"OTHER"
],
"checkout_field_values": [
{
"checkout_field_value_product_type": "ADULT",
"checkout_field_value": [
"AIR"
],
"checkout_field_value_transaction_reference": "TRANSACTION_REFERENCE"
}
],
"checkout_field_created": "2025-06-28T19:40:22.573Z"
}
],
"order_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"order_options": {
"email_options": {
"email_types": {
"send_tickets": false
}
}
},
"order_flags": [
{
"flag_id": "223425262",
"flag_name": "Stock Code",
"flag_type": "FLAG",
"flag_value_id": "123BCa1",
"flag_value": "123BCa1"
}
],
"order_event_details": [
{
"event_order_version": 2,
"event_note": "Change of timeslot on request of customer.",
"event_type": "ORDER_CREATE",
"event_created": "2025-06-28T19:40:22.573Z",
"event_creator_user_name": "Andrew",
"event_creator_user_email": "supervisor@prioticket.com",
"event_creator_user_role": "Supervisor"
}
],
"order_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"order_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"order_activity_url": "https://activity.prioticket.com/orders/ORDRREF123456",
"order_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"order_voucher_url": "https://emails.prioticket.com",
"order_created": "2025-06-28T19:40:22.573Z",
"order_created_name": "Demo Cashier",
"order_created_email": "cashier@prioticket.com",
"order_modified": "2025-06-28T19:40:22.573Z",
"order_modified_name": "Demo Cashier",
"order_modified_email": "cashier@prioticket.com",
"order_cancellation_date_time": "2025-06-28T19:40:22.573Z",
"order_cancellation_reason": "Payment declined",
"order_bookings": [
{
"booking_external_reference": "BOOKING_EXTERNALREF123",
"booking_status": "BOOKING_RESERVED",
"booking_version": 1,
"booking_voucher_released": true,
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_valid_until": "2025-06-28T19:40:22.573Z",
"booking_language": "en",
"booking_addon_reference": "BOOKING_ADDON_REFERENCE_123",
"booking_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"booking_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"booking_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"booking_voucher_url": "https://emails.prioticket.com",
"booking_created": "2025-06-28T19:40:22.573Z",
"booking_modified": "2025-06-28T19:40:22.573Z",
"booking_confirmed": "2025-06-28T19:40:22.573Z",
"booking_cancelled": "2025-06-28T19:40:22.573Z",
"booking_cancellation_reason": "Payment declined",
"product_id": "PRODUCT_ID_123",
"product_relation_id": "MAIN_PRODUCT_ID_123",
"product_pickup_point_id": "PICKUP_POINT_ID_123",
"product_pickup_point": {
"pickup_point_id": "PICKUP_POINT_ID_123",
"pickup_point_name": "Walkingtour at the Wyndham Apollo Hotel",
"pickup_point_type": "FIXED",
"pickup_point_description": "Meet at the Wyndham Apollo hotel.",
"pickup_point_location": "LOCATION_ID_123",
"pickup_point_time": "10:00",
"pickup_point_times": [
"10:00"
],
"pickup_point_duration": 30,
"pickup_point_availability_dependency": false
},
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_supplier_admin_id": "PRODUCT_SUPPLIER_ADMIN_ID",
"product_supplier_admin_name": "Supplier Admin Name",
"product_market_admin_id": "345345342",
"product_market_admin_name": "Market Admin Name",
"product_source_id": "34564574",
"product_source_name": "Prioticket",
"product_entry_notes": "Reconfirmation: Please call or email atleast 72 hour in advance to reconfirm your arrival.",
"product_admission_type": "TIME_PERIOD",
"product_class": "STANDARD",
"product_currency_code": "USD",
"product_cancellation_allowed": true,
"product_combi_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_bundle_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_addon_details": [
{
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_order_reference": "BOOKING_ORDER_REFERENCE",
"booking_reference": "BOOKING_REF123",
"booking_status": "BOOKING_RESERVED"
}
],
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"product_cancellation_policies": [
{
"cancellation_description": "Please cancel any booking 1 hour in advance.",
"cancellation_type": "TRAVEL_DATE",
"cancellation_fee_threshold": 3600,
"cancellation_fee_percentage": 20.5,
"cancellation_fee_amount": "5.00"
}
],
"booking_reference": "BOOKING_REFERENCE_123",
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
]
}
}
}This API is called to (partial) cancel an order/ booking. In case of a full cancellation, you are no longer able to amend the order. Otherwise, the updated order will be returned.
Again, to avoid mismatches and validate a correct implementation, make sure you compare the returned order_pricing.price_total.
When cancelling a booking, it's recommended to provide a valid reason for the cancellation. This is done by including a valid reason in the request.
This API can only be called for bookings with
product_cancellation_allowed:true. In case your order contains non-cancellable products, a full cancellation will result in an error. You will still be able to do partial-cancellations for those bookings with cancellable products.
Authorizations
Path parameters
order_referencestring · min: 8RequiredExample:
Order reference.
ORDRREF123456Query parameters
booking_referencestring[]OptionalExample:
[FILTER] In case the booking_reference is provided, a partial cancellation will be made. Only the specified booking(s) will be cancelled.
["BOOKING_REFERENCE_123"]product_type_transaction_idstring[]OptionalExample:
[FILTER] (ADVANCED) In case the product_type_transaction_id is provided, a partial cancellation will be made. Only the specified transaction(s) will be cancelled.
["159118380521834001"]cancellation_reasonstringOptionalExample:
[INFO] Optional reason for this cancellation.
Payment declined.payment_refundbooleanOptionalDefault:
[CONFIG] Whether the guest payment should be refunded. In case the order is partially cancelled, the amount will be partially refunded as well. If multiple payments are made (split-payment) then all linked payments will be refunded. This value will be ignored in case no payment is made.
For more flexible refunds you could use the Cancel / Refund Payment API instead.
trueExample: trueoverride_third_party_policybooleanOptionalDefault:
[CONFIG] If the third-party system does not permit order cancellations, you can still cancel the order within the Prioticket system. However, please be aware that this may result in a discrepancy between the systems. Use this option with caution.
falseExample: falseResponses
200
Item(s) removed from order
application/json
400
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
application/json
401
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
application/json
403
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.
application/json
405
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested
resource; for example, a GET request on a form that
requires data to be presented via POST, or a PUT request
on a read-only resource.
application/json
406
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
application/json
409
Conflict
The HTTP 409 Conflict response status code indicates a request conflict with current state of the server.
Conflicts are most likely to occur in response to a PUT request. For example, you may get a 409 response when trying to pay an order which is already cancelled on the server, resulting in a version control conflict.
application/json
422
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
application/json
429
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
application/json
500
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
application/json
501
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
application/json
502
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
503
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
application/json
504
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
delete
DELETE /v3.8/distributor/orders/{order_reference} HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"api_version": "3.8.0",
"data": {
"kind": "location",
"order": {
"order_platform_id": "1",
"order_platform_name": "Platform Name",
"order_reseller_id": "1300",
"order_reseller_name": "Demo reseller",
"order_distributor_id": "501",
"order_distributor_name": "Demo Distributor",
"order_merchant_id": "55201",
"order_merchant_name": "Demo Merchant",
"order_partner_id": "4534543543",
"order_partner_name": "Partner Name",
"order_reference": "ORDRREF123456",
"order_external_reference": "EXTERNALREF123",
"order_status": "ORDER_CONFIRMED",
"order_settlement_type": "EXTERNAL",
"order_channel": "PARTNER",
"order_language": "en",
"order_version": 1,
"order_contacts": [
{
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
}
],
"order_promocodes": [
{
"promo_title": "Christmas Sale 2019",
"promo_description": "20 percent discount during the Christmas days.",
"promo_code": "PROMOCODE_123"
}
],
"order_payments": [
{
"payment_id": "f44226c0-e142-11ea-86d2-83036af9991e",
"payment_original_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
"payment_partner_id": "PAYMENT_PARTNER_ID",
"payment_merchant_reference": "1478349849927_771663371",
"payment_external_reference": "SHOPPER_REFERENCE",
"payment_order_reference": "ORDRREF123456",
"payment_booking_references": [
"BKNGREF123456"
],
"payment_order_version": 2,
"payment_status": "PAID",
"payment_method": "EXTERNAL",
"payment_scheme": "VISA",
"payment_type": "CAPTURE",
"payment_link": "https://customer.prioticket.com/s?q=K0U2VmVNRGo0SEhGdFVUZ09IK2ViZkdtK1NjPQ==",
"payment_link_expires_at": "2025-06-28T19:40:22.573Z",
"payment_recurring": false,
"payment_recurring_type": "STORE",
"payment_refund_type": "SYSTEM",
"payment_refund_reason": "Guest reimbursement",
"payment_currency_code": "EUR",
"payment_currency_rate": "2.5263",
"payment_currency_amount": "10.25",
"payment_amount": "10.00",
"payment_total": "100.00",
"payment_gateway_details": {
"payment_merchant_account_name": "PrioticketECOM",
"payment_service_provider_reference": "852596799876396F",
"payment_service_provider_original_reference": "882596799845511E",
"payment_gateway_type": "ADYEN",
"payment_gateway_additional_values": {
"psp_shopper_name": "Checkout Shopper PlaceHolder",
"psp_shopper_cardnumber": "1111",
"psp_issuer_country": "NL",
"psp_fraudscore": "63",
"psp_payment_status": "Settled"
}
},
"payment_contact": {
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
},
"payment_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"payment_created": "2025-06-28T19:40:22.573Z",
"payment_created_name": "Cashier Name",
"payment_created_email": "cashier@prioticket.com"
}
],
"order_checkout_fields": [
{
"checkout_field_id": "CHECKOUT_FIELD_ID",
"checkout_field_title": "First Name",
"checkout_field_label": "Please provide your first name",
"checkout_field_place_holder": "Some text",
"checkout_field_help_text": "Custom Field",
"checkout_field_account_type": "DISTRIBUTOR",
"checkout_field_booking_reference": [
"text"
],
"checkout_field_restriction": "REQUIRED",
"checkout_field_level": "PRODUCT",
"checkout_field_unit": "text",
"checkout_field_input_type": "SINGLE",
"checkout_field_type": "contact_title",
"checkout_field_options": [
"AIR",
"RAIL",
"SEA",
"OTHER"
],
"checkout_field_values": [
{
"checkout_field_value_product_type": "ADULT",
"checkout_field_value": [
"AIR"
],
"checkout_field_value_transaction_reference": "TRANSACTION_REFERENCE"
}
],
"checkout_field_created": "2025-06-28T19:40:22.573Z"
}
],
"order_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"order_options": {
"email_options": {
"email_types": {
"send_tickets": false
}
}
},
"order_flags": [
{
"flag_id": "223425262",
"flag_name": "Stock Code",
"flag_type": "FLAG",
"flag_value_id": "123BCa1",
"flag_value": "123BCa1"
}
],
"order_event_details": [
{
"event_order_version": 2,
"event_note": "Change of timeslot on request of customer.",
"event_type": "ORDER_CREATE",
"event_created": "2025-06-28T19:40:22.573Z",
"event_creator_user_name": "Andrew",
"event_creator_user_email": "supervisor@prioticket.com",
"event_creator_user_role": "Supervisor"
}
],
"order_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"order_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"order_activity_url": "https://activity.prioticket.com/orders/ORDRREF123456",
"order_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"order_voucher_url": "https://emails.prioticket.com",
"order_created": "2025-06-28T19:40:22.573Z",
"order_created_name": "Demo Cashier",
"order_created_email": "cashier@prioticket.com",
"order_modified": "2025-06-28T19:40:22.573Z",
"order_modified_name": "Demo Cashier",
"order_modified_email": "cashier@prioticket.com",
"order_cancellation_date_time": "2025-06-28T19:40:22.573Z",
"order_cancellation_reason": "Payment declined",
"order_bookings": [
{
"booking_external_reference": "BOOKING_EXTERNALREF123",
"booking_status": "BOOKING_RESERVED",
"booking_version": 1,
"booking_voucher_released": true,
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_valid_until": "2025-06-28T19:40:22.573Z",
"booking_language": "en",
"booking_addon_reference": "BOOKING_ADDON_REFERENCE_123",
"booking_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"booking_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"booking_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"booking_voucher_url": "https://emails.prioticket.com",
"booking_created": "2025-06-28T19:40:22.573Z",
"booking_modified": "2025-06-28T19:40:22.573Z",
"booking_confirmed": "2025-06-28T19:40:22.573Z",
"booking_cancelled": "2025-06-28T19:40:22.573Z",
"booking_cancellation_reason": "Payment declined",
"product_id": "PRODUCT_ID_123",
"product_relation_id": "MAIN_PRODUCT_ID_123",
"product_pickup_point_id": "PICKUP_POINT_ID_123",
"product_pickup_point": {
"pickup_point_id": "PICKUP_POINT_ID_123",
"pickup_point_name": "Walkingtour at the Wyndham Apollo Hotel",
"pickup_point_type": "FIXED",
"pickup_point_description": "Meet at the Wyndham Apollo hotel.",
"pickup_point_location": "LOCATION_ID_123",
"pickup_point_time": "10:00",
"pickup_point_times": [
"10:00"
],
"pickup_point_duration": 30,
"pickup_point_availability_dependency": false
},
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_supplier_admin_id": "PRODUCT_SUPPLIER_ADMIN_ID",
"product_supplier_admin_name": "Supplier Admin Name",
"product_market_admin_id": "345345342",
"product_market_admin_name": "Market Admin Name",
"product_source_id": "34564574",
"product_source_name": "Prioticket",
"product_entry_notes": "Reconfirmation: Please call or email atleast 72 hour in advance to reconfirm your arrival.",
"product_admission_type": "TIME_PERIOD",
"product_class": "STANDARD",
"product_currency_code": "USD",
"product_cancellation_allowed": true,
"product_combi_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_bundle_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_addon_details": [
{
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_order_reference": "BOOKING_ORDER_REFERENCE",
"booking_reference": "BOOKING_REF123",
"booking_status": "BOOKING_RESERVED"
}
],
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"product_cancellation_policies": [
{
"cancellation_description": "Please cancel any booking 1 hour in advance.",
"cancellation_type": "TRAVEL_DATE",
"cancellation_fee_threshold": 3600,
"cancellation_fee_percentage": 20.5,
"cancellation_fee_amount": "5.00"
}
],
"booking_reference": "BOOKING_REFERENCE_123",
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
]
}
}
}This API is called to de-identify customer information on an order.
This endpoint is making use of pseudonymization which is a de-identification technique that replaces sensitive data values with cryptographically generated tokens. Pseudonymization is widely used in industries like finance and healthcare to help reduce the risk of data in use, narrow compliance scope, and minimize the exposure of sensitive data to systems while preserving data utility and accuracy.
Requests for "right to be forgotten (RTBF)" can be facilitated by this endpoint.
Authorizations
Path parameters
order_referencestring · min: 8RequiredExample:
A unique identifier got in response of booking API.
ORDRREF123456Responses
200
Successfully updated order
application/json
400
Invalid Request
The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
application/json
401
Authentication Failed
The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.
application/json
403
Forbidden
The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.
application/json
405
Method Not Allowed
The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource.
A request method is not supported for the requested
resource; for example, a GET request on a form that
requires data to be presented via POST, or a PUT request
on a read-only resource.
application/json
406
Not Acceptable
The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
application/json
409
Conflict
The HTTP 409 Conflict response status code indicates a request conflict with current state of the server.
Conflicts are most likely to occur in response to a PUT request. For example, you may get a 409 response when trying to pay an order which is already cancelled on the server, resulting in a version control conflict.
application/json
422
Unprocessable Entity
The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
application/json
429
Too Many Requests
The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").
application/json
500
Internal Server Error
The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
application/json
501
Not Implemented
The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request.
The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).
application/json
502
Bad Gateway
The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server.
The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
503
Service Unavailable
The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request.
The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.
application/json
504
Gateway Timeout
The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request.
The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.
application/json
put
PUT /v3.8/distributor/orders/{order_reference}/deidentify HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"api_version": "3.8.0",
"data": {
"kind": "location",
"order": {
"order_platform_id": "1",
"order_platform_name": "Platform Name",
"order_reseller_id": "1300",
"order_reseller_name": "Demo reseller",
"order_distributor_id": "501",
"order_distributor_name": "Demo Distributor",
"order_merchant_id": "55201",
"order_merchant_name": "Demo Merchant",
"order_partner_id": "4534543543",
"order_partner_name": "Partner Name",
"order_reference": "ORDRREF123456",
"order_external_reference": "EXTERNALREF123",
"order_status": "ORDER_CONFIRMED",
"order_settlement_type": "EXTERNAL",
"order_channel": "PARTNER",
"order_language": "en",
"order_version": 1,
"order_contacts": [
{
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
}
],
"order_promocodes": [
{
"promo_title": "Christmas Sale 2019",
"promo_description": "20 percent discount during the Christmas days.",
"promo_code": "PROMOCODE_123"
}
],
"order_payments": [
{
"payment_id": "f44226c0-e142-11ea-86d2-83036af9991e",
"payment_original_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
"payment_partner_id": "PAYMENT_PARTNER_ID",
"payment_merchant_reference": "1478349849927_771663371",
"payment_external_reference": "SHOPPER_REFERENCE",
"payment_order_reference": "ORDRREF123456",
"payment_booking_references": [
"BKNGREF123456"
],
"payment_order_version": 2,
"payment_status": "PAID",
"payment_method": "EXTERNAL",
"payment_scheme": "VISA",
"payment_type": "CAPTURE",
"payment_link": "https://customer.prioticket.com/s?q=K0U2VmVNRGo0SEhGdFVUZ09IK2ViZkdtK1NjPQ==",
"payment_link_expires_at": "2025-06-28T19:40:22.573Z",
"payment_recurring": false,
"payment_recurring_type": "STORE",
"payment_refund_type": "SYSTEM",
"payment_refund_reason": "Guest reimbursement",
"payment_currency_code": "EUR",
"payment_currency_rate": "2.5263",
"payment_currency_amount": "10.25",
"payment_amount": "10.00",
"payment_total": "100.00",
"payment_gateway_details": {
"payment_merchant_account_name": "PrioticketECOM",
"payment_service_provider_reference": "852596799876396F",
"payment_service_provider_original_reference": "882596799845511E",
"payment_gateway_type": "ADYEN",
"payment_gateway_additional_values": {
"psp_shopper_name": "Checkout Shopper PlaceHolder",
"psp_shopper_cardnumber": "1111",
"psp_issuer_country": "NL",
"psp_fraudscore": "63",
"psp_payment_status": "Settled"
}
},
"payment_contact": {
"contact_uid": "f44226c0-e142-11ea-86d2-83036af9991e",
"contact_external_uid": "MTAwOV90ZXN0MTAwOUB0ZXN0LmNvbQ==",
"contact_version": 2,
"contact_number": "4573246",
"contact_type": "GUEST",
"contact_title": "Mr.",
"contact_name_first": "John",
"contact_name_last": "Doe",
"contact_email": "Johndoe@example.com",
"contact_phone": "+14155552671",
"contact_mobile": "+14155552671",
"contact_language": "NL",
"contact_nationality": "Dutch",
"contact_flight_number": "KL 445",
"contact_loyalty_number": "46564564564547476",
"contact_birth_place": "Amsterdam",
"contact_birth_date": "2025-06-28",
"contact_passport": "JXXXXXXX",
"contact_gender": "MALE",
"contact_age": 19,
"contact_room_number": "523",
"contact_website": "example.com",
"contact_company": {
"company_name": "Example LTD.",
"company_registration_number": "text",
"company_tax_number": "text"
},
"contact_classification": "IMPORTANT",
"contact_address": {
"name": "Start of the Tour / My house / Office / John Doe",
"street": "Amstel 1",
"addition": "Apt B1",
"city": "Amsterdam",
"postal_code": "1011 PN",
"region": "Noord-Holland",
"country": "The Netherlands",
"country_code": "NL",
"place_id": "ChIJrTLr-GyuEmsRBfy61i59si0",
"latitude": "52.3785323",
"longitude": "4.893942",
"notes": "It's on the fourth floor"
},
"contact_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"contact_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"contact_created": "2025-06-28T19:40:22.573Z",
"contact_modified": "2025-06-28T19:40:22.573Z"
},
"payment_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"payment_created": "2025-06-28T19:40:22.573Z",
"payment_created_name": "Cashier Name",
"payment_created_email": "cashier@prioticket.com"
}
],
"order_checkout_fields": [
{
"checkout_field_id": "CHECKOUT_FIELD_ID",
"checkout_field_title": "First Name",
"checkout_field_label": "Please provide your first name",
"checkout_field_place_holder": "Some text",
"checkout_field_help_text": "Custom Field",
"checkout_field_account_type": "DISTRIBUTOR",
"checkout_field_booking_reference": [
"text"
],
"checkout_field_restriction": "REQUIRED",
"checkout_field_level": "PRODUCT",
"checkout_field_unit": "text",
"checkout_field_input_type": "SINGLE",
"checkout_field_type": "contact_title",
"checkout_field_options": [
"AIR",
"RAIL",
"SEA",
"OTHER"
],
"checkout_field_values": [
{
"checkout_field_value_product_type": "ADULT",
"checkout_field_value": [
"AIR"
],
"checkout_field_value_transaction_reference": "TRANSACTION_REFERENCE"
}
],
"checkout_field_created": "2025-06-28T19:40:22.573Z"
}
],
"order_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"order_options": {
"email_options": {
"email_types": {
"send_tickets": false
}
}
},
"order_flags": [
{
"flag_id": "223425262",
"flag_name": "Stock Code",
"flag_type": "FLAG",
"flag_value_id": "123BCa1",
"flag_value": "123BCa1"
}
],
"order_event_details": [
{
"event_order_version": 2,
"event_note": "Change of timeslot on request of customer.",
"event_type": "ORDER_CREATE",
"event_created": "2025-06-28T19:40:22.573Z",
"event_creator_user_name": "Andrew",
"event_creator_user_email": "supervisor@prioticket.com",
"event_creator_user_role": "Supervisor"
}
],
"order_custom_fields": [
{
"custom_field_name": "Custom Field Name",
"custom_field_value": "Custom Field Value"
}
],
"order_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"order_activity_url": "https://activity.prioticket.com/orders/ORDRREF123456",
"order_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"order_voucher_url": "https://emails.prioticket.com",
"order_created": "2025-06-28T19:40:22.573Z",
"order_created_name": "Demo Cashier",
"order_created_email": "cashier@prioticket.com",
"order_modified": "2025-06-28T19:40:22.573Z",
"order_modified_name": "Demo Cashier",
"order_modified_email": "cashier@prioticket.com",
"order_cancellation_date_time": "2025-06-28T19:40:22.573Z",
"order_cancellation_reason": "Payment declined",
"order_bookings": [
{
"booking_external_reference": "BOOKING_EXTERNALREF123",
"booking_status": "BOOKING_RESERVED",
"booking_version": 1,
"booking_voucher_released": true,
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_valid_until": "2025-06-28T19:40:22.573Z",
"booking_language": "en",
"booking_addon_reference": "BOOKING_ADDON_REFERENCE_123",
"booking_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"booking_notes": [
{
"note_value": "Wheelchair assistance required.",
"note_created": "2025-06-28T19:40:22.573Z",
"note_recipients": [
"SUPPLIER"
],
"note_creator_account_type": "DISTRIBUTOR",
"note_creator_user_name": "Andrew",
"note_creator_user_email": "supervisor@prioticket.com",
"note_creator_user_role": "Supervisor"
}
],
"booking_customer_url": "https://customer.prioticket.com/orders/ORDRREF123456",
"booking_voucher_url": "https://emails.prioticket.com",
"booking_created": "2025-06-28T19:40:22.573Z",
"booking_modified": "2025-06-28T19:40:22.573Z",
"booking_confirmed": "2025-06-28T19:40:22.573Z",
"booking_cancelled": "2025-06-28T19:40:22.573Z",
"booking_cancellation_reason": "Payment declined",
"product_id": "PRODUCT_ID_123",
"product_relation_id": "MAIN_PRODUCT_ID_123",
"product_pickup_point_id": "PICKUP_POINT_ID_123",
"product_pickup_point": {
"pickup_point_id": "PICKUP_POINT_ID_123",
"pickup_point_name": "Walkingtour at the Wyndham Apollo Hotel",
"pickup_point_type": "FIXED",
"pickup_point_description": "Meet at the Wyndham Apollo hotel.",
"pickup_point_location": "LOCATION_ID_123",
"pickup_point_time": "10:00",
"pickup_point_times": [
"10:00"
],
"pickup_point_duration": 30,
"pickup_point_availability_dependency": false
},
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_supplier_admin_id": "PRODUCT_SUPPLIER_ADMIN_ID",
"product_supplier_admin_name": "Supplier Admin Name",
"product_market_admin_id": "345345342",
"product_market_admin_name": "Market Admin Name",
"product_source_id": "34564574",
"product_source_name": "Prioticket",
"product_entry_notes": "Reconfirmation: Please call or email atleast 72 hour in advance to reconfirm your arrival.",
"product_admission_type": "TIME_PERIOD",
"product_class": "STANDARD",
"product_currency_code": "USD",
"product_cancellation_allowed": true,
"product_combi_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_bundle_details": [
{
"product_parent_id": "PRODUCT_PARENT_ID_123",
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_currency_code": "USD",
"product_availability_id": "20191026090010006526",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_capacity_id": "43525235",
"product_availability_capacity_shared_id": "435252453",
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_reference": "text",
"booking_external_reference": "BOOKING_EXTERNALREF123",
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
],
"product_addon_details": [
{
"product_id": "PRODUCT_COMBI_ID_123",
"product_title": "Test Product",
"product_supplier_id": "PRODUCT_SUPPLIER_ID",
"product_supplier_name": "Test Museum",
"product_admission_type": "TIME_PERIOD",
"product_availability_from_date_time": "2025-06-28T19:40:22.573Z",
"product_availability_to_date_time": "2025-06-28T19:40:22.573Z",
"booking_travel_date": "2025-06-28T19:40:22.573Z",
"booking_order_reference": "BOOKING_ORDER_REFERENCE",
"booking_reference": "BOOKING_REF123",
"booking_status": "BOOKING_RESERVED"
}
],
"product_code": "1539762088951995",
"product_code_settings": {
"product_code_format": "QR_CODE",
"product_code_source": "PRIO",
"product_group_code": true,
"product_combi_code": true,
"product_city_card": false,
"product_voucher_settings": "SINGLE"
},
"product_type_details": [
{
"product_type": "ADULT",
"product_type_class": "STANDARD",
"product_type_id": "PRODUCT_TYPE_ID_123",
"product_type_label": "Adult",
"product_type_age_from": 18,
"product_type_age_to": 65,
"product_type_count": 1,
"product_type_pax": 1,
"product_type_capacity": 1,
"product_type_spots": [
{
"spot_name": "Regular seat",
"spot_section": "VIP Area",
"spot_row": "F",
"spot_number": "5"
}
],
"product_type_code": "1539762088951995",
"product_type_pricing": {
"price_subtotal": "20.00",
"price_variations": [
{
"variation_label": "Peak Hour",
"variation_amount": "2.50",
"variation_type": "PRODUCT_DYNAMIC"
}
],
"price_promocodes": [
{
"promo_code": "PROMOCODE_123",
"promo_amount": "-5.50"
}
],
"price_taxes": [
{
"tax_id": "TAX_ID_123",
"tax_amount": "0.65",
"tax_rate": "20.00"
}
],
"price_fees": [
{
"fee_type": "SERVICE",
"fee_amount": "0.50",
"fee_percentage": "25.00",
"fee_tax_amount": "0.65",
"fee_included": true
}
],
"price_total": "12.00"
},
"product_type_code_supplier_reference": "text",
"product_type_transaction_id": "159118380521834001",
"product_type_status": "CONFIRMED",
"product_type_redemption_status": "REDEEMED",
"product_type_payment_status": "PAID",
"product_type_redemption_date_time": "2025-06-28T19:40:22.573Z",
"product_type_redemption_user_name": "text",
"product_type_redemption_user_email": "name@gmail.com",
"product_type_pass_details": {
"pass_code": "text",
"pass_duration": {
"pass_duration_start": "2018-06-26T12:08:47Z",
"pass_duration_end": "2018-06-26T12:08:47Z",
"pass_duration_total": 86400,
"pass_duration_remaining": 3600
},
"pass_redemptions": [
{
"pass_redemption_date_time": "2025-06-28T19:40:22.573Z",
"pass_redemption_user_name": "text",
"pass_redemption_user_email": "name@gmail.com"
}
]
}
}
],
"product_cancellation_policies": [
{
"cancellation_description": "Please cancel any booking 1 hour in advance.",
"cancellation_type": "TRAVEL_DATE",
"cancellation_fee_threshold": 3600,
"cancellation_fee_percentage": 20.5,
"cancellation_fee_amount": "5.00"
}
],
"booking_reference": "BOOKING_REFERENCE_123",
"booking_supplier_reference": "BOOKING_SUPPLIER_REFERENCE_123"
}
]
}
}
}Was this helpful?