Reservations / Cart

Manage your reservation

Reserving a product is only mandatory in case the product has managed capacity. Although we also recommend to implement it in the following cases:

• When holding customer products inside a shoppingcart.

• Lock a slot while waiting for a confirmed payment.

• High demand / low availability tickets (concert/events).

• Adding promocodes to an order.

• Managing combi- and cart-discounts.

• Cross-client order process.

Reservations can be confirmed by passing the reservation_reference to the Create Order API. One or more products can be reserved at once. We highly recommend implementing the Cart flow for maximum functionality.

Create Reservation / Create Cart

post

This API is called to reserve one or multiple product(s).

• This endpoint can also be requested for products without managed capacity.

• This endpoint should be called only once per order. Followup request such as amending the cart should be done using the 'Update Reservation` endpoint.

Authorizations

Body

Create reservation request.

api_versionstringRead-onlyRequired

Represents the version of the service API that's served in the response.

Example: 3.8.0

Responses

201

Reservation 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

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

HTTPcURLJavaScriptPython

POST /v3.8/distributor/reservations HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 7142

{
  "data": {
    "reservation": {
      "reservation_distributor_id": "501",
      "reservation_partner_id": "4534543543",
      "reservation_external_reference": "EXTERNALREF123",
      "reservation_hold_token": "17378c14-ae6a-46a4-ada4-9c745a45e018",
      "reservation_details": [
        {
          "booking_external_reference": "BOOKING_EXTERNALREF123",
          "booking_travel_date": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "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-17T08:07:06.718Z",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "booking_reservation_reference": "BOOKING_RESERVATION_REFERENCE_123",
          "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"
                  }
                ]
              }
            }
          ]
        }
      ],
      "reservation_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": "[e-mail]",
          "contact_phone": "[phone]",
          "contact_mobile": "[phone]",
          "contact_language": "NL",
          "contact_nationality": "Dutch",
          "contact_flight_number": "KL 445",
          "contact_loyalty_number": "46564564564547476",
          "contact_birth_place": "Amsterdam",
          "contact_birth_date": "2025-06-17",
          "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"
            }
          ]
        }
      ],
      "reservation_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"
            }
          ]
        }
      ],
      "reservation_pricing": {
        "price_variations": [
          {
            "variation_label": "Peak Hour",
            "variation_amount": "2.50",
            "variation_type": "PRODUCT_DYNAMIC"
          }
        ]
      },
      "reservation_payments": [
        {
          "payment_partner_id": "PAYMENT_PARTNER_ID",
          "payment_merchant_reference": "1478349849927_771663371",
          "payment_external_reference": "SHOPPER_REFERENCE",
          "payment_order_reference": "ORDRREF123456",
          "payment_method": "EXTERNAL",
          "payment_scheme": "VISA",
          "payment_type": "CAPTURE",
          "payment_refund_reason": "Guest reimbursement",
          "payment_currency_code": "EUR",
          "payment_currency_rate": "2.5263",
          "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_number": "4573246",
            "contact_type": "GUEST",
            "contact_title": "Mr.",
            "contact_name_first": "John",
            "contact_name_last": "Doe",
            "contact_email": "[e-mail]",
            "contact_phone": "[phone]",
            "contact_mobile": "[phone]",
            "contact_language": "NL",
            "contact_nationality": "Dutch",
            "contact_flight_number": "KL 445",
            "contact_loyalty_number": "46564564564547476",
            "contact_birth_place": "Amsterdam",
            "contact_birth_date": "2025-06-17",
            "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"
              }
            ]
          },
          "payment_notes": [
            {
              "note_value": "Wheelchair assistance required.",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR"
            }
          ]
        }
      ],
      "reservation_custom_fields": [
        {
          "custom_field_name": "Custom Field Name",
          "custom_field_value": "Custom Field Value"
        }
      ]
    }
  }
}

