API Reference
My Account

Order Notification Webhook

post
https://example.com/<order_notification event>

This webhook request notifies recipients of an order that was created or updated in Marketplace Orders Hub.

Use of this webhook requires the integrator to provide an endpoint. Webhook events are published to client-provided endpoints.

Body Params

Request for order create or update event

string
required

The external order ID. This is a partner-supplied ID.

string
required

The parent identifier of the store.

string
required

The source of the order. This must be one of the following values.

ValueMeaning
"Marketplace"The order originated from a Hub marketplace.
"Online"The order originated from outside the Hub.
string
required

The status of the order. This must be one of the following values.

StatusMeaning
"NEW"A new order was received.
"ACCEPTED"A new order was accepted.
"ACKNOWLEDGED"The order was acknowledged.
"DELIVERY_ACKNOWLEDGED"The delivery of the order was acknowledged.
"PICK_BEGIN"The order is being picked.
"PICK_COMPLETE"Order picking is complete.
"PACK_BEGIN"The order is being packed.
"PACK_COMPLETE"Order packing is complete.
"DISPATCHED"The order was dispatched.
"DELIVERY_IN_PROGRESS"The order is being delivered.
"DELIVERED"The order was delivered.
"DELIVERY_CANCELLED"The delivery was canceled.
"CANCELLED"The order was canceled.
"REJECTED"The order was rejected.
string

The preferred carrier for express delivery.

Example: The name of a delivery carrier

string

The time at which an express delivery will be ready for driver pickup. Specify a UTC date-time stamp in ISO 8601 format.

This value is required for delivery orders. Delivery orders have an order_service of "D" or "PD".

Example: "2024-02-23T08:31:00"

string

The start of the allotted time for order delivery. Specify a UTC date and time in ISO 8601 format.

This value is required for delivery orders. Delivery orders have an order_service of "D" or "PD".

Example: "2024-02-23T09:00:00"

string

The end of the allotted time for order delivery. Specify a UTC date and time in ISO 8601 format.

This value is required for delivery orders. Delivery orders have an order_service of "D" or "PD".

Example: "2024-02-23T09:30:00"

customer_contact_info
object
required

An object that provides customer contact information.

order_price_info
object
required

An object that provides information on the cost of the order, including totals, taxes, and bag and delivery fees.

items
array of objects
required

A list of the items that are included in the order, by item ID.

items*
delivery_instructions
array of objects

The instructions for delivery of the order.

delivery_instructions
order_summary
object

An object that represents an order by total weight and special handling requirements.

cancel_details
object

Additional information about the cancellation, if available.

string
enum
required

The marketplace that is the source of the order.
Specify one of the following country or region codes in conformance with ISO 3166.

CodeCountry or Region
"US"United States
"UK"United Kingdom
"EU"European Union
Allowed:
delivery_details
object

The delivery address, including the latitude and longitude of the location.
This value is mandatory for delivery orders - orders with an order_service of "D" or "PD".

string
required

The ISO 639 language code that is associated with the order.

Example: "en-us", "fr-ca", or "hi-in"

string
enum
required

The order service option that was selected for the order.
This must be one of the following values.

ValueOrder Service
"P"Picking
"D"Delivery
"PD"Picking and delivery
Allowed:
string

The due time for order delivery. Specify a UTC date-time stamp in ISO 8601 format.

This value is required for picking orders. Picking orders have an order_service of "P" or "PD".

Examples: "2024-02-23T09:30:00"

string

The last updated time of the order. Specify a UTC date-time stamp in ISO 8601 format.

Example: "2024-02-23T09:30:00"

string

The URL that is used to track the delivery of the order. The URL shows the location of the driver.

string

The unique identifier of the delivery order. The identifier is provided by the delivery partner.

string

The unique identifier of the quotation. The identifier is provided by the carrier.

This value is mandatory for white label orders. White label orders have an order_service value of "W".

string

The unique identifier of the customer. The identifier is provided by the retailer.

This value is mandatory for white label orders. White label orders have an order_service value of "W".

string

Specify the action for the courier to take on a delivery. This must be one of the following values.

This value is optional and applies only to white label orders and the carrier. White label orders have an order_service value of "W".

ValueAction
"deliverable_action_meet_at_door"Meet-at-door delivery. This is the default action if deliverable_action is not set.
"deliverable_action_leave_at_door"The preferred action for the courier to take on a delivery. When used, undeliverable_action can be set to “leave_at_door” for contactless delivery. The order cannot be left at the door if signature or ID verification requirements were applied when the delivery was created. Photo confirmation of delivery is required to complete order drop-off.
string

Specify the action for the courier to take on an undeliverable order. This must be one of the following values.

This value is optional and applies only to white label orders and to the carrier. White label orders have an order_service value of "W".

ValueAction
"leave_at_door"This action is taken when the customer is not available to receive a normal delivery. In this case, the courier is requested to leave the package at a dropoff location. NOTE (1) An order cannot be set to "leave at door" when signature, PIN, or ID verification requirements are applied when the deliver is created; and, (2) Photo confirmation of delivery is required to complete order drop-off.
"return"This option is used after a normal delivery attempt is made and a customer is not available. This action requests the courier to return the package back to the pickup location. NOTE If deliverable_action is set to "leave at door", the courier can return the package to the pickup location if circumstances dictate.
"discard"The discard option allows the courier to keep or discard the package if it cannot be delivered.
delivery_verification
object

The steps that must be taken to verify delivery before dropoff is complete. These typically include picture or pincode.

This value is optional and applies only to white label orders and the carrier. White label orders have an order_service value of "W".

Response
200

The Order Notification Webhook was successfully sent.

Updated about 1 year ago

Language
Response 
Click Try It! to start a request and see the response here!
Updated about 1 year ago