获取运费接口

提供运费计算能力，支持根据商品信息、发货及收货相关信息计算运费，可精准计算并返回运费价格、币种信息等内容。

适用场景

计算特定商品在指定发货区域、仓库及收货地址等条件下的运费

判断物流是否可达

接口类型

POST

请求频率限制

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

请求说明

请求URL

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

请求参数

Header参数

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

Body参数

根字段

参数名	类型	必填	默认值	可选值	说明
skus	array	是	-	-	商品SKU列表（最多不超过20个）
countryCode	string	是	-	-	国家二字码
deliveryRegionCode	string	是	-	-	发货区域编码(与仓库ID不能同时为空)
depotId	integer	是	-	-	仓库ID(与发货区域编码不能同时为空)
zipcode	string	否	-	-	邮编（填写后，可以更精准计算运费）
zone	string	否	-	-	省、州名称（填写后，可以更精准计算运费）
city	string	否	-	-	城市名称（填写后，可以更精准计算运费）
county	string	否	-	-	县区、乡镇名称（填写后，可以更精准计算运费）
freightOperatorCode	string	否	-	-	运营商编码
isCanDelivery	integer	否	0	1是、0否	是否判断物流可达

skus数组字段

参数名	类型	必填	默认值	可选值	说明
product_sku	string	是	-	-	商品sku
quantity	integer	是	-	-	商品数量

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
code	integer	业务状态码（0表示成功，1表示服务错误，2表示参数错误，3表示授权无效，4表示请求上限）
msg	string	错误描述
data	object	业务数据（运费及相关信息）

data对象字段

字段	类型	说明
freight	integer	运费价格
deliveryRegionCode	string	发货区域编码
depotId	integer	仓库id
isCanDelivery	integer	物流是否可达（1是；0否）
currency	object	币种信息对象
freightOperatorCode	string	渠道code

currency对象字段

字段	类型	说明
name	string	币种名称
code	string	币种code
symbol_left	string	币种标识前缀
symbol_right	string	币种标识后缀
decimal_place	string	小数位数

调用示例

URL请求

请求示例

{
    "countryCode": "US",
    "deliveryRegionCode": "US",
    "depotId": 3,
    "zone": "KENTUCKY",
    "city": "London",
    "zipcode": "40741",
    "county": "usstreest",
    "skus": [
        {
            "product_sku": "JH-C01-0151-01",
            "quantity": 9
        }
    ],
    "freightOperatorCode": "20648",
    "isCanDelivery": 1
}

成功返回示例

{
    "code": 0,
    "msg": "",
    "data": {
        "freight": "0.00",
        "deliveryRegionCode": "US",
        "depotId": 3
    }
}

失败返回示例

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

错误处理

公共错误码

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

常见问题

Q1：为什么填写了邮编、城市等信息后，运费计算更精准？

A：邮编、城市等信息能帮助系统更准确地定位收货地址，结合物流商的计费规则，从而更精准地计算出运费。

Q2：isCanDelivery参数设置为1时，返回结果中isCanDelivery为0表示什么？

A：表示根据当前填写的信息判断，该物流不可达至指定地址。

版本历史

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

请求参数

Header 参数

Body 参数application/json

示例

{
    "countryCode": "US",
    "deliveryRegionCode": "US",
    "depotId": 3,
    "zone": "KENTUCKY",
    "city": "London",
    "zipcode": "40741",
    "county": "usstreest",
    "skus": [
        {
            "product_sku": "JH-C01-0151-01",
            "quantity": 9
        }
    ],
    "freightOperatorCode": "20648",
    "isCanDelivery": 1
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": {
        "freight": 20,
        "deliveryRegionCode": "US",
        "depotId": 2,
        "isCanDelivery": 1,
        "currency": {
            "name": "人民币",
            "code": "CNY",
            "symbol_left": "￥",
            "symbol_right": "",
            "decimal_place": "2"
        },
        "freightOperatorCode": "DEFAULTZG"
    }
}

获取运费接口

获取运费接口#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Body参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

常见问题#

Q1：为什么填写了邮编、城市等信息后，运费计算更精准？#

Q2：isCanDelivery参数设置为1时，返回结果中isCanDelivery为0表示什么？#

版本历史#

请求参数

请求示例代码

返回响应

获取运费接口

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：为什么填写了邮编、城市等信息后，运费计算更精准？

Q2：isCanDelivery参数设置为1时，返回结果中isCanDelivery为0表示什么？

版本历史