Darwynn Driver System 接口文档

目录

版本记录

版本

日期

说明

v1.0

2022/09/02

新增接口

1、运单号生成接口

2、WMS订单同步接口

3、运单号作废接口

4、运单交割接口

v2.0

2022/09/05

"WMS订单同步接口"接口名称修改为"OMS订单同步接口"

v3.0

2022/10/09

OMS订单同步接口中的收货经度、收货纬度修改为非必填

v4.0

2022/11/01

OMS订单同步接口新增必填参数：warehouse_postcode、warehouse_address、warehouse_address2

v5.0

2022/11/28

新增判断包裹是否在配送站配送范围内接口

v6.0

2022/12/01

运单号生成接口增加请求参数：warehouse_postcode、warehouse_address、warehouse_address2

增加返回参数：station

v7.0

2022/12/06

运单号生成接口删除请求参数：warehouse_postcode、warehouse_address、warehouse_address2

v8.0

2023/01/05

订单同步接口增加非必填参数：package_price

v8.1

2023/07/05

增加接口：

1、获取面单信息

2、保存面单图片

v8.2

2023/07/08

OMS订单同步接口新增请求参数：package_type，appoint_time

操作必读

环境信息

环境

域名

正式环境


测试环境


公共返回参数

参数

格式

必填

描述

status

Int

是

接口状态码

msg

String

是

响应描述信息

data

Json|Array

是

业务数据

签名生成规则

示例：

请求参数

“qr_code”:”T1999999999″,

“device_id”:”001″,

“create_time”:”1647826159″

 

生成签名步骤

  1. 非空参数按照字典序排列，得到String
    •  String = “create_time=1647826159&device_id=001&qr_code=T1999999999”
  2. 在String后加入key(可通过咨询我方获取,测试可用：89b9d22bef4d94ce070f35c9e78ea172),得到TempSign
    • TempSign = “create_time=1647826159&device_id=001&qr_code=T1999999999&key=89b9d22bef4d94ce070f35c9e78ea172”
  3. md5加密，得到md5Sign
    • md5Sign= “1e6d22b5c2441d6590dfbc41c79e0d3b”
  4. 所有字符转为大写，得到sign
    • sign = “1E6D22B5C2441D6590DFBC41C79E0D3B”

运单号生成接口

通过接口生成运单号

  • URL:
				
					/v20/public/index.php/dds/api.DarwynnOrder/createLogisticsOrderId
  • Method：POST
  • 需要鉴权：是

请求参数

参数

格式

必填

描述

示例

user_name

String

是

订单收货人名称

John Doe

user_phone

String

是

订单收货人手机号

13095554512

user_email

String

是

订单收货人邮编


postcode

String

是

订单收货人邮政


user_address

String

是

订单收货地址1 (street address)


user_address2

String

是

订单收货地址2 (unit, suite, or apartment number)


package_length

Float

是

包裹长（单位：m）


package_width

Float

是

包裹宽（单位：m）


package_height

Float

是

包裹高（单位：m）


package_weight

Float

是

包裹重量（单位：kg）


sign

String

是

签名（见签名生成规则）

ec99d29ddaead365fcedd330bed34863

响应参数

参数

格式

描述

示例

logistics_orderid

String

运单号

DD20220902M1X1HO6B

station

Array

最匹配的配送站信息


station参数

参数

格式

描述

示例

station_id

Int

配送站id

1

station_name

String

配送站名称

安徽合肥蜀山区配送站

响应示例

				
					{
    "status": 1000,
    "msg": "success",
    "data": {
        "logistics_orderid": "DD20220902M1X1HO6B"
    },
    "refresh_ticket": ""
}

OMS订单同步接口

通过此接口同步订单信息。

  • URL:
				
					/v20/public/index.php/dds/api.DarwynnOrder/importOrder
  • Method：POST
  • 需要鉴权：是

请求参数

参数

格式

必填

描述

示例

oms_orderid

String

是

OMS订单号，订单管理系统编号

OCPS02301110000051

order_type

String

是

订单类型：B2B/B2C

B2B

electronic_commerce

String

是

订单隶属平台：Amazon、eBay、Shopify

Amazon

third_orderid

String

是

订单隶属平台订单id

201

deliver_platform

String

是

订单的承运商：Canada Post、UPS、DayRoss…

UPS

logistics_orderid

String

是

运单号


user_name

String

是

订单收货人名称

John Doe

user_phone

String

是

订单收货人手机号

13095554512

user_email

String

是

订单收货人邮箱


postcode

String

是

订单收货人邮编


user_address

String

是

订单收货地址1(street address)


user_address2

String

是

订单收货地址2 (unit, suite, or apartment number)


user_long

String

否

订单收货经度


user_lat

String

否

订单收货纬度


warehouse_postcode

String

是

仓库邮编


warehouse_address

String

是

仓库地址1 (street address)


warehouse_address2

String

是

仓库地址2 (unit, suite, or apartment number)


package_price

String

否

包裹价格（非必填）单位：元


package_type

Int

否

