版权所有©,上海海鼎信息工程股份有限公司,2016-2025,保留所有权利。
1. 接口定义
1.1. 配送方案服务
1.1.1. 查询配送范围列表
POST /{tenant_id}/eshop/carrierschemeruleservice/carrier/scopes
1.1.1.1. 说明
查询配送范围列表
1.1.1.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户Id |
string |
Query |
carrier_id |
承运商ID:fengniao、meituan |
string |
Body |
storeIds |
门店列表,门店数量不能大于100 |
< string > array |
1.1.1.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
< CarrierScope > array |
1.1.1.4. HTTP请求示例
请求 path
/string/eshop/carrierschemeruleservice/carrier/scopes
请求 body
[ "string" ]
1.1.1.5. HTTP响应示例
响应 200
[ {
"carrierId" : "meituan",
"carrierMerchantId" : "02",
"type" : "meituan",
"shopId" : "10",
"storeId" : "3243545",
"coordinates" : [ {
"type" : "GCJ02",
"rangeId" : "0,1,2",
"rangeName" : "快递配送",
"rangeNo" : "1,2",
"latitude" : 118.5,
"longtitude" : 60.2
} ]
} ]
1.1.2. 获取平台门店配送方案
GET /{tenant_id}/eshop/carrierschemeruleservice/schemerule
1.1.2.1. 说明
获平台门店配送方案
1.1.2.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户Id |
string |
Query |
platform_id |
平台ID |
string |
Query |
shop_id |
平台商家ID |
string |
Query |
store_id |
门店ID |
string |
1.1.2.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
1.1.2.4. HTTP请求示例
请求 path
/string/eshop/carrierschemeruleservice/schemerule?platform_id=string&shop_id=string&store_id=string
1.1.2.5. HTTP响应示例
响应 200
{
"platformId" : "meituan",
"shopId" : "3243",
"storeId" : "32345355",
"source" : "store",
"state" : "applying",
"schemes" : [ {
"scopeSource" : "meituan",
"carrierMerchantId" : "meituan",
"selectCoordinate" : "1,2",
"scope" : {
"carrierId" : "meituan",
"carrierMerchantId" : "02",
"type" : "meituan",
"shopId" : "10",
"storeId" : "3243545",
"coordinates" : [ {
"type" : "GCJ02",
"rangeId" : "0,1,2",
"rangeName" : "快递配送",
"rangeNo" : "1,2",
"latitude" : 118.5,
"longtitude" : 60.2
} ]
},
"minAmount" : 5.25,
"freight" : 2.0,
"maxWeight" : 2.0,
"packageAmount" : 0.0,
"selfPackageAmount" : 0.0,
"selfOrderNoFeight" : true,
"freightDecs" : [ {
"type" : "string",
"conditions" : [ {
"minValue" : "2",
"maxValue" : "3",
"decValue" : 3.0,
"freeShipping" : true
} ]
} ],
"freightIncs" : [ {
"type" : "distance",
"conditions" : [ {
"minValue" : "2",
"maxValue" : "3",
"perValue" : 2.0,
"incValue" : 3.0
} ]
} ]
} ]
}
1.1.3. 获取配送方案列表
POST /{tenant_id}/eshop/carrierschemeruleservice/schemes
1.1.3.1. 说明
获取配送方案
1.1.3.2. 参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
tenant_id |
租户Id |
string |
Body |
filter |
方案过滤条件 |
1.1.3.3. 响应
HTTP代码 | 说明 | 类型 |
---|---|---|
200 |
successful operation |
< CarrierScheme > array |
1.1.3.4. HTTP请求示例
请求 path
/string/eshop/carrierschemeruleservice/schemes
请求 body
{
"storeId" : "0001",
"scopeSource" : "fengniao"
}
1.1.3.5. HTTP响应示例
响应 200
[ {
"scopeSource" : "meituan",
"carrierMerchantId" : "meituan",
"selectCoordinate" : "1,2",
"scope" : {
"carrierId" : "meituan",
"carrierMerchantId" : "02",
"type" : "meituan",
"shopId" : "10",
"storeId" : "3243545",
"coordinates" : [ {
"type" : "GCJ02",
"rangeId" : "0,1,2",
"rangeName" : "快递配送",
"rangeNo" : "1,2",
"latitude" : 118.5,
"longtitude" : 60.2
} ]
},
"minAmount" : 5.25,
"freight" : 2.0,
"maxWeight" : 2.0,
"packageAmount" : 0.0,
"selfPackageAmount" : 0.0,
"selfOrderNoFeight" : true,
"freightDecs" : [ {
"type" : "string",
"conditions" : [ {
"minValue" : "2",
"maxValue" : "3",
"decValue" : 3.0,
"freeShipping" : true
} ]
} ],
"freightIncs" : [ {
"type" : "distance",
"conditions" : [ {
"minValue" : "2",
"maxValue" : "3",
"perValue" : 2.0,
"incValue" : 3.0
} ]
} ]
} ]
2. 定义
2.1. CarrierScheme
配送方案
名称 | 说明 | 类型 |
---|---|---|
carrierMerchantId |
承运商家选择 |
string |
freight |
基础运费 |
number |
freightDecs |
运费扣减 |
< FreightDeduction > array |
freightIncs |
动态定价 |
< FreightIncrement > array |
maxWeight |
重量限制,单位g |
number |
minAmount |
起送金额 |
number |
packageAmount |
包装费 |
number |
scope |
配送范围,获取门店配送方案(门店维度)级联出配送范围 |
|
scopeSource |
配送范围来源:meituan(美团快递)… |
string |
selectCoordinate |
配送范围选择range_no |
string |
selfOrderNoFeight |
自提订单免起送价 |
boolean |
selfPackageAmount |
自提包装费 |
number |
2.2. CarrierSchemeFilter
配送方案过滤器
名称 | 说明 | 类型 |
---|---|---|
scopeSource |
配送范围来源:fengniao、meituan |
string |
storeId |
门店ID |
string |
2.3. CarrierSchemeRule
门店配送方案规则
名称 | 说明 | 类型 |
---|---|---|
platformId |
平台ID |
string |
schemes |
配送方案列表 |
< CarrierScheme > array |
shopId |
平台商家ID |
string |
source |
来源:store(门店)、shop(商家),可能为空,保存不需要传,获取时该字段区分方案的维度 |
string |
state |
状态:applying(开通中)、opened(已开通) |
enum (applying, opened) |
storeId |
门店ID |
string |
2.4. CarrierScope
承运范围
名称 | 说明 | 类型 |
---|---|---|
carrierId |
承运商ID |
string |
carrierMerchantId |
承运平台商家 |
string |
coordinates |
坐标范围 |
< Coordinate > array |
shopId |
平台商家ID |
string |
storeId |
门店Id |
string |
type |
承运类型 |
string |
2.5. Coordinate
坐标范围
名称 | 说明 | 类型 |
---|---|---|
latitude |
纬度 |
number |
longtitude |
经度 |
number |
rangeId |
标识id,可以认为是一个分组 |
string |
rangeName |
名称 |
string |
rangeNo |
范围序号 |
string |
type |
坐标类型:BD09(百度坐标)、GCJ02(火星坐标)、WGS84(WGS84坐標) |
string |
2.6. DeductionCondition
名称 | 说明 | 类型 |
---|---|---|
decValue |
扣减量,(eg:加价3元,3即扣减量) |
number |
freeShipping |
包邮 |
boolean |
maxValue |
条件最大值 |
string |
minValue |
条件最小值 |
string |
2.7. FreightDeduction
运费满减
名称 | 说明 | 类型 |
---|---|---|
conditions |
扣减条件(规则) |
< DeductionCondition > array |
type |
样例 : |
string |
2.8. FreightIncrement
运费加价
名称 | 说明 | 类型 |
---|---|---|
conditions |
加价条件(规则) |
< IncrementCondition > array |
type |
加价类型:distance(距离加价)、time_slot(时段加价)、weight(重量加价) |
string |
2.9. IncrementCondition
加价条件
名称 | 说明 | 类型 |
---|---|---|
incValue |
增加量,(eg:加价3元,3即增加量) |
number |
maxValue |
条件最大值,距离加价和重量加价时为数字(最多1位小数),时段加价格式为HH:mm |
string |
minValue |
条件最小值,距离加价和重量加价时为数字(最多1位小数),时段加价格式为HH:mm |
string |
perValue |
每单位值,(目前重量加价有此值,eg:重量加价时,每2kg加价1元,2即每单位值) |
number |