系统-国家设置-保存
系统设置 - 国家设置保存
接口信息
- 接口地址:
{your-site-url}/api/skill/system-setting/country-set
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
POST
- Content-Type:
application/json
- 说明: 此接口用于保存国家相关配置。该国配置用于订单结账页面收货地址部分,控制国家下拉列表的内容
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数 (JSON Body)
| 字段 |
类型 |
必填 |
说明 |
status |
int |
✅ 必填 |
展示国家类型。1 = 所有国家/地区,2 = 选中的国家/地区 |
countrys |
Array[string] |
✅ 必填 |
选中的国家简码数组。当 status 为 2 时有效,可传空数组。国家简码从得到国家和省列表 返回数据中 code 字段获取 |
sorts |
Array[string] |
✅ 必填 |
国家优先级排序。数组中的国家简码将优先显示到国家下拉列表的最顶部,可传空数组。国家简码从基础 - 获取国家列表 API 返回数据中 code 字段获取 |
请求示例
cURL
curl --location --request POST '{your-site-url}/api/skill/system-setting/country-set' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"status": 2,
"countrys": ["AL", "DZ", "CX", "CC"],
"sorts": ["AX", "AL"]
}'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": [],
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Array |
返回数据,目前为空数组 |
注意事项
- 所有字段均为必填
- 该配置影响订单结账页收货地址部分的国家下拉列表内容
status 为 1 时显示所有国家/地区,countrys 无效;status 为 2 时仅显示 countrys 中指定的国家
sorts 指定的国家会优先排列在下拉列表顶部
- 保存前必须先调用 系统-国家设置-获取 获取当前配置,然后修改需要的字段,再将所有字段一并提交保存
- 注意:api保存是全量保存,即时您只配置修改一个选项,也要进行全量保存,因此,先通过获取api得到数据,然后进行更改数据,然后进行保存