包裹类型（0:普通订单，1：冷鲜，2：加急）非必填参数，默认为0

0

appoint_time

String

否

送达时间 (格式: YYYY-MM-DD HH:MM:SS)

2023-07-08 09:00:00

sign

String

是

签名（见签名生成规则）

ec99d29ddaead365fcedd330bed34863

响应示例

				
					{
    "status": 1000,
    "msg": "success",
    "data": [],
    "refresh_ticket": ""
}

运单号作废接口

通过接口作废运单号

  • URL:
				
					/v20/public/index.php/dds/api.DarwynnOrder/delOrder
  • Method：POST
  • 需要鉴权：是

请求参数

参数

格式

必填

描述

示例

logistics_orderid

String

是

运单号，多个运单号以逗号链接

DD20220811M1XY39M4,DD20220902M1X1HO6B

sign

String

是

签名（见签名生成规则）

ec99d29ddaead365fcedd330bed34863

响应示例

				
					{
    "status": 1000,
    "msg": "success",
    "data": [],
    "refresh_ticket": ""
}

运单交割接口

通过接口交割运单

  • URL:
				
					/v20/public/index.php/dds/api.DarwynnOrder/delivery
  • Method：POST
  • 需要鉴权：是

请求参数

参数

格式

必填

描述

示例

logistics_orderid

String


运单号，多个运单号以逗号链接

DD20220811M1XY39M4,DD20220902M1X1HO6

sign

String

是

签名（见签名生成规则）

ec99d29ddaead365fcedd330bed34863

响应示例

				
					{
    "status": 1000,
    "msg": "success",
    "data": [],
    "refresh_ticket": ""
}

判断判断包裹是否在配送站配送范围内

判断判断包裹是否在配送站配送范围内

  • URL:
				
					/v20/public/index.php/dds/api.DarwynnOrder/checkParcelDeliveryStation
  • Method：POST
  • 需要鉴权：是

请求参数

参数

格式

必填

描述

示例

user_address

String

是

收货地址1 (street address)


user_address2

String

是

收货地址2 (unit, suite, or apartment number)


postcode

String

是

收货邮编


sign

String

是

签名（见签名生成规则）

ec99d29ddaead365fcedd330bed34863

响应示例

				
					{
      "status": 1000,
      "msg": "success",
      "data": {
            "has_station": true   // true为在站点配送范围内，false为不在配送范围内
      },
      "refresh_ticket": ""
}

获取面单信息(XML)

通过接口交割运单

  • URL:
				
					/v20/public/index.php/dds/api.DarwynnOrder/getOrderInfo
  • Method：POST
  • 需要鉴权：是

请求参数

参数

格式

必填

描述

示例

logistics_orderid

String

是

运单号

DD20220902M1X1HO6B

sign

String

是

签名（见签名生成规则）

ec99d29ddaead365fcedd330bed34863

Data返回参数

参数

格式

描述

示例

user_name

String

收货人姓名

John Doe

postcode

String

收货邮编


user_address

String

收货地址1 (street address)


user_address2

String

收货地址2 (unit, suite, or apartment number)


warehouse_postcode

String

仓库邮编


warehouse_address

String

仓库地址1 (street address)


warehouse_address2


String

仓库地址2 (unit, suite, or apartment number)


package_weight

Float

包裹运单号（单位：kg）


oms_orderid

String

OMS订单编号

OCPS02301110000051

print_time

String

当前时间戳


响应示例

				
					<response>
    <status>1000</status>
    <msg>success</msg>
    <data>
        <user_name>李四</user_name>
        <postcode>A0A333</postcode>
        <user_address>aaa</user_address>
        <user_address2>bbb</user_address2>
        <warehouse_postcode>1</warehouse_postcode>
        <warehouse_address>1</warehouse_address>
        <warehouse_address2>20</warehouse_address2>
        <logistics_orderid>DD20230505A0A891N6</logistics_orderid>
        <package_weight>1.00</package_weight>
        <oms_orderid>22092302075066657021</oms_orderid>
        <print_time>2023-07-04 21:43:24</print_time>
        <return_label></return_label>
    </data>
</response>

保存面单图片

通过接口交割运单

  • URL:
				
					/v20/public/index.php/dds/api.DarwynnOrder/saveOrderImg
  • Method：POST
  • 需要鉴权：是

请求参数

参数

格式

必填

描述

示例

base64

String

Y

面单图片的base64


logistics_orderid

String

Y

运单号

DD20220811M1XY39M4,DD20220902M1X1HO6B

oms_orderid

String

Y

OMS订单编号

OCPS02301110000051

sign

String

Y

签名（见签名生成规则）

ec99d29ddaead365fcedd330bed34863

响应示例

				
					{
    "status": 1000,
    "msg": "success",
    "data": {
        "url": "http://o2o-dev-1305348519.cos.ap-nanjing.myqcloud.com/upload/darwynn_order/40a6a2ecb6b9fc946d79b87146171481.gif"
    },
    "refresh_ticket": ""
}
small_c_popup.png

How Can We Help?