Sign in

v3

latestOpenAPI 3.1.02026-08-0619186200.1 KB
Webhooks

Receiving status change

Supported Receiving Webhooks

All receiving-related webhooks are closely tied to the status of the receiving. Each webhook is triggered when the receiving transitions to a specific status, reflecting key milestones in the receiving process.

  • Receiving awaiting (status: awaiting)
  • Receiving in progress (status: in_progress)
  • Receiving arrived (status: arrived)
  • Receiving received (status: received)
postWebhookreceivingStatusChange

Payload

idinteger required

Server-assigned numeric identifier of the receiving. Use this value to reference the receiving in subsequent API calls.

warehousestring required

Code of the warehouse where the goods are being received.

receiving_keystring nullable required

Client-supplied reference (e.g. purchase order number) for the receiving, or null if none was provided at creation.

asnstring required

Advance Shipping Notice (ASN) number, a supplier-provided identifier for the incoming shipment.

bol_numberstring nullable required

Bill of Lading (BOL) number from the carrier transport document, or null if not provided.

supplier_namestring required

Name of the supplier sending the goods.

handling_unit_type'small_boxes' | 'single_sku_pallet' | 'mixed_sku_pallet' | 'container_20_palletized' | 'container_20_non_palletized' | 'container_40_palletized' | 'container_40_non_palletized' | 'container_53_palletized' | 'container_53_non_palletized' | 'unknown' required
handling_unit_quantityinteger required

Total number of handling units (as specified by handling_unit_type) in the shipment.

estimated_deliverystring required

Estimated date when the shipment is expected to arrive at the warehouse, in ISO 8601 format (YYYY-MM-DD).

descriptionstring nullable required

Free-form notes about the receiving, or null if none were provided.

status'awaiting' | 'arrived' | 'in_progress' | 'received' required
created_atstring date-time required

Timestamp when the receiving record was created, in ISO 8601 format.

updated_atstring date-time required

Timestamp when the receiving record was last modified, in ISO 8601 format.

arrived_atstring date-time nullable required

Timestamp when the shipment physically arrived at the warehouse, in ISO 8601 format. Null until arrival.

received_atstring date-time nullable required

Timestamp when all goods finished being received and counted, in ISO 8601 format. Null until processing is complete.

Response

Return a 2xx status to indicate that the data was received successfully