The Maropost Commerce Cloud Order Notifications API is an optional call to an external webhook in response to order status change events occurring in the Maropost Commerce Cloud e-Commerce Suite. The Notifications API uses your Maropost Commerce Cloud API key to ensure the call is coming from a trusted source.
You can use the notification API to notify your application of new orders or changes to an existing orders status. On receipt of a notification you can then use other API calls such as GetOrder or UpdateOrder to perform a desired action. Using the notification API can help to reduce the number of unnecessary calls you make to the application looking for new order or order status changes.
Notifications are sent as XML via POST to your specified URL.
|Webhook URL||Set your URL in your Maropost Commerce Cloud control panel. (Go to: Settings & Tools > All Settings & Tools > API Settings)|
|XSD Schema||EventSchema XSD|
Notification of order status changing to pick.
<?xml version="1.0" encoding="utf-8"?> <Event> <CurrentTime>2023-01-03 01:11:12</CurrentTime> <EventID>34</EventID> <EventType>Order</EventType> <Order> <OrderID>N10154</OrderID> <OrderStatus>Pick</OrderStatus> </Order> </Event>
|<Event>||Contains the child elements below|
|<EventID>||integer||The unique ID of the event call. This is logged.||12|
|<CurrentTime>||datetime||The date and time the notification was sent.||2023-01-03 01:11:12|
|<EventType>||string||The type of event.||Order|
|<Order>||Contains the child elements below|
|<OrderID>||orderidtype||The order ID related to the event.||N1000001|
|<OrderStatus>||orderstatustype||The status that the order was changed to.||Quote
If the call to your webhook is successful, your application should respond “200 OK”. If your application makes no response or provides a standard error response, Maropost Commerce Cloud will treat the notification as undelivered, and delivery will be optionally reattempted at a later time (set in Scheduled Tasks).