更新记录

2016-03-05

订单提交接口删除ServiceType参数,添加LogisticsProviderCodeLogisticsServiceCode参数

获取跟踪信息接口添加ExpressOrderNumber参数,支持根据配送单号查询

2016-08-03

调整身份证上传接口

原先IDFileUpload接口重命名为UploadOrderReceiverIDFile,该接口用于根据订单号码上传收件人身份证图片文件

新增UploadIDFile接口,该接口用于根据身份证号码上传身份证图片文件

 

2016-08-28

新增库存查询接口

更新订单提交接口:接口名称由PartnerSubmitOrder更改为SubmitOrder

添加账户余额查询接口:GetAccountBalanceList

2016-09-13

收件人证件上传接口修改

添加联系人字段

添加证件号码字段

2016-10-10

订单提交接口,一个订单支持多个入库包裹

删除:ArrivalExpressName, ArrivalTrackingNumber

添加:IncomeParcelList

2016-11-17

订单提交接口

已结算的订单不能修改

添加字段:发件人公司,收件人公司,货物条码、货物英文名称、货物HTC、货物成分、货物尺寸、货物标题、货物通用产品代码、货物用途

2017-01-13

更新签名方法,数据MD5之前,需要全部转化为小写

2017-01-17

接口BalanceAccountList更名为GetBalanceAccountList

2017-01-18

新增接口

创建仓储入库单:CreateInstockManifest

删除订单:DeleteOrder

删除入库单:DeleteInstockManifest

2017-01-23

新增接口

获取入库单详情:GetInstockManifest

获取订单详情:GetOrderDetails

2017-05-26

修改订单提交接口,将原订单提交接口根据业务场景拆分为以下三个

普通订单提交接口(默认)

仓储订单提交接口

MPS订单提交接口

2017-05-29

增加接口

获取订单面单接口:GetOrderLabel

接口版本1.0

 

1. 订单提交接口

1.1普通订单提交接口

场景描述:

合作方提交订单.

主要包含信息:订单信息、货物信息、收发货人有姓名(身份证号码)

消息类型

SubmitOrder

名称

类型

可选/必选

备注

Type

String

必传

请传固定值:Normal

BranchCode

String

必传

物流公司海外仓编号

LogisticsProviderCode

String

可选

线路编号(如果指定LogisticsServiceCode该字段为必选)

LogisticsServiceCode

String

可选

线路服务编号

OrderDetails

 

必传

订单详情

PartnerOrder

 

 

 

PartnerOrderNumber

String

必传

合作方订单编号

Order

 

必传

订单信息

GrossWeight

Decimal

可选

订单中货物的总重量

Size

String

可选

大小(长,宽,高), 如1,2,3

使用英文半角逗号分隔

UnitType

String

可选

单位制类型:

公制:Metric, 英制:Imperial

Remark

String(255)

可选

交易订单备注信息

IncomeParcelList

 

可选

入库包裹列表

IncomeParcel

 

可选

入库包裹信息

ExpressProviderName

 

可选

入库包裹配送公司

ExpressNumber

 

可选

入库包裹跟踪号

CargoList

 

可选

货物信息列表

Cargo

 

可选

货物信息

Category

String

可选

货物分类

Brand

String

可选

货物品牌

Name

String

必选

货物名称

BarCode

String

可选

货物条形码

UnitPrice

Decimal

可选

货物单价

CurrencyCode

String

可选

货币代码,如:USD, CNY

Capacity

String

可选

规格,容量;如:1L500ml,2.2KG

Quantity

Int

必选

货物件数

Weight

Decimal

可选

货物重量

DeclareUnitType

String

可选

海关申报内物单位

台、辆、套、个、只、件、支、根、条、把、块、卷、副、幅、双、对、米、千克、克、箱、罐、桶、包、打、册、本、袋、盒、瓶、部

DutyCode

String

可选

海关税号

BarCode

String

可选

条形码

EnglishName

String

可选

英文名称

HTC

String

可选

美国海关编码Harmonized Tariff Code

Ingredient

String

可选

材质/主要成分

Size

String

可选

尺寸(长,宽,高) 1,2,3使用英文半角逗号分隔

SKU

String

可选

SKU编号

Title

String

可选

标题/描述

UPC

String

可选

通用产品代码

Usage

String

可选

用途

Remark

String255

可选

备注信息

Sender

 

可选

发件人信息

如果不提供发件人信息则使用网点地址

若提不供发件人信息,发件人信息中的必选项可以忽略

ContactName

String

必选

发件人姓名

Company

String

可选

发件人公司

Telephone

String

