包裹合箱申请

请求信息

接口地址

http://oms.hkapi.esuhaitao.com/Order/MergerApply/Single

请求方式

POST

Head 参数

参数名说明类型特性默认值示例
Authorization

参数签名

把“输入参数 JSON 格式的字符串内容”使用HMACSHA1(URL安全的Base64编码) 进行加密 查看示例

string

Required

无。

输入参数

-分隔

参数名说明类型特性默认值示例
TrackingNoIdList

选择包裹信息

Collection of integer

无。

无。

无。

integer
TrackingNoList

选择包裹号信息

Collection of string

无。

无。

无。

string
ServiceProductCode

产品服务代码

string

无。

无。

无。

ExtraServiceCodes

增值服务编码

逗号分隔

string

无。

无。

无。

InsuredAmount

投保金额

decimal number

无。

无。

无。

Consignee

收货人信息

收货人信息

无。

无。

无。

参数名说明类型特性默认值示例
Name

收货人名称

string

Required

Max length: 32

无。

arthur

Mobile

收货人手机

string

Required

Max length: 16

无。

139252831XX

Country

收货国家

string

Required

Max length: 32

无。

中国

Province

收货省份

string

Required

Max length: 32

无。

广东

City

收货城市

string

Required

Max length: 32

无。

深圳

District

收货地区

string

Max length: 32

无。

南山区

Street

收货街区

string

Max length: 32

无。

科技园

Address

收货地址

string

Required

Max length: 256

无。

科技中路XXXXX

ZipCode

收货地址邮编

string

无。

无。

518067

IdcardNo

身份证地址

string

无。

无。

4403

Idcard

身份证信息

身份证信息

无。

无。

无。

参数名说明类型特性默认值示例
IdcardNo

收货人身份证号码

string

Max length: 18

无。

44030198201010814

PositiveImage

收货人身份证照片正面

如果未选中验证身份证,需必选

参数可以是 url 或 图片base64编码 两种方式

1:http://img.xxx.com/idcarddemo.jpg 最长不超过512个字符

2:base64:R0lGODl+vv///yH5BAEWADs= 图片最大不超过200K

string

Max length: 274000

无。

base64:R0lGODl+vv///yH5BAEWADs=

ObverseImage

收货人身份证照片反面

如果未选中验证身份证,需必选

参数可以是 url 或 图片base64编码 两种方式

1:http://img.xxx.com/idcarddemo.jpg 最长不超过512个字符

2:base64:R0lGODl+vv///yH5BAEWADs= 图片最大不超过200K

string

Max length: 274000

无。

http://img.xxx.com/idcarddemo.jpg

AuthType

身份证验证,默认不使用

Default 默认模式,用户提供身份证图片

Extract 使用公安身份证系统验证,每次新验证收费3元

string

无。

Default

无。

IsAutoPay

是否自动支付

boolean

无。

无。

无。

请求参数格式

application/json 或 text/json

Sample:
{
  "SiteAppId": 1,
  "UserId": 2,
  "UserCode": "sample string 3",
  "TrackingNoIdList": [
    1,
    2
  ],
  "TrackingNoList": [
    "sample string 1",
    "sample string 2"
  ],
  "ServiceProductCode": "sample string 4",
  "ExtraServiceCodes": "sample string 5",
  "InsuredAmount": 6.0,
  "Consignee": {
    "Name": "sample string 1",
    "Mobile": "sample string 2",
    "Country": "sample string 3",
    "Province": "sample string 4",
    "City": "sample string 5",
    "District": "sample string 6",
    "Street": "sample string 7",
    "Address": "sample string 8",
    "ZipCode": "sample string 9",
    "IdcardNo": "sample string 10"
  },
  "Idcard": {
    "IdcardNo": "sample string 1",
    "PositiveImage": "sample string 2",
    "ObverseImage": "sample string 3",
    "AuthType": "sample string 4"
  },
  "IsAutoPay": true
}

应答信息

资源说明

参数名说明类型特性默认值示例
Code integer

无。

无。

无。

Message string

无。

无。

无。

OrderId

订单Id

integer

无。

无。

无。

WmsTrackingNo

仓库包裹号

string

无。

无。

无。

OrderCode

订单编码

string

无。

无。

无。

应答结果格式

application/json 或 text/json

Sample:
{
  "OrderId": 1,
  "WmsTrackingNo": "sample string 2",
  "OrderCode": "sample string 3",
  "Code": 4,
  "Message": "sample string 5"
}