Order status change

wbhk

orderStatusChange

As an order progresses from initial import to full fulfillment, it transitions through multiple statuses. ShipMonk can notify external systems of these status changes via webhooks.

Supported Order Webhooks

Currently ShipMonk supports these order-related webhooks.

Order being back-ordered (processing_status: back-order)
Order is unable to submit (processing_status: unable_to_submit)
Order is queued to submit (processing_status: queued_to_submit)
Order is subscription - Order (processing_status: subscription)
Order is package-forwarding - Order (processing_status: package_forwarding)
Order is put to on hold (processing_status: on_hold)
Order is submitted (processing_status: submitted)
Order is being picked (processing_status: pick_in_progress)
Order is being packed (processing_status: pack_in_progress)
Order is packed (processing_status: packed)
Order is awaiting pickup (processing_status: awaiting_pick_up)
Order is awaiting carrier processing (processing_status: awaiting_carrier_processing)
Order is en route (processing_status: en_route)
Order is delivered (processing_status: delivered)
Order is undeliverable (processing_status: undeliverable)
Order is shipped, but it’s untrackable (processing_status: shipped_untrackable)
Order cancellation requested (processing_status: cancellation_requested)
Order is cancelled (processing_status: cancelled)

All order-related webhooks are closely tied to the order’s processing-status. Each webhook is triggered by a change in the processing-status, reflecting key moments in the order lifecycle.

Payload Structure (JSON Schema)

All order-related webhooks share the same JSON schema, which matches the response of our GET endpoint for retrieving a single order.

Payload

order_key

string

required

order_number

string

required

order_type

enum

required

store

object

required

warehouse

required

trading_partner

required

ordered_at

date-time

required

customer_email

required

shipping_method

required

requested_shipping_service

string | null

required

shipping_paid

double

required

tax_paid

double

required

order_costs

object

required

ship_from

required

ship_to

required

order_status

string

enum

required

Allowed:

processing_status

string

enum

required

items

array of objects

required

items*

attributes

array of objects

required

attributes*

currency_code

string

required

references

array of objects

required

references*

custom_data

array of objects

required

custom_data*

special_requirements

required

actions_required

object

required

master_tracking_number

string | null

required

tracking_url

string | null

required

returns

array of objects

required

returns*

packages

array of objects

required

packages*

tax_id

required

recipient_tax_id

required

shipment_data

required

order_parts

required

shipped_at

date-time | null

required

order_size

string

enum

required

Allowed:

extra_data

array of objects

required

extra_data*

serial_numbers

array of objects

required

serial_numbers*

gift_message

string | null

required

gift_from

string | null

required

customer_notes

string | null

required

order_detail_url

string

required

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.