获取运单号
接口概述
用你自己为包裹分配的跟踪号换取该包裹的 WMG 运单号。当你的系统只保存了自己的单号、而打标签或查询轨迹需要 WMG 单号时使用本接口。
包裹必须已存在——请先通过 创建单个包裹 创建。
请求信息
- Method: POST
- Path:
/api/create-barcode - Authentication: Bearer Token
请求头
| 字段 | 说明 |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer <token> |
请求参数
请求体为 JSON 格式,包含以下字段:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| Barcode | string | 是 | 你为包裹分配的跟踪号(你自己的单号),最长 50 个字符。 |
| LabelType | string | 是 | 标签类型。目前仅支持 CN23。最长 10 个字符。 |
| Origin | string | 是 | 起运国家,2 位国家代码,如 SG 表示新加坡、TW 表示台湾。 |
| Destination | string | 是 | 目的国家,2 位国家代码,如 TW 表示台湾、JP 表示日本。 |
请求体示例
json
{
"Barcode": "CUST0001234567",
"LabelType": "CN23",
"Origin": "SG",
"Destination": "JP"
}认证方式
本接口使用 Bearer Token 认证。
请先通过 获取 Token 取得 Token,并以 Authorization: Bearer <Token> 形式发送。
响应信息
响应为 JSON 格式。
响应格式
| 字段 | 类型 | 说明 |
|---|---|---|
| Code | integer | 0 表示成功;非 0 表示失败 |
| Message | string | 可读的结果说明 |
| Data | object | 业务数据;失败时为空数组 [] |
成功响应
- Status Code: 200
json
{
"Code": 0,
"Message": "Success",
"Data": {
"Barcode": "CY180000662SG"
}
}| 字段 | 类型 | 说明 |
|---|---|---|
| Data.Barcode | string | 匹配到的包裹的 WMG 运单号。 |
错误响应
- Status Code: 200(业务逻辑错误)或 4xx/5xx(系统错误)
json
{
"Code": 1,
"Message": "Parcel not found",
"Data": []
}结果码
| Code | 说明 |
|---|---|
| 0 | 成功 |
| 1 | 失败 |
示例
Bash
bash
BASE_URL="https://api.postal.test.wmgdelivery.com"
TOKEN="your_access_token"
curl -X POST "$BASE_URL/api/create-barcode" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-d '{"Barcode":"CUST0001234567","LabelType":"CN23","Origin":"SG","Destination":"JP"}'Windows PowerShell
powershell
$BASE_URL = "https://api.postal.test.wmgdelivery.com"
$TOKEN = "your_access_token"
$body = @{
Barcode = "CUST0001234567"
LabelType = "CN23"
Origin = "SG"
Destination = "JP"
} | ConvertTo-Json
$response = Invoke-RestMethod -Uri "$BASE_URL/api/create-barcode" -Method Post `
-ContentType "application/json" -Body $body -Headers @{Authorization = "Bearer $TOKEN"}
$response | ConvertTo-Json -Depth 10Python
python
import requests
BASE_URL = "https://api.postal.test.wmgdelivery.com"
TOKEN = "your_access_token"
resp = requests.post(f"{BASE_URL}/api/create-barcode", json={
"Barcode": "CUST0001234567",
"LabelType": "CN23",
"Origin": "SG",
"Destination": "JP",
}, headers={"Authorization": f"Bearer {TOKEN}"}, timeout=10)
print(resp.json())Node.js / TypeScript
typescript
const BASE_URL = "https://api.postal.test.wmgdelivery.com";
const TOKEN = "your_access_token";
const res = await fetch(`${BASE_URL}/api/create-barcode`, {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer ${TOKEN}`,
},
body: JSON.stringify({
Barcode: "CUST0001234567",
LabelType: "CN23",
Origin: "SG",
Destination: "JP",
}),
});
console.log(await res.json());PHP
php
<?php
$BASE_URL = 'https://api.postal.test.wmgdelivery.com';
$TOKEN = 'your_access_token';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $BASE_URL . '/api/create-barcode');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'Authorization: Bearer ' . $TOKEN,
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
'Barcode' => 'CUST0001234567',
'LabelType' => 'CN23',
'Origin' => 'SG',
'Destination' => 'JP',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
$response = curl_exec($ch);
curl_close($ch);
echo json_encode(json_decode($response, true), JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) . "\n";
?>注意事项
- 包裹按「你的跟踪号 +
Origin+Destination」共同匹配,且只在你自己的账号范围内查找。任何一项不匹配都会返回Parcel not found。 Barcode、Origin、Destination在匹配前会被转为大写,因此这三个字段对本接口不区分大小写。LabelType只校验长度,不影响匹配哪个包裹。请传CN23。- 其余参数区分大小写。
错误码
| code | message | 说明 |
|---|---|---|
1 | Parcel not found | 你的账号下没有与 Barcode、Origin、Destination 全部匹配的包裹。 |
1 | Barcode require | Barcode 缺失或为空。 |
1 | max size of Barcode must be 50 | Barcode 超过 50 个字符。 |
1 | LabelType require | LabelType 缺失或为空。 |
1 | max size of LabelType must be 10 | LabelType 超过 10 个字符。 |
1 | Origin require | Origin 缺失或为空。 |
1 | max size of Origin must be 2 | Origin 超过 2 个字符。 |
1 | Destination require | Destination 缺失或为空。 |
1 | max size of Destination must be 2 | Destination 超过 2 个字符。 |
1 | Error encountered, please contact tech@wmg-group.com with screenshot of error page for resolution. | 未预期的服务端错误。 |
1003 | Token error | Token 缺失、已过期或被新登录顶替。请重新调用 获取 Token。 |