transfer_order/completed

Overview

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

Description

Fired when a transfer order is marked as completed. This happens once reception is finalized at the warehouse — all lines have been processed (received, restocked, or marked as garbage), and the order state transitions to COMPLETED.

Trigger Conditions

• Warehouse staff completes reception of all lines on the transfer order
• The order state transitions from OPENED to COMPLETED

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/completed",
    "date": "2024-03-26T15:45: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 who provided the stock
state	enum	No	Always COMPLETED 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
emergency	boolean	Yes	Emergency replenishment flag
containerNumber	integer	Yes	Number of containers/pallets
containerType	enum	No	Container type: BOX, PALLET, CONTAINER
lines	TransferOrderLine[]	No	Final line details with reception quantities
createdAt	string (ISO 8601)	No	Original creation timestamp
issuedAt	string (ISO 8601)	No	Issue timestamp
updatedAt	string (ISO 8601)	No	Timestamp of completion

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	Total quantity received
restockedQuantity	integer	Yes	Quantity placed into available stock
garbageQuantity	integer	Yes	Quantity discarded (damaged/expired)
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": "g8h9i0j1-k2l3-4567-mnop-890123456789",
    "webhookId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "type": "transfer_order/completed",
    "date": "2024-03-26T15:45: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": "COMPLETED",
    "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-26T15:45: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"
      },
      {
        "id": "c9d0e1f2-a3b4-5678-cdef-789012345678",
        "transferOrderId": "d4e5f6a7-b8c9-0123-defa-234567890123",
        "stockReferenceId": null,
        "label": "Pantalon Bleu Taille 38",
        "sku": "PANTS-BLUE-38",
        "reference": "PNT-BL-38-001",
        "limitUsageDate": null,
        "batchNumber": "BATCH-2024-Q1",
        "expectedQuantity": 50,
        "receivedQuantity": 50,
        "restockedQuantity": 50,
        "garbageQuantity": 0,
        "meta": null,
        "state": "ACTIVE"
      }
    ]
  }
}

Related Events

• transfer_order/created — fired when the transfer order is first created
• transfer_order/updated — fired on any update during the lifecycle
• transfer_order/opened — fired when the order transitions to OPENED
• transfer_order/cancelled — fired when the order is cancelled instead

Notes

• The lines payload reflects the final reconciliation: expectedQuantity vs receivedQuantity.
• restockedQuantity + garbageQuantity should equal receivedQuantity when reception is complete.
• Discrepancies between expectedQuantity and receivedQuantity are normal and should be tracked by your integration.
• Stock levels at locationId are updated in real-time as reception progresses; the completed event signals the final state.