订单中心-门店服务-客户提货服务接口文档

接口

1. 接口定义

1.1. 承运服务

1.1.1. 获取门店订单可用承运商

POST /{tenant_id}/storedelivery/carrier/availablecarriers

1.1.1.1. 说明

获取门店订单可用承运商

1.1.1.2. 参数

类型	名称	说明	类型
Path	tenant_id 必填	租户ID	string
Body	action 必填	参数	CalcCarrierAction

类型

名称

说明

类型

Path

tenant_id
必填

租户ID

string

Body

action
必填

参数

CalcCarrierAction

1.1.1.3. 响应

HTTP代码	说明	类型
200	successful operation	CarrierList

HTTP代码

说明

类型

200

successful operation

CarrierList

1.1.1.4. HTTP请求示例

请求 path

/string/storedelivery/carrier/availablecarriers

请求 body

{
  "store_id" : "string",
  "expected_logistics_type" : "crowdsourcing"
}

1.1.1.5. HTTP响应示例

响应 200

{
  "carriers" : [ {
    "id" : "string",
    "name" : "string"
  } ],
  "store_carriers" : [ {
    "uuid" : "string",
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "proxy" : true,
    "line_number" : 1,
    "carrier_merchant" : {
      "id" : "string",
      "name" : "string"
    },
    "carrier_system" : {
      "id" : "string",
      "name" : "string"
    },
    "priority" : 1
  } ]
}

1.1.2. 下发承运

POST /{tenant_id}/storedelivery/carrier/createorder/create

1.1.2.1. 说明

下发承运

1.1.2.2. 参数

类型	名称	说明	类型
Path	tenant_id 必填	租户ID	string
Query	operator 必填	操作人	string
Body	request 必填	参数	CarrierOrderCreate

类型

名称

说明

类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

参数

CarrierOrderCreate

1.1.2.3. 响应

HTTP代码	说明	类型
200	successful operation	CarrierOrderCreateResponse

HTTP代码

说明

类型

200

successful operation

CarrierOrderCreateResponse

1.1.2.4. HTTP请求示例

请求 path

/string/storedelivery/carrier/createorder/create?operator=string

请求 body

{
  "station" : {
    "id" : "string",
    "name" : "string"
  },
  "sender" : {
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    },
    "address" : {
      "country" : "中国",
      "province" : "福建省",
      "city" : "厦门市",
      "district" : "思明区",
      "street" : "前埔",
      "postcode" : "363423",
      "latitude" : "45.3,范围0-90",
      "longtitude" : "121.2,范围0-180",
      "coordinate_type" : "GCJ02",
      "private_street" : "脱敏地址**"
    }
  },
  "receiver" : {
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    },
    "address" : {
      "country" : "中国",
      "province" : "福建省",
      "city" : "厦门市",
      "district" : "思明区",
      "street" : "前埔",
      "postcode" : "363423",
      "latitude" : "45.3,范围0-90",
      "longtitude" : "121.2,范围0-180",
      "coordinate_type" : "GCJ02",
      "private_street" : "脱敏地址**"
    }
  },
  "weight" : 500.0,
  "skus" : [ {
    "title" : "string",
    "qty" : 0.0,
    "weight" : 0.0,
    "sku_id" : "string"
  } ],
  "source_id" : "JPOS",
  "source_name" : "门店收银系统",
  "delivery_id" : "string",
  "order_type" : "order（订单）、rtn（退单）",
  "order_id" : "string",
  "carrier_id" : "string",
  "carrier_name" : "string",
  "carrier_merchant_id" : "string",
  "expect_delivery_time" : "2020-06-17 10:00:00",
  "expected_logistics_type" : "crowdsourcing"
}

1.1.2.5. HTTP响应示例

响应 200

{
  "message" : "string",
  "success" : true,
  "waybill_id" : "string",
  "carrier_id" : "string",
  "carrier_name" : "string",
  "carrier_merchant_id" : "string"
}

2. 定义

2.1. CalcCarrierAction

获取可用承运商

名称说明类型

名称	说明	类型
expected_logistics_type 可选	期望承运物流类型，取值范围:express(快递)、crowdsourcing(众包) 样例 : `"crowdsourcing"`	string
store_id 可选	配送门店ID 样例 : `"string"`	string

expected_logistics_type
可选

期望承运物流类型，取值范围:express(快递)、crowdsourcing(众包)
样例 : "crowdsourcing"

string

store_id
可选

