SpotterAPI对接接口文档@通用
SpotterAPI对接接口文档@通用日期
版本
说明
作者
2022/3/8
V0.0.1
新增文档
Roy
2023/3/14 
V0.0.1 
1.移除无意义声明以及文字；
2. 新增最佳实践以及接口说明；
3.新增接入appKey、appSecret以及示例代码；
4.接口字段优化调整9；
5.文档在线化；
﻿
 Child
2023/5/31 
V0.0.2 
1.新增实时销量详情批量查询接口，见接口列表 4.10
 Snow
2023/7/4
V0.0.3
1.新增销售诊断详情批量查询接口，见接口列表 4.11
Snow
﻿
1.文档简介
1.1特别声明
未得到本公司的书面许可，不得为任何目的、以任何形式或手段（包括但不限于机械的或电子的）复制或传播本文档的任何部分。对于本文档涉及的技术和产品，本公司拥有其专利（或正在申请专利）、商标、版权或其它知识产权。除非得到本公司的书面许可协议，本文档不授予这些专利、商标、版权或其它知识产权的许可。
本文档因产品功能示例和描述的需要，所使用的任何人名、企业名和数据都是虚构的，并仅限于本公司内部测试使用，不等于本公司有对任何第三方的承诺和宣传。
 
2.最佳实践
2.1基础接口
说明：查询仓库和查询承运商信息
接口：
查询仓库： https://openapi.spotterio.com/spotter-warehouse-web/open/storage/cloud/list
查询承运商： https://openapi.spotterio.com/spotter-tms-web/open/carrier/list
查询产品信息： https://openapi.spotterio.comspotter-cooperation-web/product/openapi/specification/search
2.2创建入库通知单
说明：推送入库单信息到spotter系统，货品入库到海外仓
接口：4.2.1 https://openapi.spotterio.com/spotter-ess-web/open/spt/order/save
2.3下载入库单产品箱唛
说明：获取入库单对应产品的箱唛
接口：4.2.2 https://openapi.spotterio.com/spotter-ess-web/open/spt/order/shippingmark
2.4查询入库单信息
说明：获取入库单对应信息，查询货物是否已入海外仓
接口：4.2.3 https://openapi.spotterio.com/spotter-ess-web/open/spt/order/list﻿
2.5查询库存信息
说明：获取入库单对应信息，查询货物在仓库的库存数量
接口：4.3.1 https://openapi.spotterio.com/spotter-warehouse-web/open/inventory/page
2.6查询出库单信息
说明：获取出库单对应信息，查询货物是否已经发货
接口：4.4.2 https://openapi.spotterio.com/spotter-warehouse-web/open/outbound/list
2.7查询VC库存报告
说明：获取VC库存对应信息
接口：4.7 https://openapi.spotterio.com/datars-web/open/report/vc/inventory
2.8查询实时销售报告
说明：获取实时销售报告
接口：4.8 https://openapi.spotterio.com/datars-web/open/report/real/time
2.9查询销售预测
说明：获取销售预测信息
接口：4.9 https://openapi.spotterio.com/datars-web/open/report/forecasting
2.10查询亚马逊VCPO订单
说明：查询亚马逊VCPO订单信息
接口：4.5.1 https://openapi.spotterio.com/spotter-order-web/open/amzOrder/page
﻿
2.11查询亚马逊VCPO订物流单
说明：查询亚马逊VCPO物流单信息
接口：4.6.1 https://openapi.spotterio.com/spotter-shipment-web/open/shipment/amz/page 
﻿
3.接入&调用demo
﻿
调用方式：
1.sdk
sdk-core-java-1.0.0.jar附件大小：78.4KB
2.pom依赖
6
<dependency>
  <groupId>com.spotter.api.gateway</groupId>
  <artifactId>sdk-core-java</artifactId>
  <version>1.0.0</version>
</dependency>
﻿
3.调用demo--java
62
package com.spotter;


import com.spotter.cloudapi.sdk.client.ApacheHttpClient;
import com.spotter.cloudapi.sdk.enums.HttpMethod;
import com.spotter.cloudapi.sdk.enums.Scheme;
import com.spotter.cloudapi.sdk.model.ApiCallback;
import com.spotter.cloudapi.sdk.model.ApiRequest;
import com.spotter.cloudapi.sdk.model.ApiResponse;
import com.spotter.cloudapi.sdk.model.HttpClientBuilderParams;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.nio.charset.StandardCharsets;

public class HttpApiClientSpotter extends ApacheHttpClient {

