Shgardi Hook
Through the partner's Hook URL, Shgardi can send all the Order updates
Shgardi Integration
You are kept updated on continual basis through Hook URL integrated to Shgardi's. Throughout this URL, the "Order Status" will be automatically updated.
Guide Steps
The following information is required to support Shgardi in order to hook on your system for Status update;
shgardiOrderStatusUpdate {
"EventType":
"OrderStatusChange",
"EventContent": {
"OrderId":
"cae26ee9-d258-43d0-b100-d4ae893b291f",
"OrderStatus": 5
}
}
The following information is required to support Shgardi in order to hook on your system for menu update;
Hook URL
Authorization Type, which could be (whether/or);
NoAuth
BearerToken
You will be consuming the response on time of any order update, structured as follows;
According to the aforementioned event;
Time; the time when the update has been taken place
Entity;
ID, the ID of which the entity is updated
Name, the name of the entity which is updated
Event Name; the updated event that has been taken place, while the events (whether/or);
OrderStatusUpdate
OrderDriverAssigned
For example;
Best practice is to use Method Type; POST in consuming the Hook URL
By knowing the Order ID you can call the Order Details API / Order Status API so that you can get all the updated details
Last updated