v2.order.get_booking_detail

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:13:44

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.order.get_booking_detail

Use this api to get booking detail.

§2 Overview

Overview

Field	Value
Module	Order
API type	Shop
HTTP method	GET
Path	/api/v2/order/get_booking_detail
Production URL	https://partner.shopeemobile.com/api/v2/order/get_booking_detail
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/order/get_booking_detail
Permission	ERP System; Seller In House System; Order Management; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
booking_sn_list	string	Yes	201214JAJXU6G7,201214JASXYXY6	The set of booking_sn. If there are multiple booking_sn, you need to use English comma to connect them. limit [1,50]
response_optional_fields	string	No	total_amount	The 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: item_list,cancel_by,cancel_reason,fulfillment_flag,pickup_done_time,shipping_carrier, recipient_address, dropshipper, dropshipper_phone

§4 Response parameters

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 information you are querying.
response.booking_list	object[]		The list of bookings.
response.booking_list.booking_sn	string	201214JASXYXY6	Return by default. Shopee's unique identifier for a booking.
response.booking_list.order_sn	string	201218V2Y6E59M	Shopee's unique identifier for an order. Only return if booking_status is MATCHED.
response.booking_list.region	string	MY	Return by default. The two-digit code representing the region where the booking was made.
response.booking_list.booking_status	string	CANCELLED	Return by default. Enumerated type that defines the current status of the booking. Available value: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED
response.booking_list.match_status	string	MATCH_PENDING	MATCH_PENDING/MATCH_SUCCESSFUL/MATCH_FAILED
response.booking_list.shipping_carrier	string	Standard Delivery	The logistics service provider that will deliver the booking.
response.booking_list.create_time	timestamp	1607930885	Return by default. Timestamp that indicates the date and time that the booking was created.
response.booking_list.update_time	timestamp	1608134691	Return by default. Timestamp that indicates the last time that there was a change in value of booking, such as booking status changed from 'Processed' to 'Shipped'.
response.booking_list.ship_by_date	int64	1608103685	Return by default. The deadline to ship out the parcel.
response.booking_list.recipient_address	object		This object contains detailed breakdown for the recipient address.
response.booking_list.recipient_address.name	string	Max	Recipient's name for the address.
response.booking_list.recipient_address.phone	string	3828203	Recipient's phone number input when booking was placed.
response.booking_list.recipient_address.town	string	Sara	The town of the recipient's address. Whether there is a town will depend on the region and/or country.
response.booking_list.recipient_address.district	string	Dada	The district of the recipient's address. Whether there is a district will depend on the region and/or country.
response.booking_list.recipient_address.city	string	Asajaya	The city of the recipient's address. Whether there is a city will depend on the region and/or country.
response.booking_list.recipient_address.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.
response.booking_list.recipient_address.region	string	MY	The two-digit code representing the region of the Recipient.
response.booking_list.recipient_address.zipcode	string	40009	Recipient's postal code.
response.booking_list.recipient_address.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.
response.booking_list.item_list	object[]		This object contains the detailed breakdown for the result of this API call.
response.booking_list.item_list.item_id	int64	2600144043	Shopee's unique identifier for an item.
response.booking_list.item_list.item_name	string	backpack	The name of the item.
response.booking_list.item_list.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.
response.booking_list.item_list.model_id	int64	0	ID of the model that belongs to the same item.
response.booking_list.item_list.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.
response.booking_list.item_list.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.
response.booking_list.item_list.model_quantity_purchased	int64	1	The number of identical items from one listing/item in the same booking.
response.booking_list.item_list.weight	float	12.0	The weight of the item
response.booking_list.item_list.product_location_id	string		The fulfilment warehouse ID(s) of the items in the booking. (Multi-Warehouse sellers only)
response.booking_list.item_list.image_info	object		Image info of the product.
response.booking_list.item_list.image_info.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.
response.booking_list.dropshipper	string		For Indonesia bookings only. The name of the dropshipper.
response.booking_list.dropshipper_phone	string		The phone number of dropshipper, could be empty.
response.booking_list.cancel_by	string	system	Could be one of buyer, seller, system or Ops.
response.booking_list.cancel_reason	string	BACKEND_LOGISTICS_NOT_STARTED	Use this field to get reason for buyer, seller, and system cancellation.
response.booking_list.fulfillment_flag	string	fulfilled_by_shopee	Use this field to indicate the booking is fulfilled by shopee or seller. Applicable values: fulfilled_by_shopee, fulfilled_by_cb_seller, fulfilled_by_local_seller.
response.booking_list.pickup_done_time	timestamp	0	The timestamp when pickup is done.
warning	string	string[]	Indicate warning message you should take care.

§5 Common parameters

Common 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

§6 Request samples

Request samples

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://open.admin.uat.shopee.io/api/v2/order/get_booking_detail?access_token=access_token&booking_sn_list=201214JAJXU6G7%2C201214JASXYXY6&partner_id=partner_id&response_optional_fields=total_amount&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://open.admin.uat.shopee.io/api/v2/order/get_booking_detail?access_token=access_token&booking_sn_list=201214JAJXU6G7%2C201214JASXYXY6&partner_id=partner_id&response_optional_fields=total_amount&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

§9 cURL

cURL

curl --location --request GET 'https://open.admin.uat.shopee.io/api/v2/order/get_booking_detail?access_token=access_token&booking_sn_list=201214JAJXU6G7%2C201214JASXYXY6&partner_id=partner_id&response_optional_fields=total_amount&shop_id=shop_id&sign=sign&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://open.admin.uat.shopee.io/api/v2/order/get_booking_detail?access_token=access_token&booking_sn_list=201214JAJXU6G7%2C201214JASXYXY6&partner_id=partner_id&response_optional_fields=total_amount&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
	"request_id": "a8e1b94f51d64540bf5762abe7783073",
	"error": "common.error_auth",
	"message": "Invalid access_token.",
	"response": {
		"booking_list": [
			{
				"booking_sn": "201214JASXYXY6",
				"order_sn": "201218V2Y6E59M",
				"region": "MY",
				"booking_status": "CANCELLED",
				"match_status": "MATCH_PENDING",
				"shipping_carrier": "Standard Delivery",
				"create_time": 1607930885,
				"update_time": 1608134691,
				"recipient_address": {
					"name": "Max",
					"phone": "3828203",
					"town": "Sara",
					"district": "Dada",
					"city": "Asajaya",
					"state": "Sarawak",
					"region": "MY",
					"zipcode": "40009",
					"full_address": "C-15-14 BLOK C JALAN 30/146, Asajaya, 40009, Sarawak"
				},
				"item_list": [
					{
						"item_name": "backpack",
						"item_sku": "sku",
						"model_name": "-",
						"model_sku": "-",
						"weight": 12,
						"product_location_id": "-",
						"image_info": {
							"image_url": "-"
						}
					}
				],
				"dropshipper": "-",
				"dropshipper_phone": "-",
				"cancel_by": "system",
				"cancel_reason": "BACKEND_LOGISTICS_NOT_STARTED",
				"fulfillment_flag": "fulfilled_by_shopee",
				"pickup_done_time": 0
			}
		]
	},
	"warning": "string[]"
}

§13 Error example

Error example

§14 JSON

JSON

{
    "error": "logistics.error_param",
    "message": "Wrong parameters, detail: booking_sn_list is empty string.",
    "request_id": "50b227d2a8a24157afed45fc01b479f5"
}

§15 Errors

Errors

Error	Description	Solution
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_param	request not from gateway

§16 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

§17 Update log

Update log

Date	Change
2024-07-02	New API

这条内容对你有帮助吗？