    public final static String HOST = "openapi.spotterio.com";

    static HttpApiClientSpotter instance = new HttpApiClientSpotter();

    public static HttpApiClientSpotter getInstance() {
        return instance;
    }

    public static final ObjectMapper mapper = new ObjectMapper();

    public void init(HttpClientBuilderParams httpClientBuilderParams) {
        httpClientBuilderParams.setAppKey("appKey");
        httpClientBuilderParams.setAppSecret("appSecret");
        httpClientBuilderParams.setScheme(Scheme.HTTP);
        httpClientBuilderParams.setHost(HOST);
        super.init(httpClientBuilderParams);
    }


    public void testApi(byte[] body, ApiCallback callback) {
        String path = "/spotter-warehouse-web/open/outbound/notice/list";
        ApiRequest request = new ApiRequest(HttpMethod.POST_JSON, path, body);
        sendAsyncRequest(request, callback);
    }

    public static void main(String[] args) {
        HttpApiClientSpotter instance1 = HttpApiClientSpotter.getInstance();
        HttpClientBuilderParams httpParam = new HttpClientBuilderParams();
        instance1.init(httpParam);
        String json = "[\"FBA20230313000757la834Dp9\"]";
        instance1.testApi(json.getBytes(StandardCharsets.UTF_8), new ApiCallback() {
            @Override
            public void onFailure(ApiRequest apiRequest, Exception e) {
                e.printStackTrace();
            }

            @Override
            public void onResponse(ApiRequest apiRequest, ApiResponse apiResponse) {
                String s = new String(apiResponse.getBody(), StandardCharsets.UTF_8);
                System.out.println(s);
            }
        });
    }

}
﻿
4.接口列表
4.1基础接口
4.1.1查询承运商
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-tms-web/open/carrier/list
Content-Type：application/json
请求方式：post
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
成功
String
返回文字描述
data
﻿
List<Object>
承运商信息
data.list.carrierCode
UPSN
String
承运商编码
data.list.carrier
UPS
String
承运商名称
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{
	"code": 200,
	"msg": "成功",
	"data":  [{"carrierCode":"UPSN","carrier":"UPS"}],
        "tracerId":"12345"
}
﻿
4.1.2查询仓库
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-warehouse-web/open/storage/cloud/list
Content-Type：application/json
请求方式：post
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
成功
String
返回文字描述
data
﻿
List<Object>
仓库信息
data.list.storageCode
USCATP90601A
String
仓库编码
data.list.storageName
USCATP
String
仓库名称
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{
	"code": 200,
	"msg": "成功",
	"data":  [{"storageCode":"USCATP90601A","storageName":"USCATP"}],
        "tracerId":"12345"
}
4.1.3查询产品
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-cooperation-web/product/openapi/specification/search
Content-Type：application/json
请求方式：post
请求体参数说明：
参数名
示例值
参数类型
是否必填
参数描述
asin
B07DPHSGPA
String
否
asin
msku
00001-0100-0100
String
否
msku
pageSize
20
Long
是
每页大小（不超过100）
currentPage
1
Long
是
页码
﻿
﻿
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
成功
String
返回文字描述
data
﻿
List<Object>
产品信息
data.currentPage
1
Integer
页码
data.pageSize
20
Integer
每页大小
data.totalNum
0
Integer
总数量
data.isMore
false
Integer
是否有下一页
data.totalPage
0
Integer
总页数
data.list.asin
B07DPHSGPA
String
asin
data.list.msku
00001-0100-0100
String
msku
data.list.itemsPerInnerPack
1
Integer
装箱数量
data.list.cartonWeight
1.11
BigDecimal
外箱重量
data.list.cartonLength
1.11
BigDecimal
外箱长度
data.list.cartonWidth
1.11
BigDecimal
外箱宽
data.list.cartonHeight
1.11
BigDecimal
外箱高
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{
	"code": 200,
	"msg": "成功",
	"data":  [{"asin":"B07DPHSGPA","msku":"00001-0100-0100","innerPack":1,"weight":1.11,"length":1.11,"width":1.11,"high":1.11}],
        "tracerId":"12345"
}
﻿
4.2入库接口
4.2.1SPT物流创建
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-ess-web/open/spt/order/save
Content-Type：application/json
请求方式：post
请求体参数说明：
参数名
示例值
参数类型
是否必填
参数描述
uniqueCode
123aaabbb
String
否
唯一值检验，如果传了，则校验入库单是否已经创建，如果不传，则不校验
storageCode
USCATP90601A
String
是
接收仓库编号
arriveAt
1676887250000
Long
是
预计送达时间
shippedAtMs
1676023250000
Long
是
发货日期
carrier
UPSN
String
否
承运商
contactEmail
1@qq.com;2@qq.com;3@qq.com
String
是
发货人联系邮箱，多个使用；分隔
trackingNumber
1Z14W56003
String
否
快递单号
orderDetailInitReqList
 
