Add Order Endpoint

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

Endpoint URL

https://pf.tixstock.com/v1/orders/add/{hold_id}/{quantity_sold}

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

Order Statuses

Status	Description
Approved	The order has been approved
Commissionable	When an order is set to this type Tixstock will raise an invoice to are customer. Once the order is set to this status Tixstock will no longer allow the status to be changed.
Rejected	The customer has rejected the order. This order status is only allowed if Approved and Pending Review is present. An order cannot be changed once set to this status.
Refunded/Cancelled	All outstanding raised Invoices for the order will be marked as “Cancelled” to prevent the broker associated to the order from being charged commission. An order cannot be changed once set to this status.
Pending Review	In Tixstock a broker will be required to "Approve" or "Reject" an order assigned to this status.
Sale on Hold	Order is awating for partner to either "Approve" or "Reject" the order from their end.

Request Data

Parameters

Description

order_id *

The partners ID for the order (your internal ID for the order).
Type: String

order_status *

The order status
Type: String
Allowed Values: Approved, Commissionable, Rejected, Cancelled, Refunded, Pending Review, Sale on Hold

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 partners' currency for the event the sold listing is for.

customer *

id *	The partners 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
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 partners website.
Type: String

shipping_label_raw

The shipping label in a base64 string of pdf file for the order.
Type: String|null

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": "partner.order.add",
        "request_id": "01e32kkv51vk40hbxqe15qppx3"
    },
    "message": "Order has been successfully created."
}