v2.logistics.get_booking_shipping_document_result

POST /api/v2/logistics/get_booking_shipping_document_result

Use this api to retrieve the status of the shipping document task. Document will be available for download only after the status change to 'READY'.

Endpoint URL

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

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

Name	Type	Required	Sample	Description
booking_list	object[]	True		The list of bookings you want to get. limit [1,50]
booking_sn	string	True	201201E81SYYKE	Shopee's unique identifier for a booking.
shipping_document_type	string	False	NORMAL_AIR_WAYBILL	The type of shipping document. Available values: NORMAL_AIR_WAYBILL,THERMAL_AIR_WAYBILL

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.
warning	object[]		Indicate warning message you should take care.
booking_sn	string	201201E81SYYKE	Shopee's unique identifier for a booking.
response	object		Detail informations you are querying.
result_list	object[]		The list of the result data.
booking_sn	string	201201E81SYYKE	Shopee's unique identifier for a booking.
status	string	READY	The status of the shipping document task you querying with booking_sn. Available values: READY/FAILED/PROCESSING
fail_error	string	logistics.booking_not_exist	Indicate error type if one element hit error.
fail_message	string	The booking_sn 201201V81SYYDG you provided is not exist.	Indicate error details if one element hit error.