List<OrderDetailInitReq>
是
商品信息
OrderDetailInitReq.asin
B0BGS63WM1
String
是
ASIN
OrderDetailInitReq.msku
TB-F1273
String
否
MSKU
OrderDetailInitReq.effectiveDateMs
1676023250000
Long
是
有效期
OrderDetailInitReq.innerPack
8
Integer
是
每箱装箱数量
OrderDetailInitReq.cartonsNumber
10
Integer
是
申请箱数
OrderDetailInitReq.weight
1.11
BigDecimal
是
装箱重量（英镑）
OrderDetailInitReq.length
1.11
BigDecimal
是
装箱长度（inch）
OrderDetailInitReq.width
1.11
BigDecimal
是
装箱宽度（inch）
OrderDetailInitReq.high
1.11
BigDecimal
是
装箱高度（inch）
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
成功
String
返回文字描述
data
SSP87IA784Q
String
spt物流单号
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{
	"code": 200,
	"msg": "成功",
	"data":  "SSP87IA784Q",
        "tracerId":"12345"
}
﻿
4.2.2下载箱唛
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-ess-web/open/spt/order/shippingmark
Content-Type：application/json
请求方式：post
请求体参数说明：
参数名
示例值
参数类型
是否必填
参数描述
shipmentOrderCode
SSP87IA784Q
String
是
spt物流code
asin
B07DPHSGPW
String
否
asin
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
成功
String
返回文字描述
data
["https://htmltopdf.xxxxink/convert/html2pdf?u=doctron&p=lampnick&url=https://static.xxxx.com/htmltopdf/html2pdf-85595355.html&paperWidth=8.268&paperHeight=5.906&marginLeft=0.0&marginRight=0.0&marginTop=0.0&marginBottom=0.0&scale=1.5"]
List<String>
pdf的地址集合
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{"code":200,"msg":"成功","data":["https://htmltopdf.xxxxink/convert/html2pdf?u=doctron&p=lampnick&url=https://static.xxxx.com/htmltopdf/html2pdf-85595355.html&paperWidth=8.268&paperHeight=5.906&marginLeft=0.0&marginRight=0.0&marginTop=0.0&marginBottom=0.0&scale=1.5"],"tracerId":"12345"}
 
4.2.3入库通知单【批量10】
 
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-ess-web/open/spt/order/list﻿
Content-Type：application/json
请求方式：post
请求体参数说明：
参数名
示例值
参数类型
是否必填
参数描述
shipmentOrderCodeList
[“SSP87IA784Q”,“SSP87IA784R”]
List<String>
是
SPT物流单号（最多10个），此字段直接传list，非json对象
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
成功
String
返回文字描述
data
 
Object
返回数据
data.list
 
List<Object>
暂无描述
data.list.shipmentOrderCode
SSP87IA784Q
String
SPT物流单号
data.list.storageCode
USCATP90601A
String
收货仓库编码
data.list.status
4
Integer
物流状态：1 未发货，2 Spotter确认中， 3 运输中， 4 已入库， 5已取消
data.list.createdAtMs
1676287370000
Long
创建时间
data.list.inboundDateMs
1676433659000
Long
入库时间
data.list.totalNumber
10
Integer
总数量
data.list.totalCartons
2
Integer
总箱数
data.list.shippedAtMs
1676347259000
Long
发货时间
data.list.contactEmail
1@qq.com;2@qq.com;3@qq.com
String
发货联系人邮箱，多个使用;分隔
data.list.trackingNumber
1Z004A100390651983
String
快递单号
data.list.orderItemVOList
 
