Skip to main content

Get Webhook Payload

Get Webhook Payload.

Path

get

/fulfillment/partner/fs/:fs_id/webhook/payload

Request Parameters

ParameterTypeRequiredLocationDescription
fs_id
Integer
Required
path
Fulfillment service id.
order_id
Integer
Required
query
The order ID
webhook_type
String
Required
form
Possible values: order_notification, order_status, order_cancellation, buyer_order_cancellation

Example Request

curl --location --request GET 'https://fs.tokopedia.net/fulfillment/partner/fs/13057/webhook/payload?order_id=166811899&webhook_type=order_notification'

Response Parameters

Success Response Examples

{
"header": {
"process_time": 0.072897837,
"messages": "Your request has been processed successfully"
},
"data": {
"fs_id": 13057,
"order_id": 166969580,
"invoice_ref_num": "TEST/LOCAL/166969580",
"products": [
{
"id": 15457030,
"name": "THANOS",
"notes": "i am inevitable",
"currency": "Rp.",
"weight": 10,
"total_weight": 20,
"price": 10000,
"total_price": 20000,
"quantity": 2,
"sku": "sasdas12",
"campaign_id": 10,
"event_id": 1,
"bundle_id": 2,
"bundle_variant_id": "3"
}
],
"customer": {
"id": 123123,
"name": "",
"phone": "",
"email": ""
},
"recipient": {
"name": "",
"phone": "",
"address": {
"address_full": "",
"district": "jatisampurna",
"city": "planet bekasi",
"province": "jawa barad",
"country": "englonesia",
"postal_code": "12345",
"district_id": 327510,
"city_id": 72,
"province_id": 32,
"geo": "123,123"
}
},
"shop_id": 480876,
"warehouse_id": 19551,
"shop_name": "Dodol Garut Change",
"payment_id": 123456,
"payment_date": "2021-09-05 00:00:00",
"logistics": {
"shipping_id": 10,
"district_id": 327510,
"city_id": 72,
"province_id": 32,
"geo": "123,123",
"shipping_agency": "sicepat",
"service_type": "same day"
},
"amt": {
"ttl_product_price": 20000,
"shipping_cost": 4000,
"insurance_cost": 1000,
"ttl_amount": 25000,
"voucher_amount": 0,
"toppoints_amount": 0
},
"dropshipper_info": {
"name": "",
"phone": ""
},
"voucher_info": {
"voucher_code": "",
"voucher_type": 0
},
"device_type": "ios",
"create_time": 1630924654,
"order_status": 400,
"custom_fields": {
"gift_eligibility": [
"BOTESTWHITELIST"
]
},
"accept_partial": false,
"fulfillment_order_type": 1,
"encryption": {
"secret": "",
"content": ""
},
"have_product_bundle": true,
"bundle_detail": {
"total_product": 3,
"bundle": [
{
"bundle_id": 2,
"bundle_variant_id": "2-socks_3",
"bundle_name": "Bundle Socks - 3 pairs",
"bundle_price": 40500,
"bundle_quantity": 1,
"bundle_subtotal_price": 40500,
"order_detail": [
{
"order_dtl_id": 1004,
"order_id": 100,
"product_id": 2,
"product_name": "Socks",
"quantity": 3,
"product_price": 13500,
"normal_price": 15000,
"subtotal_price": 40500,
"product_weight": 1000,
"total_weight": 3000,
"bundle_id": 2,
"bundle_variant_id": "2-socks_3"
}
]
}
],
"non_bundle": [
{
"order_dtl_id": 1005,
"order_id": 100,
"product_id": 3,
"product_name": "Shoe - White",
"quantity": 3,
"product_price": 100000,
"normal_price": 100000,
"subtotal_price": 300000,
"product_weight": 5000,
"total_weight": 15000,
"bundle_id": 0,
"bundle_variant_id": ""
}
]
}
}
}

Error Response Examples

{
"header": {
"process_time": 0.000089037,
"messages": "We could not process your request due to malformed request, please check again",
"reason": "Invalid fs_id, please double check",
"error_code": "ICR_VLD_002"
},
"data": null
}

Error Codes

Notes

Have a feedback?