SO Status Change Webhook Confirmation

Last Updated by 1/11/2022

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 Sales Order
example:
”SO_12345678”

order_type

string

Order type
example: “success”

shop_code

string

Shop Code
example: 1

client_id

integer

Client ID
example: 11223344

tenant_name

string

Client Tenant Name
example: “12345”

express_code

string

Express Code (Courier Code)
example: default

express_no

string

Express No (AWB Number)
example: YOUR_EXPRESS_NO

seller_remark

string

Seller Remark
example: “Seller Remark”

status

string

SO Status and SO Status Code
example:

  • 00: Create SO
  • 30: Partially Allocated
  • 40: Allocated
  • 50: Partially Picked
  • 60: Picked
  • 62: Partially Cartonized
  • 63: Cartonized
  • 65: Partially Loaded
  • 66: Loaded
  • 70: Partially Shipped
  • 80: Shipped
  • 90: Shipment Order Cancelled
  • 99: Shipment Order Closed

status_code

string

SO Status and SO Status Code
example:

  • 00: Create SO
  • 30: Partially Allocated
  • 40: Allocated
  • 50: Partially Picked
  • 60: Picked
  • 62: Partially Cartonized
  • 63: Cartonized
  • 65: Partially Loaded
  • 66: Loaded
  • 70: Partially Shipped
  • 80: Shipped
  • 90: Shipment Order Cancelled
  • 99: Shipment Order Closed

status_descr

string

SO Status
example: Partially Picked

status_time

string

Time when SO Updated
example: "2022-02-04 16:07:22"

Sample Payload

{
    "warehouse_id": "WH-TGR04",
    "order_no": "SO_12345678",
    "order_type": "SO",
    "shop_code": "CS008",
    "client_id": 11223344,
    "tenant_name": "12345",
    "express_code": "default",
    "express_no": "YOUR_EXPRESS_NO",
    "seller_remark": "Seller Remark",
    "status": "Partially Picked",
    "status_code": "50",
    "status_descr": "Partially Picked",
    "status_time": "2022-02-04 16:07:22"
}

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.