Update Order Endpoint

The update order endpoint will allow partners to update their order details for an order already added to Tixstock via the 'Add Order' Endpoint.

This endpoint will allow the order status to be updated, and to set the customers shipping address and shipping label.

It is required that the partner takes the lead ensuring the order status is correctly updated on Tixstock to be inline with the partner order process.

Once an order is updated to a 'Commissionable' order status, the order can no longer be updated.

Tixstock will cancel any pending invoices for commission for orders that have been updated to an order status type of 'Refunded'.

Please be aware that the API will not refund the broker if the invoice for commission has already been paid.

---

Endpoint URL

---

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

Parameter	Description
order_status *	The order status is required upon update if no address details are being passed over Type: String Allowed Values: Approved, Commissionable, Rejected, Cancelled, Refunded, Pending Review, Sale on Hold
ticket_type	If want to update order ticket type then use this parameter. Type: String (Please refer to your available ticket types when using this parameter)
datetime	The date and time for the order. Type: Date in ISO-8601 UTC Format Example: 2020-03-10T17:30:00-0400
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
shipping_address *	The shipping address details are required upon update if the status remains unchanged address_line_1 * This needs to be the first part of the customers shipping address Type: String address_line_2 This needs to be the second part of the customers shipping address Type: String town * The Town or County Type: String postcode * A valid postal/zipcode for the delivery Type: String country * 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 for any shipping labels used when sending tickets to a customer Type: URL
shipping_label_raw	The shipping label in a base64 string of pdf file for the order. 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",
            "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": "Rejected",
        "shipping_tracking_id": null,
        "shipping_label": "",
        "shipping_label_raw": ""
    },
    "meta": {
        "type": "partner.order.update",
        "mode": "Production",
        "request_id": "01e7595xa9m41ptjqw3c2gd1nw"
    },
    "message": "The order has been successfully updated."
}

---