v2.first_mile.generate_and_bind_first_mile_tracking_number

POST /api/v2/first_mile/generate_and_bind_first_mile_tracking_number

Use this api to generate first mile tracking number for courier delivery method.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/first_mile/generate_and_bind_first_mile_tracking_number

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
shipment_method	string	True	courier_delivery	The shipment method for generate and bind orders. Available value: courier_delivery.
region	string	False	CN	Use this field to specify the region you want to ship parcel. Available value: CN.
order_list	object[]	True		The list of order_sn. You can specify up to 50 order_sns in this call. One fm_tn maximum number of total bind orders is 10000.
order_sn	string	True	2410106R7TSAJR	Shopee's unique identifier for an order.
package_number	string	False		Shopee's unique identifier for the package under an order. You should fill the field with empty string when there isn't a package number.
courier_delivery_info	object	True		The set of information you need to generate FM tracking number and bind orders.
address_id	int64	True	11222	The identity of address. Retrieved from v2.logistics.get_address_list, address_type need to be FIRST_MILE_PICKUP_ADDRESS.
warehouse_id	string	True	ECP04	The identity of transit warehouse address. Retrieved from v2.first_mile.get_transit_warehouse_list.
logistics_product_id	int64	True	1010004	The definition of logistics product ID: 1010003 (kuaidi100 to C) - seller book courier pickup and pay offline 1010004 (kuaidi100 prepaid(MP)) - seller can use prepaid account to place courier order, so prepaid_account_id is required
prepaid_account_id	int64	False	21	ID of prepaid account. Retrieved from v2.merchant.get_merchant_prepaid_account_list.
courier_service_id	string	True	LCN70002	The identity of courier service. Retrieved from v2.first_mile.get_courier_delivery_channel_list.

Response Parameters

Name	Type	Sample	Description
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
request_id	string		The identifier for an API request for error tracking.
response	object
binding_id	string	DCN249601021852HU	Binding ID
success_list	object[]
order_sn	string	2410106R7TSAJR	Shopee's unique identifier for an order.
package_number	string		Shopee's unique identifier for the package under an order.
fail_list	object[]
order_sn	string	2004239MRBBFPJ	Shopee's unique identifier for an order.
package_number	string		Shopee's unique identifier for the package under an order.
fail_error	string	firstmile.package_has_bind	Indicate error type if one element hit error.
fail_message	string	Package (order_sn: 2004239MRBBFPJ, package_number: ) has been bind to first mile code.	Indicate error details if one element hit error.