SupportChangelogAPI ReferenceStatus

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
OAuth2clientCredentialsRequired

OAuth2 implementation.

Token URL:
Available scopes:
  • : Grants access to products.
  • : Grants access to reservations.
  • : Grants access to bookings.
  • : Grants access to booking details.
  • : Grants access to reporting.
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
post
/reservations

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
OAuth2clientCredentialsRequired

OAuth2 implementation.

Token URL:
Available scopes:
  • : Grants access to products.
  • : Grants access to reservations.
  • : Grants access to bookings.
  • : Grants access to booking details.
  • : Grants access to reporting.
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
get
/reservations/{reservation_reference}

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
OAuth2clientCredentialsRequired

OAuth2 implementation.

Token URL:
Available scopes:
  • : Grants access to products.
  • : Grants access to reservations.
  • : Grants access to bookings.
  • : Grants access to booking details.
  • : Grants access to reporting.
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
put
/reservations/{reservation_reference}

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
OAuth2clientCredentialsRequired

OAuth2 implementation.

Token URL:
Available scopes:
  • : Grants access to products.
  • : Grants access to reservations.
  • : Grants access to bookings.
  • : Grants access to booking details.
  • : Grants access to reporting.
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
delete
/reservations/{reservation_reference}
PreviousAvailabilityNextPromocodes

Last updated

Was this helpful?