WMS_API

/接口授权


xxxxxxxxxx
接口授权请在请求头部Header增加ApiToken值校验

参数名	示例值	参数类型	是否必填	参数描述
ApiToken	-	Text	是	ApiToken授权信息

接口返回内容中的code值为200时为成功返回，错误返回时code值为400为请求内容错误，错误提示信息在message字段中显示

/系统基础接口


xxxxxxxxxx
系统基础数据相关接口

/仓库列表


xxxxxxxxxx
暂无描述

接口URL

/common/warehouse

请求方式

POST

请求返回示例


xxxxxxxxxx
[
  {
    "warehouseCode": "USCAA",
    "warehouseName": "美国CA仓库"
  },
  {
    "warehouseCode": "USCAB",
    "warehouseName": "美国洛杉矶仓库"
  }
]

/SKU与库存管理

/SKU与库存管理/SKU创建


xxxxxxxxxx
新建SKU

接口URL

/sku/create

请求方式

POST

Content-Type

json

请求Body参数


xxxxxxxxxx
{
  "sku": "SKU",   
  "productNameCN": "产品名", 
  "productNameEN": "Mobile", 
  "length": 10, 
  "width": 10,
  "height": 10, 
  "weight": 1,  
  "remark": ""
}

参数名	示例值	参数类型	参数描述
sku	SKU	Text	系统唯一SKU,字符限制4-35位字符
productNameCN	产品名	Text	产品中文名
productNameEN	Mobile	Text	产品英文名
length	40	Float	产品包装长(cm)
width	50	Float	产品包装长(cm)
height	50	Float	产品包装长(cm)
weight	10	Float	产品总重量(kg)
remark		Text	选填
hsCode		Text	选填，海关编码
declareValue		Text	选填，申报价值

请求返回示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "sku": "SKU",
        "productNameCN": "产品名",
        "productNameEN": "Mobile",
        "declareValue": null,
        "weight": 1, 
        "length": 10,
        "width": 10,
        "height": 10,
        "weightChecked": 0,  //仓库核重数据
        "lengthChecked": 0, //仓库核尺数据
        "widthChecked": 0, //仓库核尺数据
        "heightChecked": 0 //仓库核尺数据
    }
}

####

/SKU与库存管理/删除SKU


xxxxxxxxxx
仅创建无任何其它关联记录时可删除

接口URL

/sku/delete

请求方式

POST

请求Body参数


xxxxxxxxxx
{
    "sku":"SKU"
}

参数名	示例值	参数类型	参数描述
sku	TESTSKU	Text	系统唯一SKU,字符限制4-35位字符

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "data": []
}

/SKU与库存管理/SKU信息列表查询


xxxxxxxxxx
查询SKU列表

接口URL

/sku/list

请求方式

POST

请求Body参数


xxxxxxxxxx
{
  "page": "",
  "createdTimeBefore": "",
  "createdTimeAfter": "",
  "lastUpdatedTimeBefore": "",
  "lastUpdatedTimeAfter": ""
}

参数名	参数类型	参数描述
page	Text	页码,默认1,每页50条记录
createdTimeBefore	Text	创建时间在此日期之前
createdTimeAfter	Text	创建时间在此日期之后
lastUpdatedTimeBefore	Text	最后更新时间在此日期之前
lastUpdatedTimeAfter	Text	最后更新时间在此日期之后

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "list": [
            {
                "sku": "SKU",
                "productNameCN": "产品名",
                "productNameEN": "Mobile",
                "declareValue": null,
                "weight": 1, 
                "length": 10,
                "width": 10,
                "height": 10,
                "weightChecked": 0,
                "lengthChecked": 0,
                "widthChecked": 0,
                "heightChecked": 0
            }
        ],
        "total": 1,
        "page": 1,
        "pageSize": 15
    }
}

/SKU与库存管理/SKU详情查询


xxxxxxxxxx
查询单个SKU详情

接口URL

/sku/detail

请求方式

POST

请求Body参数


xxxxxxxxxx
{
    "sku":"SKU"
}

参数名	示例值	参数类型	参数描述
sku	TESTSKU	Text	系统唯一SKU,字符限制4-35位字符

请求返回示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "sku": "SKU",
        "productNameCN": "产品名",
        "productNameEN": "Mobile",
        "declareValue": null,
        "weight": 1, 
        "length": 10,
        "width": 10,
        "height": 10,
        "weightChecked": 0,  //仓库核重数据
        "lengthChecked": 0, //仓库核尺数据
        "widthChecked": 0, //仓库核尺数据
        "heightChecked": 0 //仓库核尺数据
    }
}

####

/SKU与库存管理/SKU库存列表查询


xxxxxxxxxx
库存查询

接口URL

/sku/inventory

请求方式

POST

请求Body参数


xxxxxxxxxx
{
  "warehouseCode":"USTEST",
  "skuList":["SKU1"],
  "lastUpdatedTimeBefore": "",
  "lastUpdatedTimeAfter": "",
  "page": "1",

}

参数名	参数类型	参数描述
warehouseCode	Text	仓库代码
skuList	Array	可选，指定SKU返回
lastUpdatedTimeBefore	Text	最后更新时间在此日期之前
lastUpdatedTimeAfter	Text	最后更新时间在此日期之后
page	Text	页码,默认1,每页50条记录

####

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "list": [
            {
                "sku": "SKUTEST",
                "warehouseCode": "USCATEST",
                "inventory": 200,    //可用库存
                "inventoryOrdered": 0,  //已下单库存(锁定库存)
                "skuDetail": {
                    "sku": "SKUTESTJH2",
                    "productNameCN": "SKUTESTJH2",
                    "productNameEN": "SKUTESTJH2",
                    "declareValue": null,
                    "weight": 5,
                    "length": 5,
                    "width": 6,
                    "height": 7,
                    "weightChecked": 0,
                    "lengthChecked": 0,
                    "widthChecked": 0,
                    "heightChecked": 0,
                    "hsCode": null,
                }
            }
        ],
        "total": 1,
        "page": "1",
        "pageSize": 15
    }
}

