创建包裹

请求规格说明

请求方式

POST /api/parcels

请求数据格式

名称	类型	是否必须	描述	示例值
ReferenceId	string	必须	客户订单号，在整个系统内不得重复。为了尽量避免冲突，推荐您加贵司名称英文（或拼音）简写的前缀	SO1503061000001
SellingPlatformOrder	SellingPlatformOrder		销售平台订单信息
ShippingAddress	Address	必须	收件人地址信息	{ "Company": "公司名称", "Street1": "街道1", "Street2": "街道2", "Street3": "", "City": "London", "Province": "London", "CountryCode": "GB", "Postcode": "邮编", "Contacter": "联系人", "Tel": "电话", "Email": "邮箱地址", "TaxId": "收件人税号" }
WeightInKg	decimal	必须	包裹重量(单位:KG)	1.580
ItemDetails	ParcelItemDetail[]	必须	包裹件内明细
TotalValue	Money	必须	包裹总金额
TotalVolume	CubeSize	必须	包裹尺寸
WithBatteryType	WithBatteryType	必须	包裹是否含有带电产品
Notes	string		包裹备注
BatchNo	string		批次号或邮袋号
WarehouseCode	string	必须	交货仓库代码，请参考查询仓库接口	SZ
~~ProcessLocation~~	string		交货仓库名称已废弃，请使用 WarehouseCode	深圳
ShippingMethod	string	必须	发货产品服务代码	如:REGPOST
ItemType	ParcelItemType	必须	包裹类型
TradeType	TradeType		订单交易类型(B2B, B2C)，默认为 B2C
~~DutyPaymentMethod~~	DutyPaymentMethod		关税结算方式已废弃，系统会自动判断关税结算方式
TrackingNumber	string		预分配挂号
~~CheckRepeat~~	bool		检查客单号是否重复已废弃，系统会强制检查客单号是否重复
IsMPS	bool		快递一票多件(multiple package shipment)
MPSType	ParcelMPSType		快递一票多件类型	如:Normal, FBA
Cases	ParcelCaseInfo[]		快递一票多件,箱子列表
AllowRemoteArea	bool		是否允许偏远区域下单，默认值为 `true` 如果设置值为false，并且地址属于偏远区域，此接口则会返回代码为 `0x10008E` 的错误
AutoConfirm	bool		自动确认交运包裹，或此值为true，则无须再调用确认交运包裹接口
ShipperInfo	ParcelShipperInfo		发件人地址与税号信息发件人信息必须提供英文或者拼音的名称与地址以及联系方式英国脱欧后，进入英国货物需要提供 VatNo 欧盟2021税改后，进入欧盟货物需要提供 IOSS 按美国 T86 新规，进入美国的包裹需要提供完整的发件人信息(发件人名称，具体地址、邮箱、电话)方可清关。系统优先使用包裹上的发件人地址信息进行清关，如果包裹上未提供此信息，系统则取客户资料上留存的默认发件地址。 B2B类型或者B2C的高价值包裹必须填写 EORI

示例请求

{
    "ReferenceId": "REF1000000006",
    "SellingPlatformOrder": null,
    "ShippingAddress": {
        "Company": "Company",
        "Street1": "Street1",
        "Street2": "Street1",
        "Street3": null,
        "City": "City",
        "Province": "",
        "Country": "",
        "CountryCode": "GB",
        "Postcode": "NW1 6XE",
        "Contacter": "Jon Snow",
        "Tel": "134567890",
        "Email": "",
        "TaxId": ""
    },
    "WeightInKg": 1.2,
    "ItemDetails": [{
        "GoodsId": "GoodsId",
        "GoodsTitle": "GoodsTitle",
        "DeclaredNameEn": "Test",
        "DeclaredNameCn": "品名测试",
        "DeclaredValue": {
            "Code": "USD",
            "Value": 5.0
        },
        "WeightInKg": 0.6,
        "Quantity": 2,
        "HSCode": "",
        "CaseCode": "",
        "SalesUrl": "http://www.amazon.co.uk/gp/product/B00FEDIPQ4",
        "IsSensitive": false,
        "Brand": "",
        "Model": "",
        "MaterialCn": "",
        "MaterialEn": "",
        "UsageCn": "",
        "UsageEn": ""
    }],
    "TotalValue": {
        "Code": "USD",
        "Value": 10.0
    },
    "TotalVolume": {
        "Length": 1.0,
        "Width": 1.0,
        "Height": 1.0,
        "Unit": "CM"
    },
    "WithBatteryType": "NOBattery",
    "Notes": "Test",
    "BatchNo": "",
    "WarehouseCode": "SZ",
    "ShippingMethod": "3HPA",
    "ItemType": "SPX",
    "TradeType": "B2C",
    "TrackingNumber": "",
    "IsMPS": false,
    "MPSType": null,
    "Cases": [],
    "AllowRemoteArea": true,
    "AutoConfirm": false,
    "ShipperInfo": null
}

