SC Webhook Message
Message Type Definition
Note: if *, the type will be used by all SC, else that will be used by only "General" SC.
| Message Type | Description |
|---|---|
*ping |
only use to test connectivity of webhook url. |
*new_order |
when create a Order successfully in OMS4 |
| handle_buyer_cancellation | when seller handle the cancellation request in OMS4 |
*cancle_order |
OMS4 receives the Order Cancellation / Partial Cancellation from upstream system |
| ft_received_by_fp | when the Order's Fulfillment Task received by FP System successfully |
| parcel_packed | after the FP push a parcel to OMS4 and OMS4 save the parcel successfully |
| parcel_status_updated | when the parcel status updated in OMS4 |
| spu_stock_update | when the SPU's Stock updated in OMS4 |
| spu_price_update | when the SPU's Price updated in OMS4 |
| spu_status_update | when the upstream SPU's status updated in OMS4 |
| request_spu_info | when OMS4 request to sync the upstream SPU info |
(1)ping
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"ping",
"data":{
},
"timestamp":1603766859530
}
(2)new_order
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"new_order",
"data":{
"order_no":"ORDER00000001",
"created_time":1603703663
},
"timestamp":1603766859530
}
(3)handle_buyer_cancellation
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"handle_buyer_cancellation",
"data":{
"order_no":"ORDER00000001",
"seller_comment":"",
"handled_by":"",
"handling_result":"ACCEPT",
"reply_time":1603766859530
},
"timestamp":1603766859530
}
(4)cancle_order
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"cancle_order",
"data":{
"order_no":"ORDER00000001",
"canceller_items":["1001","1002"],
"canceller_time":1603766859530
},
"timestamp":1603766859530
}
(5)ft_received_by_fp
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"ft_received_by_fp",
"data":{
"order_no":"ORDER00000001",
"ft_no":"FT000001",
"fp_name":"fulfillment point",
"created_time":1603703663
},
"timestamp":1603766859530
}
(6)parcel_packed
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"parcel_packed",
"data":{
"order_no":"ORDER00000001",
"fp_parcel_no":"P000001",
"packed_time":1603703663
},
"timestamp":1603766859530
}
(7)parcel_status_updated
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"parcel_status_updated",
"data":{
"order_no":"ORDER00000001",
"fp_parcel_no":"P000001",
"us_parcel_no":"P000001",
"status":"SHIPPING",
"updated_time":1603703663
},
"timestamp":1603766859530
}
(8)spu_stock_update
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"spu_stock_update",
"data":{
"spu_id":"123232",
"skus":[{
"sku_id":"12323",
"seller_sku_code":"sku1",
"stock":100
}]
},
"timestamp":1603766859530
}
(9)spu_price_update
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"spu_price_update",
"data":{
"spu_id":"123232",
"skus":[{
"sku_id":"12323",
"seller_sku_code":"sku1",
"price":100.00
}]
},
"timestamp":1603766859530
}
(10)spu_status_update
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"spu_status_update",
"data":{
"spu_id":"123232",
"status":"Publishing"
},
"timestamp":1603766859530
}
(11)request_spu_info
{
"tenant_id":"1234567",
"api_key":"XXXXXXXXXXX",
"webhook_type":"SC",
"message_type":"request_spu_info",
"data":{
"sync_all_indicator":1,
"spu_id_list":["12323","42442"]
},
"timestamp":1603766859530
}