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
string
required
string | null
required
string
required
required
string
required
string
enum
required
integer
required
string
required
string | null
required
string
enum
required
Allowed:
date-time
required
date-time
required
date-time | null
required
date-time | null
required
items
array of objects
required
items*
receiving_lines
array of objects
required
receiving_lines*
custom_data
array of objects
required
custom_data*
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 9 months ago 

LoadingLoading…

Updated 9 months ago