####

/SKU与库存管理/SKU库存出入库记录查询


xxxxxxxxxx
SKU库存出入库记录查询

接口URL

/sku/inventoryIO

请求方式

POST

请求Body参数


xxxxxxxxxx
{
  "warehouseCode":"USTEST",
  "skuList":["SKU1"],
  "lastUpdatedTimeBefore": "",
  "lastUpdatedTimeAfter": "",
  "page": 1,
    "pageSize": 50

}

参数名	参数类型	参数描述
warehouseCode	Text	仓库代码
skuList	Array	可选，指定SKU返回
lastUpdatedTimeBefore	Text	最后更新时间在此日期之前
lastUpdatedTimeAfter	Text	最后更新时间在此日期之后
page	Text	页码,默认1,每页50条记录
pageSize	Text	每页记录量

####

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "list": [
            {
                "sku": "SKU1",
                "warehouseCode": "USCATEST",
                "quantity": 2,  //操作数量
                "inventoryType": "outbound",  //库存处理类型：inbound入库  outbound出库
                "inventoryTypeName": "出库",
                "remark": "",
                "bussinessOrderNumber": "", //出库业务单单号
                "bussinessName": "转运出库",
                "updatedAt": "2024-02-01 09:00:00" //操作更新时间
            }
        ],
        "total": 1,
        "page": 1,
        "pageSize": 50
    }
}

####

/SKU与库存管理/SKU库龄查询


xxxxxxxxxx
SKU库龄查询

接口URL

/sku/inventoryAge

请求方式

POST

请求Body参数


xxxxxxxxxx
{
  "warehouseCode":"USTEST",
  "skuList":["SKU1"],
  "page": 1,
    "pageSize": 50,

}

参数名	参数类型	参数描述
warehouseCode	Text	仓库代码
skuList	Array	可选，指定SKU返回
lastUpdatedTimeBefore	Text	最后更新时间在此日期之前
lastUpdatedTimeAfter	Text	最后更新时间在此日期之后
page	Text	页码,默认1,每页50条记录
pageSize	Text	每页记录量

####

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "list": [
            {
                "warehouseCode": "USTEST",
                "sku": "SKU1",
                "ageDays": 50, //库龄天数
                "quantity": 1000, //数量
                "updatedAt": "2025-02-01 10:00:00"
            }
        ],
        "total": 1,
        "page": 1,
        "pageSize": 1
    }
}

/入库单


xxxxxxxxxx
入仓单相关接口

####

/入库单/创建入库预报单


xxxxxxxxxx
计划入仓的货物需创建入库预报单，提交预报单后等待仓库接收入库

接口URL

/inboundOrder/create

请求方式

POST

请求Body参数


xxxxxxxxxx
{
    "customNumber":"",
    "warehouseCode": "USTEST", 
    "shippingType": "4",
    "shippingDate": "2022-01-01",
    "shippingDetail":[
        {
       "carrier":"DHL",
       "trackingCode":"8100000000"
        }
    ],
    "packageList": [
    {
     "customNumber": "1",
    "length": "10", 
    "width": "10",  
    "height": "10", 
    "weight": "10",   
    "packageQuantity": 1, 
    "skuList": [   
    {
    "sku": "TESTSKU", 
    "quantity": 10,  
    }],
    "remark": "",   
    }
    ],
    "remark": "备注",
    }

参数名	示例值	参数类型	参数描述
customNumber		Text	选填，自定义入库编号，唯一
warehouseCode	USCAA	Text	仓库代码
shippingType	4	Text	头程类型:1海运整柜 2海运拼柜 3空运 4快递
shippingDate	2022-01-01	Text	发货日期
shippingDetail		Text	发货物流信息明细
shippingDetail.carrier	DHL	Text	承运商
shippingDetail.trackingCode	8100000000	Text	物流跟踪查询号(柜号/快递单号)
packageList		Text
packageList.customNumber	1	Text	自定义箱号
packageList.length	10	Text
packageList.width	10	Text
packageList.height	10	Text
packageList.weight	10	Text
packageList.checkQuantity	false	bool	是否清点货物，值为true,false,默认为false
packageList.packageQuantity	1	Text	同类箱数
packageList.skuList		Text	单个箱子sku清单明细
packageList.skuList.sku	TESTSKU	Text
packageList.skuList.quantity	10	Text
packageList.remark		Text
remark	备注	Text

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "inboundOrderNumber": "IN0051",
        "warehouseCode": "USTEST",
        "statusCode": "REVIEW",
        "statusName": "待审核",
        "storageAt": "", //入库时间,如已入库则显示入库时间
        "remark": null,
        "packageList": [
            {
                "packageNumber": "IB0051-1",
                "packageQuantity": 1,  
                "packageQuantityReceived": 0,
                "skuList": [
                    {
                        "sku": "sku1",
                        "packageSkuQuantity": 20, //SKU预报数量
                        "totalQuantityReceived": 0,  //SKU实际接收数量
                        "weightChecked": 10, //SKU核重 kg
                        "lengthChecked": 40, //SKU核尺 长 cm
                        "widthChecked": 30, //SKU核尺 宽 cm
                        "heightChecked": 30 //SKU核尺 高 cm
                    }
                ],
                "weight": 0.1,
                "length": 56.2,
                "width": 37.4,
                "height": 36.2,
                "packageLabelUrl": "" //箱标返回
            }
        ]
    }
}

/入库单/入库单详情

接口URL

/inboundOrder/detail

请求Body参数


xxxxxxxxxx
{
    "customNumber":"",
    "inboundOrderNumber":""
}

