系统物流-配送方案-已配置的国家列表
物流 - 获取已选配送国家和省份列表
接口信息
- 接口地址:
{your-site-url}/api/skill/shipping/get-shipping-selected-country-and-provinces - 基础 URL:
{your-site-url}需替换为你自己的独立站 URL 地址,如https://your-domain.com/apimanager666 - 请求方式:
GET - 说明: 此接口用于创建或更新配送区域时,获取当前物流方案中已被配送区域占用的国家和省份列表。已被占用的国家和省份不可再被其他配送区域选择
认证
请求头中需要携带 skill-access-token:
| Header | 值 |
|---|---|
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数 (Query String)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
shipping_id |
int | ✅ 必填 | 物流方案 ID |
shipping_zone_id |
int | 选填 | 配送区域 ID。创建配送区域时不需要填写;更新配送区域时必填 |
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/shipping/get-shipping-selected-country-and-provinces?shipping_id=51&shipping_zone_id=101' \
--header 'skill-access-token: {your-skill-access-token}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"selectedCountryAndProvinces": [
{
"country": "AU",
"province": [
"ACT",
"NSW",
"NT",
"QLD",
"SA",
"TAS",
"VIC",
"WA"
]
}
]
},
"message": "success"
}
返回字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
code |
Number | 状态码,200 表示成功 |
message |
String | 执行结果的文字描述 |
data |
Object | 返回数据 |
data.selectedCountryAndProvinces |
Array[Object] | 该配送区域已选的国家和省份列表 |
data.selectedCountryAndProvinces[].country |
string | 国家简码 |
data.selectedCountryAndProvinces[].province |
Array[string] | 该国家已选的省份代码数组。空数组 [] 表示选中该国家所有省份 |
注意事项
shipping_id必填,shipping_zone_id选填- 此接口用于创建或更新配送区域时,获取主站中已被配送区域占用的国家和省份列表。已被占用的国家和省份不可再被其他配送区域选择,避免国家和省份重复出现在多个 zone 中
shipping_zone_id不传时返回该物流方案下所有已占用的国家和省份;传入时返回除该 zone 自身以外的已占用国家和省份(用于更新场景)