可选(2必选1

发件人电话

MobilePhone

String

发件人手机

Email

String

可选

发件人邮箱

Province

String

必传

City

String

必传

District

String

可选

StreetAddress

String

必传

发件人街道地址

PostalCode

String

必传

发件人邮编

CountryCode

String

必传

发件人国家代码

Receiver

 

必选

收件人信息

ContactName

String

必选

收件人姓名

Company

String

可选

收件人公司

Telephone

String

可选(2必选1

收件人电话

MobilePhone

String

收件人手机

Email

String

可选

收件人邮箱

Province

String

必传

City

String

必传

District

String

可选

StreetAddress

String

必传

收件人街道地址

PostalCode

String

必传

收件人邮编

CountryCode

String

必传

收件人国家代码

IDNumber

String

可选

收件人身份证号码

请求报文示例

请求示例报文:

<SubmitOrder>

  <Type>Normal</Type>

  <BranchCode>0001</BranchCode>

  <LogisticsProviderCode>coostone</LogisticsProviderCode>

  <LogisticsServiceCode>US_CN_01</LogisticsServiceCode>

  <OrderDetails>

    <PartnerOrder>

      <PartnerOrderNumber>SN1234567890</PartnerOrderNumber>

</PartnerOrder>

    <Order>

      <GrossWeight>12</GrossWeight>

      <Size>1,2,3</Size>

      <UnitType>Imperial</UnitType>

      <Remark>备注信息</Remark>

    </Order>

    <IncomeParcelList>

      <IncomeParcel>

        <ExpressProviderName>USPS</ExpressProviderName>

        <ExpressNumber>SN1234567890</ExpressNumber>

      </IncomeParcel>

      <IncomeParcel>

        <ExpressProviderName>FedEx</ExpressProviderName>

        <ExpressNumber>123456789012</ExpressNumber>

      </IncomeParcel>

    </IncomeParcelList>

    <CargoList>

      <Cargo>

        <Category>键盘式笔记本电脑</Category>

        <Brand>Lenovo</Brand>

        <Name>联想笔记本W420</Name>

        <BarCode>123123</BarCode>

        <UnitPrice>100</UnitPrice>

        <CurrencyCode>USD</CurrencyCode>

        <Capacity>500ml</Capacity>

        <Quantity>1</Quantity>

        <Weight>1.2</Weight>

        <DeclareUnitType></DeclareUnitType>

        <DutyCode>0023412</DutyCode>

        <Remark>备注信息</Remark>

      </Cargo>

      <Cargo>

        <Category>保健品</Category>

        <Brand>GNC</Brand>

        <Name>鱼油 </Name>

        <BarCode>123123</BarCode>

        <UnitPrice>100</UnitPrice>

        <CurrencyCode>USD</CurrencyCode>

        <Capacity>1KG</Capacity>

        <Quantity>2</Quantity>

        <Weight>1.2</Weight>

        <DeclareUnitType></DeclareUnitType>

        <DutyCode>0023412</DutyCode>

        <Remark>备注信息</Remark>

      </Cargo>

    </CargoList>

    <Sender>

      <ContactName>张三</ContactName>

      <Telephone></Telephone>

      <MobilePhone>1345678901</MobilePhone>

      <Email>jiyun@jiyun.com</Email>

      <Province>Oregon</Province>

      <City>Portland</City>

      <District></District>

      <StreetAddress>5835 NE 122nd Avenue Suite 130</StreetAddress>

      <PostalCode>97230</PostalCode>

    </Sender>

    <Receiver>

      <ContactName>李四</ContactName>

      <Telephone></Telephone>

      <MobilePhone>1345678901</MobilePhone>

      <Email>jiyun@jiyun.com</Email>

      <Province>上海</Province>

      <City>上海</City>

      <District>浦东区</District>

      <StreetAddress>xxxx</StreetAddress>

      <PostalCode>200000</PostalCode>

      <IDNumber>32092000200202020</IDNumber>

    </Receiver>

  </OrderDetails>

</SubmitOrder>

 

响应报文示例

返回成功报文:

<Response>

  <Success>true</Success>

  <Data>

<OrderNumber>70082728</OrderNumber>

  </Data>

</Response>

返回失败报文:

<Response>

  <Success>false</Success>

  <Reason>订单提交失败</Reason>

  <ReasonDesc>订单提交失败</ReasonDesc>

</Response>

 

1.2仓储订单提交接口

场景描述:

合作方提交订单.

主要包含信息:订单信息、货物信息、收发货人有姓名(身份证号码)

消息类型

SubmitOrder

名称

类型

可选/必选

备注

Type

String

必传

提交订单的类型

请传固定值:Warehouse

BranchCode

String

必传

物流公司海外仓编号

LogisticsProviderCode

String

可选

线路编号(如果指定LogisticsServiceCode该字段为必选)

LogisticsServiceCode

String

可选

线路服务编号

OrderDetails

 

必传

订单详情

PartnerOrder

 

 

 

PartnerOrderNumber

String

必传

合作方订单编号

Order

 

必传

订单信息

GrossWeight

Decimal

可选

订单中货物的总重量

Size

String

可选

大小(长,宽,高), 如1,2,3

使用英文半角逗号分隔

UnitType

String

可选

单位制类型:

公制:Metric, 英制:Imperial

Remark

String(255)

可选

交易订单备注信息

SKUList

 

可选

分拣库存货物列表

SKU

 

可选

库存货物

SKUID

Long

二选一

库存货物记录主键

PartnerSKUID

String

合作方SKU编号

DispatchQuantity

Int

必选

派发数量

Sender

 

可选

发件人信息

如果不提供发件人信息则使用网点地址

若提不供发件人信息,发件人信息中的必选项可以忽略

ContactName

String

必选

发件人姓名

Company

String

可选

发件人公司

Telephone

String

可选(2必选1

发件人电话

MobilePhone

String

发件人手机

Email

String

可选

发件人邮箱

Province

String

必传

City

String

必传

District

String

可选

StreetAddress

String

必传

发件人街道地址

PostalCode

String

必传

发件人邮编

CountryCode

String

必传

发件人国家代码

Receiver

 

必选

收件人信息

ContactName

String

必选

收件人姓名

Company

String

可选

收件人公司

Telephone

String

可选(2必选1

收件人电话

MobilePhone

String

收件人手机

Email

String

可选

收件人邮箱

Province

String

必传

City

String

必传

District

String

可选

StreetAddress

String

必传

收件人街道地址

PostalCode

String

必传

收件人邮编

CountryCode

String

必传

收件人国家代码

IDNumber

String

可选

收件人身份证号码

请求报文示例

请求示例报文:

<SubmitOrder>

  <Type>Warehouse</Type>

  <BranchCode>0001</BranchCode>

  <LogisticsProviderCode>coostone</LogisticsProviderCode>

  <LogisticsServiceCode>US_CN_01</LogisticsServiceCode>

  <OrderDetails>

    <PartnerOrder>

      <PartnerOrderNumber>SN1234567890</PartnerOrderNumber>

</PartnerOrder>

    <Order>

      <GrossWeight>12</GrossWeight>

      <Size>1,2,3</Size>

      <UnitType>Imperial</UnitType>

      <Remark>备注信息</Remark>

    </Order>

    <SKUList>

      <SKU>

        <SKUID>889901</SKUID>

        <DispatchQuantity>5</DispatchQuantity>

      </SKU>

      <SKU>

        <SKUID>889902</SKUID>

        <DispatchQuantity>20< DispatchQuantity>

      </SKU>

    </SKUList>

    <Sender>

      <ContactName>张三</ContactName>

      <Telephone></Telephone>

      <MobilePhone>1345678901</MobilePhone>

      <Email>jiyun@jiyun.com</Email>

      <Province>Oregon</Province>

      <City>Portland</City>

      <District></District>

      <StreetAddress>5835 NE 122nd Avenue Suite 130</StreetAddress>

      <PostalCode>97230</PostalCode>

    </Sender>

    <Receiver>

      <ContactName>李四</ContactName>

      <Telephone></Telephone>

      <MobilePhone>1345678901</MobilePhone>

      <Email>jiyun@jiyun.com</Email>

      <Province>上海</Province>

      <City>上海</City>

      <District>浦东区</District>

      <StreetAddress>xxxx</StreetAddress>

      <PostalCode>200000</PostalCode>

      <IDNumber>32092000200202020</IDNumber>

    </Receiver>

  </OrderDetails>

</SubmitOrder>

 

响应报文示例

返回成功报文:

<Response>

  <Success>true</Success>

  <Data>

<OrderNumber>70082728</OrderNumber>

  </Data>

</Response>

返回失败报文:

<Response>

  <Success>false</Success>

  <Reason>订单提交失败</Reason>

  <ReasonDesc>订单提交失败</ReasonDesc>

</Response>

 

1.3 MPS订单提交接口

场景描述:

合作方提交订单

一个订单包含一箱或多箱货物

消息类型

SubmitOrder

名称

类型

可选/必选

备注

Type

String

必传

提交订单的类型

请传固定值:MPS

BranchCode

String

必传

物流公司海外仓编号

LogisticsProviderCode

String

可选

线路编号(如果指定LogisticsServiceCode该字段为必选)

LogisticsServiceCode

String

可选

线路服务编号

Remark

String(255)

可选

备注信息

UnitType

String

可选

单位制类型:

公制:Metric, 英制:Imperial

PartnerOrder

 

 

 

PartnerOrderNumber

String

必传

合作方订单编号

BoxList

 

可选

箱子信息列表

Box

 

可选

箱子信息

PartnerBoxID

String

可选

合作方箱子唯一编号

GrossWeight

Decimal

可选

单箱货物的总重量

Size

String

可选

单箱尺寸(长,宽,高), 如1,2,3

使用英文半角逗号分隔

CargoList

 

可选

货物信息列表

Cargo

 

可选

货物信息

Category

String

可选

货物分类

Brand

String

可选

货物品牌

Name

String

必选

货物名称

BarCode

String

可选

货物条形码

UnitPrice

Decimal

可选

货物单价

CurrencyCode

String

可选

货币代码,如:USD, CNY

Capacity

String

可选

规格,容量;如:1L500ml,2.2KG

Quantity

Int

必选

货物件数

Weight

Decimal

可选

货物重量

DeclareUnitType

String

可选

海关申报内物单位

台、辆、套、个、只、件、支、根、条、把、块、卷、副、幅、双、对、米、千克、克、箱、罐、桶、包、打、册、本、袋、盒、瓶、部

DutyCode

String

可选

海关税号

BarCode

String

可选

条形码

EnglishName

String

可选

英文名称

HTC

String

可选

美国海关编码Harmonized Tariff Code

Ingredient

String

可选

材质/主要成分

Size

String

可选

尺寸(长,宽,高) 1,2,3使用英文半角逗号分隔

SKU

String

可选

SKU编号

Title

String

可选

标题/描述

UPC

String

可选

通用产品代码

Usage

String

可选

用途

Remark

String255

可选

备注信息

BoxAttributeList

 

可选

箱子附加信息

Attribute

 

可选

附加信息

Name

String

必选

附加信息名称

Value

String

必选

附加信息内容

Sender

 

可选

发件人信息

如果不提供发件人信息则使用网点地址

若提不供发件人信息,发件人信息中的必选项可以忽略

ContactName

String

必选

发件人姓名

Company

String

可选

发件人公司

Telephone

String

可选(2必选1

发件人电话

MobilePhone

String

发件人手机

Email

String

可选

发件人邮箱

Province

String

必传

City

String

必传

District

String

可选

StreetAddress

String

必传

发件人街道地址

PostalCode

String

必传

发件人邮编

CountryCode

String

必传

发件人国家代码

Receiver

 

必选

收件人信息

ContactName

String

必选

收件人姓名

Company

String

可选

收件人公司

Telephone

String

可选(2必选1

收件人电话

MobilePhone

String

收件人手机

Email

String

可选

收件人邮箱

Province

String

必传

City

String

必传

District

String

可选

StreetAddress

String

必传

收件人街道地址

PostalCode

String

必传

收件人邮编

CountryCode

String

必传

收件人国家代码

IDNumber

String

可选

收件人身份证号码

 

请求报文示例

请求示例报文:

<SubmitOrder>

  <Type>MPS</Type>

  <BranchCode>1001</BranchCode>

  <LogisticsProviderCode>ups-gfp-t-lax</LogisticsProviderCode>

  <LogisticsServiceCode>03</LogisticsServiceCode>

  <Remark>remark 123 ... </Remark>

  <UnitType>Imperial</UnitType>

  <PartnerOrder>

    <PartnerOrderNumber>9928882883</PartnerOrderNumber>

  </PartnerOrder>

  <BoxList>

    <Box>

      <PartnerBoxID>88888888012</PartnerBoxID>

      <GrossWeight>10</GrossWeight>

      <Size>10,20,10</Size>

      <CargoList>

        <Cargo>

          <Name>帐篷</Name>

          <Brand></Brand>

          <UnitPrice>6.6</UnitPrice>

          <CurrencyCode>USD</CurrencyCode>

          <Weight>20</Weight>

          <Quantity>10</Quantity>

        </Cargo>

        <Cargo>

          <Name>帐篷2</Name>

          <Brand>迪卡侬</Brand>

          <UnitPrice>8.7</UnitPrice>

          <CurrencyCode>USD</CurrencyCode>

          <Weight>21</Weight>

          <Quantity>50</Quantity>

        </Cargo>

      </CargoList>

      <BoxAttributeList>

        <Attribute>

          <Name>Freight Class</Name>

          <Value>65</Value>

        </Attribute>

      </BoxAttributeList>

    </Box>

    <Box>

      <PartnerBoxID>88888888013</PartnerBoxID>

      <GrossWeight>20</GrossWeight>