GRN Webhook Confirmation

Last Updated by 31/10/2022

Shipper will send webhook to client's endpoint based on agreed payload & parameter below

Specification

FieldEndpoint
POSTClient's Endpoint URL

Body Request Parameter

📘

Notes

"Please Fill with Empty String / 0 / false" note means client still need to pass ““ / 0 / false value to that parameter.

Field

Data Type

Description

Note

warehouse_id

string

Warehouse Identifier

example: WH-TGR99

Mandatory

order_no

string

Order No

example: ”ORDER_NO_XXXX”

Mandatory

customer_id

string

Customer Identifier

example: “MDS”

Mandatory

order_type

string

Order Type

example: “RT”

Mandatory

received_time

string

Recieved Time

example: "2021-11-18 17:42:56"

Mandatory

userDefine1

string

User Define

example: "161"

Mandatory

details

line_no

string

Line Number

example : "1"

Optional

reference_no

string

Referenec No

example: ”REF_NO_XXXX”

Mandatory

sku

string

SKU Product

example: “HJ00062“

Mandatory

received_qty

integer

Received Quantity

Optional

mfg_date

string

Manufacturing Date

Fill with empty string

exp_date

string

Expire Date

Fill with empty string

batch_no

string

Batch No

Fill with empty string

serial_no

string

Serial No

Fill with empty string

product_condition

string

Product Condition

example: ”Good”

Optional

Value should be between “Good” or “Damaged”

receipt_date

string

Receipt Date

example: "2021-11-18"

Optional

grn_no

string

GRN No

Example: ”GRN_RETUR_XXXX”

Optional

Sample Body Request

{
    "warehouse_id": "WH-BAL",
    "order_no": "RETUR_REFUND_18NOVRETUR_REFUND_18NOV",
    "customer_id": "MDS",
    "order_type": "RT",
    "received_time": "2021-11-18 17:42:56",
    "userDefine1": "161",
    "details": [
        {
            "reference_no": "REF_NO_XXXX",
            "line_no": "1",
            "sku": "HJ00062",
            "received_qty": 1,
            "mfg_date": "",
            "exp_date": "",
            "batch_no": "",
            "serial_no": "",
            "product_condition": "Good",
            "receipt_date": "2021-11-18",
            "project_ref_no": "",
            "grn_no": "GRN_RETUR_XXXX"
        }
    ]
}

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