接口授权 # 

本接口提供海外仓SKU,入库，出库订单相关接口对接。

所有接口授权使用Header AccessId,AccessToken值校验，HTTP请求方式为POST.

请求Header参数 #

参数名 示例值 参数类型 是否必填 参数描述
AccessId - Text 是 AccessId为客户账号编号
AccessToken - Text 是 AccessToken请联系客户经理获取

所有请求请在请求头加上以上参数

获取仓库列表 # 

获取账号的仓库列表及接口仓库CODE

接口URL #

/warehouses

创建商品SKU # 

新建商品SKU

接口URL #

/createSku

Content-Type #

json

请求Body参数 # 

{
  "sku": "skutest",   
  "nameCn": "中文名", 
  "nameEn": "English Name", 
  "length": "40", 
  "width": "50",
  "height": "50", 
  "weight": "10",  
  "hsCode": "",
  "goodsValue": ""
}
参数名 示例值 参数类型 参数描述
sku SKU Text 系统唯一SKU
nameCn 产品名 Text 产品中文名
nameEn Mobile Text 产品英文名
length 40 Text 产品包装长(cm)
width 50 Text 产品包装长(cm)
height 50 Text 产品包装长(cm)
weight 10 Text 产品重量(kg)
hsCode Text 海关编码
goodsValue Text 产品价值

响应示例 # 

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "nameCn": "中文名",
        "nameEn": "English Name",
        "sku": "skutest",
        "barcode": null,
        "weight": 10,
        "length": 40,
        "width": 50,
        "height": 50
    }
}

商品SKU信息列表查询 # 

查询SKU列表

接口URL #

/skuList

Content-Type #

json

请求Body参数 # 

{
	"page": "",
}
参数名 示例值 参数类型 参数描述
warehouseCode Text 仓库编码
page Text 页码,默认1

响应示例 # 

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "dataList": [],
        "total": 0,
        "page": 1,
        "totalPage": 0
    }
}

#

库存列表查询 # 

库存查询

接口URL #

/skuStock

Content-Type #

json

请求Body参数 # 

{
	
	"page": "1",

}
参数名 示例值 参数类型 参数描述
warehouseCode Text 仓库编码
page Text 页码,默认1

成功响应示例 # 

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "dataList": [
            {
                "warehouseCode": "1", //仓库代码
                "warehouseSku": "TESTSKU", //系统SKU
                "sellableQuantity": "0", //可用销售库存数量
                "reservedQuantity": "0", //已锁定数量
                "damagedQuantity": "0" //不良品数量
                "totalQuantity": "0" //仓库库存数量
            }
        ],
        "total": 1,
        "page": 1,
        "totalPage": 1
    }
}

#

库存库龄查询 # 

库存库龄查询

接口URL #

/skuStock2

请求Body参数 # 

{
	"warehouseCode":"1",
	"sku":"test",
}
参数名 示例值 参数类型 参数描述
warehouseCode Text 仓库代码
sku Text 查询SKU

#

成功响应示例 # 

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "dataList": [
            {
                "warehouseCode": "1", //仓库代码
                "warehouseSku": "TESTSKU", //系统SKU
                "quantity": "0", //数量
                "day": "0", //库龄天数量
            }
        ],
        "total": 1,
        "page": 1
    }
}

入库单详情 # 

暂无描述

接口URL #

/inOrderDetail

Content-Type #

json

请求Body参数 # 

{
    "inOrderId":""
}
参数名 示例值 参数类型 参数描述
inOrderId Text 系统入库单号

#

入库单列表 # 

暂无描述

接口URL #

/inOrderList

Content-Type #

json

请求Body参数 # 

{
	"page": ""
}
参数名 示例值 参数类型 参数描述
page Number 分页页码，数字类型

#

成功响应示例 # 

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "dataList": [
            {
                "inOrderId": 5092,
                "warehouseCode": 4,
                "orderStatus": "created",
                "boxList": [
                    {
                        "boxQuantity": 1,
                        "boxSkuList": [
                            {
                                "sku": "TESTSKU",
                                "quantity": 10
                            }
                        ]
                    }
                ]
            }
        ],
        "total": 1,
        "page": 1
    }
}

创建入库预报单 # 

暂无描述

接口URL #

/inOrderCreate

Content-Type #

json

请求Body参数 # 

{

    "warehouseCode": 1, 
    "boxList": [
    {
    
    "boxQuantity": 10,
    "boxSkuList": [   //装箱sku清单列表
    {
    "sku": "TESTSKU", //sku
    "quantity": 1,  
    }]
    }
    ]
    }
参数名 示例值 参数类型 参数描述
warehouseCode 1 Text 仓库代码
boxList Text
boxList.boxQuantity 1 Text 同类箱数
boxList.boxSkuList Text 装箱SKU明细
boxList.boxSkuList.sku TESTSKU Text
boxList.boxSkuList.quantity 1 Text 每箱中的数量

#