参数名	示例值	参数类型	参数描述
customNumber		Text	自定义编号,与入库单号选传一个
inboundOrderNumber		Text	系统入库单号,与自定义编号选传一个

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "inboundOrderNumber": "IN0051",
        "warehouseCode": "USTEST",
        "statusCode": "REVIEW",
        "statusName": "待审核",
        "storageAt": "", //入库时间,如已入库则显示入库时间
        "remark": null,
        "packageList": [
            {
                "packageNumber": "IB0051-1",
                "packageQuantity": 1,  
                "packageQuantityReceived": 0,
                "skuList": [
                    {
                        "sku": "sku1",
                        "packageSkuQuantity": 20, //SKU预报数量
                        "totalQuantityReceived": 0,  //SKU实际接收数量
                        "weightChecked": 10, //SKU核重 kg
                        "lengthChecked": 40, //SKU核尺 长 cm
                        "widthChecked": 30, //SKU核尺 宽 cm
                        "heightChecked": 30 //SKU核尺 高 cm
                    }
                ],
                "weight": 0.1,
                "length": 56.2,
                "width": 37.4,
                "height": 36.2,
                "packageLabelUrl": "" //箱标返回
            }
        ]
    }
}

####

/入库单/查询入库单列表


xxxxxxxxxx
查询历史入库单记录

接口URL

/inboundOrder/list

请求方式

POST

请求Body参数


xxxxxxxxxx
{
  "warehouseCode":"",
  "createdTimeBefore": "",
  "createdTimeAfter": "",
  "lastUpdatedTimeBefore": "",
  "lastUpdatedTimeAfter": "",
  "page": "",

}

参数名	参数类型	参数描述
warehouseCode	Text	仓库代码
createdTimeBefore	Text	在此创建时间之前
createdTimeAfter	Text	在此创建时间之后
lastUpdatedTimeBefore	Text	最后更新时间之前
lastUpdatedTimeAfter	Text	最后更新时间之后
page	Text	分页页码，数字类型

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "list": [
            {
                "inboundOrderNumber": "IN0051",
                "warehouseCode": "USTEST",
                "statusCode": "REVIEW",
                "statusName": "待审核",
                "storageAt": "", //入库时间,如已入库则显示入库时间
                "remark": null,
                "packageList": [
                    {
                        "packageNumber": "IB0051-1",
                        "packageQuantity": 1,  
                        "packageQuantityReceived": 0,
                        "skuList": [
                            {
                                "sku": "sku1",
                                "packageSkuQuantity": 20, //SKU预报数量
                                "totalQuantityReceived": 0,  //SKU实际接收数量
                                "weightChecked": 10, //SKU核重 kg
                                "lengthChecked": 40, //SKU核尺 长 cm
                                "widthChecked": 30, //SKU核尺 宽 cm
                                "heightChecked": 30 //SKU核尺 高 cm
                            }
                        ],
                        "weight": 0.1,
                        "length": 56.2,
                        "width": 37.4,
                        "height": 36.2,
                        "packageLabelUrl": "" //箱标返回
                    }
                ]
            }
        ],
        "total": 48,
        "page": 1,
        "pageSize": 1
    }
}

/入库单/变更入库单状态(取消或提交审核入库)


xxxxxxxxxx
当前仅用于取消和提交审核操作

接口URL

/inboundOrder/status

请求方式

POST

Content-Type

json

请求Body参数


xxxxxxxxxx
{
    "customNumber":"",
    "inboundOrderNumber":"",
    "statusCode":""
}

参数名	参数类型	参数描述
customNumber	Text	自定义编号,与入库单号选传一个
inboundOrderNumber	Text	系统入库单号,与自定义编号选传一个
statusCode	Text	目标状态码

返回示例数据


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {}
}

/入库单/状态码列表


xxxxxxxxxx
入库单所有状态码列表

状态码	状态名	描述
DRAFT	待提交
REIVEW	待审核	提交审核使用该状态码
IN_TRANSIT	待到仓
RECEIVED	已接收
COMPLETED	已入库
PART_STOCKED	部分入库
REJECT	未通过审核
CANCELED	已取消	取消入库单使用该状态码

####

/代发订单


xxxxxxxxxx
一件代发出库订单相关接口

####

/代发订单/订单详情


xxxxxxxxxx
获取单个订单最新详情和状态

接口URL

/outboundOrder/detail

请求方式

POST

请求Body参数


xxxxxxxxxx
{
   "customOrderNumber":"TESTORDER001",
   "orderNumber":"165464665",
}

参数名	示例值	参数类型	参数描述
sellerOrderNumber	TESTORDER001	Text	选取一个参数传递
orderNumber	165464665	Text	选取一个参数传递

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
                "customOrderNumber": "TEST32131",
                "orderNumber": "168264411677697",
                "warehouseCode": "USTEST",
                "shipTo": {
                    "company": "test",
                    "name": "test",
                    "country": "US",
                    "state": "WA",
                    "city": "Issaquah",
                    "postalCode": "98027",
                    "phone": "8000000000",
                    "street1": "street1 test",
                    "street2": null
                },
                "skuList": [
                    {
                        "sku": "sku1",
                        "skuQty": 1
                    }
                ],
                "shipment": {
                    "carrier": "FedEx",
                    "carrierService": "FEDEX_GROUND",
                    "trackingCode": "770000000000"
                }
                "carrier": "FedEx",
                "carrierService": "FEDEX_GROUND",
                "shipmentFee": {
                    "amount": 12.34, //运费
                    "currency": "USD"
                },
                "feeList": [
                    {
                        "code": "HANDLE",
                        "amount": 2,
                        "currency": "USD",
                        "description": "订单处理费"
                    }
                ],
                "statusCode": "SHIPPED",
                "statusName": "已发货",
                "errorMessage": null,
                "remark": null
            }
}

####

/代发订单/订单列表查询


xxxxxxxxxx
获取多个订单详情数据

接口URL

/outboundOrder/list

请求方式

POST

请求Body参数


xxxxxxxxxx
{
  "warehouseCode":"",
  "createdTimeBefore": "",
  "createdTimeAfter": "",
  "lastUpdatedTimeBefore": "",
  "lastUpdatedTimeAfter": "",
  "page": "",

}