{
  "api_version": "3.8.0",
  "data": {
    "kind": "location",
    "reservation": {
      "reservation_distributor_id": "501",
      "reservation_distributor_name": "Demo Distributor",
      "reservation_partner_id": "4534543543",
      "reservation_partner_name": "Partner Name",
      "reservation_reference": "ABC123456",
      "reservation_external_reference": "EXTERNALREF123",
      "reservation_hold_token": "17378c14-ae6a-46a4-ada4-9c745a45e018",
      "reservation_valid_until": "2025-06-17T08:07:06.718Z",
      "reservation_details": [
        {
          "booking_external_reference": "BOOKING_EXTERNALREF123",
          "booking_status": "BOOKING_RESERVED",
          "booking_version": 1,
          "booking_voucher_released": true,
          "booking_travel_date": "2025-06-17T08:07:06.718Z",
          "booking_valid_until": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "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-17T08:07:06.718Z",
          "booking_modified": "2025-06-17T08:07:06.718Z",
          "booking_confirmed": "2025-06-17T08:07:06.718Z",
          "booking_cancelled": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
          "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "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"
                  }
                }
              ],
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_reference": "text",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "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"
                  }
                }
              ],
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_reference": "text",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_order_reference": "BOOKING_ORDER_REFERENCE",
              "booking_reference": "BOOKING_REF123",
              "booking_status": "BOOKING_RESERVED"
            }
          ],
          "booking_reservation_reference": "BOOKING_RESERVATION_REFERENCE_123",
          "booking_reservation_valid_until": "2025-06-17T08:07:06.718Z",
          "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"
              }
            }
          ]
        }
      ],
      "reservation_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": "[e-mail]",
          "contact_phone": "[phone]",
          "contact_mobile": "[phone]",
          "contact_language": "NL",
          "contact_nationality": "Dutch",
          "contact_flight_number": "KL 445",
          "contact_loyalty_number": "46564564564547476",
          "contact_birth_place": "Amsterdam",
          "contact_birth_date": "2025-06-17",
          "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-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "note_creator_user_role": "Supervisor"
            }
          ],
          "contact_custom_fields": [
            {
              "custom_field_name": "Custom Field Name",
              "custom_field_value": "Custom Field Value"
            }
          ],
          "contact_created": "2025-06-17T08:07:06.718Z",
          "contact_modified": "2025-06-17T08:07:06.718Z"
        }
      ],
      "reservation_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-17T08:07:06.718Z"
        }
      ],
      "reservation_promocodes": [
        {
          "promo_title": "Christmas Sale 2019",
          "promo_description": "20 percent discount during the Christmas days.",
          "promo_code": "PROMOCODE_123"
        }
      ],
      "reservation_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"
      },
      "reservation_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-17T08:07:06.718Z",
          "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": "[e-mail]",
            "contact_phone": "[phone]",
            "contact_mobile": "[phone]",
            "contact_language": "NL",
            "contact_nationality": "Dutch",
            "contact_flight_number": "KL 445",
            "contact_loyalty_number": "46564564564547476",
            "contact_birth_place": "Amsterdam",
            "contact_birth_date": "2025-06-17",
            "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-17T08:07:06.718Z",
                "note_recipients": [
                  "SUPPLIER"
                ],
                "note_creator_account_type": "DISTRIBUTOR",
                "note_creator_user_name": "Andrew",
                "note_creator_user_email": "[e-mail]",
                "note_creator_user_role": "Supervisor"
              }
            ],
            "contact_custom_fields": [
              {
                "custom_field_name": "Custom Field Name",
                "custom_field_value": "Custom Field Value"
              }
            ],
            "contact_created": "2025-06-17T08:07:06.718Z",
            "contact_modified": "2025-06-17T08:07:06.718Z"
          },
          "payment_notes": [
            {
              "note_value": "Wheelchair assistance required.",
              "note_created": "2025-06-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "note_creator_user_role": "Supervisor"
            }
          ],
          "payment_created": "2025-06-17T08:07:06.718Z",
          "payment_created_name": "Cashier Name",
          "payment_created_email": "[e-mail]"
        }
      ],
      "reservation_custom_fields": [
        {
          "custom_field_name": "Custom Field Name",
          "custom_field_value": "Custom Field Value"
        }
      ],
      "reservation_created": "2025-06-17T08:07:06.718Z",
      "reservation_created_name": "Demo Cashier",
      "reservation_created_email": "[e-mail]",
      "reservation_modified": "2025-06-17T08:07:06.718Z"
    }
  }
}

