API接入 - Powered by MinDoc

/接口授权

本接口所有请求和返回数据均为Json格式,对于查询类接口使用GET方法，对于创建与更新等涉及变更的使用POST方法
接口授权统一使用Header ApiToken值校验

请求Header参数

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

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

/系统基础接口

系统基础数据相关接口

/仓库列表

暂无描述

接口URL

/common/warehouse

请求方式

GET

成功响应示例

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

/SKU与库存管理

暂无描述

/SKU与库存管理/SKU创建

新建SKU

接口URL

/sku/create

请求方式

POST

Content-Type

json

请求Body参数

{
  "sku": "SKU",   
  "productNameCN": "产品名", 
  "productnameEN": "Mobile", 
  "length": "40", 
  "width": "50",
  "height": "50", 
  "weight": "10",  
  "remark": "",
  "hsCode": "",
  "declareValue": null  //sku申报价值
}

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

/SKU与库存管理/SKU修改

暂无描述

接口URL

/sku/update

请求方式

POST

Content-Type

json

请求Body参数

{
  "sku": "SKU",   
  "productNameCN": "产品名", 
  "productnameEN": "Mobile", 
  "length": "40", 
  "width": "50",
  "height": "50", 
  "weight": "10",  
  "remark": "",
  "hsCode": "",
  "declareValue": null  //sku申报价值
}

参数名	示例值	参数类型	参数描述
sku	SKU	Text	系统唯一SKU,字符限制4-35位字符
productNameCN	产品名	Text	产品中文名
productnameEN	Mobile	Text	产品英文名
length	40	Text	产品包装长(cm)
width	50	Text	产品包装长(cm)
height	50	Text	产品包装长(cm)
weight	10	Text	产品总重量(kg)
remark		Text
hsCode		Text	海关编码
declareValue		Text	申报价值
####
## /SKU与库存管理/删除SKU
`text
暂无描述
`
#### 接口URL
> /sku/delete

请求方式

POST

Content-Type

json

请求Body参数

{
    "sku":"TESTSKU"
}

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

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

查询SKU列表

接口URL

/sku/list

请求方式

GET

Content-Type

json

请求Body参数

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

参数名	参数类型	参数描述
page	Text	页码,默认1,每页50条记录
createdTimeBefore	Text	创建时间在此日期之前
createdTimeAfter	Text	创建时间在此日期之后
lastUpdatedTimeBefore	Text	最后更新时间在此日期之前
lastUpdatedTimeAfter	Text	最后更新时间在此日期之后
#### 成功响应示例
`javascript
{
“message”: “”,
“code”: 200,
“data”: []
}
`
## /SKU与库存管理/SKU详情查询
`text
暂无描述
`
#### 接口URL
> /sku/detail

请求方式

GET

Content-Type

json

请求Body参数

{
    "sku":"TESTSKU"
}

参数名	示例值	参数类型	参数描述
sku	TESTSKU	Text	系统唯一SKU,字符限制4-35位字符
####
## /SKU与库存管理/SKU库存列表查询
`text
库存查询
`
#### 接口URL
> /sku/inventory

请求方式

GET

Content-Type

json

请求Header参数

参数名	示例值	参数类型	是否必填	参数描述
ApiToken	-	Text	是	ApiToken授权信息
#### 请求Body参数
`javascript
{
“warehouseCode”:”USCAA”,
“lastUpdatedTimeBefore”: “”,
“lastUpdatedTimeAfter”: “”,
“page”: “1”,

}

参数名 | 示例值 | 参数类型 | 参数描述
--- | --- | --- | ---
warehouseCode |  | Text | 仓库代码
lastUpdatedTimeBefore |  | Text | 最后更新时间在此日期之前
lastUpdatedTimeAfter |  | Text | 最后更新时间在此日期之后
page |  | Text | 页码,默认1,每页50条记录
#### 
#### 成功响应示例
```javascript
{
    "message": "",
    "code": 200,
    "data": []
}

/入库单

暂无描述

/入库单/入库单详情

