Skip to main content

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

ParameterTypeRequiredLocationDescription
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 -X GET \
'https://fs.tokopedia.net/v2/fs/13004/order?invoice_num=INV/20170720/XVII/VII/12472252' \
-H 'Authorization: Bearer OoHgyxcgQ5a1uCbmbbXjjA' \

Response Parameters

NameTypeDemo ValueDescription
order_id
Integer
12472302
Order Unique Identifier
buyer_id
Integer
5511917
Buyer User Unique Identifier
seller_id
Integer
479573
Seller User Unique Identifier
payment_id
Integer
11539459
Payment Unique Identifier
is_affiliate
Integer
false
Is affiliate?
is_fulfillment
Integer
false
Order Fulfilled by Tokocabang (true), Order Fulfilled by Shop (false)
order_warehouse
Object
order_status
Integer
0
Order Status
invoice_number
String
INV/20170720/XVII/VII/1247225
Invoice Number
invoice_pdf
String
Invoice-5511917-479573-20170720175058-WE1NWElRVVk.pdf
Invoice PDF Filename
invoice_url
String
https://staging.tokopedia.com/invoice.pl?id=12472302&pdf=Invoice-5511917-479573-20170720175058-WE1NWElRVVk
Invoice URL
open_amt
Integer
270000
Total Price Amount
lp_amt
Integer
0
cashback_amt
Integer
0
Cashback Amount
info
String
Info
comment
String
* 24/07/2017 08:01:07 : Penjual telah melebihi batas waktu proses pesanan
Order Comment
item_price
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
hold_info
null
cancel_request_info
null
create_time
Timestamp
2017-07-20T17:50:58.061156Z
Order Creation Date
shipping_date
Timestamp
null
Order Shipping Date
update_time
Timestamp
2017-07-24T08:01:07.073696Z
Order Update Date
payment_date
Timestamp
2017-07-20T17:50:58.061156Z
Order Payment Date
delivered_date
Timestamp
null
Order Delivered Date
est_shipping_date
Timestamp
null
Estimated Order Shipping Date
est_delivery_date
Timestamp
null
Estimated Order Delivered Date
related_invoices
null
Related Invoices
custom_fields
null
Custom Fields

Success Response Examples

{
"header": {
"process_time": 0.149503274,
"messages": "Your request has been processed successfully"
},
"data":
{
"order_id": 12472302,
"buyer_id": 5511917,
"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": 5511917,
"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": 261000,
"subtotal_price": 261000,
"weight": 0.2,
"total_weight": 0.2,
"quantity": 1,
"quantity_deliver": 1,
"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": "first_mile"
},
{
"name": "JNE",
"sequence": 2,
"milestone": "last_mile"
}
]
},
"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
},
"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
}

}

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 CodeError MessageDescription
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
  • Path
  • Request Parameters
  • Example Request
  • Response Parameters
  • Success Response Examples
  • Error Response Examples
  • Error Codes
  • Have a feedback?