成功响应示例 # 

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "inOrderId": 5092,
        "warehouseCode": 4,
        "orderStatus": "created", // 状态码值：created-创建待提审，pending-审核中，inTransit-已发货待接收，received-已到仓接收中，inbounded-已完成入库，cancel-已取消
        "boxList": [
            {
                "boxQuantity": 10,
                "boxSkuList": [
                    {
                        "sku": "TESTSKU",
                        "quantity": 1
                    }
                ]
            }
        ]
    }
}

订单详情 # 

暂无描述

接口URL #

/outOrderDetail

Content-Type #

json

请求Body参数 # 

{
   "outOrderId":"123-789",
}
参数名 示例值 参数类型 参数描述
outOrderId 123-789 Text 订单号

请求返回示例 # 

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "outOrderId": "123-789",
        "warehouseCode": 4,
        "shipmentPrivoder": "system",
        "receiver": {
            "company": null,
            "name": "test",
            "country": "US",
            "state": "GA",
            "city": "Dallas",
            "postalCode": "30132",
            "phone": "1234567890",
            "address1": "test RD",
            "address2": null
        },
        "skuList": [
            {
                "sku": "SKU",
                "quantity": 1
            }
        ],
        "orderStatus": "pending",
        "orderStatusName": "待处理",
        "shipmentTracking": "88888888",
        "shipmentCarrier": "FedEx",
        "inOrderId": null,
        "shipTime": null,
        "shipCharge": 12.5,  //运费
        "handlingCharge": 0.6   //操作处理费
    }
}

#

订单列表查询 # 

暂无描述

接口URL #

/outOrderList

Content-Type #

json

请求Body参数 # 

{

	"lastUpdatedBefore": "",
	"lastUpdatedAfter": "",
	"page": "",

}
参数名 示例值 参数类型 参数描述
warehouseCode 1 Text 仓库编码
lastUpdatedBefore Text
lastUpdatedAfter Text
page Text 分页页码，数字类型

#

创建订单 # 

暂无描述

接口URL #

/outOrderCreate

Content-Type #

json

请求Body参数 # 

{
    "warehouseCode": 1, 
     "outOrderId": "123-789",
     "orderStatus": "created",  // 状态码值：created-创建待提交，labelpending-待生成面单，pending-待处理发货，processing-订单处理中，completed-已完成发货，exception-异常，cancel-订单已取消
     "receiver":{
         "company":"test",
         "name": "test",  
          "phone": "8000000000",  
          "address1": "street1 test",    
          "address2": "",    
          "city": "test", 
          "country": "US",    
          "state": "WA",  
          "postalCode": "91021", 
     },
  "skuList": [    //订单sku产品数组
  {
  "sku": "TESTSKU",   //产品sku
  "quantity": 1 //sku订单数量
  }
  ]
  
  }
参数名 示例值 参数类型 参数描述
warehouseCode 1 Text 仓库编码
outOrderId 123-456 Text 自定义单号
receiver Text 订单派送地址信息
receiver.company test Text
receiver.name test Text 订单收件人名称
receiver.phone 8000000000 Text 收件人电话号码
receiver.address1 street1 test Text 街道地址1
receiver.address2 Text 街道地址2
receiver.city Issaquah Text 城市
receiver.country US Text 国家两位简码，如US
receiver.state WA Text 洲/省两位简码，如CA
receiver.postalCode 98027 Text 邮编
skuList Text 订单产品明细
skuList.sku SKU1 Text
skuList.quantity 1 Text
shipmentCarrier FedEx Text 物流服务商
shipmentType 1 int 物流渠道面单枚举类型：1-仓库系统面单（默认） 2-自供面单（需上传面单文件）

#

成功返回示例 # 

{
    "code": "SUCCESS",
    "msg": "",
    "data": {
        "outOrderId": "123-789",
        "warehouseCode": 4,
        "shipmentPrivoder": "system",
        "receiver": {
            "company": null,
            "name": "test",
            "country": "US",
            "state": "WA",
            "city": "test",
            "postalCode": "91021",
            "phone": "8000000000",
            "address1": "street1 test",
            "address2": null
        },
        "skuList": [
            {
                "sku": "TESTSKU",
                "quantity": 1
            }
        ],
        "orderStatus": "created",
        "orderStatusName": "已创建",
        "shipmentTracking": null,
        "shipmentCarrier": null
    }
}

取消订单 # 

暂无描述

接口URL #

/outOrderCancel

Content-Type #

json

请求Body参数 # 

{
   "outOrderId":"123-789"
}
参数名 示例值 参数类型 参数描述
outOrderId 123-789 Text 订单号

上传运单物流信息 # 

仅针对客户自提供运单的订单

接口URL #

/outOrderUploadLabel

Content-Type #

json

请求Body参数 # 

{
    "outOrderId":"",
    "shipmentCarrier":"",
    "shipmentTracking":"",
    "labelData":"",
}
参数名 示例值 参数类型 参数描述
outOrderId Text 系统订单号
shipmentCarrier Text 物流渠道
shipmentTracking Text 物流跟踪号
labelData Text 运单pdf文件base64编码