v2.returns.get_shipping_carrier

GET /api/v2/returns/get_shipping_carrier

Use this API to get the list of shipping carriers and request parameters needed before calling v2.returns.upload_shipping_proof. Only for TW and BR returns with is_seller_arrange = true.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/returns/get_shipping_carrier

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
return_sn	string	True	2206150VT13E3MQ	The serial number of return.

Response Parameters

Name	Type	Sample	Description
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
request_id	string	d52ca43b277a4f9292fb8be658bfd33d	The identifier for an API request for error tracking.
response	object
is_shipping_proof_mandatory	boolean	true	To indicate whether uploading shipping proof is mandatory for seller to confirm "Arrange Pickup" when is_seller_arrange = true.
has_uploaded_seller_arrange_proof	boolean	false	To indicate whether seller has already uploaded shipping proof for this return.
shipping_proof_template	object[]		To display list of request parameters needed to upload shipping proof.
is_tracking_number_required	boolean	true	To indicate whether it is mandatory to provide tracking number when uploading shipping proof.
is_shipping_image_file_mandatory	boolean	true	To indicate whether it is mandatory to provide shipping image file(s) when uploading shipping proof.
reverse_logistics_carrier_list	object[]		The list of logistics carriers available for sellers to choose.
reverse_logistics_carrier_id	int64	0	To indicate the id of the non-integrated reverse logistics channel used by seller.
reverse_logistics_carrier_name	string	test_reverse_logistics_carrier_name	To indicate the selected carrier name from the list of carrier names provided.