Lingxing
切换旧版

创建报告

POST/openReport/report/task/createReport

接口信息

此接口为异步创建

API Path请求协议请求方式令牌桶容量
/openReport/report/task/createReportHTTPSPOST1

请求参数

reportOptionsobject必填
报告参数,按json对象传,参考
reportTypeinteger必填
报告类型,1-亚马逊订单;2-产品表现;
dataStartTimestring必填
报告开始时间,格式:yyyy-MM-dd HH:mm:ss
dataEndTimestring必填
报告结束时间,格式:yyyy-MM-dd HH:mm:ss
sidsarray<any>必填
店铺id,对应查询亚马逊店铺列表接口对应字段【sid】
midsarray<any>
站点id

请求cURL示例

curl --location 'https://openapi.lingxing.com/openReport/report/task/createReport?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{
  "reportType": 1,
  "reportOptions": {
    "dateType": 1
  },
  "dataStartTime": "2021-01-01 00:00:00",
  "dataEndTime": "2021-01-31 23:59:59",
  "sids": [
    "1",
    "2"
  ],
  "mids": [
    "1",
    "2"
  ]
}'

返回结果

Json Object

codeinteger必填
状态码
messagestring必填
消息
error_detailsarray<any>必填
错误详情
request_idstring必填
请求流水号
response_timestring必填
响应时间
dataobject必填
响应数据
隐藏子属性
reportIdstring必填
报告id

返回成功示例

{
  "code": 200,
  "message": "success",
  "error_details": [],
  "request_id": "20210101123456789",
  "response_time": "2021-01-01 12:34:56",
  "data": {
    "reportId": "20210101123456789"
  }
}

附加说明

按json对象传

  • 当传入reportType=1 (亚马逊订单)

可选字段:

|参数名|是否必填|说明| |--|--|--| |dateType|否|查询时间类型,可选值:1 - 订购时间【站点时间】 2 - 订单修改时间【北京时间】 3 - 平台更新时间【UTC时间】|

示例传入:{"dateType":1}

  • 当传入reportType=2(产品表现)

可选字段:

|参数名|是否必填|说明| |--|--|--| |sort_field|是|排序条件,可选值:volume-销量,amount-金额| |sort_type|是|排序类型,可选值:desc-降序,asc-升序| |search_field|否|搜索条件,可选值:volume-销量;parent_asin-父asin;msku;local_sku-sku;item_name-标题| |summary_field|否|汇总行维度,可选值:asin-asin; parent_asin-父asin; msku-msku; sku-sku| |currency_code|否|货币类型转换,可选值:USD-美元;CNY-人民币| |is_recently_enum|否|是否仅查询活跃商品,可选值:true-仅活跃;false-所有商品|

当上述字段都传参时,示例:

{
  "sort_field": "volume",
  "sort_type": "desc",
  "search_field": "volume",
  "summary_field": "asin",
  "currency_code": "USD"
}