参数名	参数类型	参数描述
warehouseCode	Text
createdTimeBefore	Text
createdTimeAfter	Text
lastUpdatedTimeBefore	Text
lastUpdatedTimeAfter	Text
page	Text	分页页码，数字类型

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "data": {
        "list": [
            {
                "customOrderNumber": "TEST32131",
                "orderNumber": "168264411677697",
                "warehouseCode": "USTEST",
                "shipTo": {
                    "company": "test",
                    "name": "test",
                    "country": "US",
                    "state": "WA",
                    "city": "Issaquah",
                    "postalCode": "98027",
                    "phone": "8000000000",
                    "street1": "street1 test",
                    "street2": null
                },
                "skuList": [
                    {
                        "sku": "sku1",
                        "skuQty": 1
                    }
                ],
                "shipment": {
                    "carrier": "FedEx",
                    "carrierService": "FEDEX_GROUND",
                    "trackingCode": "770000000000"
                }
                "carrier": "FedEx",
                "carrierService": "FEDEX_GROUND",
                "shipmentFee": {
                    "amount": 12.34, //运费
                    "currency": "USD"
                },
                "feeList": [
                    {
                        "code": "HANDLE",
                        "amount": 2,
                        "currency": "USD",
                        "description": "订单处理费"
                    }
                ],
                "statusCode": "SHIPPED",
                "statusName": "已发货",
                "errorMessage": null,
                "remark": null
            }
        ],
        "total": 4,
        "page": 1,
        "pageSize": 15
    }
}

####

/代发订单/创建订单

接口URL

/outboundOrder/create

请求方式

POST

请求Body参数


xxxxxxxxxx
{
    "warehouseCode": "USCAA", 
     "customOrderNumber": "TESTORDER123",
     "salePlatformCode":"",
     "storeCode":"",
     "shipTo":{
         "company":"test",
         "name": "test",  
          "phone": "8000000000",  
          "street1": "street1 test",    
          "street2": "",    
          "city": "Issaquah", 
          "country": "US",    
          "state": "WA",  
          "postalCode": "98027", 
     },
  "remark": "", 
  "carrier": "",  
  "skuList": [    //订单sku产品数组
  {
  "sku": "TESTSKU",   //产品sku
  "skuQty": 1 //sku订单数量
  }
  ],
  "options":{
      "WarehouseLabel": true,
      "deliveryConfirmation": false,  
  }, 
  
  }

参数名	示例值	参数类型	参数描述
submitType	1	Inter	提交类型，默认值1表示订单提交至待提交状态，值2订单提交至待处理状态
warehouseCode	USCAA	Text	必填，仓库代码
customOrderNumber	TESTORDER123	Text	必填，客户自定义单号，单号唯一
platformOrderNumber	TESTORDER123	Text	选填，销售平台单号，无唯一限制，比如平台同单号拆单也可使用相同单号
salePlatformCode		Text	销售平台代码
storeCode		Text	店铺代码
shipTo		Text	必填，订单派送地址信息
shipTo.company	test	Text
shipTo.name	test	Text	订单收件人名称
shipTo.phone	8000000000	Text	收件人电话号码
shipTo.street1	street1 test	Text	街道地址1
shipTo.street2		Text	街道地址2
shipTo.city	Issaquah	Text	城市
shipTo.country	US	Text	国家两位简码，如US
shipTo.state	WA	Text	洲/省两位简码，如CA
shipTo.postalCode	98027	Text	邮编
remark		Text
carrier	UPS	Text	可选，订单物流商值：UPS/FedEx/USPS，非特殊需求通常不建议填写，系统自动选择最优物流商
carrierService	Ground	Text	可选，物流商名下渠道物流方式，当前无特殊要求不要填写
trackingCode		Text	选填，当为自有运单时可上传物流商跟踪号
labelData		Text	选填，当为自有运单时时上传运单pdf文件base64编码
skuList		Text	必填，订单SKU明细
skuList.sku	TESTSKU	Text	系统SKU
skuList.skuQty	1	Text	SKU数量
skuList.reference	1	Text	SKU参考信息
options		Text	订单选项
options.warehouseLabel	true	bool	仓库提供运单，默认为true，如为false则需要上传自有运单信息
options.deliveryConfirmation	false	bool	签收增值服务，收取签收费用，默认为false
options.insureAmount	200	Number	保险金额，默认为0不购买保险，传入金额则为购买保险

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "customOrderNumber": "3014239572",
        "orderNumber": "5131787752116",
        "warehouseCode": "USTEST",
        "shipTo": {
            "company": null,
            "name": "test",
            "country": "US",
            "state": "KS",
            "city": "Louisville",
            "postalCode": "40222",
            "phone": "5134608915",
            "street1": "test",
            "street2": null
        },
        "skuList": [
            {
                "sku": "SKUTEST",
                "skuQty": 1
            }
        ],
        "shipment": null,
        "carrier": null,
        "carrierService": null,
        "statusCode": "PENDING",
        "statusName": "待处理",
        "errorMessage": null,
        "remark": "3014239572"
    }
}

/代发订单/变更订单状态（取消或提交订单处理）


xxxxxxxxxx
当订单需要取消时可使用该接口，仅支持未处理订单取消

接口URL

/outboundOrder/status

请求方式

POST

请求Body参数


xxxxxxxxxx
{
   "orderNumber":"165464665",
   "statusCode":"cancel"
}

参数名	示例值	参数类型	参数描述
customOrderNumber	TESTORDER001	Text	自定义单号
orderNumber	165464665	Text	系统订单号
statusCode	cancel	Text	变更的目标状态码

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {
        "customOrderNumber": "3014239572",
        "orderNumber": "5131787752116",
        "warehouseCode": "USTEST",
        "shipTo": {
            "company": null,
            "name": "test",
            "country": "US",
            "state": "KS",
            "city": "Louisville",
            "postalCode": "40222",
            "phone": "5134608915",
            "street1": "test",
            "street2": null
        },
        "skuList": [
            {
                "sku": "SKUTEST",
                "skuQty": 1
            }
        ],
        "shipment": null,
        "carrier": null,
        "carrierService": null,
        "statusCode": "PENDING",
        "statusName": "待处理",
        "errorMessage": null,
        "remark": "3014239572"
    }
}