Reservation Details / Cart Details

get

This API is called to get reservation details and status.

You are still able to retrieve the cart details for expired reservations up to 10 days.

Authorizations

Path parameters

reservation_referencestring · min: 8Required

A unique identifier got in response of the create reservation API.

Header parameters

If-Modified-SincestringOptional

[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.

Example: Wed, 21 Jan 2022 07:28:00 GMT

Responses

200

Get Reservation Detail Response

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

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

HTTPcURLJavaScriptPython

GET /v3.8/distributor/reservations/{reservation_reference} HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "api_version": "3.8.0",
  "data": {
    "kind": "location",
    "reservation": {
      "reservation_distributor_id": "501",
      "reservation_distributor_name": "Demo Distributor",
      "reservation_partner_id": "4534543543",
      "reservation_partner_name": "Partner Name",
      "reservation_reference": "ABC123456",
      "reservation_external_reference": "EXTERNALREF123",
      "reservation_hold_token": "17378c14-ae6a-46a4-ada4-9c745a45e018",
      "reservation_valid_until": "2025-06-17T08:07:06.718Z",
      "reservation_details": [
        {
          "booking_external_reference": "BOOKING_EXTERNALREF123",
          "booking_status": "BOOKING_RESERVED",
          "booking_version": 1,
          "booking_voucher_released": true,
          "booking_travel_date": "2025-06-17T08:07:06.718Z",
          "booking_valid_until": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "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-17T08:07:06.718Z",
          "booking_modified": "2025-06-17T08:07:06.718Z",
          "booking_confirmed": "2025-06-17T08:07:06.718Z",
          "booking_cancelled": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
          "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "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"
                  }
                }
              ],
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_reference": "text",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "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"
                  }
                }
              ],
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_reference": "text",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_order_reference": "BOOKING_ORDER_REFERENCE",
              "booking_reference": "BOOKING_REF123",
              "booking_status": "BOOKING_RESERVED"
            }
          ],
          "booking_reservation_reference": "BOOKING_RESERVATION_REFERENCE_123",
          "booking_reservation_valid_until": "2025-06-17T08:07:06.718Z",
          "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"
              }
            }
          ]
        }
      ],
      "reservation_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": "[e-mail]",
          "contact_phone": "[phone]",
          "contact_mobile": "[phone]",
          "contact_language": "NL",
          "contact_nationality": "Dutch",
          "contact_flight_number": "KL 445",
          "contact_loyalty_number": "46564564564547476",
          "contact_birth_place": "Amsterdam",
          "contact_birth_date": "2025-06-17",
          "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-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "note_creator_user_role": "Supervisor"
            }
          ],
          "contact_custom_fields": [
            {
              "custom_field_name": "Custom Field Name",
              "custom_field_value": "Custom Field Value"
            }
          ],
          "contact_created": "2025-06-17T08:07:06.718Z",
          "contact_modified": "2025-06-17T08:07:06.718Z"
        }
      ],
      "reservation_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-17T08:07:06.718Z"
        }
      ],
      "reservation_promocodes": [
        {
          "promo_title": "Christmas Sale 2019",
          "promo_description": "20 percent discount during the Christmas days.",
          "promo_code": "PROMOCODE_123"
        }
      ],
      "reservation_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"
      },
      "reservation_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-17T08:07:06.718Z",
          "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": "[e-mail]",
            "contact_phone": "[phone]",
            "contact_mobile": "[phone]",
            "contact_language": "NL",
            "contact_nationality": "Dutch",
            "contact_flight_number": "KL 445",
            "contact_loyalty_number": "46564564564547476",
            "contact_birth_place": "Amsterdam",
            "contact_birth_date": "2025-06-17",
            "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-17T08:07:06.718Z",
                "note_recipients": [
                  "SUPPLIER"
                ],
                "note_creator_account_type": "DISTRIBUTOR",
                "note_creator_user_name": "Andrew",
                "note_creator_user_email": "[e-mail]",
                "note_creator_user_role": "Supervisor"
              }
            ],
            "contact_custom_fields": [
              {
                "custom_field_name": "Custom Field Name",
                "custom_field_value": "Custom Field Value"
              }
            ],
            "contact_created": "2025-06-17T08:07:06.718Z",
            "contact_modified": "2025-06-17T08:07:06.718Z"
          },
          "payment_notes": [
            {
              "note_value": "Wheelchair assistance required.",
              "note_created": "2025-06-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "note_creator_user_role": "Supervisor"
            }
          ],
          "payment_created": "2025-06-17T08:07:06.718Z",
          "payment_created_name": "Cashier Name",
          "payment_created_email": "[e-mail]"
        }
      ],
      "reservation_custom_fields": [
        {
          "custom_field_name": "Custom Field Name",
          "custom_field_value": "Custom Field Value"
        }
      ],
      "reservation_created": "2025-06-17T08:07:06.718Z",
      "reservation_created_name": "Demo Cashier",
      "reservation_created_email": "[e-mail]",
      "reservation_modified": "2025-06-17T08:07:06.718Z"
    }
  }
}

