Retrieve tickets

Endpoint to poll for order status and retrieve the tickets.

Tickets will be available once the order_status has reached the done state.

If the order_status changes from pending to failed, the order was not successful and cannot be fulfilled. Please refund your customer. Failed orders are not invoiced by Tiqets.

Only once the order_status is done (see example below) the order was confirmed and fulfilled successfully.

Polling versus Webhook

To avoid periodic polling, use the callback_url. When implemented, the callback URL will be called by Tiqets every time the order status changes (e.g., the PDF voucher is ready).

Still opting for polling? Then we recommend implementing an "exponential back-off" mechanism or a 5 - 10 minutes interval wait while retrying until the order is in a final status (failed / done / canceled) for a maximum of 24 hours.

Fulfilment Speed

The majority of Tiqets products are fulfilled immediately.

There are however some products where fulfilment can be delayed because of the ticket supplier, specific handling of the ticket or other circumstances. These Products with a higher risk of fulfilment delay can be identified by the property instant_ticket_delivery being set to false.

These products are typically fulfilled within 30 minutes but there can be circumstances when this can go up to a max of 24 hours.

It is up to the API partner to decide to support these products or not.

Retrieve tickets

get

https://api.tiqets.com/v2https://api-tiqt-test.steq.it/v2https://api.api-tiqt-test.steq.it/v2

/orders/{orderReferenceId}/tickets

Path parameters

orderReferenceIdstringRequired

Tiqets Order ID.

Example: 1111111

Query parameters

langstringOptional

Language of the content to retrieve (ISO 639-1). Defaults to English if undefined.

Default: enExample: en

Header parameters

AuthorizationstringRequired

Token <Your_API_Key>.

Default: Token <Partner_API_key>.

Responses

200

Successful operation.

application/json

successbooleanOptional

order_reference_idstringOptional

Unique order reference ID.

order_statusstring · enumOptional

The order status, as one of the following values:

• new: Order is successfully created in Tiqets but not yet confirmed by the distributor.
• pending: Order is confirmed; Tiqets is currently working on the fulfilment.
• failed: Order fulfilment failed.
• done: Order is fulfilled and the PDF tickets are ready.
• cancelled: A previously fulfilled order has been cancelled.

Possible values:

how_to_use_infostring · nullableOptional

Instructions of how to use the tickets. Also displayed on the voucher.

post_purchase_infostring · nullableOptional

Post-purchase information.

tickets_pdf_urlstring · nullableOptional

URL to PDF document with the tickets. Language on the voucher follows order language as defined at order creation. Value is null unless the order_status is done.

must_knowstring · nullableOptional

Important information. Also displayed on the voucher.

pre_purchasestring · nullableOptional

Pre-purchase information.

good_to_knowstring · nullableOptional

Additional information.

includedstring · nullableOptional

Description of what is included in the ticket.

excludedstring · nullableOptional

Description of what is explicitly not included in the ticket.

has_timeslotsboolean · nullableOptional

Indicates whether the product has timeslots.

has_dynamic_pricingbooleanOptionalDeprecated

Indicates whether the product has dynamic pricing.

customer_data_required_on_create_orderbooleanOptionalDeprecated

This element can be ignored and is only returned for compatibility with legacy integrations. Always true.

starting_point_addressstring · nullableOptional

Address of the starting point.

starting_point_latitudenumber · nullableOptional

Latitude of the starting point.

starting_point_longitudenumber · nullableOptional

Longitude of the starting point.

starting_point_city_idinteger · nullableOptional

Tiqets city ID of the starting point.

400

Bad Request -- Check your request parameters (typo in parameter or invalid value).

application/json

401

Unauthorized -- Your API key is incorrect.

application/json

403

Forbidden -- The endpoint or parameters are not allowed for the matching API key.

application/json

404

Not Found -- Requested resource/endpoint could not be found.

application/json

405

Method Not Allowed -- Check your request method.

application/json

429

Too Many Requests -- We currently apply a fair-use policy, but we might enforce limits in the future.

application/json

500

Internal Server Error -- We had a problem with our server. Try again later.

application/json

503

Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

application/json

get

/orders/{orderReferenceId}/tickets

HTTPcURLJavaScriptPython

GET /v2/orders/{orderReferenceId}/tickets HTTP/1.1
Host: api.tiqets.com
Authorization: Token <Partner_API_key>.
Accept: */*

{
  "order_reference_id": "13798247",
  "how_to_use_info": "Show the vouchers at the door.",
  "post_purchase_info": "The venue is closed every Tuesday.",
  "order_status": "done",
  "success": true,
  "tickets_pdf_url": "http://www.tiqets.com/voucher.pdf",
  "must_know": "Pets are not allowed.",
  "pre_purchase": "Children under 6 years old do not need a ticket.",
  "good_to_know": "Storage lockers are available in the basement for an additional fee.",
  "included": "Entrance ticket",
  "excluded": "Usage of storage locker",
  "has_timeslots": false,
  "has_dynamic_pricing": true,
  "customer_data_required_on_create_order": true,
  "starting_point_address": "1017 Amsterdam, Netherlands",
  "starting_point_latitude": 52.3702,
  "starting_point_longitude": 4.8951,
  "starting_point_city_id": 1017
}