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;

{
"Time": "UTC date and time format", 
"Entity": {
    "Id": "string", 
    "Name": "string"
    }, 
"EventName": "string"
}

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;

{
"Time": "2021-08-17T15:40:19Z", 
"Entity": {
    "Id": "cda318d6-9f84-45a1-81fb-2406cebf9add", 
    "Name": "Order"
    }, 
"EventName": "OrderDriverAssigned"
}

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