transfer_order/opened

Overview

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

Description

Fired when a transfer order transitions from DRAFT to OPENED. An opened transfer order is confirmed and active — the warehouse is expecting the delivery and reception can begin.

Trigger Conditions

• A user or integration confirms and opens a draft transfer order via the API
• The order state transitions from DRAFT to OPENED

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/opened",
    "date": "2024-03-16T08: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 OPENED for this event
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	Confirmed 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 the state transition

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 from supplier
receivedQuantity	integer	Yes	Not yet set (null at time of opening)
restockedQuantity	integer	Yes	Not yet set (null at time of opening)
garbageQuantity	integer	Yes	Not yet set (null at time of opening)
meta	object	Yes	Arbitrary metadata (JSON)
state	enum	No	Line state: ACTIVE or CANCELED

Full JSON Payload Sample

{
  "header": {
    "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "messageId": "h9i0j1k2-l3m4-5678-nopq-901234567890",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "transfer_order/opened",
    "date": "2024-03-16T08: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": "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": null,
    "emergency": false,
    "containerNumber": 2,
    "containerType": "PALLET",
    "createdAt": "2024-03-15T10:23:45.000Z",
    "issuedAt": "2024-03-15T10:23:45.000Z",
    "updatedAt": "2024-03-16T08: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": "ACTIVE"
      }
    ]
  }
}

Related Events

• transfer_order/created — fired when the transfer order is first created
• transfer_order/updated — fired on any subsequent field update
• transfer_order/completed — fired when all lines are received
• transfer_order/cancelled — fired when the order is cancelled

Notes

• The opened event marks the transition from planning (DRAFT) to active receiving mode (OPENED).
• This event is separate from transfer_order/updated so integrations can react specifically to the state transition without polling.
• receivedQuantity, restockedQuantity, and garbageQuantity will be null at opening time — they are populated as reception proceeds.