Update Reservation / Update Cart

put

This API is called to update an existing reservation / cart.

This endpoint can also be requested for products without availability (product_availability:false) or managed capacity (product_capacity:false).

Cart Functionality:

• To add a product to the cart, send a reservation_details array item with a blank booking_reservation_reference.

• To amend an existing booking, please send the corresponding booking_reservation_reference for the array item with the amended data. In this case the latest request takes precedence and therefore the quantity is always overwritten, not summed.

  Only sent the booking details of those bookings you would like to amend.

• To remove a product from the cart, please call the "Remove Cart Item" endpoint.

• To only change the contact details, do not provide the reservation_details object in the request.

• TIP: The full reservation / cart details will be returned on every request. Therefore you are able to manage the cart outside of your system if required. ReadOnly properties which are included in the response, but not allowed in the request, such as booking_reservation_valid_until will be ignored and can be safely sent. If you choose not to do this, make sure both carts are kept in sync.

Authorizations

Path parameters

reservation_referencestring · min: 8Required

A unique identifier for the created reservation in Prio.

Body

Create reservation request.

api_versionstringRead-onlyRequired

Represents the version of the service API that's served in the response.

Example: 3.8.0

Responses

200

Reservation Updated

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

HTTPcURLJavaScriptPython

PUT /v3.8/distributor/reservations/{reservation_reference} HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 7142