/代发订单/上传或更新自有物流信息


xxxxxxxxxx
当订单使用用户自用物流运单时，可使用该接口更新/上传自有物流单信息。

接口URL

/outboundOrder/syncShipment

请求方式

POST

请求Body参数


xxxxxxxxxx
{
    "orderNumber":"546564546",
    "carrier":"FedEx",
    "carrierService":"",
    "trackingCode":"78653131566",
    "labelData":"文件base64数据",
}

参数名	参数类型	参数描述
orderNumber	Text	系统订单号
carrier	Text	必填,物流商
carrierService	Text	选填,物流商服务方式
trackingCode	Text	必填，物流商跟踪号
labelData	Text	必填，运单pdf文件base64编码

返回示例数据


xxxxxxxxxx
{
    "code": 200,
    "message": "",
    "data": {}
}

/代发订单/状态码列表


xxxxxxxxxx
代发订单所有状态码列表

状态码	状态名	描述
DRAFT	待提交
PENDING	待处理
HANDLING	处理中
SHIPPED	已发货
HOLDED	暂缓
ABNORMAL	异常订单
CANCELLED	已取消

/物流运单服务/询价

接口URL

/shipment/rates

请求方式

POST

请求Body参数


xxxxxxxxxx
{
    "shipFrom": {
        "company": "TEST",
        "name": "TEST",
        "country": "US",
        "state": "CA",
        "city": "rowland height",
        "street1": "test",
        "street2": "",
        "postalCode": "91748",
        "phone": "0000000000"
    },
    "shipTo": {
        "company": "TEST",
        "name": "TEST",
        "country": "US",
        "state": "CA",
        "city": "rowland height",
        "street1": "test",
        "street2": "",
        "postalCode": "91748",
        "phone": "0000000000",
        "residential": true
    },
    "packages": [
        {
            "length": 10,
            "width": 10,
            "height": 10,
            "weight": 14,
            "quantity": 1,
            "reference1": "REF01"
        }
    ],
    "options": {
        "dimUnit": "IN",
        "weightUnit": "LBS",
        "deliveryConfirmation": ""
    }
}

请求示例2


xxxxxxxxxx
{
    "storeCode":"TESTStore",
    "shipFrom": {
        "addressCode": "TEST",
    },
    "shipTo": {
        "company": "TEST",
        "name": "TEST",
        "country": "US",
        "state": "CA",
        "city": "rowland height",
        "street1": "test",
        "street2": "",
        "postalCode": "91748",
        "phone": "0000000000",
        "residential": true
    },
    "skuList": [
        {
            "sku":"testsku",
            "skuQty":1
        }
    ],
    "options": {
        "deliveryConfirmation": ""
    }
}

参数名	参数类型	参数描述
storeCode	string	选填,销售店铺账号代码,需存在于系统设置店铺管理中
shipFrom	Object	发件地址
shipFrom.addressCode	string	选填,仓库地址代码,系统预设地址,如填写该字段则以下发件地址被忽略(可不传),将以此地址代码对应的详细地址为准
shipFrom.company	string	公司名
shipFrom.name	string	联系人
shipFrom.country	string	国家两位简写
shipFrom.state	string	洲两位简写
shipFrom.city	string	城市
shipFrom.street1	string	详细街道地址一
shipFrom.street2	string	详细街道地址二
shipFrom.postalCode	string	邮编
shipFrom.phone	string	电话
shipTo	Object	收件地址
shipTo.company	string	公司名
shipTo.name	string	联系人
shipTo.country	string	国家两位简写
shipTo.state	string	洲两位简写
shipTo.city	string	城市
shipTo.street1	string	详细街道地址一
shipTo.street2	string	详细街道地址二
shipTo.postalCode	string	邮编
shipTo.phone	string	电话
shipTo.residential	bool	是否住宅，默认住宅
packages	Array	与skuList选一项必填,订单包裹数组，如未传SKU必传此项，如传SKU请不要传此项，此项优先于SKU列表skuList
packages.length	string	长
packages.width	string	宽
packages.height	string	高
packages.quantity	string	包裹数量
packages.reference1	string	包裹参考信息
skuList	Array	与packages选一项必填,,订单SKU数组，如同时传SKU和packages包裹尺寸，包裹将以packages为准，否则按系统中SKU的尺寸重量自动预报包裹
skuList.sku	string	系统SKU
skuList.skuQty	string	SKU数量，未传包裹数据将自动按此数量生成包裹数
options	Object	订单选项
options.dimUnit	枚举	尺寸单位值：INCH，CM
options.weightUnit	枚举	重量单位值：LBS, KG
options.deliveryConfirmation	枚举	签收服务，不传默认为空不签收，签收传值signature

/物流运单服务/打单

接口URL

/shipment/createLabel

请求方式

POST

请求Body参数


xxxxxxxxxx
{
    "orderNumber": "T0928034",
    "carrier": "UPS",
    "carrierService": "Ground",
    "shipFrom": {
        "company": "TEST",
        "name": "TEST",
        "country": "US",
        "state": "CA",
        "city": "rowland height",
        "street1": "test",
        "street2": "",
        "postalCode": "91748",
        "phone": "0000000000"
    },
    "shipTo": {
        "company": "TEST",
        "name": "TEST",
        "country": "US",
        "state": "CA",
        "city": "rowland height",
        "street1": "test",
        "street2": "",
        "postalCode": "91748",
        "phone": "0000000000",
        "residential": true
    },
    "packages": [
        {
            "length": 10,
            "width": 10,
            "height": 10,
            "weight": 14,
            "quantity": 1,
            "reference1": "REF01"
        }
    ],
    "options": {
        "dimUnit": "IN",
        "weightUnit": "LBS",
        "deliveryConfirmation": ""
    }
}

