v2.logistics.get_booking_shipping_document_data_info

POST /api/v2/logistics/get_booking_shipping_document_data_info

Use this api to fetch the logistics information of a booking these info can be used for airwaybill printing. Dedicated for crossborder SLS order airwaybill. May not be applicable for local channel airwaybill. Besides, this api supports returning personal info as images.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/logistics/get_booking_shipping_document_data_info

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	string	True	201201E81SYYKE	Shopee's unique identifier for a booking.
recipient_address_info	object[]	False		recipient address to query as image
key	string	True	name	fields to query in the recipient address, should be name, phone, full_address, town, district, city, state, region, zipcode.
style	object	False		image style
text_style	string[]	False	["bold", "italic"]	supports bold and italic
font_size	int64	False	12	supports 1 - 108
text_color	string	False	#39c5bb	color string like "#AbCd12"
image_width	float	False	3.0	supports 0.1-30, in centimeters
h_align	string	False	center	text horizontal align, supports left, center and right.

Response Parameters

Name	Type	Sample	Description
request_id	string	862fc4d77de74edf9bf045c7650f1988	The identifier for an API request for error tracking.
error	string	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.
recipient_address_info	object
key	string	name	queried field in recipient address
image	string	data:image/png;base64,/9j/4AAQSkZJRgABAgEASABIAAD/……	base64 encoded png data string
shipping_document_info	object
booking_weight	int64	500	Use this field to indicate booking weight when calculate the shipping fee. The unit of weigh is gram.
logistics_channel_id	int64	28016	The identity of logistic channel.
shipping_carrier	string	Standard Delivery	The logistics service provider for the booking.
recipient_sort_code	object		The sort_code of recipient.
first_recipient_sort_code	string	B-151-ATP-ATP-010	The first-level sort_code of recipient.
second_recipient_sort_code	string		The second-level sort_code of recipient.
third_recipient_sort_code	string	SAN ROQUE 009	The third-level sort_code of recipient.
sender_sort_code	object		The sort_code of sender.
first_sender_sort_code	string		The first-level sort_code of sender.
second_sender_sort_code	string		The second-level sort_code of sender.
third_sender_sort_code	string		The third-level sort_code of sender.
return_sort_code	object		The sort code for 3PL doing RTS.
return_first_sort_code	string	RTS-FM-MAN	The first-level sort code for 3PL doing RTS.
tracking_number	string	MY200448706479IT	The tracking number assigned by the shipping carrier for item shipment.
pickup_hub	string		The name of pickup hub.
delivery_hub	string		The name of delivery hub.
deliver_area	string	SAN ROQUE 009	Zone name.
ec_booking_no	string		The name of ec booing.
create_date_ymd_sl	string	2022/12/05	The date of create shipment booking.
manufacturers_name	string		The name of manufacturer.
manufacturers_website	string		The website of manufacturer.
is_lm_dg_bool	int64	0	Use this field to indicate booking contains dangerous goods or not. dg:1 non-dg:0
spx_sub_district	string		The sub-district of recipient's address.
spx_receive_station	object		The spx receive station.
spx_first_receive_station	string		The first pickup station.
zone	string		The zone of this booking.
zone_code	string		Delivery Sub Zone.
destination_base_code	string		Distribution Center Code.