stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§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
| Field | Value |
|---|---|
| Module | FirstMile |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/first_mile/generate_and_bind_first_mile_tracking_number |
| Production URL | https://partner.shopeemobile.com/api/v2/first_mile/generate_and_bind_first_mile_tracking_number |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/first_mile/generate_and_bind_first_mile_tracking_number |
| Permission | ERP System; Seller In House System; Order Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| shipment_method | string | Yes | courier_delivery | The shipment method for generate and bind orders. Available value: courier_delivery. |
| region | string | No | CN | Use this field to specify the region you want to ship parcel. Available value: CN. |
| order_list | object[] | Yes | 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_list.order_sn | string | Yes | 2410106R7TSAJR | Shopee's unique identifier for an order. |
| order_list.package_number | string | No | 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 | Yes | The set of information you need to generate FM tracking number and bind orders. | |
| courier_delivery_info.address_id | int64 | Yes | 11222 | The identity of address. Retrieved from v2.logistics.get_address_list, address_type need to be FIRST_MILE_PICKUP_ADDRESS. |
| courier_delivery_info.warehouse_id | string | Yes | ECP04 | The identity of transit warehouse address. Retrieved from v2.first_mile.get_transit_warehouse_list. |
| courier_delivery_info.logistics_product_id | int64 | Yes | 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 |
| courier_delivery_info.prepaid_account_id | int64 | No | 21 | ID of prepaid account. Retrieved from v2.merchant.get_merchant_prepaid_account_list. |
| courier_delivery_info.courier_service_id | string | Yes | LCN70002 | The identity of courier service. Retrieved from v2.first_mile.get_courier_delivery_channel_list. |
§4 Response parameters
Response parameters
| Name | Type | Required | 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 | |||
| response.binding_id | string | DCN249601021852HU | Binding ID | |
| response.success_list | object[] | |||
| response.success_list.order_sn | string | 2410106R7TSAJR | Shopee's unique identifier for an order. | |
| response.success_list.package_number | string | Shopee's unique identifier for the package under an order. | ||
| response.fail_list | object[] | |||
| response.fail_list.order_sn | string | 2004239MRBBFPJ | Shopee's unique identifier for an order. | |
| response.fail_list.package_number | string | Shopee's unique identifier for the package under an order. | ||
| response.fail_list.fail_error | string | firstmile.package_has_bind | Indicate error type if one element hit error. | |
| response.fail_list.fail_message | string | Package (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
| Name | Type | Required | 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 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×tamp=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×tamp=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×tamp=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×tamp=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
| Error | Description | Solution |
|---|---|---|
| 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 |
§15 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. |
§16 Update log
Update log
| Date | Change |
|---|---|
| 2024-10-29 | New API |
