v2.logistics.upload_serviceable_polygon
POST /api/v2/logistics/upload_serviceable_polygon
Only available for Brazil sellers. Use this API to upload KML file for shop level serviceability setting for BR Entrega Turbo channel (Channel ID: 90026). Please note that multiple Outlet Shops under the same Mart Shop cannot have overlapping service areas.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/logistics/upload_serviceable_polygon
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 |
|---|---|---|---|---|
| file | file | True | The .kml file to be uploaded to denote the serviceability area of the shops. Note: Please refer to “KML file format for v2.logistics.upload_serviceable_polygon” to understand the structure specifications and upload requirements for KML files. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | error_param | Indicate error type if hit error. Empty if no error happened. |
| message | string | File size exceeds max allowable size. | Indicate error details if hit error. Empty if no error happened. |
| request_id | string | a316752d608baf000b2c73e2e5eed5c8 | The identifier for an API request for error tracking. |
| response | object | Detail informations you are querying. | |
| task_id | string | Use the task_id to call v2.logistics.check_polygon_update_status to check if the upload job has been completed. |