暂无描述

接口URL

/inboundOrder/detail

请求方式

GET

Content-Type

json

请求Body参数

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

参数名	参数类型	参数描述
customNumber	Text	自定义编号,与入库单号选传一个
inboundOrderNumber	Text	系统入库单号,与自定义编号选传一个
####
## /入库单/查询入库单列表
`text
暂无描述
`

接口URL

/inboundOrder/list

请求方式

GET

Content-Type

json

请求Body参数

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

}

参数名	参数类型	参数描述
warehouseCode	Text	仓库代码
createdTimeBefore	Text	在此创建时间之前
createdTimeAfter	Text	在此创建时间之后
lastUpdatedTimeBefore	Text	最后更新时间之前
lastUpdatedTimeAfter	Text	最后更新时间之后
page	Text	分页页码，数字类型
####
## /入库单/创建入库预报单
`text
暂无描述
`
#### 接口URL
> /inboundOrder/create

请求方式

POST

Content-Type

json

请求Body参数

{
    "customNumber":"",
    "warehouseCode": "USCAA", 
    "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清单列表
    {
    "sku": "TESTSKU", //sku
    "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.packageQuantity	1	Text	同类箱数
packageList.skuList		Text	装箱SKU明细
packageList.skuList.sku	TESTSKU	Text
packageList.skuList.quantity	10	Text
packageList.remark		Text
remark	备注	Text
####
## /入库单/修改入库预报单
`text
暂无描述
`

接口URL

/inboundOrder/update

请求方式

POST

Content-Type

json

请求Body参数

{
    "inboundOrderNumber":"I64212362",
    "customNumber":"",
    "warehouseCode": "USCAA", 
    "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清单列表
    {
    "sku": "TESTSKU", //sku
    "quantity": 10,  
    }],
    "remark": "",   //装箱备注
    }
    ],
    "remark": "备注",
    }

参数名	示例值	参数类型	参数描述
inboundOrderNumber	I64212362	Text	系统入库单号
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.packageQuantity	1	Text	同类箱数
packageList.skuList		Text	装箱SKU明细
packageList.skuList.sku	TESTSKU	Text
packageList.skuList.quantity	10	Text
packageList.remark		Text
remark	备注	Text
####
## /入库单/删除入库预报单
`text
暂无描述
`
#### 接口URL
> /inboundOrder/delete

请求方式

POST

Content-Type

json

请求Body参数

{
    "inboundOrderNumber":""
}

参数名	参数类型	参数描述
inboundOrderNumber	Text	系统入库单号
## /入库单/变更入库单状态
`text
暂无描述
`

接口URL

/inboundOrder/status

请求方式

POST

Content-Type

json

请求Body参数

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

参数名	参数类型	参数描述
customNumber	Text	自定义编号,与入库单号选传一个
inboundOrderNumber	Text	系统入库单号,与自定义编号选传一个
statusCode	Text	目标状态码
####
## /代发订单
`text
暂无描述
`
####
## /代发订单/订单详情
`text
暂无描述
`

接口URL

/outboundOrder/detail

请求方式

GET

Content-Type

json

请求Body参数

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

参数名	示例值	参数类型	参数描述
sellerOrderNumber	TESTORDER001	Text	选取一个参数传递
orderNumber	165464665	Text	选取一个参数传递
####
## /代发订单/订单列表查询
`text
暂无描述
`

接口URL

/outboundOrder/list

请求方式

GET

Content-Type

json

请求Body参数

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

}

参数名	参数类型	参数描述
warehouseCode	Text
createdTimeBefore	Text
createdTimeAfter	Text
lastUpdatedTimeBefore	Text
lastUpdatedTimeAfter	Text
page	Text	分页页码，数字类型
####
## /代发订单/创建订单
`text
暂无描述
`

接口URL

/outboundOrder/create

请求方式

POST

Content-Type

json

请求Body参数

