发货区域列表接口

提供发货区域列表的查询能力，支持根据国家二字码筛选特定的发货区域信息。

适用场景

查询所有发货区域列表

根据国家二字码查询特定的发货区域信息

接口类型

GET

请求频率限制

默认频率：以平台配额为准

请求说明

请求URL

正式环境：https://www.westmonth.com/openapi/productCategory/getDeliveryRegions
测试环境：https://testing.westmonth.com/openapi/productCategory/getDeliveryRegions

请求参数

Header参数

参数名	类型	必填	示例值	说明
Authorization	string	是	authorization	身份验证Token
Content-Type	string	是	application/json	建议固定传此值

Query参数

参数名	类型	必填	默认值	可选值	说明
code	string	否	-	-	国家二字码，用于筛选特定国家的发货区域

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
status	string	状态（success：成功）
message	string	响应信息描述
data	array	业务数据（发货区域列表）

data数组字段

字段	类型	说明
id	integer	区域ID
name	string	区域名称
code	string	区域编码（国家二字码）
logo	string	区域LOGO的URL地址

调用示例

URL请求

请求示例

成功返回示例

{
    "status": "success",
    "message": "success",
    "data": [
        {
            "id": 5,
            "name": "中国",
            "code": "CN",
            "logo": "https://oss.westmonth.com/catalog/delivery_regions/中国国旗.svg"
        }
    ]
}

失败返回示例

{
    "code": 3,
    "msg": "授权无效 authorization timestamp error",
    "data": []
}

错误处理

公共错误码

HTTP status code	错误码	错误信息	描述

常见问题

Q1：不传入code参数时会返回什么结果？

A：不传入code参数时，将返回所有可用的发货区域列表信息。

Q2：如何判断返回的发货区域是否为有效的国家区域？

A：可通过code字段判断，若code字段为有效的国家二字码，则该区域为国家区域；若code字段为空，则可能为测试区域等非国家区域。

版本历史

版本	日期	修改说明
v1.0	2025-01-01	初始版本

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "status": "success",
    "message": "success",
    "data": [
        {
            "id": 5,
            "name": "中国",
            "code": "CN",
            "logo": "https://catalog/172630185958_中国国旗.png"
        },
        {
            "id": 22,
            "name": "test_fahuo",
            "code": "",
            "logo": "https://westmonth/20250326174635356076.jpg"
        },
        {
            "id": 23,
            "name": "test",
            "code": "",
            "logo": "https://westmonth/20250403170638318223.png"
        }
    ]
}

发货区域列表

发货区域列表接口#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Query参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

常见问题#

Q1：不传入code参数时会返回什么结果？#

Q2：如何判断返回的发货区域是否为有效的国家区域？#

版本历史#

请求参数

请求示例代码

返回响应

发货区域列表接口

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Query参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：不传入code参数时会返回什么结果？

Q2：如何判断返回的发货区域是否为有效的国家区域？

版本历史