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

FieldEndpoint
POSTClient's Endpoint URL

Body Request Parameter

FieldData TypeDescription
warehouse_idstringWarehouse code assigned
Example: "WH-TGR04"
order_nostringOrder number for this Purchase Order
example:
”PO/2023/06/15_1”
po_typestringPurchase Order type
"PO": Normal PO
"CG": Normal PO
"RT": Return PO
example: "PO"
client_idintegerClient ID
example: 11223344
po_statusstringPO Status Code
example:
- "00": Scheduled (PO Created)
- "30": Partially Received
- "40": Fully Received
- "90": PO Cancelled
- "99": PO Closed
statusstringPO Status
example: "PO Closed"
po_datestringTime 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.