List<Object>
产品信息
data.list.orderItemVOList.shipmentOrderCode
SSP87IA784Q
String
SPT物流单号
data.list.orderItemVOList.asin
B0BN6HPLQ8
String
asin
data.list.orderItemVOList.ssku
xxxx-xxxx-xxxx
String
ssku
data.list.orderItemVOList.innerPack
5
Integer
每箱装箱数量
data.list.orderItemVOList.applyNumber
10
Integer
申请数量
data.list.orderItemVOList.cartons
2
Integer
发货箱数
data.list.orderItemVOList.effectiveDateMs
1707883259000
Long
有效期
data.list.orderItemVOList.inboundNumber
10
Integer
入库数量
data.list.orderItemVOList.inboundDateMs
1676433659000
Long
入库时间
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{"code":200,"data":{"shipmentOrderCode":"SSP87IA784Q","status":4,"createdAtMs":1676287370000,"inboundDateMs":1676433659000,"totalNumber":10,"totalCartons":2,"shippedAtMs":1675336600521,"contactEmail":"123@qq.com","trackingNumber":"1Z004A100390651983","orderItemVOList":[{"shipmentOrderCode":"SSPIE2BU850","asin":"B07DPHSGPW","ssku":"1111-1111-1111","innerPack":2,"applyNumber":2,"cartons":1,"effectiveDateMs":1676287065000,"inboundNumber":2,"inboundDateMs":1676287065000}]}"msg":"成功","tracerId":"12345"}
 
4.3库存接口
4.3.1仓库库存
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-warehouse-web/open/inventory/page
Content-Type：application/json
请求方式：post
请求体参数说明：
参数名
示例值
参数类型
是否必填
参数描述
asins
[“B07DPHSGPW”]
List<String>
否
asins
storageCode
USCATP90601A
String
是
仓库编码
pageSize
20
Long
是
每页大小（不超过100）
currentPage
1
Long
是
页码
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
成功
String
返回文字描述
data
 
Object
返回数据
data.currentPage
1
Integer
页码
data.pageSize
20
Integer
每页大小
data.totalNum
0
Integer
总数量
data.isMore
false
Integer
是否有下一页
data.totalPage
0
Integer
总页数
data.startIndex
0
Integer
开始下标
data.list
 
List<Object>
 
data.list.residueNums
10
Integer
剩余库存
data.list.singleNums
5
Integer
单件区剩余库存
data.list.fullContainerNums
5
Integer
整箱区剩余库存
data.list.availableNum
1
Integer
总可用件数
data.list.asin
B07DPHSGPW
String
产品asin
data.list.ssku
1234567
String
产品ssku
data.list.upc
1234567
String
产品upc
data.list.storageCode
USCATP90601A
String
仓库编码
data.list.storageName
USCATP
String
仓库名称
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{"code":200,"msg":"成功","tracerId":"12345","data":{"currentPage":1,"pageSize":20,"totalNum":0,"isMore":false,"totalPage":0,"startIndex":0,"data":[{"residueNums":10,"singleNums":10,"fullContainerNums":10,"asin":"B07DPHSGPW","ssku":"00004-0500-0490","upc":"1234567","storageCode":"USCATP90601A","storageName":"USCATP"}]}}
 
 
4.4出库接口
4.4.1出库通知单列表【批量10】
 
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-warehouse-web/open/outbound/list
Content-Type：application/json
请求方式：post
请求体参数说明：
参数名
示例值
参数类型
是否必填
参数描述
outboundNoList
DF202302270006309908
List<String>
是
出库单号，，此字段直接传list，非json对象
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
success
String
返回文字描述
data
 
Object
返回数据
data.list
 
List<Object>
 
data.list.outboundNo
FBA202302270006309908
String
出库单号
data.list.status
5
Integer
出库状态 2-待发货,3-创建失败,4-已取消,5-已发货，6-待捡货
data.list.storageCode
USCATP90601A
String
出库仓库编码
data.list.storageName
USCATP
String
出库仓库名称
data.list.outboundType
4
Integer
出库单类型：1-VCPO 2-FBA订单 3-移仓 4--DF订单 5-多渠道订单
data.list.carrier
UPSN
String
运输商
data.list.trackingNo
1Z004A100390651984
String
运单号
data.list.requestedPickupDateMs
1677484800000
Long
预计提货时间
data.list.deliveryDateMs
1677484800000
Long
发货日期
data.list.orderCode
TEST16
String
销售订单号
data.list.outboundDetailVos
 