配送门店ID
样例 : "string"

string

2.2. CarrierList

承运商列表

名称说明类型

名称	说明	类型
carriers 可选	承运商列表(废弃) 样例 : `[ "IdName" ]`	< IdName > array
store_carriers 可选	承运商列表(新) 样例 : `[ "StoreCarrier" ]`	< StoreCarrier > array

carriers
可选

承运商列表(废弃)
样例 : [ "IdName" ]

< IdName > array

store_carriers
可选

承运商列表(新)
样例 : [ "StoreCarrier" ]

< StoreCarrier > array

2.3. CarrierOrderCreate

承运单

名称说明类型

名称	说明	类型
carrier_id 可选	承运平台Id 样例 : `"string"`	string
carrier_merchant_id 可选	承运商家Id 样例 : `"string"`	string
carrier_name 可选	承运平台名称样例 : `"string"`	string
delivery_id 必填	配送ID,一次配送唯一值样例 : `"string"`	string
expect_delivery_time 可选	期望送达时间样例 : `"2020-06-17 10:00:00"`	string (date-time)
expected_logistics_type 可选	期望承运物流类型，取值范围:express(快递)、crowdsourcing(众包) 样例 : `"crowdsourcing"`	string
order_id 必填	单号样例 : `"string"`	string
order_type 必填	单号类型样例 : `"order（订单）、rtn（退单）"`	string
receiver 必填	收货人信息样例 : LReceiver	LReceiver
sender 可选	寄件人信息,不传取配送门店信息样例 : Sender	Sender
skus 可选	包裹列表样例 : `[ "CarrierOrderSkuCreate" ]`	< CarrierOrderSkuCreate > array
source_id 必填	来源ID 样例 : `"JPOS"`	string
source_name 必填	来源名称样例 : `"门店收银系统"`	string
station 可选	配送门店样例 : IdName	IdName
weight 可选	订单重量，单位：g 样例 : `500.0`	number

carrier_id
可选

承运平台Id
样例 : "string"

string

carrier_merchant_id
可选

承运商家Id
样例 : "string"

string

carrier_name
可选

承运平台名称
样例 : "string"

string

delivery_id
必填

配送ID,一次配送唯一值
样例 : "string"

string

expect_delivery_time
可选

期望送达时间
样例 : "2020-06-17 10:00:00"

string (date-time)

expected_logistics_type
可选

期望承运物流类型，取值范围:express(快递)、crowdsourcing(众包)
样例 : "crowdsourcing"

string

order_id
必填

单号
样例 : "string"

string

order_type
必填

单号类型
样例 : "order（订单）、rtn（退单）"

string

receiver
必填

收货人信息
样例 : LReceiver

LReceiver

sender
可选

寄件人信息,不传取配送门店信息
样例 : Sender

Sender

skus
可选

包裹列表
样例 : [ "CarrierOrderSkuCreate" ]

< CarrierOrderSkuCreate > array

source_id
必填

来源ID
样例 : "JPOS"

string

source_name
必填

来源名称
样例 : "门店收银系统"

string

station
可选

配送门店
样例 : IdName

IdName

weight
可选

订单重量，单位：g
样例 : 500.0

number

2.4. CarrierOrderCreateResponse

名称说明类型

名称	说明	类型
carrier_id 可选	承运平台Id 样例 : `"string"`	string
carrier_merchant_id 可选	承运商家Id 样例 : `"string"`	string
carrier_name 可选	承运平台名称样例 : `"string"`	string
message 可选	信息样例 : `"string"`	string
success 可选	是否成功默认值 : `false` 样例 : `true`	boolean
waybill_id 可选	运单号样例 : `"string"`	string

carrier_id
可选

承运平台Id
样例 : "string"

string

carrier_merchant_id
可选

承运商家Id
样例 : "string"

string

carrier_name
可选

承运平台名称
样例 : "string"

string

message
可选

信息
样例 : "string"

string

success
可选

是否成功
默认值 : false
样例 : true

boolean

waybill_id
可选

运单号
样例 : "string"

string

2.5. CarrierOrderSkuCreate

承运单商品

名称说明类型

名称	说明	类型
qty 可选	数量样例 : `0.0`	number
sku_id 可选	货号样例 : `"string"`	string
title 可选	名称样例 : `"string"`	string
weight 可选	单个商品重量,单位：g 样例 : `0.0`	number

qty
可选

数量
样例 : 0.0

number

sku_id
可选

货号
样例 : "string"

