ORDER

A sales order changed state. Fetch the order from url to get its current details.

Header

ob-event: ORDER

Subscribe with

ORDER_PURCHASEORDER_BOOKINGORDER_REFUNDORDER_CANCELORDER_PRINTORDER_UPDATE

Sent to

The entity that owns the sales channel of the order.

Actions

PURCHASE

A purchase was paid.

BOOKING

A reservation was confirmed.

REFUND

A refund was made. The refund is a new order with its own code; previous_code is the order it refunds.

CANCEL

A purchase was cancelled.

PRINT

The tickets of the order were printed, or printing failed. See print_status.

RELOCATE

The seats of an order were relocated, which creates a new order that replaces the previous one. Sent to webhooks subscribed to ORDER_PURCHASE.

UPDATE

Companion notification for the order referenced in previous_code.

Payload

codestring

Order code.

urlstring

URL of the order in the Orders API.

previous_codestring

Relocations and refundsCode of the order that this one replaces or refunds.

reimbursementboolean

RefundsWhether the money is returned to the buyer.

print_statusstring

PRINTFINISHED, ERROR or BLACKLISTED.

Examples

ob-action: PURCHASE

{
  "code" : "9N1FTEJKTQH2",
  "url" : "https://api.oneboxtds.com/orders-mgmt-api/v1/orders/9N1FTEJKTQH2"
}

ob-action: REFUND

{
  "code" : "R0017AB3XK9",
  "url" : "https://api.oneboxtds.com/orders-mgmt-api/v1/orders/R0017AB3XK9",
  "previous_code" : "0017AB3XK9",
  "reimbursement" : true
}

ob-action: PRINT

{
  "code" : "0017AB3XK9",
  "url" : "https://api.oneboxtds.com/orders-mgmt-api/v1/orders/0017AB3XK9",
  "print_status" : "FINISHED"
}

Companion UPDATE notification

When an order has a previous_code and the webhook also subscribes to ORDER_UPDATE, a second request is sent right after the first one, with ob-action: UPDATE and the code and url of the previous order. Subscribing to ORDER_UPDATE alone does not deliver anything: it only adds this second notification.

A refund can also trigger a notification for the original order. Always read the current state of the order from the API instead of inferring it from the action.