Get All Orders
This endpoint retrieves all orders for your shop between given timestamps.
Path
get
/v2/order/list?fs_id=:fs_id&from_date=:from_date&to_date=:to_date&page=:page&per_page=:per_page
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
fs_id | Integer | Required | path | Fulfillment service id |
from_date | Integer | Required | query | UNIX timestamp of date (hour, min, sec) from which the order details are requested |
to_date | Integer | Required | query | UNIX timestamp of date (hour, min, sec) to which the order details are requested |
page | Integer | Required | query | Determine which page the order list should start. Minimal value is 1 |
per_page | Integer | Required | query | Determine how many orders will be shown per page. Max Value is 100 |
shop_id | Integer | Optional | query | Limit the order shown to the given shop_id. Please use either shop_id or warehouse_id |
warehouse_id | Integer | Optional | query | Limit the order shown to the given warehouse_id. Please use either shop_id or warehouse_id |
status | Integer | Optional | query | Limit the order shown to the given status. See Notes to check available status code |
Example Request
curl -X GET \
'https://fs.tokopedia.net/v2/order/list?fs_id=13004&shop_id=479573&from_date=1491623331&to_date=1554695331&page=1&per_page=1' \
-H 'Authorization: Bearer OoHgyxcgQ5a1uCbmbbXjjA' \
Response Parameters
Success Response Examples
{
"header": {
"process_time": 0.018328845,
"messages": "Your request has been processed successfully"
},
"data": [
{
"fs_id": "13004",
"order_id": 43481289,
"is_cod_mitra": false,
"accept_partial": false,
"invoice_ref_num": "INV/20200110/XX/I/502",
"products": [
{
"id": 15242279,
"name": "Chitato Rasa Beef BBQ 35 gr isi 20 pcs",
"quantity": 1,
"notes": "",
"weight": 0.004,
"total_weight": 0.004,
"price": 98784,
"total_price": 98784,
"currency": "Rp",
"sku": "11550001",
"is_wholesale" : true
}
],
"products_fulfilled": [
{
"product_id": 15242279,
"quantity_deliver": 1,
"quantity_reject": 0
}
],
"device_type": "",
"buyer": {
"id": ,
"name": "",
"phone": "",
"email": ""
},
"shop_id": 479066,
"payment_id": 11687315,
"recipient": {
"name": "",
"phone": "",
"address": {
"address_full": "",
"district": "Kobakma",
"city": "Kab. Mamberamo Tengah",
"province": "Papua",
"country": "Indonesia",
"postal_code": "99558",
"district_id": 5455,
"city_id": 555,
"province_id": 33,
"geo": "-3.69624360109313,139.10973580486393"
}
},
"logistics": {
"shipping_id": 999,
"district_id": 0,
"city_id": 0,
"province_id": 0,
"geo": "",
"shipping_agency": "Custom Logistik",
"service_type": "Service Normal"
},
"amt": {
"ttl_product_price": 98784,
"shipping_cost": 10000,
"insurance_cost": 0,
"ttl_amount": 108784,
"voucher_amount": 0,
"toppoints_amount": 0
},
"dropshipper_info": {},
"voucher_info": {
"voucher_code": "",
"voucher_type": 0
},
"order_status": 700,
"warehouse_id": 0,
"fulfill_by": 0,
"fulfillment_order_type": 0, //Order Prioritization
"create_time": 1578671153,
"custom_fields": {
"awb": "CSDRRRRR502",
"gift_eligibility": {"promo_codes"}
},
"promo_order_detail": {
"order_id": 43481289,
"total_cashback": 0,
"total_discount": 20000,
"total_discount_product": 10000,
"total_discount_shipping": 10000,
"total_discount_details":[
{
"amount":10000,
"type":"discount_product"
},
{
"amount":10000,
"type":"discount_shipping"
}
],
"summary_promo": [
{
"name": "Promo Product July",
"is_coupon": false,
"show_cashback_amount": true,
"show_discount_amount": true,
"cashback_amount": 0,
"cashback_points": 0,
"type": "discount",
"discount_amount": 10000,
"discount_details": [
{
"amount" : 10000,
"type" : "discount_product"
}
],
"invoice_desc": "PRODUCTDISC"
},
{
"name": "Promo Ongkir",
"is_coupon": false,
"show_cashback_amount": true,
"show_discount_amount": true,
"cashback_amount": 0,
"cashback_points": 0,
"type": "discount",
"discount_amount": 10000,
"discount_details": [
{
"amount" : 10000,
"type" : "discount_shipping"
}
],
"invoice_desc": "ONGKIRFREE"
}
]
},
"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.018328845,
"messages": "We could not process your request due to malformed request, please check again",
"reason": "Date Range must be less than 3 days",
"error_code": "ORD_DLV_013"
},
"data": null
}
Error Codes
Notes
This endpoint only can pull orders with 3 days interval between from_date and to_date
Order status code
| Code | Description |
|---|---|
0 | Seller cancel order. |
3 | Order Reject Due Empty Stock. |
5 | Order Canceled by Fraud |
6 | Order Rejected (Auto Cancel Out of Stock) |
10 | Order rejected by seller. |
15 | Instant Cancel by Buyer. |
100 | Order Created. |
103 | Wait for payment confirmation from third party. |
220 | Payment verified, order ready to process. |
221 | Waiting for partner approval. |
400 | Seller accept order. |
450 | Waiting for pickup. |
500 | Order shipment. |
501 | Status changed to waiting resi have no input. |
520 | Invalid shipment reference number (AWB). |
530 | Requested by user to correct invalid entry of shipment reference number. |
540 | Delivered to Pickup Point. |
550 | Return to Seller. |
600 | Order delivered. |
601 | Buyer open a case to finish an order. |
690 | Fraud Review |
700 | Order finished. |
Response highlight
| Response Field | Type | Description |
|---|---|---|
fulfillment_order_type | Integer | Tokocabang Order Prioritization Type, 0 = Normal Order, 1 = BO Ekstra |