PO Status Change Webhook
Last Updated by 15/6/2023
Shipper will send webhook to client's endpoint based on agreed payload & parameter below
Specification
Field | Endpoint |
---|---|
POST | Client's Endpoint URL |
Body Request Parameter
Field | Data Type | Description |
---|---|---|
warehouse_id | string | Warehouse code assigned Example: "WH-TGR04" |
order_no | string | Order number for this Purchase Order example: ”PO/2023/06/15_1” |
po_type | string | Purchase Order type "PO": Normal PO "CG": Normal PO "RT": Return PO example: "PO" |
client_id | integer | Client ID example: 11223344 |
po_status | string | PO Status Code example: - "00": Scheduled (PO Created) - "30": Partially Received - "40": Fully Received - "90": PO Cancelled - "99": PO Closed |
status | string | PO Status example: "PO Closed" |
po_date | string | Time when PO Updated example: "2023-06-15" |
Sample Payload
{
"warehouse_id": "WH-TGR04",
"order_no": "PO/2023/06/15_1",
"po_type": "PO",
"client_id": 11223344,
"po_status": "99",
"status": "PO Closed",
"po_date": "2023-06-15"
}
Sample Client Response
{
"metadata": {
"path": "",
"http_status_code": [200/201/202],
"http_status": "Ok",
"timestamp": 1615969609
}
}
Important Return Parameter
Shipper will ignore response body from client, the accepted HTTP response status that Shipper acknowledge as success are {200, 201, 202}. If client sent another status then Shipper will retry at most 3 times.but if HTTP status code is not 2xx, Shipper will retry at most 3 times to send the data.
Updated about 1 year ago