v2.logistics.get_booking_shipping_parameter

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:12:53

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 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.

§2 Overview

Overview

Field	Value
Module	Logistics
API type	Shop
HTTP method	GET
Path	/api/v2/logistics/get_booking_shipping_parameter
Production URL	https://partner.shopeemobile.com/api/v2/logistics/get_booking_shipping_parameter
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/logistics/get_booking_shipping_parameter
Permission	ERP System; Seller In House System; Order Management; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
booking_sn	string	Yes	201214JASXYXY6	Shopee's unique identifier for a booking.

§4 Response parameters

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.
response.info_needed	object		The parameters required based on each specific booking to Init. Must use the fields included under info_needed to call Init.
response.info_needed.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.
response.info_needed.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.
response.pickup	object		Logistics information for pickup mode booking.
response.pickup.address_list	object[]		List of available pickup address info.
response.pickup.address_list.address_id	int64	234	The identity of address.
response.pickup.address_list.region	string	SG	The region of specify address.
response.pickup.address_list.state	string	Sarawak	The state of specify address.
response.pickup.address_list.city	string		The city of specify address.
response.pickup.address_list.district	string		The district of specify address.
response.pickup.address_list.town	string	haha	The town of specify address.
response.pickup.address_list.address	string		The address description of specify address.
response.pickup.address_list.zipcode	string	50003	The zipcode of specify address.
response.pickup.address_list.address_flag	string[]		The flag of shop address, applicable values: default_address, pickup_address, return_address, current_address(only for multi-warehouse sellers)
response.pickup.address_list.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.
response.pickup.address_list.time_slot_list.date	timestamp		The date of pickup time. In timestamp.
response.pickup.address_list.time_slot_list.time_text	string		The text description of pickup time. Only applicable for certain channels.
response.pickup.address_list.time_slot_list.pickup_time_id	string		The identity of pickuptime.
response.pickup.address_list.time_slot_list.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.
response.pickup.address_list.time_slot_list.error	string		return if error getting pickup time, otherwise omitted
response.pickup.address_list.time_slot_list.msg	string		return if error getting pickup time, otherwise omitted

§5 Common parameters

Common 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

§6 Request samples

Request samples

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://open.admin.uat.shopee.io/api/v2/logistics/get_booking_shipping_parameter?access_token=access_token&booking_sn=201214JASXYXY6&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://open.admin.uat.shopee.io/api/v2/logistics/get_booking_shipping_parameter?access_token=access_token&booking_sn=201214JASXYXY6&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

§9 cURL

cURL

curl --location --request GET 'https://open.admin.uat.shopee.io/api/v2/logistics/get_booking_shipping_parameter?access_token=access_token&booking_sn=201214JASXYXY6&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp'

§10 Python

Python

import requests

url = "https://open.admin.uat.shopee.io/api/v2/logistics/get_booking_shipping_parameter?access_token=access_token&booking_sn=201214JASXYXY6&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

§11 Response sample

Response sample

§12 JSON

JSON

{
	"request_id": "2880a5a28510424eaa3288fd941fae2c",
	"error": "error_auth",
	"message": "Invalid access_token.",
	"response": {
		"info_needed": {
			"dropoff": [],
			"pickup": [
				"address_id",
				"pickup_time_id"
			]
		},
		"pickup": {
			"address_list": [
				{
					"region": "SG",
					"state": "Sarawak",
					"city": "-",
					"district": "-",
					"town": "haha",
					"address": "-",
					"zipcode": "50003",
					"address_flag": [
						"-"
					],
					"time_slot_list": [
						{
							"date": 1718341672250,
							"time_text": "-",
							"pickup_time_id": "-",
							"error": "-",
							"msg": "-"
						}
					]
				}
			]
		}
	}
}

§13 Error example

Error example

§14 JSON

JSON

{
   "error": "error_server",
   "message": "System error. Please try again later.",
   "request_id": "3aed6e1a6d8f4409ac3db19f893261a4"
}

§15 Errors

Errors

Error	Description	Solution
logistics.invalid_address_version	Some addresses are no longer supported per new regulation, please update to avoid wrong fulfilment
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_param	request not from gateway
logistics.product_location_mismatch	Pickup address does not match product location. Please check warehouse configuration

§16 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

§17 Update log

Update log

Date	Change
2025-03-24	Add “flags” response parameter under time_slot_list
2024-07-02	New API

这条内容对你有帮助吗？