新订单信息

请求信息

接口地址

http://oms.hkapi.esuhaitao.com/Order/Create

请求方式

POST

Head 参数

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

参数签名

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

string

Required

无。

输入参数

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

外部单号

string

无。

无。

无。

TrackingNo

预报号码

string

无。

无。

无。

WarehouseCode

所属仓库

string

Required

无。

无。

IsAutoPay

是否自动支付

boolean

Required

无。

无。

IsMerger

是否合箱

boolean

Required

无。

无。

Consignee

收货人信息

收货人信息

Required

无。

无。

参数名说明类型特性默认值示例
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

Consigner

发货人信息

发货人信息

无。

无。

无。

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

发货人名称

string

Required

Max length: 32

无。

arthur

Mobile

发货人手机

string

Max length: 16

无。

139252831XX

Country

发货国家

string

Max length: 32

无。

中国

Province

发货省份

string

Max length: 32

无。

广东

City

发货城市

string

Max length: 32

无。

深圳

District

发货地区

string

Max length: 32

无。

南山区

Address

发货详细地址

string

Max length: 256

无。

科技中路XXXXX

ZipCode

发货地址邮编

string

无。

无。

518067

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

无。

Weight

包裹重量

decimal number

无。

无。

无。

UserRemarks

用户备注

string

无。

无。

无。

ServiceProductCode

产品服务代码

string

Required

无。

无。

ExtraServiceCodes

增值服务编码

逗号分隔

string

无。

无。

无。

InsuredAmount

投保金额

decimal number

无。

无。

无。

OrderShopImgs

购物图片

string

无。

无。

无。

ShippingMethod

派送方式

1 快递上门

2 送货上门

3 代购

integer

无。

无。

无。

Items

包含的商品列表

Collection of OrderItem参数

无。

无。

无。

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

商品主键

integer

无。

无。

1

Name

商品名称

string

Required

Max length: 512

无。

斯凯奇SKECHERS Rumblers女士休闲坡跟拖鞋凉鞋黑色

Sku

接入商产品唯一编号

string

Max length: 64

无。

10021

Upc

国际商品编号

string

Max length: 16

无。

6940406900044

CategoryName

商品类别Id+名称

格式为“id-Name”

string

Max length: 64

无。

10-鞋子

UnitPrice

商品单价

decimal number

Required

无。

2799

CurrencyCode

商品单价单位

单位编码

CNY:人民币元

USD:美元

AUD:澳元

JPY:日元

string

Required

Matching regular expression pattern: ^[a-zA-Z][\w]+$

Max length: 3

无。

USD

Quantity

商品数量

integer

Required

无。

2

Brand

商品品牌

string

Max length: 64

无。

斯凯奇

Model

商品型号

数据格式 key:value;key:value

string

Max length: 128

无。

颜色:黑色Black;尺寸:6

SkuItems

Sku商品列表

Collection of OrderSkuItem参数

无。

无。

无。

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

接入商产品唯一编号

string

Required

Max length: 64

无。

10021

Upc

国际商品编号

string

Required

Max length: 16

无。

6940406900044

UnitPrice

商品单价

decimal number

Required

无。

2799

Quantity

商品数量

integer

Required

无。

2

OrderIdList

选择包裹信息

Collection of integer

无。

无。

无。

integer
CurrencyCode

货币编码

string

无。

无。

无。

Invoice

发票地址

string

无。

无。

无。

SplitParentId

拆分单Id

integer

无。

无。

无。

ReCharging

需要重新计费

boolean

无。

无。

无。

请求参数格式

application/json 或 text/json

Sample:
{
  "SiteAppId": 1,
  "UserId": 2,
  "UserCode": "sample string 3",
  "ExternalCode": "sample string 4",
  "TrackingNo": "sample string 5",
  "TrackingNoEx": "sample string 6",
  "WarehouseCode": "sample string 7",
  "IsAutoPay": true,
  "IsMerger": true,
  "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"
  },
  "Consigner": {
    "Name": "sample string 1",
    "Mobile": "sample string 2",
    "Country": "sample string 3",
    "Province": "sample string 4",
    "City": "sample string 5",
    "District": "sample string 6",
    "Address": "sample string 7",
    "ZipCode": "sample string 8"
  },
  "Idcard": {
    "IdcardNo": "sample string 1",
    "PositiveImage": "sample string 2",
    "ObverseImage": "sample string 3",
    "AuthType": "sample string 4"
  },
  "Weight": 10.0,
  "UserRemarks": "sample string 11",
  "ServiceProductCode": "sample string 12",
  "ExtraServiceCodes": "sample string 13",
  "InsuredAmount": 14.0,
  "OrderShopImgs": "sample string 15",
  "ShippingMethod": 16,
  "OpUserId": 17,
  "SecondUserCode": "sample string 18",
  "ExtendInfo": "sample string 19",
  "Items": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Sku": "sample string 3",
      "Upc": "sample string 4",
      "CategoryName": "sample string 5",
      "UnitPrice": 6.0,
      "CurrencyCode": "sample string 7",
      "Quantity": 8,
      "Brand": "sample string 9",
      "Model": "sample string 10",
      "Description": "sample string 11",
      "ImageUrl": "sample string 12"
    },
    null
  ],
  "SkuItems": [
    {
      "Sku": "sample string 1",
      "Upc": "sample string 2",
      "UnitPrice": 3.0,
      "Quantity": 4
    },
    null
  ],
  "OrderIdList": [
    1,
    2
  ],
  "CurrencyCode": "sample string 20",
  "Invoice": "sample string 21",
  "SplitParentId": 22,
  "ReCharging": 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"
}