{
    "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": "",  
  "carrierService": "",
  "skuList": [    //订单sku产品数组
  {
  "sku": "TESTSKU",   //产品sku
  "skuQty": 1 //sku订单数量
  }
  ],
  "options":{
      "WarehouseLabel": true,
      "deliveryConfirmation": false,  
  }, 

  }

参数名	示例值	参数类型	参数描述
warehouseCode	USCAA	Text	仓库代码
customOrderNumber	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	可选，物流商名下渠道物流方式，非特殊需求通常不建议填写
skuList		Text	订单SKU明细
skuList.sku	TESTSKU	Text
skuList.skuQty	1	Text
options		Text	订单选项
options.WarehouseLabel	true	Text	仓库提供运单，默认为true，如为false则需要上传自有运单信息
options.deliveryConfirmation	false	Text	签收增值服务，收取签收费用，默认为false
####
## /代发订单/修改订单
`text
暂无描述
`

接口URL

/outboundOrder/update

请求方式

POST

Content-Type

json

请求Body参数

{
    "orderNumber":"165464665",
    "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": "",  
  "carrierService": "",
  "skuList": [    //订单sku产品数组
  {
  "sku": "TESTSKU",   //产品sku
  "skuQty": 1 //sku订单数量
  }
  ],
  "options":{
      "WarehouseLabel": true,
      "deliveryConfirmation": false,  
  }, 

  }

/代发订单/变更订单状态

暂无描述

接口URL

/outboundOrder/status

请求方式

POST

Content-Type

json

请求Body参数

{
   "customOrderNumber":"TESTORDER001",
   "orderNumber":"165464665",
   "statusCode":"cancel"
}

参数名	示例值	参数类型	参数描述
customOrderNumber	TESTORDER001	Text	自定义单号
orderNumber	165464665	Text	系统订单号
statusCode	cancel	Text	变更的目标状态码
## /代发订单/上传/更新自有物流信息
`text
暂无描述
`

接口URL

/outboundOrder/syncShipment

请求方式

POST

Content-Type

json

请求Body参数

{
    "orderNumber":"",
    "carrier":"",
    "carrier_service":"",
    "trackingCode":"",
    "labelUrl":"",
    "labelData":"",
}

参数名	参数类型	参数描述
orderNumber	Text	系统订单号
carrier	Text	物流商
carrier_service	Text	物流商服务方式
trackingCode	Text	物流商跟踪号
labelUrl	Text	运单pdf文件远程url，和labelData选其中一个传
labelData	Text	运单pdf文件base64编码

/物流运单服务/询价

接口URL

/shipment/rates

请求方式

POST

Content-Type

json

请求Body参数

{
    "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",
        "addressLine1": "test",
        "addressLine2": "",
        "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": ""
    }
}

参数名	参数类型	参数描述
shipFrom	Object	发件地址
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	是否住宅，默认住宅
options	Object	订单选项
options.dimUnit	枚举	尺寸单位值：INCH，CM
options.weightUnit	枚举	重量单位值：LBS, KG
options.deliveryConfirmation	枚举	签收服务，不传默认为空不签收，签收传值signature

/物流运单服务/打单

接口URL

/shipment/createLabel

请求方式

POST

Content-Type

json

请求Body参数

{
    "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",
        "addressLine1": "test",
        "addressLine2": "",
        "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": ""
    }
}

参数名	参数类型	参数描述
orderNumber	string	销售订单编号
carrier	string	物流服务商FedEx/UPS/USPS
carrierService	string	物流服务渠道代码
shipFrom	Object	发件地址
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	是否住宅，默认住宅
options	Object	订单选项
options.dimUnit	枚举	尺寸单位值：INCH，CM
options.weightUnit	枚举	重量单位值：LBS, KG
options.deliveryConfirmation	枚举	签收服务，不传默认为空不签收，签收传值signature

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

接口URL

/shipment/cancel

请求方式

POST

Content-Type

json

请求Body参数

{
    "trackingCode": "777XXXXXXXXXX" 
}

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

/批量发货转运单

转运单,暂未开放

####

/退件单

退件单,暂未开放

####