transfer_order/cancelled

Overview

Property	Value
Webhook type	transfer_order/cancelled
Kafka topic	transfer-order.cancelled
Direction	Platform → Your endpoint

Description

Fired when a transfer order is cancelled. All active lines transition to CANCELED state, and no further reception is possible on this order.

Trigger Conditions

• A user or integration explicitly cancels the transfer order via the API
• The transfer order was in DRAFT or OPENED state before cancellation

Message Envelope

{
  "header": {
    "organizationId": "org_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "messageId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "webhookId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "type": "transfer_order/cancelled",
    "date": "2024-03-18T11:00:00.000Z"
  },
  "body": { ... }
}

Body — Property Table

TransferOrder Object

Field	Type	Nullable	Description
id	string (uuid)	No	Unique transfer order identifier
organizationId	string (uuid)	No	Organization that owns this transfer order
locationId	string (uuid)	No	Destination warehouse/location
supplierId	string (uuid)	Yes	Supplier providing the stock
state	enum	No	Always CANCELED for this event
orderNumber	string	No	Human-readable order reference number
externalReference	string	Yes	External system reference
shippingDate	string (ISO 8601)	No	Originally scheduled shipping date
expectedDate	string (ISO 8601)	No	Originally expected arrival date
carrier	string	Yes	Carrier name
tracking	string	Yes	Carrier tracking number
comment	string	Yes	Free-text comment (may contain cancellation reason)
emergency	boolean	Yes	Emergency replenishment flag
containerNumber	integer	Yes	Number of containers/pallets
containerType	enum	No	Container type: BOX, PALLET, CONTAINER
lines	TransferOrderLine[]	No	Lines with updated state: CANCELED
createdAt	string (ISO 8601)	No	Original creation timestamp
issuedAt	string (ISO 8601)	No	Issue timestamp
updatedAt	string (ISO 8601)	No	Timestamp of cancellation

TransferOrderLine Object

Field	Type	Nullable	Description
id	string (uuid)	No	Unique line identifier
transferOrderId	string (uuid)	No	Parent transfer order ID
stockReferenceId	string (uuid)	Yes	Associated stock reference
label	string	Yes	Display label
sku	string	Yes	Stock keeping unit
reference	string	Yes	Product reference code
limitUsageDate	string (ISO 8601)	Yes	Expiry date
batchNumber	string	Yes	Batch / lot number
expectedQuantity	integer	No	Declared quantity
receivedQuantity	integer	Yes	Quantity received before cancellation
restockedQuantity	integer	Yes	Quantity restocked before cancellation
garbageQuantity	integer	Yes	Quantity discarded before cancellation
meta	object	Yes	Arbitrary metadata (JSON)
state	enum	No	Always CANCELED for lines of a cancelled order

Full JSON Payload Sample

{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "f7a8b9c0-d1e2-3456-fabc-678901234567",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "transfer_order/cancelled",
    "date": "2024-03-18T11:00:00.000Z"
  },
  "body": {
    "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "locationId": "e5f6a7b8-c9d0-1234-efab-345678901234",
    "supplierId": "f6a7b8c9-d0e1-2345-fabc-456789012345",
    "state": "CANCELED",
    "orderNumber": "TO-2024-001234",
    "externalReference": "SUPP-PO-98765",
    "shippingDate": "2024-03-20T00:00:00.000Z",
    "expectedDate": "2024-03-25T00:00:00.000Z",
    "carrier": "DHL Freight",
    "tracking": null,
    "comment": "Supplier unable to fulfill — order rescheduled",
    "emergency": false,
    "containerNumber": 2,
    "containerType": "PALLET",
    "createdAt": "2024-03-15T10:23:45.000Z",
    "issuedAt": "2024-03-15T10:23:45.000Z",
    "updatedAt": "2024-03-18T11:00:00.000Z",
    "lines": [
      {
        "id": "a7b8c9d0-e1f2-3456-abcd-567890123456",
        "transferOrderId": "d4e5f6a7-b8c9-0123-defa-234567890123",
        "stockReferenceId": "b8c9d0e1-f2a3-4567-bcde-678901234567",
        "label": "T-Shirt Blanc Taille M",
        "sku": "TSHIRT-WHITE-M",
        "reference": "TSH-WH-M-001",
        "limitUsageDate": null,
        "batchNumber": null,
        "expectedQuantity": 100,
        "receivedQuantity": null,
        "restockedQuantity": null,
        "garbageQuantity": null,
        "meta": null,
        "state": "CANCELED"
      }
    ]
  }
}

Related Events

• transfer_order/created — fired when the transfer order is first created
• transfer_order/updated — fired on any field update
• transfer_order/opened — fired when the order transitions to OPENED
• transfer_order/completed — fired when all lines are received

Notes

• Once cancelled, a transfer order cannot be reopened. A new transfer order must be created.
• All lines in the payload will have state: CANCELED regardless of their prior state.
• Stock that was already received and restocked before cancellation is not automatically reversed; any stock adjustments must be handled manually.