Update Order Endpoint

The update order endpoint will allow resellers 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 to one of the resellers, and to set the customers shipping address and shipping label.

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

Once an order is updated to an 'Commissionable' order status type, the order cannot 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

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

Parameter	Description
order_status *	The order status is required upon update if no address details are being passed over Type: String
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
shipping_label	The URL for any shipping labels used when sending tickets to a customer Type: URL
items	An array of ticket items previously set, but can only update the customer information here. Type: Array customer 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
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",
            "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": ""
    },
    "meta": {
        "type": "orders.update",
        "mode": "Production",
        "request_id": "01e7595xa9m41ptjqw3c2gd1nw"
    },
    "message": "The order has been successfully updated."
}

---