Get Single Order
This endpoint retrieves single orders for your shop between given order id or invoice ref number.
Path
get
/v2/fs/:fs_id/order
Request Parameters
| Parameter | Type | Required | Location | Description |
|---|---|---|---|---|
fs_id | Integer | Required | path | Fulfillment service unique identifier |
order_id | Integer | Required | query | Order unique identifier |
invoice_num | String | Optional | query | Invoice Number |
Note:
For query order_id and invoice_num, user must choose one of those queries to retrieve order information
Example Request
- Curl
curl -X GET \
'https://fs.tokopedia.net/v2/fs/13004/order?invoice_num=INV/20170720/XVII/VII/12472252' \
-H 'Authorization: Bearer OoHgyxcgQ5a1uCbmbbXjjA' \
Response Parameters
| Name | Type | Demo Value | Description |
|---|---|---|---|
Integer | 12472302 | Order Unique Identifier | |
Integer | 0 | Buyer User Unique Identifier | |
Integer | 479573 | Seller User Unique Identifier | |
Integer | 11539459 | Payment Unique Identifier | |
Integer | false | Is affiliate? | |
Integer | false | Order Fulfilled by Tokocabang (true), Order Fulfilled by Shop (false) | |
order_warehouse | Object | ||
Integer | 0 | Order Status | |
String | INV/20170720/XVII/VII/1247225 | Invoice Number | |
String | Invoice-5511917-479573-20170720175058-WE1NWElRVVk.pdf | Invoice PDF Filename | |
String | https://staging.tokopedia.com/invoice.pl?id=12472302&pdf=Invoice-5511917-479573-20170720175058-WE1NWElRVVk | Invoice URL | |
Integer | 270000 | Total Price Amount | |
Integer | 0 | ||
Integer | 0 | Cashback Amount | |
String | Info | ||
String | * 24/07/2017 08:01:07 : Penjual telah melebihi batas waktu proses pesanan | Order Comment | |
Integer | 261000 | Item Price | |
buyer_info | Object | ||
shop_info | Object | ||
shipment_fulfillment | Object | ||
preorder | Object | ||
order_info | Object | ||
origin_info | Object | ||
payment_info | Object | ||
insurance_info | Object | ||
null | |||
null | |||
Timestamp | 2017-07-20T17:50:58.061156Z | Order Creation Date | |
Timestamp | null | Order Shipping Date | |
Timestamp | 2017-07-24T08:01:07.073696Z | Order Update Date | |
Timestamp | 2017-07-20T17:50:58.061156Z | Order Payment Date | |
Timestamp | null | Order Delivered Date | |
Timestamp | null | Estimated Order Shipping Date | |
Timestamp | null | Estimated Order Delivered Date | |
null | Related Invoices | ||
null | Custom Fields | ||
promo_order_detail | Object | ||
summary_promo | Object | ||
pof_info | Object |
Notes
Partners type details
Brand: Currently the list only contain OS (Official Store) and it will automatically deduct to seller ballance (saldo seller) if the transaction has been finish.Partner: The list contain 3rd party like bank partner or logistic (e.g J&T, JNE, etc) and after the transaction has been finish, it will not automatically deduct seller ballance, so Tokopedia and Partner need to do manually invoicing with the agreement before the campaign start.
Success Response Examples
{
"header": {
"process_time": 0.149503274,
"messages": "Your request has been processed successfully"
},
"data":
{
"order_id": 12472302,
"buyer_id": 0,
"seller_id": 479573,
"payment_id": 11539459,
"is_affiliate": false,
"is_fulfillment": false,
"order_warehouse": {
"warehouse_id": 0,
"fulfill_by": 0,
"meta_data": {
"warehouse_id": 0,
"partner_id": 0,
"shop_id": 0,
"warehouse_name": "",
"district_id": 0,
"district_name": "",
"city_id": 0,
"city_name": "",
"province_id": 0,
"province_name": "",
"status": 0,
"postal_code": "",
"is_default": 0,
"latlon": "",
"latitude": "",
"longitude": "",
"email": "",
"address_detail": "",
"country_name": "",
"is_fulfillment": false
}
},
"order_status": 0,
"invoice_number": "INV/20170720/XVII/VII/12472252",
"invoice_pdf": "Invoice-5511917-479573-20170720175058-WE1NWElRVVk.pdf",
"invoice_url": "https://staging.tokopedia.com/invoice.pl?id=12472302&pdf=Invoice-5511917-479573-20170720175058-WE1NWElRVVk",
"open_amt": 270000,
"lp_amt": 0,
"cashback_amt": 0,
"info": "",
"comment": "* 24/07/2017 08:01:07 : Penjual telah melebihi batas waktu proses pesanan",
"item_price": 261000,
"buyer_info": {
"buyer_id": 0,
"buyer_fullname": "Maulana Hasim",
"buyer_email": " ",
"buyer_phone": "*******0644"
},
"shop_info": {
"shop_owner_id": 5510391,
"shop_owner_email": "hana.mahrifah+inti@tokopedia.com",
"shop_owner_phone": "628119916444",
"shop_name": "I`nti.Cosmetic",
"shop_domain": "icl",
"shop_id": 479573
},
"shipment_fulfillment": {
"id": 0,
"order_id": 0,
"payment_date_time": "0001-01-01T00:00:00Z",
"is_same_day": false,
"accept_deadline": "0001-01-01T00:00:00Z",
"confirm_shipping_deadline": "0001-01-01T00:00:00Z",
"item_delivered_deadline": {
"Time": "0001-01-01T00:00:00Z",
"Valid": false
},
"is_accepted": false,
"is_confirm_shipping": false,
"is_item_delivered": false,
"fulfillment_status": 0
},
"preorder": {
"order_id": 0,
"preorder_type": 0,
"preorder_process_time": 0,
"preorder_process_start": "2017-07-20T17:50:58.061156Z",
"preorder_deadline": "0001-01-01T00:00:00Z",
"shop_id": 0,
"customer_id": 0
},
"order_info": {
"order_detail": [
{
"order_detail_id": 20274955,
"product_id": 14286600,
"product_name": "STABILO Paket Ballpoint Premium Bionic Rollerball - Multicolor",
"product_desc_pdp": "Paket\n pulpen premium membuat kegiatan menulis kamu bisa lebih berwarna kenyamanan yang maksimal- memiliki 4 warna Paket\n pulpen premium membuat kegiatan menulis kamu bisa lebih berwarna kenyamanan yang maksimal- memiliki 4 warna",
"product_desc_atc": "Paket\n pulpen premium membuat kegiatan menulis kamu bisa lebih berwarna kenyamanan yang maksimal- memiliki 4 warna Paket\n pulpen premium membuat kegiatan menulis kamu bisa lebih berwarna kenyamanan yang maksimal- memiliki 4 warna",
"product_price": 26100,
"subtotal_price": 261000,
"weight": 0.2,
"total_weight": 0.2,
"quantity": 10,
"quantity_deliver": 10,
"quantity_reject": 0,
"is_free_returns": false,
"insurance_price": 0,
"normal_price": 0,
"currency_id": 2,
"currency_rate": 0,
"min_order": 0,
"child_cat_id": 1122,
"campaign_id": "",
"product_picture": "https://imagerouter-staging.tokopedia.com/image/v1/p/14286600/product_detail/desktop",
"snapshot_url": "https://staging.tokopedia.com/snapshot_product?order_id=12472302&dtl_id=20274955",
"sku": "SKU01"
}
],
"order_history": [
{
"action_by": "system-automatic",
"hist_status_code": 0,
"message": "",
"timestamp": "2017-07-24T08:01:07.073696Z",
"comment": "Penjual telah melebihi batas waktu proses pesanan",
"create_by": 0,
"update_by": "system"
},
{
"action_by": "buyer",
"hist_status_code": 220,
"message": "",
"timestamp": "2017-07-20T17:50:58.374626Z",
"comment": "",
"create_by": 0,
"update_by": "tokopedia"
},
{
"action_by": "buyer",
"hist_status_code": 100,
"message": "",
"timestamp": "2017-07-20T17:50:58.374626Z",
"comment": "",
"create_by": 0,
"update_by": "system"
}
],
"order_age_day": 812,
"shipping_age_day": 0,
"delivered_age_day": 0,
"partial_process": false,
"shipping_info": {
"sp_id": 1,
"shipping_id": 1,
"logistic_name": "Kurir Rekomendasi",
"logistic_service": "Reguler",
"shipping_price": 9000,
"shipping_price_rate": 9000,
"shipping_fee": 0,
"insurance_price": 0,
"fee": 0,
"is_change_courier": false,
"second_sp_id": 0,
"second_shipping_id": 0,
"second_logistic_name": "",
"second_logistic_service": "",
"second_agency_fee": 0,
"second_insurance": 0,
"second_rate": 0,
"awb": "",
"autoresi_cashless_status": 0,
"autoresi_awb": "",
"autoresi_shipping_price": 0,
"count_awb": 0,
"isCashless": false,
"is_fake_delivery": false,
"recommended_courier_info": [
{
"name": "SICEPAT",
"sequence": 1,
"milestone": "pickup_by"
},
{
"name": "JNE",
"sequence": 2,
"milestone": "delivered_by"
}
]
},
"destination": {
"receiver_name": "maul",
"receiver_phone": "085712345678",
"address_street": "jalan gatot subroto kav 123456789",
"address_district": "Jagakarsa",
"address_city": "Kota Administrasi Jakarta Selatan",
"address_province": "DKI Jakarta",
"address_postal": "123456",
"customer_address_id": 4649619,
"district_id": 2263,
"city_id": 175,
"province_id": 13
},
"is_replacement": false,
"replacement_multiplier": 0,
"is_plus": true
},
"origin_info": {
"sender_name": "I`nti.Cosmetic",
"origin_province": 13,
"origin_province_name": "DKI Jakarta",
"origin_city": 174,
"origin_city_name": "Kota Administrasi Jakarta Barat",
"origin_address": "Jalan Letjen S. Parman, Palmerah, 11410",
"origin_district": 2258,
"origin_district_name": "Palmerah",
"origin_postal_code": "",
"origin_geo": "-6.190449999999999,106.79771419999997",
"receiver_name": "maul",
"destination_address": "jalan gatot subroto kav 123456789",
"destination_province": 13,
"destination_city": 175,
"destination_district": 2263,
"destination_postal_code": "123456",
"destination_geo": ",",
"destination_loc": {
"lat": 0,
"lon": 0
}
},
"payment_info": {
"payment_id": 11539459,
"payment_ref_num": "PYM/20170720/XVII/VII/4999664",
"payment_date": "2017-07-20T17:50:06Z",
"payment_method": 0,
"payment_status": "Verified",
"payment_status_id": 2,
"create_time": "2017-07-20T17:50:06Z",
"pg_id": 12,
"gateway_name": "Installment Payment",
"discount_amount": 0,
"voucher_code": "",
"voucher_id": 0
},
"insurance_info": {
"insurance_type": 0
},
"hold_info": null,
"cancel_request_info": null,
"create_time": "2017-07-20T17:50:58.061156Z",
"shipping_date": null,
"update_time": "2017-07-24T08:01:07.073696Z",
"payment_date": "2017-07-20T17:50:58.061156Z",
"delivered_date": null,
"est_shipping_date": null,
"est_delivery_date": null,
"related_invoices": null,
"custom_fields": null,
"promo_order_detail": {
"order_id": 12472302,
"total_cashback": 2180,
"total_discount": 23000,
"total_discount_product": 0,
"total_discount_shipping": 23000,
"total_discount_details": [
{
"amount": 23000,
"type": "discount_shipping"
}
],
"summary_promo": [
{
"name": "Bebas Ongkir Hingga Rp50.000",
"is_coupon": false,
"show_cashback_amount": true,
"show_discount_amount": true,
"cashback_amount": 0,
"cashback_points": 0,
"cashback_details": null,
"type": "discount",
"discount_amount": 23000,
"discount_details": [
{
"amount": 23000,
"type": "discount_shipping",
"budget_details": [
{
"budget_type": 1,
"benefit_amount": 0,
"actual_benefit_amount": 0
},
{
"budget_type": 2,
"benefit_amount": 23000,
"actual_benefit_amount": 23000
},
{
"budget_type": 3,
"benefit_amount": 0,
"actual_benefit_amount": 0
}
]
}
],
"invoice_desc": ""
},
{
"name": "GoPay Hemat November 2022",
"is_coupon": false,
"show_cashback_amount": true,
"show_discount_amount": true,
"cashback_amount": 2180,
"cashback_points": 2180,
"cashback_details": [
{
"amount_points": 2180,
"amount_idr": 2180,
"actual_amount_idr": 2180,
"actual_amount_points": 2180,
"currency_type": "gopay_coins",
"currency_type_str": "GoPay Coins",
"budget_details": [
{
"budget_type": 1,
"benefit_amount": 0,
"actual_benefit_amount": 0
},
{
"budget_type": 2,
"benefit_amount": 2180,
"actual_benefit_amount": 2180
},
{
"budget_type": 3,
"benefit_amount": 0,
"actual_benefit_amount": 0
}
]
}
],
"type": "cashback",
"discount_amount": 0,
"discount_details": null,
"invoice_desc": ""
}
]
},
"pof_info": {
"order_id": 12472302,
"pof_status": 200,
"shipping_price": 2000,
"insurance_price": 0,
"pof_detail_info": [
{
"order_id": 12472302,
"order_dtl_id": 20274955,
"product_id": 14286600,
"quantity_request": 1,
"total_price_request": 26100,
}
],
"create_time": "2023-04-03T08:36:29.331837Z",
"create_by": 5510391,
"create_by_type": 1,
"update_time": "2023-04-03T08:36:36.482397Z",
"update_by": 5510391,
"update_by_type": 2
}
}
}
Error Response Examples
{
"header": {
"process_time": 0.015608829,
"messages": "We could not process your request due to malformed request, please check again",
"reason": "Data Not Found",
"error_code": "ORD_API_008"
},
"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_008 | Data Not Found | Order data not found |
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_003 | error order id and invoice no is empty | Both Order ID and Invoice Number is empty |
ORD_DLV_004 | error must choose either order id or invoice no as parameter | Please choose either Order ID or Invoice Number to be filled |
ORD_DLV_005 | invalid order_id format | Invalid order_id format, please check again |
SHP_GRPC_001 | Failed Send GRPC Request | Failed sending request to upstream |
SHP_GRPC_003 | Data Not Found | Failed finding data from upstream |