transfer_order/updated

Overview

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

Description

Fired when any field on an existing transfer order is updated. This includes changes to header fields (carrier, tracking, dates, comment) as well as line-level changes such as received quantities being recorded.

Trigger Conditions

• A transfer order's header fields are modified (reference, dates, carrier, tracking, comment, etc.)
• Line items are added, updated, or cancelled
• Received / restocked / garbage quantities are recorded upon warehouse reception

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/updated",
    "date": "2024-03-15T14:35: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	Transfer order state: DRAFT, OPENED, CANCELED, COMPLETED
orderNumber	string	No	Human-readable order reference number
externalReference	string	Yes	External system reference
shippingDate	string (ISO 8601)	No	Scheduled shipping date
expectedDate	string (ISO 8601)	No	Expected arrival date
carrier	string	Yes	Carrier name
tracking	string	Yes	Carrier tracking number
comment	string	Yes	Free-text comment
emergency	boolean	Yes	Emergency replenishment flag
containerNumber	integer	Yes	Number of containers/pallets
containerType	enum	No	Container type: BOX, PALLET, CONTAINER
lines	TransferOrderLine[]	No	Updated array of transfer order lines
createdAt	string (ISO 8601)	No	Original creation timestamp
issuedAt	string (ISO 8601)	No	Issue timestamp
updatedAt	string (ISO 8601)	No	Timestamp of this update

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
restockedQuantity	integer	Yes	Quantity restocked
garbageQuantity	integer	Yes	Quantity discarded
meta	object	Yes	Arbitrary metadata (JSON)
state	enum	No	Line state: ACTIVE, CANCELED

Full JSON Payload Sample

{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "e5f6a7b8-c9d0-1234-efab-345678901234",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "transfer_order/updated",
    "date": "2024-03-22T09:15: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": "OPENED",
    "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": "1234567890123456",
    "comment": "Carrier updated, delivery confirmed for March 25",
    "emergency": false,
    "containerNumber": 2,
    "containerType": "PALLET",
    "createdAt": "2024-03-15T10:23:45.000Z",
    "issuedAt": "2024-03-15T10:23:45.000Z",
    "updatedAt": "2024-03-22T09:15: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": 98,
        "restockedQuantity": 95,
        "garbageQuantity": 3,
        "meta": null,
        "state": "ACTIVE"
      }
    ]
  }
}

Related Events

• transfer_order/created — fired when the transfer order is first created
• transfer_order/opened — fired when the order transitions to OPENED
• transfer_order/completed — fired when all lines are received
• transfer_order/cancelled — fired when the order is cancelled

Notes

• This event fires on any change to the transfer order, including partial reception updates.
• The full current state of the order (including all lines) is always included in the payload.
• Multiple rapid updates may result in multiple webhook deliveries in quick succession.