List<Object>
出库商品详情
data.list.outboundDetailVos.outboundType
4
Integer
出库单类型：1-VCPO 2-FBA订单 3-移仓 4--DF订单 5-多渠道订单
data.list.outboundDetailVos.asin
B07DPHSGPW
String
asin
data.list.outboundDetailVos.ssku
xxxx-xxxx-xxxxx
String
ssku
data.list.outboundDetailVos.packNo
BNs0gc44dj3E
String
入库批次号
data.list.outboundDetailVos.storageCode
USCATP90601A
String
出库仓库编码
data.list.outboundDetailVos.status
5
Integer
状态 2-待发货,3-创建失败,4-已取消,5-已发货，6-待捡货
data.list.outboundDetailVos.outboundDateMs
1677484800000
Long
发货日期
data.list.outboundDetailVos.arriveDateMs
1677643259000
Long
预计到达时间
data.list.pendingShipNum
2
Integer
待发货箱数
data.list.pendingShipQuantity
2
Integer
待发货数量
data.list.outboundDetailVos.outNums【已废弃】
2
Integer
箱数
data.list.outboundDetailVos.actualNums【已废弃】
2
Integer
实际发货箱数【发货后才有】
data.list.actualOutboundNum
2
Integer
实际发货箱数
data.list.actualOutboundQuantity
2
Integer
实际发货数量
data.list.outboundDetailVos.innerPack
1
Integer
装箱数量
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{"code":200,"msg":"成功","tracerId":"12345","data":[{"outboundNo":"FBA202302270006309908","status":5,"storageCode":"USCATP90601A","storageName":"USCATP","outboundType":4,"carrier":"UPSN","trackingNo":"1Z004A100390651983","requestedPickupDateMs":1677484800000,"deliveryDateMs":1677484800000,"orderCode":"TEST16","outboundDetailVos":[{"storageCode":"USCATP90601A","status":5,"outboundDateMs":1677484800000,"outNums":2,"actualNums":2,"actualOutboundNum":2,"actualOutboundQuantity":2,"pendingShipNum":2,"pendingShipQuantity":2,innerPack":1}]}]}
4.5订单接口
﻿
4.5.1获取亚马逊VCPO采购单
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-order-web/open/amzOrder/page
Content-Type：application/json
请求方式：post
请求体参数说明：
参数名
示例值
参数类型
是否必填
参数描述
saCode
SA8501104399
String
否
as订单号
orderStatus
NEW
String
否
订单状态:New,Pending,Acknowledged,Closed
orderedOnStartMs
12345678
Long
否
下单时间-开始
orderedOnEndMs
87654321
Long
否
下单时间-结束
pageSize
20
Long
是
每页大小（不超过100）
currentPage
1
Long
是
页码
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
success
String
返回文字描述
data
 
Object
返回数据
data.currentPage
1
Integer
页码
data.pageSize
20
Integer
每页大小
data.totalNum
0
Integer
总数量
data.isMore
false
Integer
是否有下一页
data.totalPage
0
Integer
总页数
data.startIndex
0
Integer
起始下标
data.list
 
List<Object>
 
data.list.saCode
SA8501104399
String
sa单号
data.list.asin
B07DPHSGPW
String
asin
data.list.ssku
xxxx-xxxx-xxxx
String
ssku
data.list.upc
123456
String
upc
data.list.status
New
String
订单状态： New-待确认,Acknowledged-已确认,Closed-已关闭,Pending-处理中
data.list.orderedOnMs
1678615765000
Long
下单时间
data.list.orderedQuantity
10
Integer
采购数量
data.list.confirmedQuantity
8
Integer
实际接单数量
data.list.innerPack
2
Integer
装箱数量
data.list.orderDetailVos
﻿
List<Object>
订单详情，confirmedQuantity为0返回为[]
data.list.orderDetailVos.shipFrom
USCATP90601A
String
发货仓库编码
data.list.orderDetailVos.shipTo
USCA
String
收货地址
data.list.orderDetailVos.confirmedQuantity
2
Integer
发货数量
data.list.orderDetailVos.windowStartMs
12345678
Long
发货窗口-始
data.list.orderDetailVos.windowEndMs
87654321
Long
发货窗口-末
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{"code":200,"data":{"currentPage":1,"data":[{"asin":"B07XHQ19ZR","ssku":"1111-1111-1111","confirmedQuantity":4,"innerPack":1,"orderDetailVos":[{"confirmedQuantity":4,"shipFrom":"USCATP90601A","shipTo":"AVP1","windowEndMs":1682763545000,"windowStartMs":1682504345000}],"orderStatus":"Pending","orderType":"PO","orderedOnMs":1682245145000,"orderedQuantity":4,"saCode":"SA8673332336","upc":"648722113051"}"isMore":True,"pageSize":10,"startIndex":0,"totalNum":46,"totalPage":5},"msg":"成功","tracerId":"8d11085ef78e4ab79400ead9e60563d2"}
﻿
4.6物流接口
﻿
4.6.1获取亚马逊VCPO物流单
接口状态：已上线
接口URL：https://openapi.spotterio.com/spotter-shipment-web/open/shipment/amz/page 
Content-Type：application/json
请求方式：post
请求体参数说明：
参数名
示例值
参数类型
是否必填
参数描述
shipmentAmzCode
VCPOSPus9Wv92B91
String
否
物流号
saOrder
SA0205334259
String
否
sa单号
pageSize
20
Long
是
每页大小（不超过100）
currentPage
1
Long
是
页码
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Integer
暂无描述
msg
success
String
返回文字描述
data
 
Object
返回数据
data.currentPage
1
Integer
页码
data.pageSize
20
Integer
每页大小
data.totalNum
0
Integer
总数量
data.isMore
false
Integer
是否有下一页
data.totalPage
0
Integer
总页数
data.startIndex
0
Integer
起始下标
data.list
 
List<Object>
 
data.list.shipmentAmzCode
VCPOSPus9Wv92B91
String
物流号
data.list.status
finished
String
物流状态：processing 处理中; pending_pick_up 待取件；in_transport 运输中；canceled 已取消;  finished 已交付;
data.list.cartonLabelList
["www.aaaa.com/shipment/shipmentList/cartonLabel/7d4c05e7695c43b39effd5e3f7ff5e0a/VCPO-FRD-20220803-CNT0J-CAL.pdf"]
List<String>
cartonLabel文件地址
data.list.bolLabelList
["www.aaaa.com/shipment/shipmentList/bol/574342414bf04ccebde22e270af68699/VCPO-FRD-20220810-USCATP - Topland-BOL.pdf"]
List<String>
bolLabel文件地址
data.list.shippingLabelList
["www.aaaa.com/shipment/shipmentList/shippingLabel/37072687c4ba4af5a7cb79686552200a/VCPO-FRD-20220803-CNT0J-SP.pdf"]
List<String>
shippingLabel文件地址
data.list.carrier
UPSN
String
运输公司
data.list.arrived
true
Boolean
是否到达，true到达，false 未到达
data.list.totalPallets
1
Integer
总托盘数量
data.list.transportModel
SP
String
运输模式
data.list.shipmentItemVOList
﻿
List<Object>
物流详情
data.list.shipmentItemVOList.asin
B07DPHSGPW
String
asin
data.list.shipmentItemVOList.ssku
1111-1111-11111
String
ssku
data.list.shipmentItemVOList.saCode
SA8501104399
String
sa单号
data.list.shipmentItemVOList.windowEndMs
11111111
Long
最晚发货日期
data.list.shipmentItemVOList.outboundNums
1
Integer
发货数量
data.list.shipmentItemVOList.orderedOnMs
11111111
Long
下单时间
tracerId
8a5b3306d3764fe4a394fc780547d517
String
tracerId
 
返回示例：(200)成功
{"code":200,"msg":"成功","tracerId":"12345","data":{"currentPage":1,"pageSize":20,"totalNum":0,"isMore":false,"totalPage":0,"startIndex":0,"data":[{"saCode":"SA8501104399","asin":"B07DPHSGPW","ssku":"1111-1111-1111","status":"finished","shipmentAmzCode":"VCPOSPus9Wv92B91","carrier":"UPSN","arrived":true,"windowEndMs":1111111111,"outboundNums":2,"orderedOnMs":111111111}]}}
﻿
﻿
4.7vc库存报告
 
接口状态：已上线
接口URL：https://openapi.spotterio.com/datars-web/open/report/vc/inventory
Content-Type：application/json
请求方式：post
接口备注：获取vc库存报告
URI参数说明：
参数名
示例值
参数类型
是否必填
参数描述
asin
B09ABCDE
String
否
ASIN
queryStartDate
2023-02-02
String
否
洛杉矶时间
queryEndDate
2023-02-12
String
否
洛杉矶时间
currentPage
1
String
是
分页
pageSize
20
String
是
每页条数
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Number
暂无描述
msg
success
String
返回文字描述
data
 
List<Object>
返回数据
data.list.date
2023-01-01
String
洛杉矶日期
data.list.asin
B09ABCDE
String
asin
data.list.ssku
0000-0000-0000
String
ssku
data.list.productTitle
AAAAA BBBBB
String
产品名称
data.list.availableInventory
10
Integer
可用库存
data.list.openPurchaseOrderQuantity
10
Integer
采购订单在途数量
data.list.totalInventory
20
Integer
总库存
 
返回示例：(200)成功
{
	"code": 200,
	"msg": "success",
	"data": {
		"currentPage": "1"
		"pageSize": "20",
		"totalNum": 30,
		"totalPage": 1,
		"isMore": true,
		"data": [{
			"date": "2023-01-01",
			"asin": "B09ABCDE",
			"ssku": "0000-0000-0000",
			"productTitle": "AAAAA BBBBB",
			"availableInventory": 10,
			"openPurchaseOrderQuantity": 10,
			"totalInventory": 20
		}]
	}
}
 
﻿
4.8实时销售报告
 
接口状态：已上线
接口URL：https://openapi.spotterio.com/datars-web/open/report/real/time
Content-Type：application/json
请求方式：post
接口备注：获取24h内的实时销售报告，时间为空则默认返回最近24小时数据，asin为空则默认返回当前时间所有asin之和的数据
URI参数说明：
参数名
示例值
参数类型
是否必填
参数描述
asin
B09ABCDE
String
否
ASIN
queryDate
2023-02-02
String
否
洛杉矶时间
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Number
暂无描述
msg
success
String
返回文字描述
data
 
List<Object>
返回数据
data.list.dateTime
2023-01-01 00:00:00
String
洛杉矶时间
data.list.orderedUnits
10
String
销售数量
data.list.orderedRevenue
10.00
BigDecimal
销售额
 
返回示例：(200)成功
{
	"code": 200,
	"msg": "success",
	"data": [{
			"dateTime": "2023-01-01 00:00:00",
			"orderedUnits": 100,
			"orderedRevenue": 200.00
		},{
			"dateTime": "2023-01-01 01:00:00",
			"orderedUnits": 100,
			"orderedRevenue": 200.00
		},{
			"dateTime": "2023-01-01 02:00:00",
			"orderedUnits": 100,
			"orderedRevenue": 200.00
		}
	}]
}
 
 
4.9销售预测
 
接口状态：已上线
接口URL：https://openapi.spotterio.com/datars-web/open/report/forecasting
Content-Type：application/json
请求方式：post
接口备注：获取销售预测数据，当前周以及未来47周的销售预测数据（总共48周数据），每周是以周六开始，周日结束为计算一周。
URI参数说明：
参数名
示例值
参数类型
是否必填
参数描述
asins
B09ABCDE
List<String>
否
ASIN，一次至多传10个
stat
MEAN
String
否
销售预测统计方式，MEAN/P70/P80/P90，目前只支持MEAN
currentPage
1
String
是
分页
pageSize
20
String
是
每页条数
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Number
暂无描述
msg
success
String
返回文字描述
data
 
List<Object>
返回数据
list.asin
B09ABCDE
String
asin
list.ssku
0000-0000-0000
String
ssku
list.asin.list.weekStart
2023-04-02
String
周起始日期
list.asin.list.weekEnd
2023-04-08
String
周结束日期
list.asin.list.value
2000
Integer
预测值
list.asin.list.stat
MEAN
String
销售预测预测的统计方式
 
返回示例：(200)成功
{
	"code": 200,
	"msg": "success",
	"data": {
		"currentPage": 1,
		"pageSize": 20,
		"totalNum": 30,
		"totalPage": 1,
		"isMore": true,
		"data": [{
			"asin": "AAAAAAAAAA",
			"ssku": "0000-0000-0000",
			"weeksValue": [{
					"weekStart": "2023-02-12",
					"weekEnd": "2023-02-18",
					"value": 1000
				}, ...,
				{
					"weekStart": "2023-12-31",
					"weekEnd": "2024-01-06",
					"value": 3532
				}]
			}, {
			"asin": "BBBBBBBBBB",
			"ssku": "0000-0000-0000",
			"weeksValue": [{
					"weekStart": "2023-02-12",
					"weekEnd": "2023-02-18",
					"value": 1000
				}, ...,
				{
					"weekStart": "2023-12-31",
					"weekEnd": "2024-01-06",
					"value": 3532
				}]
			}]
	    }
}
﻿
4.10实时销售详情报告
 
接口状态：已上线
接口URL：https://openapi.spotterio.com/datars-web/open/report/real/time/detail
Content-Type：application/json
请求方式：post
接口备注：获取 24h 内的实时销售报告，时间为空则默认返回最近 24 小时数据，asin 为空则默认返回当前时间 (洛杉矶时间) 的实时销量数据
URI参数说明：
参数名
示例值
参数类型
是否必填
参数描述
 asins
B09ABCDE
List<String>
否
ASIN
queryDate
2023-01-01
String
否
洛杉矶时间
currentPage
1
String
是
分页
pageSize
10
String
是
每页条数（每次请求限制最大为10条）
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Number
暂无描述
msg
success
String
返回文字描述
data
 
List<Object>
返回数据
data.list.date
2023-01-01
String
洛杉矶时间
data.list.asin
B09ABCDE
String
ASIN
data.list.ssku
0000-0000-0000
String
ssku
data.list.totalOrderedUnits
10
String
销售数量
data.list.totalOrderedRevenue
10.00
BigDecimal
销售额
data.list.salesRealTimeDetailVOS
﻿
List<Object>
实时销售详情
data.list.salesRealTimeDetailVOS.asin
B09ABCDE
String
ASIN
data.list.salesRealTimeDetailVOS.ssku
0000-0000-0000
String
ssku
data.list.salesRealTimeDetailVOS.dateTime
2023-01-01 00:00:00
String
洛杉矶时间
data.list.salesRealTimeDetailVOS.orderedRevenue
10
String
销售数量
data.list.salesRealTimeDetailVOS.orderedUnits
10.00
BigDecimal
销售额
 
返回示例：(200)成功
{
	"code": 200,
	"msg": "success",
	"data": {
		"currentPage": 1,
		"pageSize": 10,
		"totalNum": 1,
		"totalPage": 1,
		"isMore": true,
		"data": [{
                        "asin": "B09ABCDE",
                        "ssku": "00000-0000-0000",
                        "date": "2023-01-01",
                        "totalOrderedRevenue": 600.00,
                        "totalOrderedUnits": 300,
                        "salesRealTimeDetailVOS": [{
                              "asin": "B09ABCDE",
                              "ssku": "00000-0000-0000",
                              "dateTime": "2023-01-01 00:00:00",
                              "orderedUnits": 100,
                              "orderedRevenue": 200.00
                             },{
                              "asin": "B09ABCDE",
                              "ssku": "00000-0000-0000",
                              "dateTime": "2023-01-01 01:00:00",
                              "orderedUnits": 100,
                              "orderedRevenue": 200.00
                             },{
                              "asin": "B09ABCDE",
                              "ssku": "00000-0000-0000",
                              "dateTime": "2023-01-01 02:00:00",
                              "orderedUnits": 100,
                              "orderedRevenue": 200.00
                         }]
                }]
	}
}
 
4.11销售诊断详情报告
 
接口状态：已上线
接口URL：https://openapi.spotterio.com/datars-web/open/report/sales/v2
Content-Type：application/json
请求方式：post
接口备注：批量获取销售详情报告，若给定的时间为一个区间则会获取该区间内之和的销量数据；若查询某日的数据，queryStartDate和queryEndDate相同即可。
URI参数说明：
参数名
示例值
参数类型
是否必填
参数描述
 asins
B09ABCDE
List<String>
否
ASIN
queryStartDate
2023-01-01
String
否
洛杉矶时间
queryEndDate
2023-01-01
String
否
洛杉矶时间
currentPage
1
String
是
分页
pageSize
20
String
是
每页条数
 
返回参数说明：(200)成功
参数名
示例值
参数类型
参数描述
code
200
Number
暂无描述
msg
success
String
返回文字描述
data
 
List<Object>
返回数据
data.list.asin
B09ABCDE
String
ASIN
data.list.ssku
0000-0000-0000
String
ssku
data.list.orderedRevenue
10.0
Double
销售额
data.list.orderedUnits
10
Integer
销量
data.list.shippedUnits
10
Integer
发货量
data.list.glanceViews
10
Integer
浏览量
data.list.conversionRate
0.23
Double
转化率
data.list.customerReturnUnits
10
Integer
退货数量
 
返回示例：(200)成功
{
	"code": 200,
	"msg": "success",
	"data": {
		"currentPage": 1,
		"pageSize": 20,
		"totalNum": 1,
		"totalPage": 1,
		"isMore": true,
		"data": [{
                        "asin": "B09ABCDE",
                        "ssku": "00000-0000-0000",
                        "orderedRevenue": 600.00,
                        "orderedUnits": 300,
                        "shippedUnits": 20,
                        "glanceViews": 20,
                        "conversionRate": 20,
                        "customerReturnUnits": 20
                }]
	}
}
 