v2.logistics.get_mass_shipping_parameter

POST /api/v2/logistics/get_mass_shipping_parameter

Use this api to check if package support pickup, dropoff, non-integrated. For pickup, return address and pickup time id options. For dropoff, return branch id, sender real name, etc. Can batch request for packages under same product_location_id and logistics_channel_id. [Please call it when packages meet: 1) fulfillment status is LOGISTICS_READY; or 2) fulfillment status is LOGISTICS_PICKUP_RETRY; or 3) fulfillment status is LOGISTICS_REQUEST_CREATED and meet Instant Order Reschedule conditions]

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/logistics/get_mass_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
logistics_channel_id	int64	False	50021	The API can only batch request the shipping parameter for multiple packages under the same product_location_id and same logistics_channel_id.  Use this field to specify the logistics_channel_id for the request. If not specified, will use the logistics_channel_id corresponds to the first package_number by default.
product_location_id	string	False	"VN0002BIZ"	The API can only batch request the shipping parameter for multiple packages under the same product_location_id and same logistics_channel_id.  Use this field to specify the product_location_id for the request. If not specified, will use the product_location_id corresponds to the first package_number by default.
package_list	object[]	True		The list of packages you want to get shipping parameters. limit [1, 50].
package_number	string	True	["OFG188728166212046"]	Shopee's unique identifier for the package under an order. You shouldn't fill the field with empty string when there isn't a package number.

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.	Indicate error details if hit error. Empty if no error happened.<path></path><path></path>
response	object
info_needed	object		The parameters required based on each specific order to Init. Must use the fields included under info_needed to call Init. For logistic_id 80003 and 80004, both Regular and JOB shipping methods are supported. If you choose Regular shipping method, please use "tracking_no" to call Init API. If you choose JOB shipping method, please use "sender_real_name" to call Init API. Note that only one of "tracking_no" and "sender_real_name" can be selected.
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.
non_integrated	string[]		Could contain 'tracking_no'. If it contains 'tracking_no', should manually input these values in Init API. If it has empty value, developer should still include "non-integrated" field in Init API.
dropoff	object		Logistics information for dropoff mode package.
branch_list	object[]		List of available dropoff branches info.
branch_id	int64		The identity of logistics branch.
region	string		The region of specify address.
state	string		The state of specify address.
city	string		The city of specify address.
address	string		The address description of specify address.
zipcode	string		The zipcode of specify address.
district	string		The district of specify address.
town	string		The town of specify address.
pickup	object		Logistics information for pickup mode package.
address_list	object[]		List of available pickup address info. For Multi-Warehouse sellers, note that changing pickup address from Current may incur higher shipping fees.
address_id	int64		The identity of address.
region	string		The region of specify address.
state	string		The state of specify address.
city	string		The city of specify address.
district	string		The district of specify address.
town	string		The town of specify address.
address	string		The address description of specify address.
zipcode	string		The zipcode of specify address.
address_flag	string[]		The flag of shop address, applicable values: default_address, pickup_address, return_address, current_address (Multi-Warehouse sellers only)
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.
success_list	object[]		Success package list.
package_number	string		Shopee's unique identifier for the package under an order.
fail_list	object[]		Fail package list.
package_number	string		Shopee's unique identifier for the package under an order.
fail_reason	string		Reason for failure.

, { "package_number": "OFG189588735210225" }, { "package_number": "OFG190576613214356" } ], "logistics_channel_id": 50021, "product_location_id": "VN0002BIZ" }