v2.order.get_booking_detail

GET /api/v2/order/get_booking_detail

Use this api to get booking detail.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/order/get_booking_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
booking_sn_list	string	True	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	False	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

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.
booking_list	object[]		The list of bookings.
booking_sn	string	201214JASXYXY6	Return by default. Shopee's unique identifier for a booking.
order_sn	string	201218V2Y6E59M	Shopee's unique identifier for an order. Only return if booking_status is MATCHED.
region	string	MY	Return by default. The two-digit code representing the region where the booking was made.
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
match_status	string	MATCH_PENDING	MATCH_PENDING/MATCH_SUCCESSFUL/MATCH_FAILED
shipping_carrier	string	Standard Delivery	The logistics service provider that will deliver the booking.
create_time	timestamp	1607930885	Return by default. Timestamp that indicates the date and time that the booking was created.
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'.
ship_by_date	int64	1608103685	Return by default. The deadline to ship out the parcel.
recipient_address	object		This object contains detailed breakdown for the recipient address.
name	string	Max	Recipient's name for the address.
phone	string	3828203	Recipient's phone number input when booking was placed.
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.
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	int64	1	The number of identical items from one listing/item in the same booking.
weight	float	12.0	The weight of the item
product_location_id	string		The fulfilment warehouse ID(s) of the items in the booking. (Multi-Warehouse sellers only)
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.
dropshipper	string		For Indonesia bookings only. The name of the dropshipper.
dropshipper_phone	string		The phone number of dropshipper, 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.
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.
pickup_done_time	timestamp	0	The timestamp when pickup is done.
warning	string	string[]	Indicate warning message you should take care.