Events
The OMS currently emits the events listed below. Every event follows the payload structure described in Introduction to Webhooks; the content of each event's payload is documented with the event.
The id (event UUIDv7), data.id (resource id), data.timestamp and payload values in the examples below are examples — real deliveries carry your own ids and timestamps.
resource | event | Emitted when |
|---|---|---|
PaymentExternalTransaction | refund_requested | OMS requests a refund from the payment gateway — details |
AccountingSaleDocument | issued | an invoice or receipt is issued for an order — details |
AccountingCreditDocument | issued | the credit note of a repayment request (return) is issued — details |
ShippingLabel | issued | a shipping label (waybill) is issued for a shipping — details |
Order | acquiring, with_anomalies, ready, processing, completed, shipped, delivered, storage, cancelled, refunded | an order enters that status — details |
RepaymentRequest | created, waiting_warehouse_reception, waiting_for_approval, processing, completed, to_refund, refunded, rejected, draft | a repayment request (return) enters that status — details |
Every event below can be sent to your own endpoint from the Webhook tester, with the exact envelope, headers and body of a real delivery.
Payment transaction — refund requested
resource: PaymentExternalTransaction — event: refund_requested
The payload contains the refund transaction created by the OMS — amount is the (negative) amount to refund — together with the original payment transaction it refunds, in sale_transaction.
The event is emitted only for refund transactions created internally by the OMS in requested status — a status the API mutations cannot submit, so transactions recorded through the API never trigger this event.
{
"id": "019f935c-395e-723d-a53b-08adff459954",
"data": {
"id": 1234,
"resource": "PaymentExternalTransaction",
"event": "refund_requested",
"timestamp": "2026-07-24T09:02:02+00:00",
"payload": {
"id": 1234,
"number": "refund-1234",
"amount": "-10.00",
"currency": "EUR",
"reference_code": "refund-reference-1234",
"merchant": {
"code": "merchant-code"
},
"sale_transaction": {
"id": 5678,
"number": "sale-5678",
"amount": "10.00",
"currency": "EUR",
"reference_code": "sale-reference-5678"
}
}
}
}
Sale document — issued
resource: AccountingSaleDocument — event: issued
Emitted when a fiscal document — an invoice or a receipt — is issued for an order. The payload contains the sale document (id, number) and the order it belongs to; the document itself is retrievable through the order documents queries, using payload.order.id and matching the document by payload.id.
{
"id": "01a04779-292a-7a60-8d87-f63fc5220c7a",
"data": {
"id": 1234,
"resource": "AccountingSaleDocument",
"event": "issued",
"timestamp": "2026-08-28T08:25:17+00:00",
"payload": {
"id": 1234,
"number": "sale-document-1234",
"order": {
"id": 5678
}
}
}
}
Credit note — issued
resource: AccountingCreditDocument — event: issued
Emitted when the credit note of a repayment request (return) is issued. The payload contains the credit note (id, number), the repayment_request it belongs to and the related order; the document itself is retrievable through the repayment documents query, using payload.repayment_request.id.
{
"id": "01a0477b-4581-7ac4-9169-0a583d6628e4",
"data": {
"id": 1234,
"resource": "AccountingCreditDocument",
"event": "issued",
"timestamp": "2026-08-28T08:27:36+00:00",
"payload": {
"id": 1234,
"number": "repayment-document-1234",
"repayment_request": {
"id": 5678
},
"order": {
"id": 9012
}
}
}
}
Shipping label — issued
resource: ShippingLabel — event: issued
Emitted when a shipping label (waybill) is issued for a shipping. The payload contains the shipping label (id, number) together with the shipping and the order it belongs to; the label files are retrievable through the order documents queries, using payload.order.id (match the shipping by payload.shipping.id and the label by payload.id). A multi-parcel shipping may have one label per parcel or a single label for all of them, depending on the carrier: the event is emitted once per label issued.
{
"id": "01a0477a-6a37-7bc6-817c-fcdcce1fcf85",
"data": {
"id": 1234,
"resource": "ShippingLabel",
"event": "issued",
"timestamp": "2026-08-28T08:26:40+00:00",
"payload": {
"id": 1234,
"number": "tracking-1234",
"shipping": {
"id": 5678
},
"order": {
"id": 9012
}
}
}
}
Order — status changes
resource: Order — event: the status the order has entered, one of the OrderStatus values.
One event per status: acquiring, with_anomalies, ready, processing, completed, shipped, delivered, storage, cancelled and refunded. Each is emitted when the order enters that status — the meaning of every status and the typical progression are documented in Things to know about orders. Like every other event, you choose which of them to receive when Calicantus configures your webhook.
The payload is empty: data.id is the order id, so read whatever you need with the order query — see Get order details.
{
"id": "01a065f5-a674-7293-ae43-b28b863e2fb6",
"data": {
"id": 1234,
"resource": "Order",
"event": "completed",
"timestamp": "2026-09-03T06:29:52+00:00",
"payload": {}
}
}
Repayment request — status changes
resource: RepaymentRequest — event: the status the repayment request (return) has entered, one of the RepaymentStatus values.
One event per status: created, waiting_warehouse_reception, waiting_for_approval, processing, completed, to_refund, refunded, rejected and draft. Each is emitted when the repayment request enters that status — the meaning of every status and the typical progression are documented in Things to know about repayment requests. Like every other event, you choose which of them to receive when Calicantus configures your webhook.
The payload contains the repayment request (id, the same as data.id) and the order it belongs to; read whatever else you need with the repaymentRequest query — see Get repayment request details.
{
"id": "01a1c489-bd38-7721-821b-cdb9c2c9bf13",
"data": {
"id": 1234,
"resource": "RepaymentRequest",
"event": "waiting_warehouse_reception",
"timestamp": "2026-11-10T08:18:43+00:00",
"payload": {
"id": 1234,
"order": {
"id": 5678
}
}
}
}