PO Webhook Confirmation

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

Specification

Field	Endpoint	Description
POST	Client's Endpoint URL	/v1/webhook/fulfillment/inbound_confirmation

Body Request Parameter

Field	Data Type	Description
client_id	integer	Client Identifier example: 1111111
group_key	string	Group Key return from inbound request example: ”hwinbound.2022.02.XXXXXXXX.XXXXXX”
status	string	Status Identifier example: “success
total_data	int	Number of total data example: 1
total_success	int	Number of total success example: 1
items	[ ] string	List of Client Inbound request payload (formatted in JSON) and also error message

Sample Payload

Header	How to fill
x-api-key	Shipper api key

{
    "client_id": 11223344,
    "group_key": "qyinbound.2022.02.04073405.112233",
    "status": "success",
    "total_data": 1,
    "total_success": 1,
    "items": [
        {
            "payload": "{\"customer_id\":\"SHI\",\"warehouse_id\":\"WH-BAL\",\"po_type\":\"CG\",\"doc_no\":\"SAMPLE_DOCUMENT_NUMBER\",\"po_creation_time\":\"2022-02-04 00:00:00\",\"supplier_id\":\"SHI\",\"po_reference_a\":\"\",\"po_reference_b\":\"\",\"po_reference_c\":\"\",\"po_reference_d\":\"\",\"expected_arrival_time1\":\"\",\"expected_arrival_time2\":\"\",\"cust_01\":\"\",\"cust_02\":\"\",\"supplier_name\":\"\",\"supplier_address1\":\"\",\"supplier_address2\":\"\",\"supplier_country\":\"\",\"supplier_province\":\"\",\"supplier_city\":\"\",\"supplier_district\":\"\",\"supplier_street\":\"\",\"supplier_contact\":\"\",\"supplier_fax\":\"\",\"supplier_mail\":\"\",\"supplier_tel1\":\"\",\"supplier_tel2\":\"\",\"supplier_zip\":\"\",\"issuer_party_id\":\"\",\"issuer_party_name\":\"\",\"user_define1\":\"\",\"user_define2\":\"\",\"user_define3\":\"\",\"notes\":\"\",\"InboundID\":0,\"details\":[{\"customer_id\":\"SHI\",\"line_no\":1,\"sku\":\"12345678\",\"ordered_qty\":10,\"pack_id\":\"\",\"mfg_date\":\"\",\"exp_date\":\"\",\"batch_no\":\"\",\"serial_no\":\"\",\"notes\":\"\",\"receipt_date\":\"\",\"product_condition\":\"\",\"total_price\":0,\"cust_04\":\"\",\"cust_05\":\"\",\"user_define1\":\"\",\"user_define2\":\"\",\"project_ref_no\":\"\"},{\"customer_id\":\"SHI\",\"line_no\":2,\"sku\":\"23456781\",\"ordered_qty\":8,\"pack_id\":\"\",\"mfg_date\":\"\",\"exp_date\":\"\",\"batch_no\":\"\",\"serial_no\":\"\",\"notes\":\"\",\"receipt_date\":\"\",\"product_condition\":\"\",\"total_price\":0,\"cust_04\":\"\",\"cust_05\":\"\",\"user_define1\":\"\",\"user_define2\":\"\",\"project_ref_no\":\"\"},{\"customer_id\":\"SHI\",\"line_no\":3,\"sku\":\"38144482\",\"ordered_qty\":7,\"pack_id\":\"\",\"mfg_date\":\"\",\"exp_date\":\"\",\"batch_no\":\"\",\"serial_no\":\"\",\"notes\":\"\",\"receipt_date\":\"\",\"product_condition\":\"\",\"total_price\":0,\"cust_04\":\"\",\"cust_05\":\"\",\"user_define1\":\"\",\"user_define2\":\"\",\"project_ref_no\":\"\"},{\"customer_id\":\"SHI\",\"line_no\":4,\"sku\":\"38144491\",\"ordered_qty\":10,\"pack_id\":\"\",\"mfg_date\":\"\",\"exp_date\":\"\",\"batch_no\":\"\",\"serial_no\":\"\",\"notes\":\"\",\"receipt_date\":\"\",\"product_condition\":\"\",\"total_price\":0,\"cust_04\":\"\",\"cust_05\":\"\",\"user_define1\":\"\",\"user_define2\":\"\",\"project_ref_no\":\"\"},{\"customer_id\":\"SHI\",\"line_no\":5,\"sku\":\"65521184\",\"ordered_qty\":16,\"pack_id\":\"\",\"mfg_date\":\"\",\"exp_date\":\"\",\"batch_no\":\"\",\"serial_no\":\"\",\"notes\":\"\",\"receipt_date\":\"\",\"product_condition\":\"\",\"total_price\":0,\"cust_04\":\"\",\"cust_05\":\"\",\"user_define1\":\"\",\"user_define2\":\"\",\"project_ref_no\":\"\"},{\"customer_id\":\"SHI\",\"line_no\":6,\"sku\":\"65521193\",\"ordered_qty\":14,\"pack_id\":\"\",\"mfg_date\":\"\",\"exp_date\":\"\",\"batch_no\":\"\",\"serial_no\":\"\",\"notes\":\"\",\"receipt_date\":\"\",\"product_condition\":\"\",\"total_price\":0,\"cust_04\":\"\",\"cust_05\":\"\",\"user_define1\":\"\",\"user_define2\":\"\",\"project_ref_no\":\"\"},{\"customer_id\":\"SHI\",\"line_no\":7,\"sku\":\"65521200\",\"ordered_qty\":14,\"pack_id\":\"\",\"mfg_date\":\"\",\"exp_date\":\"\",\"batch_no\":\"\",\"serial_no\":\"\",\"notes\":\"\",\"receipt_date\":\"\",\"product_condition\":\"\",\"total_price\":0,\"cust_04\":\"\",\"cust_05\":\"\",\"user_define1\":\"\",\"user_define2\":\"\",\"project_ref_no\":\"\"},{\"customer_id\":\"SHI\",\"line_no\":8,\"sku\":\"12345678\",\"ordered_qty\":15,\"pack_id\":\"\",\"mfg_date\":\"\",\"exp_date\":\"\",\"batch_no\":\"\",\"serial_no\":\"\",\"notes\":\"\",\"receipt_date\":\"\",\"product_condition\":\"\",\"total_price\":0,\"cust_04\":\"\",\"cust_05\":\"\",\"user_define1\":\"\",\"user_define2\":\"\",\"project_ref_no\":\"\"}]}",
            "error": ""
        }
    ]
}

Sample Client Response

Header	How to fill
x-request-id	Request ID generated from Shipper for tracking purposes

{
  "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. We have max attempt to retry that can be adjust in our config. currently is set to 1 max attempt and 15 seconds delay to next attempt.