请求示例2


xxxxxxxxxx
{
    "orderNumber": "T0928034",
    "carrier": "UPS",
    "carrierService": "Ground",
    "storeCode":"TESTStore",
    "shipFrom": {
        "addressCode": "TEST",
    },
    "shipTo": {
        "company": "TEST",
        "name": "TEST",
        "country": "US",
        "state": "CA",
        "city": "rowland height",
        "street1": "test",
        "street2": "",
        "postalCode": "91748",
        "phone": "0000000000",
        "residential": true
    },
    "skuList": [
        {
            "sku":"testsku",
            "skuQty":1
        }
    ],
    "options": {
        "deliveryConfirmation": ""
    }
}

参数名	示例值	参数类型	参数描述
shipmentId		string	订单shipmentId，可选，仅用于二次获取运单时使用，值由第一次请求打单返回，主要应用于非实时出单渠道，详情请咨询客服
orderNumber		string	销售订单编号
carrier		string	物流服务商FedEx/UPS/USPS
carrierService		string	物流服务渠道代码
storeCode		string	选填,销售店铺账号代码,需存在于系统设置店铺管理中
shipFrom		Object	发件地址
shipFrom.addressCode		string	选填,仓库地址代码,系统预设地址,如填写该字段则以下发件地址被忽略(可不传),将以此地址代码对应的详细地址为准
shipFrom.company		string	公司名
shipFrom.name		string	联系人
shipFrom.country		string	国家两位简写
shipFrom.state		string	洲两位简写
shipFrom.city		string	城市
shipFrom.street1		string	详细街道地址一
shipFrom.street2		string	详细街道地址二
shipFrom.postalCode		string	邮编
shipFrom.phone		string	电话
shipTo		Object	收件地址
shipTo.company		string	公司名
shipTo.name		string	联系人
shipTo.country		string	国家两位简写
shipTo.state		string	洲两位简写
shipTo.city		string	城市
shipTo.street1		string	详细街道地址一
shipTo.street2		string	详细街道地址二
shipTo.postalCode		string	邮编
shipTo.phone		string	电话
shipTo.residential		bool	是否住宅，默认住宅
packages		Array	与skuList选一项必填,订单包裹数组，如未传SKU必传此项，如传SKU请不要传此项，此项优先于SKU列表skuList
packages.length		string	长
packages.width		string	宽
packages.height		string	高
packages.quantity		string	包裹数量
packages.reference1		string	包裹参考信息
packages.insureAmount	200	Number	保险金额，默认为0不购买保险，传入金额则为每个包裹购买相应保险
skuList		Array	与packages选一项必填,,订单SKU数组，如同时传SKU和packages包裹尺寸，包裹将以packages为准，否则按系统中SKU的尺寸重量自动预报包裹
skuList.sku		string	系统SKU
skuList.skuQty		string	SKU数量，未传包裹数据将自动按此数量生成包裹数
options		Object	订单选项
options.dimUnit		枚举	尺寸单位值：INCH，CM
options.weightUnit		枚举	重量单位值：LBS, KG
options.deliveryConfirmation		枚举	签收服务，不传默认为空不签收，签收传值signature

/物流运单服务/订单详情


xxxxxxxxxx
通过shipmentId或trackingCode获取单信息

接口URL

/shipment/detail

请求方式

POST

请求Body参数


xxxxxxxxxx
{
    "shipmentId": "" 
}

参数名	示例值	参数类型	参数描述
shipmentId		string	订单shipmentId
trackingCode		string	(主)运单号

/物流运单服务/取消运单

接口URL

/shipment/cancel

请求方式

POST

Content-Type

json

请求Body参数


xxxxxxxxxx
{
    "trackingCode": "777XXXXXXXXXX" 
}

参数名	示例值	参数类型	参数描述
trackingCode		string	(主)运单号

/物流运单服务/订单状态码列表


xxxxxxxxxx
代发订单所有状态码列表

状态码	状态名	描述
DRAFT	初始单待生成	系统建单初始状态，此状态未生成运单，需手动确认生成
PENDING	等待生成中
HANDLING	处理中
SHIPPED	已发货
HOLDED	暂缓
ABNORMAL	异常订单
CANCELLED	已取消

/物流运单服务/校验地址


xxxxxxxxxx
检查地址信息是否正确，校验信息来源于物流商地址库，结果仅供参考，
1.如校验通过则返回地址库参考的地址信息，洲及邮编如某个有错误仍可能通过查到正确推荐地址信息，此类情况建议校验结果给出推荐地址后将邮编和洲与原来的自行对比是否需要更正。
2.如校验错误，推荐到地图查询地址是否存在或与客户确认是否正确，校验错误并非一定邮寄不到，可能地址库或地址写法上无法匹配，如确认地址正确，可忽略校验结果正常发货。

接口URL

/shipment/verifyAddress

请求方式

POST

请求Body参数


xxxxxxxxxx
{
    "country": "US",
    "state": "CA",
    "city": "Los Gatos",
    "street1": "street1",
    "street2": "",
    "postalCode": "95030"
}

参数名	示例值	参数类型	参数描述
country	US	string	国家US
state	CA	string	洲简写
city	Chino	string	城市名
street1		string	街道地址一
street2		string	街道地址二
postalCode		string	邮编

/转运订单

####

/转运订单/创建订单


xxxxxxxxxx
此接口主要用于VC单，FBA转运单等B2B业务单

接口URL

/bulkOrder/create

请求方式

POST

Content-Type

json

请求Body参数