string

title
可选

名称
样例 : "string"

string

weight
可选

单个商品重量,单位：g
样例 : 0.0

number

2.6. IdName

名称说明类型

名称	说明	类型
id 可选	样例 : `"string"`	string
name 可选	样例 : `"string"`	string

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.7. LAddress

地址信息

名称说明类型

名称	说明	类型
city 可选	市样例 : `"厦门市"`	string
coordinate_type 可选	坐标类型，BD09：百度坐标， GCJ02：火星坐标，WGS84：WGS84坐标样例 : `"GCJ02"`	string
country 可选	国家样例 : `"中国"`	string
district 可选	区样例 : `"思明区"`	string
latitude 可选	纬度样例 : `"45.3,范围0-90"`	number
longtitude 可选	经度样例 : `"121.2,范围0-180"`	number
postcode 可选	邮编样例 : `"363423"`	string
private_street 可选	脱敏地址样例 : `"脱敏地址**"`	string
province 可选	省份样例 : `"福建省"`	string
street 可选	详细地址样例 : `"前埔"`	string

city
可选

市
样例 : "厦门市"

string

coordinate_type
可选

坐标类型，BD09：百度坐标， GCJ02：火星坐标，WGS84：WGS84坐标
样例 : "GCJ02"

string

country
可选

国家
样例 : "中国"

string

district
可选

区
样例 : "思明区"

string

latitude
可选

纬度
样例 : "45.3,范围0-90"

number

longtitude
可选

经度
样例 : "121.2,范围0-180"

number

postcode
可选

邮编
样例 : "363423"

string

private_street
可选

脱敏地址
样例 : "脱敏地址**"

string

province
可选

省份
样例 : "福建省"

string

street
可选

详细地址
样例 : "前埔"

string

2.8. LReceiver

收货人

名称	说明	类型
address 必填	地址样例 : LAddress	LAddress
contact 必填	联系方式样例 : 联系方式(soms)	联系方式(soms)

名称

说明

类型

address
必填

地址
样例 : LAddress

LAddress

contact
必填

联系方式
样例 : 联系方式(soms)

联系方式(soms)

2.9. Sender

寄件人信息

名称	说明	类型
address 必填	地址样例 : LAddress	LAddress
contact 必填	联系方式样例 : 联系方式(soms)	联系方式(soms)

名称

说明

类型

address
必填

地址
样例 : LAddress

LAddress

contact
必填

联系方式
样例 : 联系方式(soms)

联系方式(soms)

2.10. StoreCarrier

门店承运商对象

名称说明类型

名称	说明	类型
carrier 可选	承运平台样例 : IdName	IdName
carrier_merchant 可选	承运商家样例 : IdName	IdName
carrier_system 可选	样例 : IdName	IdName
line_number 必填	行号样例 : `1`	integer (int32)
priority 可选	优先级样例 : `1`	integer (int32)
proxy 可选	默认值 : `false` 样例 : `true`	boolean
uuid 可选	样例 : `"string"`	string

carrier
可选

承运平台
样例 : IdName

IdName

carrier_merchant
可选

承运商家
样例 : IdName

IdName

carrier_system
可选

样例 : IdName

IdName

line_number
必填

行号
样例 : 1

integer (int32)

priority
可选

优先级
样例 : 1

integer (int32)

proxy
可选

默认值 : false
样例 : true

boolean

uuid
可选

样例 : "string"

string

2.11. 联系方式(soms)

联系方式

名称说明类型

名称	说明	类型
email 可选	邮箱样例 : `"55151@qq.com"`	string
fax 可选	传真样例 : `"123123"`	string
mobile 可选	手机(mobile和telephone建议给值mobile) 样例 : `"189389928893"`	string
name 可选	姓名样例 : `"李飞"`	string
private_mobile 可选	隐私号样例 : `"189389928893"`	string
private_name 可选	脱敏名称样例 : `"脱敏名称**"`	string
telephone 可选	电话样例 : `"189389928893"`	string

email
可选

邮箱
样例 : "55151@qq.com"

string

fax
可选

传真
样例 : "123123"

string

mobile
可选

手机(mobile和telephone建议给值mobile)
样例 : "189389928893"

string

name
可选

姓名
样例 : "李飞"

string

private_mobile
可选

隐私号
样例 : "189389928893"

string

private_name
可选

脱敏名称
样例 : "脱敏名称**"

string

telephone
可选

电话
样例 : "189389928893"

string