API Reference

Receiving status change

wbhk
receivingStatusChange

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)
Payload
integer
required

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

string
required

Code of the warehouse where the goods are being received.

string | null
required

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

string
required

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

required

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

string
required

Name of the supplier sending the goods.

string
enum
required

Type of handling units used to ship the goods.

integer
required

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

string
required

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

string | null
required

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

string
enum
required

Current status of the receiving: awaiting (created, shipment not yet arrived), arrived (shipment received at the warehouse but not yet processed), in_progress (goods being unloaded and counted), received (processing complete).

Allowed:
date-time
required

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

date-time
required

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

date-time | null
required

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

date-time | null
required

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

items
array of objects
required

Expected and received quantities aggregated per product across the entire receiving.

items*
receiving_lines
array of objects
required

Itemized receiving lines, each linking a product (with optional lot data) to a specific carton or pallet in the packing hierarchy.

receiving_lines*
custom_data
array of objects
required

Arbitrary name/value pairs supplied by client integrations and attached to the receiving.

custom_data*
cartons
array of objects
required

Cartons declared on the receiving. Each receiving_lines entry with a non-null carton_key references one of these by carton_key.

cartons*
pallets
array of objects
required

Pallets declared on the receiving. Each carton or loose-units line may reference one of these by pallet_key.

pallets*
Responses
200

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

default

For a 4xx status, ShipMonk will retry the webhook delivery up to 100 times, with a 5-minute delay between attempts.

Updated about 1 month ago 

LoadingLoading…

Updated about 1 month ago