SO Success Created Webhook

Last updated by 1/11/2022

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
client_idintegerClient Identifier
example:
1111111
group_keystringGroup Key return from inbound request
example:
”hwoutboundoms.2022.02.04083214.112233”
statusstringStatus Identifier
example: “success
total_dataintNumber of total data
example: 1
total_successintNumber of total success
example: 1
items[ ] stringList of Client Outbound request payload (formatted in JSON) and also error message

Sample Payload

{
    "client_id": 11223344,
    "group_key": "hwoutboundoms.2022.02.04083214.112233",
    "status": "success",
    "total_data": 1,
    "total_success": 1,
    "items": [
        {
            "payload": "{\"warehouse_id\":\"WH-TGR04\",\"customer_id\":\"CS008\",\"seller_nick\":\"\",\"so_number\":\"SO_123456\",\"order_identification_code\":1,\"internal_order_status\":\"Created\",\"express_code\":\"EXPRESS_CODE\",\"tenant_name\":\"SHI\",\"consignee\":\"User008\",\"consignee_phone\":\"08123123123\",\"consignee_mobile\":\"08123123123\",\"consignee_email\":\"[email protected]\",\"consignee_full_address\":\"YOUR_ADDRESS\",\"consignee_state\":\"Indonesia\",\"consignee_province\":\"province\",\"consignee_city\":\"city\",\"area\":\"\",\"town\":\"\",\"zip_code\":\"12345\",\"consignee_doc_type\":0,\"consignee_doc_no\":\"\",\"notice_send_date\":\"\",\"trans_priority\":0,\"seller_flag\":\"\",\"buyer_remark\":\"SHI\",\"seller_remark\":\"SHI\",\"order_price\":1800,\"pre_tax_price\":0,\"tax_price\":0,\"discount_price\":0,\"postage\":10,\"cod_price\":1800,\"order_time\":\"2022-02-04 08:31:45\",\"payment_time\":\"2022-02-04 08:31:45\",\"invoice_type\":0,\"invoice_title\":\"\",\"invoice_content\":\"\",\"invoice_amount\":0,\"payment_type\":1,\"payment_way\":\"COD\",\"distribution_status\":0,\"plat_last_changed\":\"2022-02-04 08:31:45\",\"distribution_mode\":0,\"distribution_name\":\"\",\"express_no\":\"PRD-EXPRESS-NO\",\"payment_number\":\"\",\"gross_weight\":0,\"paint_maker\":\"\",\"express_print_data\":\"\",\"OutboundID\":0,\"OwnerCode\":\"\",\"details\":[{\"oid\":\"\",\"title\":\"\",\"sku\":\"SKU-A\",\"order_qty\":1,\"goods_price\":1800,\"avg_money\":0,\"tax_price\":0,\"discount_price\":0,\"refund_status\":0,\"sku_properties\":\"\",\"net_weight\":0}]}",
            "error": ""
        }
    ]
}

Sample Client Response

{
  "metadata": {
    "path": "",
    "http_status_code": 200,
    "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