v2.returns.upload_shipping_proof
POST /api/v2/returns/upload_shipping_proof
Use this API to upload shipping proof (Only for TW and BR returns with is_seller_arrange = true). This is not to upload evidence for disputes.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/returns/upload_shipping_proof
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 | The serial number of return. | |
| reverse_logistics_carrier_id | int64 | True | Unique ID of non-integrated reverse logistics channel used by seller. | |
| reverse_logistics_carrier_name | string | False | Non-integrated reverse logistics channel name used by seller. | |
| tracking_number | string | False | Tracking number used in seller arrange. Required when is_tracking_number_required = true in v2.returns.get_shipping_carrier. | |
| image_id_list | object[] | False | List of image_id of shipping proof image. Required when is_shipping_image_file_mandatory = true in v2.returns.get_shipping_carrier. Max: 3. You can call the v2.media.upload_image to upload image and get the image_id, for this scenario, please pass the business = 2 and scene = 1. | |
| image_id | string | False | Unique image_id. | |
| remarks | string | False | Optional remarks |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error code if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. If success, return success | |
| request_id | string | 200203171852695 | The identifier for an API request for error tracking |
| response | object | Detail informations you are querying. For this API will return null. |