Hold Tickets Endpoint

When a broker’s ticket has been added to a customer’s cart on a Partners website, it is required that the partner sends a request to Tixstock’s Hold Tickets Endpoint to notify the system the listing needs to be placed on hold to prevent double selling.

A Partner must save the supplied hold_id as this will be required to remove the listing from being on hold via the release tickets endpoint, or to complete an order via the add order endpoint.

Please note Listings will be automatically released after 30 minutes.


Endpoint URL

https://sandbox-pf.tixstock.com/v1/tickets/hold

Authorisation Description
Bearer Token A valid bearer token must be provided within the header parameters for the API request. To generate an access token, please see your bearer token settings from within the Tixstock Partner Admin Area.

Please see 'Authentication - Bearer Tokens' for further information


Request Data

The supplied data must adhere to the following ruleset:

Parameters Description
listing_id* The id of the listing is required in order to place the listing on hold.
quantity* The quantity of tickets to be held.
Must adhere to the listings split type and quantity available (this cdata can be accessed via the Get Tickets Endpoint).

Type: Integer
Min: 1

API Response:

{
    "data": {
        "quantity_available": 3
    },
    "meta": {
        "mode": "Sandbox",
        "type": "partner.ticket.hold",
        "hold_id": "01e32ems8ask9y28kk2a6g6yqs",
        "quantity": 1,
        "request_id": "01e32emsjae3mzcyysr8w2pj3m"
    },
    "message": "Ticket(s) has successfully been put on hold."
}