v2.order.get_order_detail

GET /api/v2/order/get_order_detail

Use this api to get order detail.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/order/get_order_detail

Common Request Parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Request Parameters

Name	Type	Required	Sample	Description
order_sn_list	string	True	201214JAJXU6G7,201214JASXYXY6	The set of order_sn. If there are multiple order_sn, you need to use English comma to connect them. limit [1,50]
request_order_status_pending	boolean	False	true	Compatible parameter during migration period, send True will let API support PENDING status and return  pending_terms, send False or don’t send will fallback to old logic
response_optional_fields	string	False	total_amount	a response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them. Available values: buyer_user_id,buyer_username,estimated_shipping_fee,recipient_address,actual_shipping_fee ,goods_to_declare,note,note_update_time,item_list,pay_time,dropshipper, dropshipper_phone,split_up,buyer_cancel_reason,cancel_by,cancel_reason,actual_shipping_fee_confirmed,buyer_cpf_id,fulfillment_flag,pickup_done_time,package_list,shipping_carrier,payment_method,total_amount,buyer_username,invoice_data,order_chargeable_weight_gram,return_request_due_date,edt,payment_info,international_label

Response Parameters

Name	Type	Sample	Description
request_id	string	a8e1b94f51d64540bf5762abe7783073	The identifier for an API request for error tracking.
error	string	common.error_auth	Indicate error type if hit error. Empty if no error happened.
message	string	Invalid access_token.	Indicate error details if hit error. Empty if no error happened.
response	object		Detail informations you are querying.
order_list	object[]		The list of orders.
order_sn	string	2404098R48U37H	Return by default. Shopee's unique identifier for an order.
region	string	VN	Return by default. The two-digit code representing the region where the order was made.
currency	string	VND	Return by default. The three-digit code representing the currency unit for which the order was paid.
cod	boolean	false	Return by default. This value indicates whether the order was a COD (cash on delivery) order.
total_amount	float	1004.0	The total amount paid by the buyer for the order. This amount includes the total sale price of items, shipping cost beared by buyer; and offset by Shopee promotions if applicable. This value will only return after the buyer has completed payment for the order.
pending_terms	string[]	["SYSTEM_PENDING", "KYC_PENDING"]	The list of pending terms. Applicable values: - SYSTEM_PENDING: Under Shopee internal processing. - KYC_PENDING: Under KYC checking (TW CB order only). - ARRANGE_SHIPMENT_PENDING: Temporarily held due to 3PL capacity constraints.
pending_description	string[]	["Order is being processed by Shopee"]	The value of this field is the description of pending reason corresponding with pending terms. Applicable values: - For SYSTEM_PENDING: Order is being processed by Shopee. - For KYC_PENDING: Order is pending buyer TW KYC pre-authorization. - For ARRANGE_SHIPMENT_PENDING: Allocating delivery resources due to high order volume. Label print will be available within 4 days after buyer paid.
order_status	string	CANCELLED	Return by default. Enumerated type that defines the current status of the order.
shipping_carrier	string	Standard Delivery	The logistics service provider that the buyer selected for the order to deliver items. Note: If logistics_channel_id is 90021, 90025 or 90026, service_code will be appended, e.g., Entrega Turbo - M1020.
payment_method	string	Bank Transfer	The payment method that the buyer selected to pay for the order. Applicable values: See Data Definition- Payment Methods.
estimated_shipping_fee	float	4.0	The estimated shipping fee is an estimation calculated by Shopee based on specific logistics courier's standard.
message_to_seller	string		Return by default. Message to seller.
create_time	timestamp	1607930885	Return by default. Timestamp that indicates the date and time that the order was created.
update_time	timestamp	1608134691	Return by default. Timestamp that indicates the last time that there was a change in value of order, such as order status changed from 'Paid' to 'Completed'.
days_to_ship	int32	2	Return by default. Shipping preparation time set by the seller when listing item on Shopee.
ship_by_date	timestamp	1608103685	Return by default. The deadline to ship out the parcel.
buyer_user_id	int64	9193214	The user id of buyer of this order, will be empty if it is a non-integrated order in TW region.
buyer_username	string	Tom	The name of buyer, will be masked as "****" if it is a non-integrated order in TW region.
recipient_address	object		This object contains detailed breakdown for the recipient address. Different parameters might be masked according to each market and kind of seller. For TW region integrated channel orders will be all masked as "****". More details may refer the announcement.
name	string	Max	Recipient's name for the address.
phone	string	3828203	Recipient's phone number input when order was placed. [Only for TW non-integrated channel] Will return "****" when the "virtual_contact_number" is available
town	string	Sara	The town of the recipient's address. Whether there is a town will depend on the region and/or country.
district	string	Dada	The district of the recipient's address. Whether there is a district will depend on the region and/or country.
city	string	Asajaya	The city of the recipient's address. Whether there is a city will depend on the region and/or country.
state	string	Sarawak	The state/province of the recipient's address. Whether there is a state/province will depend on the region and/or country.
region	string	MY	The two-digit code representing the region of the Recipient.
zipcode	string	40009	Recipient's postal code.
full_address	string	C-15-14 BLOK C JALAN 30/146, Asajaya, 40009, Sarawak	The full address of the recipient, including country, state, even street, and etc.
geolocation	object		Geolocation info. Only available for logistics_channel_id 90026.
latitude	float	-23.567851	Latitude.
longitude	float	-46.6912611	Longitude.
actual_shipping_fee	float	0.0	The actual shipping fee of the order if available from external logistics partners.
goods_to_declare	boolean	false	Only work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. "T" means true and it will mark as "T" on the shipping label; "F" means false and it will mark as "P" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo.
note	string	haha	The note seller made for own reference.
note_update_time	timestamp	1608103685	Update time for the note.
item_list	object[]		This object contains the detailed breakdown for the result of this API call.
item_id	int64	2600144043	Shopee's unique identifier for an item.
item_name	string	backpack	The name of the item.
item_sku	string	sku	A item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
model_id	int64	0	ID of the model that belongs to the same item.
model_name	string		Name of the model that belongs to the same item. A seller can offer models of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate model. Each model can have a different quantity and price.
model_sku	string		A model SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are models of one item in Shopee Listings.
model_quantity_purchased	int32	1	The number of identical items purchased at the same time by the same buyer from one listing/item.
model_original_price	float	1000.0	The original price of the item in the listing currency.
model_discounted_price	float	1000.0	The after-discount price of the item in the listing currency. If there is no discount, this value will be same as that of model_original_price. In case of bundle deal item, this value will return 0 as by design bundle deal discount will not be breakdown to item/model level. Due to technical restriction, the value will return the price before bundle deal if we don't configure it to 0. Please call GetEscrowDetails if you want to calculate item-level discounted price for bundle deal item.
wholesale	boolean	false	This value indicates whether buyer buy the order item in wholesale price.
weight	float	12.0	The weight of the item
add_on_deal	boolean	false	To indicate if this item belongs to an addon deal.
main_item	boolean	false	To indicate if this item is main item or sub item. True means main item, false means sub item.
add_on_deal_id	int64	0	A unique ID to distinguish groups of items in Cart, and Order. (e.g. AddOnDeal)
promotion_type	string	flash_sale	Available type：product_promotion, flash_sale, bundle_deal, add_on_deal_main, add_on_deal_sub. For items which attend multiple promotions will only show one promotion, the order of priority is: bundle_deal > add_on_deal_main > add_on_deal_sub > product_promotion >flash_sale
promotion_id	int64	0	The ID of the promotion.
order_item_id	int64	2600144043	The identify of order item.
promotion_group_id	int32	0	The identify of product promotion.
image_info	object		Image info of the product.
image_url	string		The image url of the product. Default to be variation image, if the model does not have a variation image, will use an item main image instead.
product_location_id	string		The fulfilment warehouse ID(s) of the items in the order. (Multi-Warehouse sellers only)
is_prescription_item	boolean		To indicate if this item is prescription item
consultation_id	string		An identifier of teleconsultation session which buyer did to order this item. Empty if item is not ordered through teleconsultation session
is_b2c_owned_item	boolean		determine if item is B2C_shop_item It should be **is\_b2c\_shop\_item** but it was a bug from dev. Then now it's is_b2c_owned_item
promotion_list	object[]
promotion_type	string	seller_discount	Indicates the type of item or package level promotion applied to a product. Each item can be associated with at most one item promotion and one package promotion at a time. Item Promotions: low_price_promotion deep_discount platform_sale seller_discount flash_sale wholesale welcome_package_free_gift brand_flash_sale in_shop_flash_sale synced_promo platform_streaming_price seller_streaming_price exclusive_streamer_price price_bidding_with_rebate price_bidding_without_rebate seller_advisor_price selling_price settlement_price campaign_settlement_price local_sip_settlement_price platform_exclusive_price seller_exclusive_price seller_member_exclusive_sku item_price order_sync_price Package Promotions: bundle_deal add_on_deal_main add_on_deal_sub
promotion_id	int64	848474823	Represents the unique identifier of a specific promotion applied to an item. Each promotion_id corresponds to a distinct promotion rule or campaign, defined under a particular promotion_type. The value is expressed in a numeric string format.
hot_listing_item	boolean	true	[Only for PH,TH,VN,MY,BR,TW] True if the item is hot listing.
pay_time	timestamp	1607930885	The time when the order status is updated from UNPAID to PAID. This value is NULL when order is not paid yet.
dropshipper	string		For Indonesia orders only. The name of the dropshipper.
dropshipper_phone	string		The phone number of dropshipper, could be empty.
split_up	boolean	false	To indicate whether this order is split to fullfil order(forder) level. Call GetForderInfo if it's "true".
buyer_cancel_reason	string		Cancel reason from buyer, could be empty.
cancel_by	string	system	Could be one of buyer, seller, system or Ops.
cancel_reason	string	BACKEND_LOGISTICS_NOT_STARTED	Use this field to get reason for buyer, seller, and system cancellation.
actual_shipping_fee_confirmed	boolean	false	Use this filed to judge whether the actual_shipping_fee is confirmed.
buyer_cpf_id	string		Buyer's CPF number for taxation and invoice purposes. Only for Brazil order.
fulfillment_flag	string	fulfilled_by_shopee	Use this field to indicate the order is fulfilled by shopee or seller. Applicable values: fulfilled_by_shopee, fulfilled_by_cb_seller, fulfilled_by_local_seller.
pickup_done_time	timestamp	0	The timestamp when pickup is done.
package_list	object[]		The list of package under an order
package_number	string	"61630084074470"	Shopee's unique identifier for the package under an order.
logistics_status	string	LOGISTICS_INVALID	The Shopee logistics status for the order. Applicable values: See Data Definition-LogisticsStatus.
logistics_channel_id	int64	18080	The identity of logistic channel.
shipping_carrier	string	Standard Delivery	The logistics service provider that the buyer selected for the order to deliver items. Note: If logistics_channel_id is 90021, 90025 or 90026, service_code will be appended, e.g., Entrega Turbo - M1020.
allow_self_design_awb	boolean	false	To indicate whether the package allows for self-designed AWB, if allow_self_design_awb returns false, it means that the package does not allow for self-designed AWB and only the system-AWB can be used.
item_list	object[]		The lis of items.
item_id	int64	2600144043	Shopee's unique identifier for an item.
model_id	int64	0	Shopee's unique identifier for a model.
model_quantity	int32	1	The number of identical items/variations purchased at the same time by the same buyer from one listing/item.
order_item_id	int64	2600144043	The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id.
promotion_group_id	int32	7850298	The identify of product promotion.
product_location_id	string	IDL	The warehouse ID of the item.
parcel_chargeable_weight	int		display weight used to calculate ASF for this parcel
group_shipment_id	int64	150654369130420	The common identifier for multiple orders combined in the same parcel.
virtual_contact_number	string	0928000886	[Only for TW non-integrated channel] The virtual phone number to contact the recipient.
package_query_number	string	66668888	[Only for TW non-integrated channel] The query number used in virtual phone number calls to contact the recipient of this package.
sorting_group	string	North	[Only for TW 30029 channel] This field indicate the sorting group value of the package. This field is only available for logistics_channel_id = 30029 and after the package has been arranged for shipment.
invoice_data	object		The invoice data of the order.
number	string		The number of the invoice.
series_number	string		The series number of the invoice.
access_key	string		The access key of the invoice.
issue_date	timestamp		The issue date of the invoice.
total_value	float		The total value of the invoice.
products_total_value	float		The products total value of the invoice.
tax_code	string		The tax code for the invoice.
checkout_shipping_carrier	string	Standard Delivery	For non masking order, the logistics service provider that the buyer selected for the order to deliver items. For masking order, the logistics service type that the buyer selected for the order to deliver items.
reverse_shipping_fee	float		Shopee charges the reverse shipping fee for the returned order.The value of this field will be non-negative.
order_chargeable_weight_gram	int		display weight used to calculate ASF for this order
prescription_check_status	int		Prescription check status. Only for ID and PH whitelist sellers. Applicable value: 0: NONE 1: PASSED 2: FAILED
pharmacist_name	string		Name of the Pharmacist for Prescription Order.
prescription_images	string[]		Return prescription images of this order, only for ID and PH whitelist sellers. Please add the prefix to review: for ID: https://cf.shopee.co.id/file/+prescription_image for PH:https://cf.shopee.ph/file/+prescription_image
prescription_approval_time	timestamp		Time of when the prescription is approved.
prescription_rejection_time	timestamp		Time of when the prescription is rejected.
prescription_reject_reason	string	Insufficient prescription detail	Return the reason why a prescription is rejected. If there is no rejection reason, return empty.
is_buyer_shop_collection	boolean		To indicate if this order is buyer self collection at store order
buyer_proof_of_collection	string[]		The image url of the buyer self collection at the store.
edt_from	timestamp		Earliest estimated delivery date of orders (only available for BR region)
edt_to	timestamp		Latest estimated delivery time of orders (only available for BR region)
booking_sn	string	2404098R48U37H	Return by default. Shopee's unique identifier for a booking. Only returned for advance fulfilment matched order only.
advance_package	boolean	true	Indicate whether order will be fulfilled using advance fulfilment stock or not. If value is true, order will be matched with a booking and seller should not arrange shipment.
return_request_due_date	timestamp		This field represents the deadline for buyers to initiate returns and refunds after order is completed. The “return_request_due_date” response parameter will be returned if the requested order meets ALL the conditions below: - The status of the order is COMPLETED - The return refund eligibility of the order is true If you have any questions related to the function of "returns and refunds after order is completed," please refer to the following link: https://seller.shopee.tw/edu/article/18474
payment_info	object[]		[Only for BR] List of payment information, to follow NT 2025.001 (BR government invoice rules).
payment_method	string	Debit Card	[Only for BR] Payment method used in the order, such as Credit Card, Debit Card, Pix, etc.
payment_processor_register	string	38.372.267/0001-82	[Only for BR] CNPJ of the payment processor handling the transaction.
card_brand	string	VISA	[Only for BR] Card brand for credit or debit transactions, such as VISA, MASTER, etc. Empty string for Pix payments.
transaction_id	string	951679	[Only for BR] Payment authorization code generated by the bank or payment processor to validate the transaction.
payment_amount	float	1004.0	[Only for BR] Amount paid by the corresponding payment method.
hot_listing_order	boolean	true	[Only for PH,TH,VN,MY,BR,TW] True if the order includes hot listing item.
is_international	boolean	false	[Only for BR] Indicate if the order is SIP order. This field will only be returned if international_label is included in response_optional_field in the request.
warning	string[]		Indicate warning message you should take care.