Webhook schemas

This section contains the schemas for the Webhook API.

Request schema for `webhook`

Name	Type	Required	Description
`tracking_number`	string	false	none
`tracking_url`	string	false	none
`current_state`	string	false	Possible enumerations are `await_collection`, `awaiting_collection`, `awaiting_drop_off`, `cancelled`, `completed`, `parcel_completed`, `partially_completed`, `customs_awaiting_paym`, `customs_failed`, `customs_on_hold`, `damaged`, `delivery_attempted`, `delivery_failed`, `in_transit`, `insufficient_address`, `invalidated`, `lost`, `pickup_failed`, `processing`, `ready_for_pickup`, `return_booked`, `return_booking_failed`, `return_requested`, `returned_to_sender`, `untrackable`, `with_customs`, `with_driver`
`retailer_order_number`	string	false	none
`courier_name`	string	false	none
`courier_job_id`	string	false	none
`delivery_address`	string	false	none
`delivery_suburb`	string	false	none
`delivery_postcode`	string	false	none
`delivery_state`	string	false	none
`merchant_url`	string	false	none
`status_history`	Array, see table	false	[The tracking history returned by the webhook]
`products`	Array, see table	false	none
`expected_delivery_date`	string	false	none
`retailer_reference`	string	false	none
`source_platform`	string	false	none
`delivery_country_code`	string	false	none
`delivery_latitude`	integer	false	none
`delivery_longitude`	integer	false	none
`delivery_instructions`	string	false	none

Name	Type	Required	Description
`status`	string	true	Order status
`time`	string	true	Timestamp

Name	Type	Required	Description
`quantity`	integer(int32)	false	none
`sku`	string	false	none
`title`	string	false	none
`product_line_id`	string	false	none