v2.logistics.mass_ship_order

POST /api/v2/logistics/mass_ship_order

Use this api to initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels. Should call v2.logistics.get_mass_shipping_parameter to fetch all required params first. It's recommended to initiate logistics one hour after the orders were placed since there is one-hour window buyer can cancel any order without request to seller. The API can only batch arrange shipment for multiple packages under the same product_location_id and same logistics_channel_id.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/logistics/mass_ship_order

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 arrange shipment 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		The API can only batch arrange shipment 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 arrange shipment. limit [1, 50].
package_number	string	True		Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number.
pickup	object	False		Required parameter ONLY if GetParameterForInit returns "pickup" or if GetLogisticsInfo returns "pickup" under "info_needed" for the same order. Developer should still include "pickup" field in the call even if "pickup" has empty value.
address_id	int64	False		The identity of address.
pickup_time_id	string	False		The pickup time id. Retrieved from v2.logistics.get_mass_shipping_parameter, you can only select one from the time_slot_list. 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.
dropoff	object	False		Required parameter ONLY if GetParameterForInit returns "dropoff" or if GetLogisticsInfo returns "dropoff" under "info_needed" for the same order. Developer should still include "dropoff" field in the call even if "dropoff" has empty value. 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.
branch_id	int64	False	0	The identity of branch.
sender_real_name	string	False		The real name of sender.
tracking_number	string	False		Need input this field when "tracking_number" is returned from "info_need". Please note that this tracking number is assigned by third-party shipping carrier for item shipment.
non_integrated	object	False		Optional parameter when get_mass_shipping_parameter returns "non-integrated" under "info_needed".
tracking_number	object[]	False		Optional parameter for non-integrated channel order. The tracking number assigned by the shipping carrier for item shipment.
package_number	string	True		Shopee's unique identifier for the package under an order.
tracking_number	string	True		Optional parameter for non-integrated channel order. The tracking number assigned by the shipping carrier for item shipment.

Response Parameters

Name	Type	Sample	Description
request_id	string	3dad66f43b8447d282ae6da36626c6b7	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.
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": "OFG192433773204150" } ], "pickup": { "address_id": 200000015, "pickup_time_id": "1737104400_5" } }