{
  "data": {
    "reservation": {
      "reservation_distributor_id": "501",
      "reservation_partner_id": "4534543543",
      "reservation_external_reference": "EXTERNALREF123",
      "reservation_hold_token": "17378c14-ae6a-46a4-ada4-9c745a45e018",
      "reservation_details": [
        {
          "booking_external_reference": "BOOKING_EXTERNALREF123",
          "booking_travel_date": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "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-17T08:07:06.718Z",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "booking_reservation_reference": "BOOKING_RESERVATION_REFERENCE_123",
          "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"
                  }
                ]
              }
            }
          ]
        }
      ],
      "reservation_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": "[e-mail]",
          "contact_phone": "[phone]",
          "contact_mobile": "[phone]",
          "contact_language": "NL",
          "contact_nationality": "Dutch",
          "contact_flight_number": "KL 445",
          "contact_loyalty_number": "46564564564547476",
          "contact_birth_place": "Amsterdam",
          "contact_birth_date": "2025-06-17",
          "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"
            }
          ]
        }
      ],
      "reservation_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"
            }
          ]
        }
      ],
      "reservation_pricing": {
        "price_variations": [
          {
            "variation_label": "Peak Hour",
            "variation_amount": "2.50",
            "variation_type": "PRODUCT_DYNAMIC"
          }
        ]
      },
      "reservation_payments": [
        {
          "payment_partner_id": "PAYMENT_PARTNER_ID",
          "payment_merchant_reference": "1478349849927_771663371",
          "payment_external_reference": "SHOPPER_REFERENCE",
          "payment_order_reference": "ORDRREF123456",
          "payment_method": "EXTERNAL",
          "payment_scheme": "VISA",
          "payment_type": "CAPTURE",
          "payment_refund_reason": "Guest reimbursement",
          "payment_currency_code": "EUR",
          "payment_currency_rate": "2.5263",
          "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_number": "4573246",
            "contact_type": "GUEST",
            "contact_title": "Mr.",
            "contact_name_first": "John",
            "contact_name_last": "Doe",
            "contact_email": "[e-mail]",
            "contact_phone": "[phone]",
            "contact_mobile": "[phone]",
            "contact_language": "NL",
            "contact_nationality": "Dutch",
            "contact_flight_number": "KL 445",
            "contact_loyalty_number": "46564564564547476",
            "contact_birth_place": "Amsterdam",
            "contact_birth_date": "2025-06-17",
            "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"
              }
            ]
          },
          "payment_notes": [
            {
              "note_value": "Wheelchair assistance required.",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR"
            }
          ]
        }
      ],
      "reservation_custom_fields": [
        {
          "custom_field_name": "Custom Field Name",
          "custom_field_value": "Custom Field Value"
        }
      ]
    }
  }
}

{
  "api_version": "3.8.0",
  "data": {
    "kind": "location",
    "reservation": {
      "reservation_distributor_id": "501",
      "reservation_distributor_name": "Demo Distributor",
      "reservation_partner_id": "4534543543",
      "reservation_partner_name": "Partner Name",
      "reservation_reference": "ABC123456",
      "reservation_external_reference": "EXTERNALREF123",
      "reservation_hold_token": "17378c14-ae6a-46a4-ada4-9c745a45e018",
      "reservation_valid_until": "2025-06-17T08:07:06.718Z",
      "reservation_details": [
        {
          "booking_external_reference": "BOOKING_EXTERNALREF123",
          "booking_status": "BOOKING_RESERVED",
          "booking_version": 1,
          "booking_voucher_released": true,
          "booking_travel_date": "2025-06-17T08:07:06.718Z",
          "booking_valid_until": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "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-17T08:07:06.718Z",
          "booking_modified": "2025-06-17T08:07:06.718Z",
          "booking_confirmed": "2025-06-17T08:07:06.718Z",
          "booking_cancelled": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
          "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "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"
                  }
                }
              ],
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_reference": "text",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "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"
                  }
                }
              ],
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_reference": "text",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_order_reference": "BOOKING_ORDER_REFERENCE",
              "booking_reference": "BOOKING_REF123",
              "booking_status": "BOOKING_RESERVED"
            }
          ],
          "booking_reservation_reference": "BOOKING_RESERVATION_REFERENCE_123",
          "booking_reservation_valid_until": "2025-06-17T08:07:06.718Z",
          "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"
              }
            }
          ]
        }
      ],
      "reservation_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": "[e-mail]",
          "contact_phone": "[phone]",
          "contact_mobile": "[phone]",
          "contact_language": "NL",
          "contact_nationality": "Dutch",
          "contact_flight_number": "KL 445",
          "contact_loyalty_number": "46564564564547476",
          "contact_birth_place": "Amsterdam",
          "contact_birth_date": "2025-06-17",
          "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-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "note_creator_user_role": "Supervisor"
            }
          ],
          "contact_custom_fields": [
            {
              "custom_field_name": "Custom Field Name",
              "custom_field_value": "Custom Field Value"
            }
          ],
          "contact_created": "2025-06-17T08:07:06.718Z",
          "contact_modified": "2025-06-17T08:07:06.718Z"
        }
      ],
      "reservation_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-17T08:07:06.718Z"
        }
      ],
      "reservation_promocodes": [
        {
          "promo_title": "Christmas Sale 2019",
          "promo_description": "20 percent discount during the Christmas days.",
          "promo_code": "PROMOCODE_123"
        }
      ],
      "reservation_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"
      },
      "reservation_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-17T08:07:06.718Z",
          "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": "[e-mail]",
            "contact_phone": "[phone]",
            "contact_mobile": "[phone]",
            "contact_language": "NL",
            "contact_nationality": "Dutch",
            "contact_flight_number": "KL 445",
            "contact_loyalty_number": "46564564564547476",
            "contact_birth_place": "Amsterdam",
            "contact_birth_date": "2025-06-17",
            "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-17T08:07:06.718Z",
                "note_recipients": [
                  "SUPPLIER"
                ],
                "note_creator_account_type": "DISTRIBUTOR",
                "note_creator_user_name": "Andrew",
                "note_creator_user_email": "[e-mail]",
                "note_creator_user_role": "Supervisor"
              }
            ],
            "contact_custom_fields": [
              {
                "custom_field_name": "Custom Field Name",
                "custom_field_value": "Custom Field Value"
              }
            ],
            "contact_created": "2025-06-17T08:07:06.718Z",
            "contact_modified": "2025-06-17T08:07:06.718Z"
          },
          "payment_notes": [
            {
              "note_value": "Wheelchair assistance required.",
              "note_created": "2025-06-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "note_creator_user_role": "Supervisor"
            }
          ],
          "payment_created": "2025-06-17T08:07:06.718Z",
          "payment_created_name": "Cashier Name",
          "payment_created_email": "[e-mail]"
        }
      ],
      "reservation_custom_fields": [
        {
          "custom_field_name": "Custom Field Name",
          "custom_field_value": "Custom Field Value"
        }
      ],
      "reservation_created": "2025-06-17T08:07:06.718Z",
      "reservation_created_name": "Demo Cashier",
      "reservation_created_email": "[e-mail]",
      "reservation_modified": "2025-06-17T08:07:06.718Z"
    }
  }
}

