Order Update Webhook
The order update webhook will be sent to the Partner when a Tixstock broker either updates the order status, or adds an shipping tracking ID to an applicable order. The order update webhook will contain all information relating to the order.
It is required that Partners return the order status of the order back to Tixstock, which will be updated on the order.
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. |
Post Data
The order resource will be sent to the Partner including all information regarding the order to be updated.
Example Request
{
"data": {
"id": "456",
"date": "2020-04-05T21:30:00+0000",
"customer": {
"id": "123",
"first_name": "Joe",
"last_name": "Doe",
"email_address": "joe.doe@example.com",
"contact_number": "+441234567890",
"billing_address": {
"address_line_1": "68 Osborne Road",
"address_line_2": null,
"town": "King",
"county": "Norfolk",
"postcode": "PE30 6GN",
"country_code": "GB"
},
"shipping_address": {
"address_line_1": null,
"address_line_2": null,
"town": null,
"county": null,
"postcode": null,
"country_code": null
}
},
"items": [
{
"listing_id": "15454541",
"general_admission": "false",
"type": "Eticket",
"section": "Floor A1",
"row": "B",
"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,
"ticket_type": "eticket",
"currency": "GBP",
"sub_total": "190.00",
"grand_total": "190.00",
"status": "Approved",
"shipping_tracking_id": null,
"shipping_label": null
},
"meta": {
"type": "order.update"
}
}
Partners JSON Response
It is required that Partners provide a valid JSON response back from the webhook request.
Success Response
{
"order_status": "Delivered",
"success": true
}
Error Response
{
"order_status": "Rejected",
"success": false
}