xxxxxxxxxx
{
    "warehouseCode": "USCAA", 
     "customOrderNumber": "TESTORDER123",
     "salePlatformCode":"",
     "storeCode":"",
     "orderType":"VC",
     "shipmentVendor":1,
     "shipmentType":1,
     "orderDescription":"",
     "shipTo":{
         "company":"test",
         "name": "test",  
          "phone": "8000000000",  
          "street1": "street1 test",    
          "street2": "",    
          "city": "Issaquah", 
          "country": "US",    
          "state": "WA",  
          "postalCode": "98027"
     },
    "skuList": [   
        {
        "sku": "TESTSKU",   
        "skuQty": 1 
        }
    ],
    "cargoPacking":{
        "packingType":1
    },
    "shipmentFreight":{
        "pickUpDate":"2022-11-01",
        "pickUpReferenceNumber":"ARN092435903XXXX"
    },
    "fileList": [   
        {
        "fileName": "文件名.pdf",   
        "fileExt": "pdf",
        "fileClass":1,
        "fileData":""
        }
    ],
    "trackingList": [
        {
            "carrier": "FedEx",
            "carrierService": "FEDEX_GROUND",
            "trackingCode": "75XXXXXXXXXXX1",
            "reference":""
        },
        {
            "carrier": "FedEx",
            "carrierService": "FEDEX_GROUND",
            "trackingCode": "75XXXXXXXXXXX2",
            "reference":""
        }
    ]
  
  }

参数名	示例值	参数类型	参数描述
submitType	1	Inter	提交类型，默认值1表示订单提交至待提交状态，值2订单提交至待处理状态
warehouseCode	USCAA	Text	仓库代码
customOrderNumber	TESTORDER123	Text	自定义单号
salePlatformCode		Text	选填，销售平台代码
storeCode		Text	选填，店铺代码
orderType		Text	订单类型可选:VC/FBA/OTHER
shipmentVendor		inter	物流发货提供商：值1为海外仓提供物流发货,值2为自提物流发货
shipmentType		inter	物流运输类型： 1快递，2卡派
orderDescription		Text	选填，订单处理说明描述
shipTo		Text	订单派送地址信息，shipmentVendor为1时由海外仓负责安排物流时必填
shipTo.company	test	Text	公司名
shipTo.name	test	Text	订单收件人名称
shipTo.phone	8000000000	Text	收件人电话号码
shipTo.street1	street1 test	Text	街道地址1
shipTo.street2		Text	街道地址2
shipTo.city	Issaquah	Text	城市
shipTo.country	US	Text	国家两位简码，如US
shipTo.state	WA	Text	洲/省两位简码，如CA
shipTo.postalCode	98027	Text	邮编
skuList		Object Array	订单SKU明细
skuList.sku	TESTSKU	Text	系统SKU
skuList.skuQty	1	Text	发货数量
skuList.reference	1	Text	选填,发货箱标参考/备注
cargoPacking		Object	货物包装信息
cargoPacking.packingType		inter	1.原箱转出(默认值) 2.仓库装箱打包
cargoPacking.palletQuantity		inter	选填，要求打托数量，如平台有要求必须打的托盘数量可传此值，否则不需要传
cargoPacking.palletRemark		Text	选填，特殊打托要求备注信息
freightPickUp		Object	选填，卡派预约信息
freightPickUp.freightCompany		Text	预约卡车公司
freightPickUp.pickUpDate	2022-11-01	Text	预约提货日期
freightPickUp.pickUpReferenceNumber		Text	预约提货参考编号，如BOL NUMBER,ARN号等
freightPickUp.pickUpRemark		Text	选填，预约备注
skuList.sku	TESTSKU	Text	系统SKU
skuList.skuQty	1	Text	发货数量
skuList.reference	1	Text	选填,发货箱标参考/备注
fileList		Object Array	订单文件数组
fileList.fileName	文件名.pdf	Text	原文件名称
fileList.fileExt		Text	文件扩展名
fileList.fileClass		inter	文件所属类别：1.快递运单文件 2.BOL提货文件 3.外箱标文件 4.托盘标文件 5.其它文件
fileList.fileData		Text	文件Base64数据
trackingList		Object Array	选填，物流自提时可以传递这部分内容，物流跟踪单号明细,
trackingList.carrier	FedEx	Text	物流服务商，例如快递商UPS，FedEx，卡派服务商名等，值根据实际填写即可
trackingList.carrierService		Text	选填，物流服务商服务渠道
trackingList.trackingCode		Text	物流跟踪号
trackingList.reference		Text	选填,物流其它参考信息/备注

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "data": {
        "orderNumber": "ZY-70232873327",
        "customOrderNumber": "41X6UKMS-1_7607710",
        "orderType": "VC",
        "warehouseCode": "USTEST",
        "shipmentType": 2,
        "shipmentVendor": 2,
        "shipTo": {
            "company": null,
            "name": "Korie",
            "country": "US",
            "state": "US",
            "city": "Ammon",
            "postalCode": "83406",
            "street1": "Sunburst Dr",
            "street2": null,
            "phone": "00000000"
        },
        "orderDescription": null,
        "fileList": [
            {
                "fileClass": 1,
                "fileClassDescription": "快递运单文件",
                "fileName": "6UKMS-1.pdf",
                "fileUrl": ""
            },
            {
                "fileClass": 3,
                "fileClassDescription": "外箱标文件",
                "fileName": "6UKMS-1 箱贴.pdf",
                "fileUrl": ""
            }
        ],
        "skuList": [
            {
                "sku": "E1701",
                "skuQty": 10,
                "reference": "B0BKS3454WZN4B"
            },
            {
                "sku": "E1702",
                "skuQty": 2,
                "reference": "B0BKSW23423N4DT"
            }
            
        ],
        "freightPickUp": {
            "pickUpDate": "2020-12-05",
            "pickUpReferenceNumber": "1托"
        },
        "cargoPacking": {
            "packingType": null,
            "palletQuantity": null,
            "palletRemark": null
        },
        "statusCode": "PENDING",
        "statusName": "待处理"
    }
}

/转运订单/提审处理或撤回操作