Cancel Reservation / Remove Cart Item / Empty Cart

delete

This API is called to cancel a reserved timeslot, delete products from your cart or empty the cart. In case of a full cancellation, you are no longer able to amend the reservation. Otherwise, the updated cart will be returned.

Note that (combi-)pricing might have changed.

If payment is made, funds will be automatically refunded.

Authorizations

Path parameters

reservation_referencestring · min: 8Required

A unique identifier for the created reservation in the Prio system.

Query parameters

booking_reservation_referencestring[]Optional

When using the Cart functionality you are able to remove individual products.

Example: BOOKING_RESERVATION_REFERENCE_123

cancellation_reasonstringOptional

Optional reason for this cancellation.

Example: Payment declined

Responses

200

Item(s) removed from Cart

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

HTTPcURLJavaScriptPython

DELETE /v3.8/distributor/reservations/{reservation_reference} HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "api_version": "3.8.0",
  "data": {
    "kind": "location",
    "reservation": {
      "reservation_distributor_id": "501",
      "reservation_distributor_name": "Demo Distributor",
      "reservation_partner_id": "4534543543",
      "reservation_partner_name": "Partner Name",
      "reservation_reference": "ABC123456",
      "reservation_external_reference": "EXTERNALREF123",
      "reservation_hold_token": "17378c14-ae6a-46a4-ada4-9c745a45e018",
      "reservation_valid_until": "2025-06-17T08:07:06.718Z",
      "reservation_details": [
        {
          "booking_external_reference": "BOOKING_EXTERNALREF123",
          "booking_status": "BOOKING_RESERVED",
          "booking_version": 1,
          "booking_voucher_released": true,
          "booking_travel_date": "2025-06-17T08:07:06.718Z",
          "booking_valid_until": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "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-17T08:07:06.718Z",
          "booking_modified": "2025-06-17T08:07:06.718Z",
          "booking_confirmed": "2025-06-17T08:07:06.718Z",
          "booking_cancelled": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
          "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "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"
                  }
                }
              ],
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_reference": "text",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "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"
                  }
                }
              ],
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_reference": "text",
              "booking_external_reference": "BOOKING_EXTERNALREF123"
            }
          ],
          "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-17T08:07:06.718Z",
              "product_availability_to_date_time": "2025-06-17T08:07:06.718Z",
              "booking_travel_date": "2025-06-17T08:07:06.718Z",
              "booking_order_reference": "BOOKING_ORDER_REFERENCE",
              "booking_reference": "BOOKING_REF123",
              "booking_status": "BOOKING_RESERVED"
            }
          ],
          "booking_reservation_reference": "BOOKING_RESERVATION_REFERENCE_123",
          "booking_reservation_valid_until": "2025-06-17T08:07:06.718Z",
          "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"
              }
            }
          ]
        }
      ],
      "reservation_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": "[e-mail]",
          "contact_phone": "[phone]",
          "contact_mobile": "[phone]",
          "contact_language": "NL",
          "contact_nationality": "Dutch",
          "contact_flight_number": "KL 445",
          "contact_loyalty_number": "46564564564547476",
          "contact_birth_place": "Amsterdam",
          "contact_birth_date": "2025-06-17",
          "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-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "note_creator_user_role": "Supervisor"
            }
          ],
          "contact_custom_fields": [
            {
              "custom_field_name": "Custom Field Name",
              "custom_field_value": "Custom Field Value"
            }
          ],
          "contact_created": "2025-06-17T08:07:06.718Z",
          "contact_modified": "2025-06-17T08:07:06.718Z"
        }
      ],
      "reservation_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-17T08:07:06.718Z"
        }
      ],
      "reservation_promocodes": [
        {
          "promo_title": "Christmas Sale 2019",
          "promo_description": "20 percent discount during the Christmas days.",
          "promo_code": "PROMOCODE_123"
        }
      ],
      "reservation_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"
      },
      "reservation_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-17T08:07:06.718Z",
          "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": "[e-mail]",
            "contact_phone": "[phone]",
            "contact_mobile": "[phone]",
            "contact_language": "NL",
            "contact_nationality": "Dutch",
            "contact_flight_number": "KL 445",
            "contact_loyalty_number": "46564564564547476",
            "contact_birth_place": "Amsterdam",
            "contact_birth_date": "2025-06-17",
            "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-17T08:07:06.718Z",
                "note_recipients": [
                  "SUPPLIER"
                ],
                "note_creator_account_type": "DISTRIBUTOR",
                "note_creator_user_name": "Andrew",
                "note_creator_user_email": "[e-mail]",
                "note_creator_user_role": "Supervisor"
              }
            ],
            "contact_custom_fields": [
              {
                "custom_field_name": "Custom Field Name",
                "custom_field_value": "Custom Field Value"
              }
            ],
            "contact_created": "2025-06-17T08:07:06.718Z",
            "contact_modified": "2025-06-17T08:07:06.718Z"
          },
          "payment_notes": [
            {
              "note_value": "Wheelchair assistance required.",
              "note_created": "2025-06-17T08:07:06.718Z",
              "note_recipients": [
                "SUPPLIER"
              ],
              "note_creator_account_type": "DISTRIBUTOR",
              "note_creator_user_name": "Andrew",
              "note_creator_user_email": "[e-mail]",
              "note_creator_user_role": "Supervisor"
            }
          ],
          "payment_created": "2025-06-17T08:07:06.718Z",
          "payment_created_name": "Cashier Name",
          "payment_created_email": "[e-mail]"
        }
      ],
      "reservation_custom_fields": [
        {
          "custom_field_name": "Custom Field Name",
          "custom_field_value": "Custom Field Value"
        }
      ],
      "reservation_created": "2025-06-17T08:07:06.718Z",
      "reservation_created_name": "Demo Cashier",
      "reservation_created_email": "[e-mail]",
      "reservation_modified": "2025-06-17T08:07:06.718Z"
    }
  }
}