版权所有©,上海海鼎信息工程股份有限公司,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
可选

承运商家选择
样例 : "meituan"

string

freight
可选

基础运费
样例 : 2.0

number

freightDecs
可选

运费扣减
样例 : [ "FreightDeduction" ]

< FreightDeduction > array

freightIncs
可选

动态定价
样例 : [ "FreightIncrement" ]

< FreightIncrement > array

maxWeight
可选

重量限制,单位g
样例 : 2.0

number

minAmount
可选

起送金额
样例 : 5.25

number

packageAmount
可选

包装费
样例 : 0.0

number

scope
可选

配送范围,获取门店配送方案(门店维度)级联出配送范围
样例 : CarrierScope

scopeSource
必填

配送范围来源:meituan(美团快递)…
样例 : "meituan"

string

selectCoordinate
可选

配送范围选择range_no
样例 : "1,2"

string

selfOrderNoFeight
可选

自提订单免起送价
默认值 : false
样例 : true

boolean

selfPackageAmount
可选

自提包装费
样例 : 0.0

number

2.2. CarrierSchemeFilter

配送方案过滤器

名称 说明 类型

scopeSource
必填

配送范围来源:fengniao、meituan
样例 : "fengniao"

string

storeId
必填

门店ID
样例 : "0001"

string

2.3. CarrierSchemeRule

门店配送方案规则

名称 说明 类型

platformId
必填

平台ID
样例 : "meituan"

string

schemes
可选

配送方案列表
样例 : [ "CarrierScheme" ]

< CarrierScheme > array

shopId
必填

平台商家ID
样例 : "3243"

string

source
可选

来源:store(门店)、shop(商家),可能为空,保存不需要传,获取时该字段区分方案的维度
样例 : "store"

string

state
必填

状态:applying(开通中)、opened(已开通)
样例 : "applying"

enum (applying, opened)

storeId
必填

门店ID
样例 : "32345355"

string

2.4. CarrierScope

承运范围

名称 说明 类型

carrierId
可选

承运商ID
样例 : "meituan"

string

carrierMerchantId
可选

承运平台商家
样例 : "02"

string

coordinates
可选

坐标范围
样例 : [ "Coordinate" ]

< Coordinate > array

shopId
可选

平台商家ID
样例 : "10"

string

storeId
可选

门店Id
样例 : "3243545"

string

type
可选

承运类型
样例 : "meituan"

string

2.5. Coordinate

坐标范围

名称 说明 类型

latitude
可选

纬度
样例 : 118.5

number

longtitude
可选

经度
样例 : 60.2

number

rangeId
可选

标识id,可以认为是一个分组
样例 : "0,1,2"

string

rangeName
可选

名称
样例 : "快递配送"

string

rangeNo
可选

范围序号
样例 : "1,2"

string

type
可选

坐标类型:BD09(百度坐标)、GCJ02(火星坐标)、WGS84(WGS84坐標)
样例 : "GCJ02"

string

2.6. DeductionCondition

名称 说明 类型

decValue
可选

扣减量,(eg:加价3元,3即扣减量)
样例 : 3.0

number

freeShipping
可选

包邮
默认值 : false
样例 : true

boolean

maxValue
可选

条件最大值
样例 : "3"

string

minValue
可选

条件最小值
样例 : "2"

string

2.7. FreightDeduction

运费满减

名称 说明 类型

conditions
可选

扣减条件(规则)
样例 : [ "DeductionCondition" ]

< DeductionCondition > array

type
可选

样例 : "string"

string

2.8. FreightIncrement

运费加价

名称 说明 类型

conditions
可选

加价条件(规则)
样例 : [ "IncrementCondition" ]

< IncrementCondition > array

type
必填

加价类型:distance(距离加价)、time_slot(时段加价)、weight(重量加价)
样例 : "distance"

string

2.9. IncrementCondition

加价条件

名称 说明 类型

incValue
可选

增加量,(eg:加价3元,3即增加量)
样例 : 3.0

number

maxValue
可选

条件最大值,距离加价和重量加价时为数字(最多1位小数),时段加价格式为HH:mm
样例 : "3"

string

minValue
可选

条件最小值,距离加价和重量加价时为数字(最多1位小数),时段加价格式为HH:mm
样例 : "2"

string

perValue
可选

每单位值,(目前重量加价有此值,eg:重量加价时,每2kg加价1元,2即每单位值)
样例 : 2.0

number