Order Status Notifications
Human API can send notifications when order status changes. This notification includes high level order status.
Here is how the notification payload will look -
[
{
"humanId": "427fb62f5a2c4fac3b8fd0c76711fad0",
"clientId": "f000a44e935045a2fb2248c2d8693a079b5d383f",
"userId": "6260aafef7fd1c6db5dd9e38",
"clientUserId": "Policy_001",
"updatedAt": "2022-04-21T03:10:13.103Z",
"action": "status",
"endpoint": "https://admin.humanapi.co/api/v1/users",
"property": "orderState",
"topic": "order",
"value": "In Progress",
"clientData": {
}
}
]
Note:
The payload is a JSON array
Here is the description of different properties in order status notification payload:
Property | Description | Value |
---|---|---|
value | updated value of the property | In Progress Pended Completed Cancelled |
updatedAt | timestamp to when the property was updated | (format ISO 8601) Example: 2020-02-25T03:49:12.115Z |
topic | Topic is the level at which the subscription is happening. Order covers all possible actions for an order update. | order |
humanId | Human API generated identifier | |
endpoint | Endpoint to pull the full details of the user | https://admin.humanapi.co/api/v1/users |
clientUserId | Customer unique identifier like policy number or unique Id | |
action | Action to which the user is subscribed, that triggered this event. status refers to changes in status | status |
Updated about 2 years ago