Add Order Endpoint

When a Tixstock broker ticket(s) has been purchased on a reseller website, it is required the reseller notifies Tixstock of the order by sending a request to the add order endpoint.

It is required that the reseller takes the lead ensuring the order status is correct on Tixstock to be inline with the resellers order process. For example, if the reseller has an order approval process it is required that the order type status set as 'Pending Approval' before updating to 'Approved' or 'Rejected'.

It is required that resellers have set up their supported order statuses from within the Tixstock Reseller Admin Area before using this endpoint.

Endpoint URL

https://api.tixstock.com/v1/order/add/{hold_id}/{sold_quantity}

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

Parameters

Description

order_id *

The resellers external ID for the order.
Type: String

order_status *

The order status ‘External Status’
Validates against the resellers order statuses from the Tixstock Reseller Admin Area. Type: String

datetime *

The date and time for the order.
Type: Date in ISO-8601 UTC Format
Example: 2020-03-10T17:30:00-0400

currency *

The currency the listing was purchased in.
Should match the resellers currency for the event the sold listing is for.
Please see Supported Event Currencies
Type: Date in ISO-8601 UTC Format
Example: 2020-03-10T17:30:00-0400

customer *

id *	The resellers ID for the customer. Type: String
first_name	The customers first name. Type: String
last_name	The customers last name. Type: String
email_address	The customers email address. Type: String
dob	The customers date of birth. Type: Date in YYYY-MM-DD Format Example: 1993-06-24
national_id	The customers National ID Number. Type: String
contact_number	The customers mobile or telephone number. Type: String\|null

billing_address

(optional) The customers billing address. All fields are required if providing a billing address for the order.
address_line_1 *	The address line 1 for the billing address Type: String
address_line_2	The address line 2 for the billing address Type: String
town *	The town for the billing address. Type: String
county *	The county for the billing address. Type: String
postcode *	The postcode for the billing address. Type: String
country_code *	The country for the billing address. Please refer to supported country codes Format: ISO-3166 Alpha 2 Country Code Type: String

shipping_address

(optional) The customers shipping address. All fields are required if providing a shipping address for the order.
address_line_1 *	The address line 1 for the shipping address Type: String
address_line_2	The address line 2 for the shipping address Type: String
town *	The town for the shipping address. Type: String
county *	The county for the shipping address. Type: String
postcode *	The postcode for the shipping address. Type: String
country_code *	The country for the shipping address. Please refer to supported country codes Format: ISO-3166 Alpha 2 Country Code Type: String

items

An array of line items for each ticket purchased for the order, this will be validated against the quantity being purchased.
Type: Array

general_admission *

The general admission status for the listing. Must match the GA status saved on the listing
Type: Boolean

row

The row must be the row saved against the listing.
Type: String

seat

The seat must be the seat saved against the listing.
Type: String

price

The price the customer paid for the individual ticket, in the order currency.
Type: Float

customer

(Optional) An array of customer information for each ticket purchased for the order. Type: Array
first_name	The customers first name. Type: String
last_name	The customers last name. Type: String
email_address	The customers email address. Type: String
dob	The customers date of birth. Type: Date in YYYY-MM-DD Format Example: 1993-06-24
national_id	The customers National ID Number. Type: String
contact_number	The customers mobile or telephone number. Type: String\|null
address	The customers address. Type: String
nationality	The customers nationality. Type: String
birth_place	The customers place/city of birth. Type: String
birth_country	The customers country of birth. Type: String

shipping_tracking_id

The shipping tracking id provided by courier.
Type: String|null

shipping_label

The URL to the shipping label for the order on the resellers website.
Type: String

notes

The order/booking notes by the customer that the broker on the checkout page.
Type: String

API Response:

{
    "data": {
        "id": "234234324",
        "date": "2020-04-05T21:30:00+0000",
        "customer": {
            "id": "123",
            "first_name": "Walter",
            "last_name": "Smith",
            "email_address": "walter.smith@example.com",
            "dob": "1993-06-24",
            "national_id": "NI23221245",
            "contact_number": "+441234567890",
            "billing_address": {
                "address_line_1": "1st Floor 49 Peter Street",
                "address_line_2": "",
                "town": "Manchester",
                "county": "Greater Manchester",
                "postcode": "M2 3NG",
                "country_code": "GB"
            },
            "shipping_address": {
                "address_line_1": "1st Floor 49 Peter Street",
                "address_line_2": "",
                "town": "Manchester",
                "county": "Greater Manchester",
                "postcode": "M2 3NG",
                "country_code": "GB"
            }
        },
        "items": [
            {
                "listing_id": "9211231",
                "general_admission": "true",
                "type": "Paper",
                "section": "",
                "row": "",
                "file": [],
                "customer": {
                    "first_name": "Walter",
                    "last_name": "Smith",
                    "email_address": "",
                    "dob": "1993-06-24",
                    "national_id": "NI23221245",
                    "contact_number": "+441234567890",
                    "address":"49 Peter Street, Manchester",
                    "nationality": "British",
                    "birth_place": "Manchester",
                    "birth_country": "United Kingdom"
                }
            }
        ],
        "quantity": 1,
        "currency": "GBP",
        "sub_total": "90.00",
        "grand_total": "90.00",
        "status": "Pending Review",
        "shipping_tracking_id": null,
        "shipping_label": ""
    },
    "meta": {
        "mode": "Production",
        "type": "orders.add",
        "request_id": "01e32kkv51vk40hbxqe15qppx3"
    },
    "message": "Order has been successfully created."
}