Get All Orders
This endpoint retrieves all orders for your shop between given timestamps. This endpoint retrieves all orders for your shop between given timestamps and the orders that already hit Payment Verified (220) Status
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 | query | Fulfillment service unique identifier |
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. The minimal value is 1 |
per_page | Integer | Required | query | Determine how many orders will be shown per page |
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. Check Order Status Code on Notes for more details. |
Example Request
- Curl
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
| Name | Type | Demo Value | Description |
|---|---|---|---|
String | 13004 | Fullfilment Service Unique Identifier | |
Integer | 43481289 | Order Unique Identifier | |
Boolean | false | Is COD mitra? | |
Boolean | false | Is accept partial? | |
String | INV/20200110/XX/I/502 | Invoice Number | |
Boolean | true | Have product bundle? | |
products | Object Array | ||
products_fulfilled | Object Array | ||
bundle_detail | Object | ||
String | Device Type | ||
buyer | Object | ||
Integer | 479066 | Shop Unique Identifier | |
Integer | 11687315 | Payment Unique Identifier | |
recipient | Object | ||
logistics | Object | ||
amt | Object | ||
Object | |||
voucher_info | Object | ||
Integer | 700 | Order Status Code | |
Integer | 0 | Warehouse Unique Identifier | |
Integer | 0 | Order Fulfilled by Tokocabang (1), Order Fulfilled by Shop (0) | |
Integer | 1578671153 | Order Created Time | |
custom_fields | Object | ||
promo_order_detail | Object | ||
Boolean | true | Plus Order Flag | |
pof_info | Object |
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",
"have_product_bundle": true,
"products": [
{
"id": 2147967676,
"Name": "[DEV] TEST BARANG",
"quantity": 4,
"notes": "",
"weight": 0.1,
"total_weight": 0.4,
"price": 10000,
"total_price": 40000,
"currency": "Rp",
"sku": "",
"is_wholesale": false
},
{
"id": 2147967676,
"Name": "[DEV] TEST BARANG",
"quantity": 1,
"notes": "",
"weight": 0.1,
"total_weight": 0.1,
"price": 100000,
"total_price": 100000,
"currency": "Rp",
"sku": "",
"is_wholesale": false
}
],
"products_fulfilled": [
{
"product_id": 2147967676,
"quantity_deliver": 4,
"quantity_reject": 0
},
{
"product_id": 2147967676,
"quantity_deliver": 1,
"quantity_reject": 0
}
],
"bundle_detail": {
"bundle": [
{
"bundle_id": 8925,
"bundle_variant_id": "bid:8925-pid:2147967676-pid1:2147967676",
"bundle_name": "Paket Murah",
"bundle_price": 40000,
"bundle_quantity": 1,
"bundle_subtotal_price": 40000,
"order_detail": [
{
"order_dtl_id": 20627504,
"order_id": 167046488,
"product_id": 2147967676,
"product_name": "[DEV] TEST BARANG",
"product_desc": "",
"quantity": 4,
"product_price": 10000,
"product_weight": 0.1,
"total_weight": 0.4,
"subtotal_price": 40000,
"notes": "",
"finsurance": 1,
"returnable": 0,
"child_cat_id": 0,
"currency_id": 1,
"insurance_price": 0,
"normal_price": 100000,
"currency_rate": 1,
"prod_pic": "[{\"file_name\":\"cf50e595-6d09-43b6-8043-1a75df4d2910.jpg\",\"file_path\":\"hDjmkQ/2021/11/12\",\"status\":2}]",
"min_order": 4,
"must_insurance": 0,
"condition": 1,
"campaign_id": 0,
"sku": "",
"is_slash_price": false,
"oms_detail_data": "",
"thumbnail": "https://ecs7.tokopedia.net/img/cache/100-square/hDjmkQ/2021/11/12/cf50e595-6d09-43b6-8043-1a75df4d2910.jpg",
"bundle_id": 8925,
"bundle_variant_id": "bid:8925-pid:2147967676-pid1:2147967676"
}
]
}
],
"non_bundle": [
{
"order_dtl_id": 20627505,
"order_id": 167046488,
"product_id": 2147967676,
"product_name": "[DEV] TEST BARANG",
"product_desc": "",
"quantity": 1,
"product_price": 100000,
"product_weight": 0.1,
"total_weight": 0.1,
"subtotal_price": 100000,
"notes": "",
"finsurance": 1,
"returnable": 0,
"child_cat_id": 0,
"currency_id": 1,
"insurance_price": 0,
"normal_price": 100000,
"currency_rate": 1,
"prod_pic": "[{\"file_name\":\"cf50e595-6d09-43b6-8043-1a75df4d2910.jpg\",\"file_path\":\"hDjmkQ/2021/11/12\",\"status\":2}]",
"min_order": 0,
"must_insurance": 0,
"condition": 1,
"campaign_id": 0,
"sku": "",
"is_slash_price": false,
"oms_detail_data": "",
"thumbnail": "https://ecs7.tokopedia.net/img/cache/100-square/hDjmkQ/2021/11/12/cf50e595-6d09-43b6-8043-1a75df4d2910.jpg"
}
],
"total_product": 1
},
"device_type": "",
"buyer": {
"id": 0,
"Name": "Mitra Test Account",
"phone": "*******8888",
"email": " "
},
"shop_id": 479066,
"payment_id": 11687315,
"recipient": {
"Name": "Mitra Test Account",
"phone": "62888888888",
"address": {
"address_full": "Kobakma, Kab. Mamberamo Tengah, Papua, 99558",
"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,
"create_time": 1578671153,
"custom_fields": {
"awb": "CSDRRRRR502"
},
"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",
"budget_details": [
{
"budget_type": 1,
"benefit_amount": 10000,
"actual_benefit_amount": 10000
},
{
"budget_type": 2,
"benefit_amount": 0,
"actual_benefit_amount": 0
},
{
"budget_type": 3,
"benefit_amount": 0,
"actual_benefit_amount": 0
}
]
}
],
"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",
"budget_details": [
{
"budget_type": 1,
"benefit_amount": 10000,
"actual_benefit_amount": 10000
},
{
"budget_type": 2,
"benefit_amount": 0,
"actual_benefit_amount": 0
},
{
"budget_type": 3,
"benefit_amount": 0,
"actual_benefit_amount": 0
}
]
}
],
"invoice_desc": "ONGKIRFREE"
}
]
},
"encryption": {
"secret": "UJ+lOOt4aYkNPr9/1EjPcoaIKa2Ws9kZla3zIQbG3uWRHwpHcFe4z8kVHusFbv63csfc+S1BfP6HhI0pjElaQl+Y4wxhXf7J7X4xYjJn+MIs2RoIp8vlUlmktD612wiQT31xBcCUO0+hhaSfy9Xb8L6XJaVwnOVVYvbKo0YeT7vBGrCD/+DWAcdXrelQZDTJpytBoRifp458nrUMrARx+3UM+RSdk0b0wO1CbqHpzuuyxSnRsnZUqkdJ98k6ld9h+C4xvF4B/FRCHMPz7E084pTbOb37KybeYmKWvCXds3CCxQTh9hFn/oGLr4BNFlMM+AHrSGGwD8o5IC1KXDfUHYtpxng3tJdFq1Hc68YeT1YcoG9fkWGticewQ0p/Fdtuub92BLC6vCvrFK4fnmi4qpmbeI7OKlD5+H8UpWa9b0Cf0YGj5L5vaErf/fC82Qbj+c+hKZUBTp+rAXoaW223Vc1FUF7nweDrSV7hvgSnengNexSoMYJuMMtbctA4iOAd3NbQvMk+UGy8Y45BfeUISU9JKJG+A9b/oA5kqCkpxrisG0cmtxrGPulFVnd1Y6UUWQu3SiZC556kRL7liP9UC4FgSrxZCT32SH0/vnj+IyHxOjWK0VvQNN9H70y1YgIEV9YdS30SbfdFLKukixXiw613Ksrek1to0/ShSbtqCpM=",
"content": "QkJVoryibql2XHrJYlXshtINsO/30ReFsgvTh9cup9rG0fEC7ADJFuJ/Z6JKgV6zAbGy04ytClStWqy380Qr7wTYaipfYIwJMSXc+NXxXgtmiEOzjSVRYbQD5PdmZb6BqE/ow2cs7Na/NS1+IWIQh057C48bPxJ+DloQsqGMYi5wmruGQeR+B/wWNuMIXg0MedAAZhJscTaohgpdb1rPOD4oveQaa3OldboarqxecOW+uSIsBwxYmrNKR78o7doxbukxloISy0FV7PHR93u1x1IbPD6YL67BvOD0puyf9eMAiugGvIShvmNvC8h4HeUvplz6vmfhrqvkCpoQFkpSU1rvODM="
},
"addon_info": null,
"shipment_fulfillment": {
"accept_deadline": "2022-08-12T22:43:39Z",
"confirm_shipping_deadline": "2022-08-15T22:43:39Z"
},
"is_plus": false
}
]
}
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
| Error Code | Error Message | Description |
|---|---|---|
ORD_API_001 | Failed To Initialize Request | Failed sending request to upstream |
ORD_API_003 | Failed To Fetching Request | Failed fetching response from upstream |
ORD_API_004 | Failed To Reading Response Body | Failed processing response from upstream |
ORD_API_005 | Failed To Parsing Json Response | Failed processing response from upstream |
ORD_API_006 | There Are Error From Ext Service | Failed getting response from upstream |
ORD_API_009 | Error Data Order Too Big, Must Reduce Time Interval | Response is too large, please reduce the time interval |
ORD_USC_015 | FS ID Is Not Associated With Shop ID or Warehouse ID | FS ID is not associated with Shop ID or Warehouse ID |
ORD_DLV_001 | fs_id cannot be empty | fs_id field is empty, please check again |
ORD_DLV_002 | invalid fs_id format | Invalid fs_id format, please check again |
ORD_DLV_006 | invalid shop_id format | Invalid shop_id format, please check again |
ORD_DLV_007 | invalid warehouse_id format | Invalid warehouse_id format, please check again |
ORD_DLV_008 | please choose one between shop id or warehouse id | Please choose either Shop ID or Warehouse ID to be filled |
ORD_DLV_009 | from_date cannot be empty | from_date is empty, please check again |
ORD_DLV_010 | invalid from_date format | Invalid from_date format, please check again |
ORD_DLV_011 | to_date cannot be empty | to_date is empty, please check agai |
ORD_DLV_012 | invalid to_date format | Invalid to_date format, please check again |
ORD_DLV_013 | Date Range must be less than %d days | |
ORD_DLV_014 | page cannot be empty | page is empty, please check again |
ORD_DLV_015 | invalid page format | Invalid page format, please check again |
ORD_DLV_016 | per_page cannot be empty | per_page is empty, please check again |
ORD_DLV_017 | invalid per_page format | Invalid per_page format, please check again |
ORD_DLV_018 | invalid status format | Invalid status format, please check again |
ORD_DLV_028 | invalid order_type param value | Invalid order_type param value, please check again |
ORD_DLV_029 | invalid order_type param format | Invalid order_type format, please check again |
Notes
This endpoint only can pull orders with 3 days interval between from_date and to_date.
You can check the have_product_bundle field. If true, check the bundle_detail field. There you can differentiate bundle and non-bundle products from the bundle and non_bundle fields
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. |