v2.logistics.get_booking_shipping_parameter
GET /api/v2/logistics/get_booking_shipping_parameter
Use this api to get the parameter "info_needed" from the response to check if the booking has pickup or dropoff. This api will also return the addresses and pickup time id options for the pickup method. For dropoff, it can return branch id, sender real name etc, depending on the 3PL requirements.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/logistics/get_booking_shipping_parameter
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 | 201214JASXYXY6 | Shopee's unique identifier for a booking. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | 2880a5a28510424eaa3288fd941fae2c | 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. | |
| response | object | Detail information you are querying. | |
| info_needed | object | The parameters required based on each specific booking to Init. Must use the fields included under info_needed to call Init. | |
| dropoff | string[] | [ ] | Could contain 'branch_id', 'sender_real_name' or 'tracking_no'. If it contains 'branch_id', choose one to Init. If it contains 'sender_real_name' or 'tracking_no', should manually input these values in Init API. If it has empty value, developer should still include "dropoff" field in Init API. |
| pickup | string[] | ["address_id", "pickup_time_id"] | Could contain 'address_id' and 'pickup_time_id'. Choose one address_id and its corresponding pickup_time_id to Init. If it has empty value, developer should still include "pickup" field in Init API.It could contains "tracking_number" returned from "info_need"for some channels, please also add it when init. |
| pickup | object | Logistics information for pickup mode booking. | |
| address_list | object[] | List of available pickup address info. | |
| address_id | int64 | 234 | The identity of address. |
| region | string | SG | The region of specify address. |
| state | string | Sarawak | The state of specify address. |
| city | string | The city of specify address. | |
| district | string | The district of specify address. | |
| town | string | haha | The town of specify address. |
| address | string | The address description of specify address. | |
| zipcode | string | 50003 | The zipcode of specify address. |
| address_flag | string[] | The flag of shop address, applicable values: default_address, pickup_address, return_address, current_address(only for multi-warehouse sellers) | |
| time_slot_list | object[] | List of pickup_time information corresponding to the address_id. Some logistics channels may not return any date or time for pickup time slots. In such cases, sellers can arrange shipment without selecting any time slot, and Shopee will arrange a suitable timing for these situations. | |
| date | timestamp | The date of pickup time. In timestamp. | |
| time_text | string | The text description of pickup time. Only applicable for certain channels. | |
| pickup_time_id | string | The identity of pickuptime. | |
| flags | string[] | ["recommended"] | This field will have the value “recommended” for the time slot that Shopee suggests sellers choose. While it is advisable for sellers to choose the recommended time slot, they can also choose other time slots that do not have the recommended flag. |
| error | string | return if error getting pickup time, otherwise omitted | |
| msg | string | return if error getting pickup time, otherwise omitted |