预约取件接口

POST

/api/OOrderService

（1）在线下单接口是快递鸟提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口。
（2）为客户解决在线发货需求，商户通过网络选择快递公司发送请求通知快递公司有快递要发货。
（3）客户把数据通过此接口转发到快递鸟，由快递鸟为您安排快递员上门取件的服务。
（4）订单编号（OrderCode）不可重复提交，重复提交系统会返回具体错误代码。
（5）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"。
（6）接口地址： API测试地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址：https://api.kdniao.com/api/OOrderService

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://prod-cn.your-api-server.com/api/OOrderService' \
--header 'Content-Type: application/json' \
--data-raw '{
    "OrderCode": "012657018199",
    "ShipperCode": "SF",
    "PayType": 1,
    "MonthCode": "1234567890",
    "ExpType": 1,
    "Cost": 1.0,
    "OtherCost": 1.0,
    "Sender": {
        "Company": "LV",
        "Name": "快递鸟",
        "Mobile": "15018442396",
        "ProvinceName": "上海",
        "CityName": "上海市",
        "ExpAreaName": "青浦区",
        "Address": "明珠路"
    },
    "Receiver": {
        "Company": "GCCUI",
        "Name": "Yann",
        "Mobile": "15018442396",
        "ProvinceName": "北京",
        "CityName": "北京市",
        "ExpAreaName": "朝阳区",
        "Address": "三里屯街道"
    },
    "Commodity": [
        {
            "GoodsName": "鞋子",
            "Goodsquantity": 1,
            "GoodsWeight": 1.0
        }
    ],
    "AddService": [
        {
            "Name": "COD",
            "Value": "1020",
            "CustomerID": "1234567890"
        }
    ],
    "Weight": 1.0,
    "Quantity": 1,
    "Volume": 0.0,
    "Remark": "小心轻放"
}'

响应示例

{
  "EBusinessID": "1237100",
  "Success": true,
  "Order": {
    "OrderCode": "012657018199",
    " ShipperCode ": " SF ",
    " LogisticCode ": "615123456789"
  },
  "ResultCode": "100",
  "Reason": ""
}

请求参数

Body 参数application/json

RequestData

string

必需

请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。

EBusinessID

string

必需

商户ID，请在我的服务页面查看。

RequestType

string

必需

请求指令类型：1007

DataSign

string

必需

数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后进行URL(utf-8)编码。详细过程请查看Demo。

DataType

string

可选

请求、返回数据类型：只支持JSON格式

WarehouseID

string

可选

仓库标识(备用字段)

WarehouseAddress

string

可选

仓库地址(备用字段)

CallBack

string

用户自定义回传字段

可选

MemberID

string

可选

ERP系统、电商平台等系统或平台类型用户的会员ID或店铺账号等唯一性标识，用于区分其用户

ShipperCode

string

必需

快递公司编码详细编码参考《快递鸟接口支持快递公司编码.xlsx》

FcBoxShipperCode

string

可选

选择快递柜支持预约的快递公司 (ShipperCode为FCBOX时必填) SF：顺丰速运(仅支持ExpType为1和2两种业务类型) ZTO：中通快递 STO：申通快递 YD：韵达速递 EMS：EMS

LogisticCode

string

快递单号

可选

ThrOrderCode

string

可选

第三方订单号，即电商平台原始订单号(ShipperCode=SF且需要核销原订单时必传)

OrderCode

string

必需

订单编号(自定义，不可重复)

PayType

integer

必需

运费支付方式： 1-现付，2-到付，3-月结，4-第三方付(仅SF支持)

MonthCode

string

月结编号

可选

ExpType

integer

必需

详细快递类型参考《快递公司快递业务类型.xlsx》

IsReturnSignBill

integer

必需

是否要求签回单 0-不要求，1-要求

Cost

integer

快递运费

可选

OtherCost

integer

其他费用

可选

Sender

object

可选

Company

string

发件人公司

必需

Name

string

发件人

必需

Mobile

string

必需

电话与手机，必填一个

Tel

string

必需

电话与手机，必填一个

PostCode

string

可选

发件地邮编(ShipperCode为EMS、YZPY、YZBK时必填)

ProvinceName

string

必需

发件省 (如广东省，不要缺少“省”；如是直辖市，请直接传北京、上海等；如是自治区，请直接传广西壮族自治区等)

CityName

string

必需

发件市(如深圳市，不要缺少“市；如是市辖区，请直接传北京市、上海市等”)

ExpAreaName

string

必需

发件区/县(如福田区，不要缺少“区”或“县”)

Address

string

必需

发件人详细地址(不用传省市区)

Receiver

object

可选

Company

string

收件人公司

必需

Name

string

收件人

必需

Mobile

string

必需

电话与手机，必填一个

Tel

string

必需

电话与手机，必填一个

ProvinceName

string

必需

收件省 (如广东省，不要缺少“省”；如是直辖市，请直接传北京、上海等；如是自治区，请直接传广西壮族自治区等)

CityName

string

必需

收件市(如深圳市，不要缺少“市；如是市辖区，请直接传北京市、上海市等”)

ExpAreaName

string

必需

收件区/县(如福田区，不要缺少“区”或“县”)

Address

string

必需

收件人详细地址(不用传省市区)

StartDate

string

可选

上门揽件开始时间，示例：2021-01-01 09:00:00

EndDate

string

可选

上门揽件结束时间，示例：2021-01-01 17:00:00

Weight

integer

必需

包裹总重量kg，当选择IsInstallService时，必填

Quantity

integer

可选

包裹数，一个包裹对应一个运单号，如果是大于1个包裹，返回则按照子母件的方式返回母运单号和子运单号

Volume

integer

包裹总体积m3

可选

Remark

string

备注

必需

Commodity

array [object {6}]

必需

GoodsName

string

商品名称

必需

GoodsCode

string

商品编码

可选

Goodsquantity

integer

商品件数

可选

GoodsWeight

integer

商品重量kg

可选

GoodsDesc

string

商品描述

必需

GoodsVol

string

商品体积m3

必需

InstallTypeCode

string

可选

需送装时，必传安装品类编码(仅支持ShipperCode为SF)

IsInstallService

integer

可选

送装服务(仅支持ShipperCode为SF)； 0-非安装订单，1-送装分离，2-送装一体，不填默认为0

PackingType

integer

可选

包装类型(快运字段)； 0-纸，1-纤，2-木，3-托膜，4-木托，99-其他

DeliveryMethod

integer

可选

送货方式(快运字段)；自提，1-送货上门（不含上楼），2-送货上楼。

AddService

array [object {3}]

必需

Name

string

可选

Value

string

可选

CustomerID

string

可选

示例

返回响应

🟢200成功

application/json

Body

EBusinessID

string

用户ID

必需

Order

object

必需

OrderCode

string

订单编号

必需

ShipperCode

string

快递公司编码

必需

LogisticCode

string

快递单号

必需

Success

boolean

必需

成功与否(true/false)

ResultCode

string

返回编号

必需

Reason

string

失败原因

必需

UniquerRequestNumber

string

唯一标识

必需

修改于 2023-04-06 04:11:43

应用场景/功能说明/使用流程