返回数据格式说明

返回数据格式

名称	类型	描述
ProcessCode	string	包裹处理号
IndexNumber	string	检索号
ReferenceId	string	客户订单号
TrackingNumber	string	跟踪号注意：部分渠道在创建包裹时不一定能够立即返回跟踪号，您需要调用获取包裹接口来查询包裹信息并试图获得跟踪号
IsVirtualTrackingNumber	bool	是否为虚拟跟踪号如果为 true，请先打单发货，待我司操作之后才会分配最终的派送单号。您需要视平台标记发货方式而定，有选择性地调用获取包裹接口来查询包裹真实派送单号。一般只有美国USPS渠道才会出现此情况。如果为false，可忽略。
SortCode	string	包裹分区码要求客户分区装箱时，可以通过此字段获取包裹所属的分区。跟踪号分配成功状态下，此分区码方才有效。
IsRemoteArea	bool	是否偏远
Status	string	状态，如果请求中 AutoConfirm 参数为 true，返回的状态为 Confirmed，否则为 Original

返回数据示例

{
  "Data": {
    "ProcessCode": "SBXPAA0000038638YQ",
    "IndexNumber": "90010000038638",
    "ReferenceId": "REF1000000006",
    "TrackingNumber": "",
    "IsVirtualTrackingNumber": false,
    "SortCode": "",
    "IsRemoteArea": false,
    "Status": "Original"
  },
  "Succeeded": true,
  "Error": null
}

其它说明

我司系统限定了同一客单号只能下一个单（所有客户全局唯一）。因此您需要能够控制到您系统内的每个单只能来下一次单。客单号重复的错误代码为 0x100005。

如果您的系统内需要修改地址并重新获取跟踪号的话，您可以选择
- 使用新的客单号来申请
- 调用删除包裹接口删除现有数据，并重新下单，但这要求之前的包裹数据没有被确认交运过
在特殊情况下，如创建包裹成功而将相应数据保存到您系统数据库时失败，或者在我司系统创建包裹成功，而在您那端网络超时等，您需要使用相同客单号与地址信息再次创建包裹，除了1中的选择以外，你还可以通过判断错误代码为 0x100005，选择通过客单号使用搜索包裹接口，来获取上次创建的包裹并获得相应的处理号以及跟踪号信息。

变更记录

2021-07-19

返回数据结构中新增 SortCode 属性

2021-06-17

请求数据，发件人 ShipperInfo 税号格式变更，并支持 IOSS

2020-12-28

请求数据，新增 SellingPlatformOrder

2019-12-02

请求数据，收件人地址中新增收件人税号 TaxId

2019-08-21

返回数据结构中新增 IsVirtualTrackingNumber 与 Status 属性

2016-06-01

请求数据结构中新增 AllowRemoteArea 参数
返回数据结构中新增 IsRemoteArea 属性

2016-02-27

请求数据结构中移除 DutyPaymentMethod 参数

2015-08-26

请求数据结构中新增 TradeType 参数
ShipperInfo中新增 EORI 参数

2015-06-26

请求数据结构中新增 MPSType 参数，当包裹是一票多件时,需要填写

2015-06-06

请求数据结构中新增 ShipperInfo 参数，当客户是代理时,必须填写

2015-05-11

请求数据结构中移除 CheckRepeat 参数，系统将强制要求客单号不得重复

2015-05-11

请求数据结构中新增 AutoConfirm 参数

2015-04-17

请求数据结构中新增 WarehouseCode 参数，原参数 ProcessLocation 不再推荐使用