快工助手跨境电商知识与商机助手

v2.first_mile.generate_and_bind_first_mile_tracking_number

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

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

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.first_mile.generate_and_bind_first_mile_tracking_number

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

#

§2 Overview

Overview

FieldValue
ModuleFirstMile
API typeShop
HTTP methodPOST
Path/api/v2/first_mile/generate_and_bind_first_mile_tracking_number
Production URLhttps://partner.shopeemobile.com/api/v2/first_mile/generate_and_bind_first_mile_tracking_number
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/first_mile/generate_and_bind_first_mile_tracking_number
PermissionERP System; Seller In House System; Order Management; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
shipment_methodstringYescourier_deliveryThe shipment method for generate and bind orders. Available value: courier_delivery.
regionstringNoCNUse this field to specify the region you want to ship parcel. Available value: CN.
order_listobject[]YesThe 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_list.order_snstringYes2410106R7TSAJRShopee's unique identifier for an order.
order_list.package_numberstringNoShopee'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_infoobjectYesThe set of information you need to generate FM tracking number and bind orders.
courier_delivery_info.address_idint64Yes11222The identity of address. Retrieved from v2.logistics.get_address_list, address_type need to be FIRST_MILE_PICKUP_ADDRESS.
courier_delivery_info.warehouse_idstringYesECP04The identity of transit warehouse address. Retrieved from v2.first_mile.get_transit_warehouse_list.
courier_delivery_info.logistics_product_idint64Yes1010004The 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
courier_delivery_info.prepaid_account_idint64No21ID of prepaid account. Retrieved from v2.merchant.get_merchant_prepaid_account_list.
courier_delivery_info.courier_service_idstringYesLCN70002The identity of courier service. Retrieved from v2.first_mile.get_courier_delivery_channel_list.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
request_idstringThe identifier for an API request for error tracking.
responseobject
response.binding_idstringDCN249601021852HUBinding ID
response.success_listobject[]
response.success_list.order_snstring2410106R7TSAJRShopee's unique identifier for an order.
response.success_list.package_numberstringShopee's unique identifier for the package under an order.
response.fail_listobject[]
response.fail_list.order_snstring2004239MRBBFPJShopee's unique identifier for an order.
response.fail_list.package_numberstringShopee's unique identifier for the package under an order.
response.fail_list.fail_errorstringfirstmile.package_has_bindIndicate error type if one element hit error.
response.fail_list.fail_messagestringPackage (order_sn: 2004239MRBBFPJ, package_number: ) has been bind to first mile code.Indicate error details if one element hit error.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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 Payload

Payload

{
	"shipment_method": "courier_delivery",
	"region": "CN",
	"order_list": [
		{
			"order_sn": "2410106R7TSAJR"
		},
		{
			"order_sn": "2004239MRBBFPJ"
		}
	],
	"courier_delivery_info": {
		"address_id": 11222,
		"warehouse_id": "ECP04",
		"logistics_product_id": 1010004,
		"prepaid_account_id": 21,
		"courier_service_id": "LCN70002"
	}
}
#

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/first_mile/generate_and_bind_first_mile_tracking_number?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"courier_delivery_info\": {
      \"address_id\": 11222,
      \"courier_service_id\": \"LCN70002\",
      \"logistics_product_id\": 1010004,
      \"prepaid_account_id\": 21,
      \"warehouse_id\": \"ECP04\"
   },
   \"order_list\": [
      {
         \"order_sn\": \"2410106R7TSAJR\"
      },
      {
         \"order_sn\": \"2004239MRBBFPJ\"
      }
   ],
   \"region\": \"CN\",
   \"shipment_method\": \"courier_delivery\"
}")
.asString();
#

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/first_mile/generate_and_bind_first_mile_tracking_number?access_token=access_token&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 => 'POST',
  CURLOPT_POSTFIELDS => '{
    "courier_delivery_info": {
        "address_id": 11222,
        "courier_service_id": "LCN70002",
        "logistics_product_id": 1010004,
        "prepaid_account_id": 21,
        "warehouse_id": "ECP04"
    },
    "order_list": [
        {
            "order_sn": "2410106R7TSAJR"
        },
        {
            "order_sn": "2004239MRBBFPJ"
        }
    ],
    "region": "CN",
    "shipment_method": "courier_delivery"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§10 cURL

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/first_mile/generate_and_bind_first_mile_tracking_number?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "courier_delivery_info": {
      "address_id": 11222,
      "courier_service_id": "LCN70002",
      "logistics_product_id": 1010004,
      "prepaid_account_id": 21,
      "warehouse_id": "ECP04"
   },
   "order_list": [
      {
         "order_sn": "2410106R7TSAJR"
      },
      {
         "order_sn": "2004239MRBBFPJ"
      }
   ],
   "region": "CN",
   "shipment_method": "courier_delivery"
}'
#

§11 Python

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/first_mile/generate_and_bind_first_mile_tracking_number?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "courier_delivery_info": {
    "address_id": 11222,
    "courier_service_id": "LCN70002",
    "logistics_product_id": 1010004,
    "prepaid_account_id": 21,
    "warehouse_id": "ECP04"
  },
  "order_list": [
    {
      "order_sn": "2410106R7TSAJR"
    },
    {
      "order_sn": "2004239MRBBFPJ"
    }
  ],
  "region": "CN",
  "shipment_method": "courier_delivery"
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§12 Response sample

Response sample

#

§13 JSON

JSON

{
    "error": "",
    "message": "",
    "request_id": "317a860d24a78058b47d1a5ae67ff700:040000d06621af77:0300021f9befdc9c",
    "response": {
        "binding_id": "DCN241681623620GU",
        "success_list": [
            {
                "order_sn": "2410106R7TSAJR",
                "package_number": null
            }
        ]
        "fail_list": [
            {
                "order_sn": "2004239MRBBFPJ",
                "package_number": "",
                "fail_error": "firstmile.package_has_bind",
                "fail_message": "Package (order_sn: 2004239MRBBFPJ, package_number: ) has been bind to first mile code."
            }
        ]
    }
}
#

§14 Errors

Errors

ErrorDescriptionSolution
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_shopshopid is invalid
error_paramrequest not from gateway
#

§15 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp 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_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe 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_suspendedThe API is offline. Please call v2 API instead.
error_limitThe 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_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour 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_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§16 Update log

Update log

DateChange
2024-10-29New API
#