Order Ticket Fulfilment Webhooks

If an order requires fulfilment the broker can upload their tickets within Tixstock. An order fulfilment webhook is sent to the Partner containing the base64 encoded PDF and the order details it relates to each time a broker uploads their ticket.

The order eTicket Fulfilment Webhook and Order Mobile Fulfilment Webhook payload are the same with the exception of the webhook type. As such, we would recommend using the same endpoint for both types of webhook.

The Order eTicket Fulfilment webhook type is order.eticket_fulfilment and is used for ETicket orders. Conversely, the Order Mobile Fulfilment webhook type is set to order.mobile_ticket_fulfilment and represents Mobile Ticket orders.

Order Statuses

Partners are required to return an order status in their endpoints response. This will ensure the order status remain in sync for both systems.

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

Parameter	Description
order_id*	The Partners ID for the order. Type: String
id*	The Partners ID for the listing the order relates to. Type: String
general_admission*	The General Admission (GA) status of the listing. Type: Boolean
row*	The row that the ticket is assigned to. If the listing is set to GA, `NULL` will be sent. Type: String
seat*	The seat that the eTicket is assigned to. Type: String
file*	Base64 encoded string of eTicket PDF file. Type: String
proof_file_url	An Array of valid proof urls for mobile ticket fulfillment. Can be blank array in case of non mobile ticket type fulfillment. Type: Array
additional_file	URL to an additional file, such as an instruction letter that can be uploaded by the seller and sent to your end customer. Type: String
mobile_links	An array of mobile links with seat in case of mobile link orders. Type: Array

GA Example Request

{
    "data": {
        "order_id": "3434341233",
        "id": "15454542",
        "general_admission": 1,
        "row": null,
        "seat": null,
        "file": "base64 PDF file...",
        "proof_file_url": [
            "url 1",
            "url 2"
            ...
        ],
        "additional_file": "url",
        "mobile_links": []
    },
    "meta": {
        "type": "order.eticket_fulfilment"
    }
}

None GA Example Request

{
    "data": {
        "order_id": "3434341233",
        "id": "15454542",
        "general_admission": 0,
        "row": "V",
        "seat": "100",
        "file": "base64 PDF file...",
         "proof_file_url": [
            "url 1",
            "url 2"
            ...
        ],
        "additional_file": "url",
        "mobile_links": []

    },
    "meta": {
        "type": "order.mobile_ticket_fulfilment"
    }
}

Mobile link Example Request

{
  "data": {
    "order_id": "3434341233",
    "id": "15454542",
    "general_admission": 0,
    "row": "V",
    "seat": "100",
    "file": "",
    "proof_file_url": [],
    "additional_file": "url",
    "mobile_links": [
      {
        "seat": "1",
        "link": "url"
      },
      {
        "seat": "2",
        "link": "url"
      }
       ...
    ]
  },
  "meta": {
    "type": "order.mobile_link_ticket_fulfilment"
  }
}

Paper/Member Seasons Card fulfilment Example Request

{
    "data": {
        "order_id": "01hgzagrm95g4q0e9a2bzcpxtd",
        "id": "01hgza5v9wybqtx7qsfsecp9ca",
        "paper_ticket_details": {
            "shipping_tracking_id": "4433221155WER",
            "delivery_partner_name": "DHL"
        }
    },
    "meta": {
        "type": "order.paper_ticket_fulfilment"
    }
}

Partners JSON Response

It is required that Partners provide a valid JSON response back from the webhook request.

Success Response

{
  "external_id": "3434341233",
  "order_status": "Delivered",
  "message": "Listing has been fulfilled for the order.",
  "success": true
}

Paper Success Response

{
    "external_id": "01hgzagrm95g4q0e9a2bzcpxtd",
    "order_status": "Shipped",
    "message": "Order has been fulfilled.",
    "success": true
}

Error Response

{
  "external_id": "3434341233",
  "order_status": "Accepted",
  "message": "Listing failed to be fulfilled for the order.",
  "success": false
}