PGI Webhook Confirmation

Last Updated by 1/11/2022

Shipper will send webhook to client's endpoint based on agreed payload & parameter below after PGI issued at WMS

Specification

Field

Endpoint

POST

Client's Endpoint URL

Webhook Parameter

Field

Data Type

Description

Mandatory / Optional

warehouse_id

String

Warehouse Code

Mandatory

order_type

String

Order type
Notes:
“SO” for Normal Sales Order “RT” for Vendor Return

Mandatory

doc_no

String

Document No (Sales Order No or Supplier Return Doc No)

Mandatory

delivery_no

String

AWB

Mandatory

carrier_id

String

Expedition Code. To check carrier name list, please check GET Express List on “express_code” field

Optional

carrier_name

String

Expedition Name. To check carrier name list, please check GET Express List on “express_name” field

Mandatory

Details Payload Information

sku

String

SKU Code

Mandatory

qty_shipped

Integer

QTY Picked

Mandatory

mfg_date

yyyy-MM-dd

Manufacturing Date

Optional

exp_date

yyyy-MM-dd

Expire Date

Optional

stock_condition

String

Stock Condition
Notes:
N = Good Condition
Y = Damaged

Optional

Sample Payload

{
  "warehouse_id":"WH-BAL",
  "customer_id":"MDS",
  "order_type":"SO",
  "doc_no":"22010700077875",
  "delivery_no":"PRD-571020-CGK012299",
  "carrier_id":"",
  "carrier_name":"SAP ODS",
  "so_reference_a":"PRD_SO_571120",
  "so_reference_b":"",
  "user_define_1":"",
  "user_define_2":"",
  "user_define_3":"",
  "pgi_date":"2022-01-10 12:04:14",
  "shop_code":"CS792",
    "details":[
      {
        "sku":"27752701",
        "qty_shipped":1,
        "mfg_date":"",
        "exp_date":"",
        "batch_no":"",
        "serial_no":"",
        "receipt_date":"2021-11-02",
        "stock_condition":"N",
        "user_define_1":"",
        "user_define_2":"",
        "user_define_3":"",
        "project_ref_no":""
      },
      {
        "sku":"28362756",
        "qty_shipped":1,
        "mfg_date":"",
        "exp_date":"",
        "batch_no":"",
        "serial_no":"",
        "receipt_date":"2021-11-03",
        "stock_condition":"N",
        "user_define_1":"",
        "user_define_2":"",
        "user_define_3":"",
        "project_ref_no":""
      }
    ]
}

Sample Client Response

{
  "metadata": {
    "path": "",
    "http_status_code": 200,
    "http_status": "Ok",
    "timestamp": 1615969609
  }
}

Important Return Parameter
currently we ignore response from client webhook but if client webhook give not 200 response code then open api will retry sending webhook. 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


What’s Next