xxxxxxxxxx
用于订单正式提交仓库处理以及未处理撤回订单操作

接口URL

/bulkOrder/status

请求方式

POST

请求Body参数


xxxxxxxxxx
{
   "orderNumber":"165464665",
   "statusCode":"状态码"
}

参数名	示例值	参数类型	参数描述
orderNumber	165464665	Text	系统订单号
statusCode		Text	目标状态码，提交处理状态码：PENDING，撤回状态码：DRAFT

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "data": {
        "orderNumber": "ZY-70232873327",
        "customOrderNumber": "41X6UKMS-1_7607710",
        "orderType": "VC",
        "warehouseCode": "USTEST",
        "shipmentType": 2,
        "shipmentVendor": 2,
        "shipTo": {
            "company": null,
            "name": "Korie",
            "country": "US",
            "state": "US",
            "city": "Ammon",
            "postalCode": "83406",
            "street1": "Sunburst Dr",
            "street2": null,
            "phone": "00000000"
        },
        "orderDescription": null,
        "fileList": [
            {
                "fileClass": 1,
                "fileClassDescription": "快递运单文件",
                "fileName": "6UKMS-1.pdf",
                "fileUrl": ""
            },
            {
                "fileClass": 3,
                "fileClassDescription": "外箱标文件",
                "fileName": "6UKMS-1 箱贴.pdf",
                "fileUrl": ""
            }
        ],
        "skuList": [
            {
                "sku": "E1701",
                "skuQty": 10,
                "reference": "B0BKS3454WZN4B"
            },
            {
                "sku": "E1702",
                "skuQty": 2,
                "reference": "B0BKSW23423N4DT"
            }
            
        ],
        "freightPickUp": {
            "pickUpDate": "2020-12-05",
            "pickUpReferenceNumber": "1托"
        },
        "cargoPacking": {
            "packingType": null,
            "palletQuantity": null,
            "palletRemark": null
        },
        "statusCode": "CANCELED",
        "statusName": "已取消"
    }
}

/转运订单/订单详情


xxxxxxxxxx
用于获取订单详情信息

接口URL

/bulkOrder/detail

请求方式

POST

请求Body参数


xxxxxxxxxx
{
   "orderNumber":"165464665"
}

参数名	示例值	参数类型	参数描述
orderNumber	165464665	Text	系统订单号

返回数据示例


xxxxxxxxxx
{
    "code": 200,
    "data": {
        "orderNumber": "ZY-70232873327",
        "customOrderNumber": "41X6UKMS-1_7607710",
        "orderType": "VC",
        "warehouseCode": "USTEST",
        "shipmentType": 2,
        "shipmentVendor": 2,
        "shipTo": {
            "company": null,
            "name": "Korie",
            "country": "US",
            "state": "US",
            "city": "Ammon",
            "postalCode": "83406",
            "street1": "Sunburst Dr",
            "street2": null,
            "phone": "00000000"
        },
        "orderDescription": null,
        "fileList": [
            {
                "fileClass": 1,
                "fileClassDescription": "快递运单文件",
                "fileName": "6UKMS-1.pdf",
                "fileUrl": ""
            },
            {
                "fileClass": 3,
                "fileClassDescription": "外箱标文件",
                "fileName": "6UKMS-1 箱贴.pdf",
                "fileUrl": ""
            }
        ],
        "skuList": [
            {
                "sku": "E1701",
                "skuQty": 10,
                "reference": "B0BKS3454WZN4B"
            },
            {
                "sku": "E1702",
                "skuQty": 2,
                "reference": "B0BKSW23423N4DT"
            }
            
        ],
        "freightPickUp": {
            "pickUpDate": "2020-12-05",
            "pickUpReferenceNumber": "1托"
        },
        "cargoPacking": {
            "packingType": null,
            "palletQuantity": null,
            "palletRemark": null
        },
        "statusCode": "SHIPPED",
        "statusName": "已发货"
    }
}

/转运订单/状态码列表


xxxxxxxxxx
转运单所有状态码列表

状态码	状态名	描述
DRAFT	待提交
PENDING	待处理
HANDLING	仓库处理
CARGO_PICK	拣货中
LABEL	贴标中
PACKING	装箱/打托
CARGO_COMPELTED	备货完成
PENDING_PICKUP	待提货
SHIPPED	已发货
CANCELED	操作取消

####

/退件单


xxxxxxxxxx
退件单,暂未开放

####

/接口授权

请求Header参数

/系统基础接口

/仓库列表

接口URL

请求方式

请求返回示例

/SKU与库存管理

/SKU与库存管理/SKU创建

接口URL

请求方式

Content-Type

请求Body参数

请求返回示例

/SKU与库存管理/删除SKU

接口URL

请求方式

请求Body参数

返回数据示例

/SKU与库存管理/SKU信息列表查询

接口URL

请求方式

请求Body参数

返回数据示例

/SKU与库存管理/SKU详情查询

接口URL

请求方式

请求Body参数

请求返回示例

/SKU与库存管理/SKU库存列表查询

接口URL

请求方式

请求Body参数

返回数据示例

/SKU与库存管理/SKU库存出入库记录查询

接口URL

请求方式

请求Body参数

返回数据示例

/SKU与库存管理/SKU库龄查询

接口URL

请求方式

请求Body参数

返回数据示例

/入库单

/入库单/创建入库预报单

接口URL

请求方式

请求Body参数

返回数据示例

/入库单/入库单详情

接口URL

请求Body参数

返回数据示例

/入库单/查询入库单列表

接口URL

请求方式

请求Body参数

返回数据示例

/入库单/变更入库单状态(取消或提交审核入库)

接口URL

请求方式

Content-Type

请求Body参数

返回示例数据

/入库单/状态码列表

/代发订单

/代发订单/订单详情

接口URL

请求方式

请求Body参数

返回数据示例

/代发订单/订单列表查询

接口URL

请求方式

请求Body参数

返回数据示例

/代发订单/创建订单

接口URL

请求方式