Hold Tickets Endpoint

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

The reseller 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.

Listings will be automatically released after 30 minutes.


Endpoint URL

https://api.tixstock.com/v1/tickets/hold/{external_id}

Authorisation

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 API settings from within the Tixstock Reseller Admin Area.

Please see 'Authentication - Bearer Tokens' for further information


Request Data

The resellers listing ID (external_id) is required to delete the listing and should be passed in the URL. If no listing is found in Tixstock with the same ID, an error will be outputted.

The supplied data must adhere to the following ruleset:

Parameters Description
external_id* The resellers listing ID is required.
quantity* The quantity of tickets to be held.
Must adhere to the listings split type and quantity.
Type: Integer
Min: 1

API Response:

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