
Linkfox Amazon Store Report
- 237 installs
- 64 repo stars
- Updated August 3, 2026
- linkfox-ai/linkfox-skills
Helps with ai & agent building tasks.
About
linkfox-amazon-store-report is a Claude Code skill for ai & agent building. It helps solo builders move faster with AI-assisted development.
- linkfox-amazon-store-report
- AI & Agent Building
- AI-coding skill
Linkfox Amazon Store Report by the numbers
- 237 all-time installs (skills.sh)
- +36 installs in the week ending Aug 2, 2026 (Skillselion tracking)
- Ranked #2,640 of 16,546 AI & Agent Building skills by installs in the Skillselion catalog
- Data as of Aug 4, 2026 (Skillselion catalog sync)
npx skills add https://github.com/linkfox-ai/linkfox-skills --skill linkfox-amazon-store-reportAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 237 |
|---|---|
| repo stars | ★ 64 |
| Last updated | August 3, 2026 |
| Repository | linkfox-ai/linkfox-skills ↗ |
What it does
Helps with ai & agent building tasks.
Files
Amazon 店铺报告 API Reference
本文档描述 报告获取 相关的 API。授权与令牌相关接口(/spApi/authorizeUrl、/spApi/storeTokens、/spApi/refreshToken 等)属于 依赖 skill linkfox-amazon-store-auth,请参考该 skill 的 references/api.md。
⚠️ 依赖提示:在调用本 skill 接口前,请先确认linkfox-amazon-store-auth已安装(参见本 skill 的SKILL.md顶部 Prerequisites)。
Calling Conventions
- Base URL:
https://tool-gateway.linkfox.com(默认;可用STORE_API_BASE_URL或兼容旧名SPAPI_BASE_URL覆盖) - Request Method: POST
- Content-Type:
application/json - Authentication: Header
Authorization: <api_key>,读取环境变量LINKFOXAGENT_API_KEY
API Endpoints
1. Developer Proxy(转发亚马逊开放接口)
Endpoint: /spApi/developerProxy
报告相关的上游调用(列表 / 请求 / 查状态 / 取下载链接)都通过该代理接口转发。
Request Parameters (JSON):
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| region | string | Yes | 区域代码:NA/EU/FE | "NA" |
| path | string | Yes | 上游 Reports 等 API 路径(不含域名与 developer-proxy/{region}/ 前缀) | "reports/2021-06-30/reports" |
| method | string | Yes | HTTP 方法:GET/POST/PUT/DELETE | "GET" |
| amzAccessToken | string | Yes | 访问令牌(来自 /spApi/storeTokens) | "Atza\ |
| queryString | string | No | Query 参数(无 ?) | "marketplaceIds=ATVPDKIKX0DER" |
| body | string | No | POST/PUT 请求体(JSON 字符串) | "{\"reportType\":\"...\"}" |
| contentType | string | No | Content-Type 头(默认 application/json) | "application/json" |
Response:
{
"errcode": 200,
"errmsg": "ok",
"httpStatus": 200,
"contentType": "application/json",
"body": "{\"reports\":[...]}"
}Important Notes:
path必须在白名单内(后端sp-api.developer-proxy.allowed-path-prefixes)- 默认白名单含
reports/2021-06-30/reports amzAccessToken必须与region匹配的店铺令牌一致- 速率限制按上游亚马逊接口端点执行
---
createReport 请求体(POST reports/2021-06-30/reports)
developerProxy 的 body 为 JSON 字符串,反序列化后与 Amazon CreateReport 请求体一致。
通用字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| reportType | string | 是 | 报告类型枚举,见 references/report-types.md |
| marketplaceIds | array[string] | 是 | 站点 ID 列表(多数报告至少一个) |
| dataStartTime | string | 视报告 | ISO 8601;部分 schema 仅使用日期部分 YYYY-MM-DD |
| dataEndTime | string | 视报告 | 同上 |
| lastUpdatedDate | string | 视报告 | 部分 Vendor 报告要求,与日期字段组合以官方 schema 为准 |
| reportOptions | object | 视报告 | Brand Analytics、销售流量、促销/优惠券、部分 Vendor 等必填;键与枚举见各报告专页 |
与官方 JSON Schema 的对应关系
Amazon 在仓库 amzn/selling-partner-api-models/schemas/reports 中为 带 JSON 结果包裹 的报告提供了 Schema(含 reportSpecification 示例与结果字段定义)。
本 skill 在 references/report-requests/ 下为 *每个 `.json 维护一份同名 .md`*,内容包括:
- 上游 Raw 链接与摘要说明
- 从 schema 提取的 `reportType` 与 `reportSpecification` 官方示例(可直接作为
body模板) - `reportOptions` 键表(若有)
- 结果文档结构说明要点
入口索引:report-requests/README.md 按 `reportType` 全覆盖(109 个):report-requests/types/README.md
大量 Flat File(订单、库存等 TSV)报告在官方仓库中无独立schemas/reports/*.json时,请求体通常为reportType+marketplaceIds+ 可选dataStartTime/dataEndTime,详见 Report type values。
脚本参数映射(scripts/get_report.py)
| JSON 参数 | 写入 createReport 体 |
|---|---|
| reportType | reportType |
| marketplaceIds | marketplaceIds |
| dataStartTime | dataStartTime |
| dataEndTime | dataEndTime |
| lastUpdatedDate | lastUpdatedDate |
| reportOptions | reportOptions(对象原样合并) |
---
与依赖 skill 的接力关系
下面是典型调用序列(本 skill + linkfox-amazon-store-auth):
linkfox-amazon-store-auth/scripts/store_tokens.py # 取 accessToken
│
▼
linkfox-amazon-store-report/scripts/get_report.py # 用 accessToken 拉报告
1. POST /spApi/developerProxy (method=POST, path=reports/2021-06-30/reports)
2. POST /spApi/developerProxy (method=GET, path=reports/2021-06-30/reports/{reportId}) # 轮询
3. POST /spApi/developerProxy (method=GET, path=reports/2021-06-30/documents/{reportDocumentId})
4. 直接下载返回的 url 并解压Error Codes
| errcode | 含义 | 建议动作 |
|---|---|---|
| 200 | 代理调用成功(还需看 httpStatus) | 继续解析 body |
| 1002 | 缺参数或认证失败 | 检查必填参数与 API key |
| 1003 | 第三方服务调用失败 | 稍后重试 |
| 1005 | path 不在白名单 | 联系后端加白名单 |
Developer Proxy 上游状态码
调用成功(errcode=200)后必须再检查 httpStatus:
| httpStatus | 含义 | 建议动作 |
|---|---|---|
| 200 | 成功 | 正常解析 body |
| 202 | 已接受(创建报告后返回) | 拿到 reportId 进入轮询 |
| 400 | 参数错误 | 检查 reportType / marketplaceIds |
| 403 | 未授权 | 检查 accessToken、店铺权限、品牌备案 |
| 404 | 资源不存在 | 核对 reportId/reportDocumentId |
| 429 | 请求过快 | 指数退避重试 |
| 500 | 上游错误 | 延时重试 |
---
curl Examples
列出现有报告
curl -X POST https://tool-gateway.linkfox.com/spApi/developerProxy \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"region": "NA",
"path": "reports/2021-06-30/reports",
"method": "GET",
"amzAccessToken": "Atza|IwEBI...",
"queryString": "reportTypes=GET_MERCHANT_LISTINGS_ALL_DATA&marketplaceIds=ATVPDKIKX0DER"
}'请求新报告
curl -X POST https://tool-gateway.linkfox.com/spApi/developerProxy \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"region": "NA",
"path": "reports/2021-06-30/reports",
"method": "POST",
"amzAccessToken": "Atza|IwEBI...",
"body": "{\"reportType\":\"GET_MERCHANT_LISTINGS_ALL_DATA\",\"marketplaceIds\":[\"ATVPDKIKX0DER\"]}",
"contentType": "application/json"
}'查询报告状态
curl -X POST https://tool-gateway.linkfox.com/spApi/developerProxy \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"region": "NA",
"path": "reports/2021-06-30/reports/<reportId>",
"method": "GET",
"amzAccessToken": "Atza|IwEBI..."
}'获取下载链接
curl -X POST https://tool-gateway.linkfox.com/spApi/developerProxy \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"region": "NA",
"path": "reports/2021-06-30/documents/<reportDocumentId>",
"method": "GET",
"amzAccessToken": "Atza|IwEBI..."
}'---
Feedback API
本接口与上面工具 API 不同 base URL,不要混用。
- POST
https://skill-api.linkfox.com/api/v1/public/feedback - Content-Type:
application/json
{
"skillName": "linkfox-amazon-store-report",
"sentiment": "NEGATIVE",
"category": "BUG",
"content": "Report FATAL for Brand Analytics, but store lacks brand registry — error not surfaced clearly."
}Field rules:
skillName: 使用本 skill frontmatter 的namesentiment:POSITIVE/NEUTRAL/NEGATIVEcategory:BUG/COMPLAINT/SUGGESTION/OTHERcontent: 用户说了什么、实际发生了什么、为什么是问题
---
报告类型索引
完整列表见 references/report-types.md(95+ 种)。精简摘要见 references/report-types-basic.md。
带 schema 的请求/结果格式:references/report-requests/README.md(与 GitHub schemas/reports 一一对应)。
accountHealthReport-2020-11-18.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:accountHealthReport-2020-11-18.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
The root schema comprises the entire JSON document.
对应 reportType(SP-API)
- (文档结构对应账户状况类报告;
reportType以 Report Type Values 为准,常见为账户状况/绩效相关枚举)
本 JSON 主要为报告结果文档字段定义,文件中未嵌入 reportSpecification 示例。创建报告时的 reportType、是否需 reportOptions 请查阅官方 Report Type Values。
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
无内嵌 reportSpecification 示例
创建请求请以 Report Type Values 为准;可先用最小字段试请求,再根据 400 错误补充 reportOptions。
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
b2bProductOpportunitiesNotYetOnAmazonReport-2020-11-19.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:b2bProductOpportunitiesNotYetOnAmazonReport-2020-11-19.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
Provides B2B product recommendations based on predicted incremental units sold, unmet buyer demand, and other factors for products not yet listed on Amazon. The recommendations are personalized to the seller based on past sales activity.
对应 reportType(SP-API)
GET_B2B_PRODUCT_OPPORTUNITIES_NOT_YET_ON_AMAZON
Schema 描述输出 recommendations 结构。创建报告通常:reportType + marketplaceIds,日期字段以官方为准。
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
无内嵌 reportSpecification 示例
创建请求请以 Report Type Values 为准;可先用最小字段试请求,再根据 400 错误补充 reportOptions。
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
b2bProductOpportunitiesRecommendedForYouReport-2020-11-19.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:b2bProductOpportunitiesRecommendedForYouReport-2020-11-19.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
Provides B2B product recommendations based on predicted incremental units sold, unmet buyer demand, low offer count, and other factors for products already offered on Amazon. The recommendations are personalized to the Seller based on past sales activity.
对应 reportType(SP-API)
GET_B2B_PRODUCT_OPPORTUNITIES_RECOMMENDED_FOR_YOU
同上,输出为推荐列表结构。
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
无内嵌 reportSpecification 示例
创建请求请以 Report Type Values 为准;可先用最小字段试请求,再根据 400 错误补充 reportOptions。
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
endUserDataReport.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:endUserDataReport.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
Provides end user (customer) data to IE, ES, FR, BE, NL, DE, IT, SE, and PL selling partners. The data contains customer personal data that includes contact information, page view (glance view), and order data for customers that elect to share this data with specific sellers. The customer data is accessible across various reporting periods (DAY, WEEK, and MONTH). Developers can choose start and end dates and the reporting period for data retrieval and aggregation. If the customer does not elect to share their data, the report does not generate data.
对应 reportType(从 schema 中提取)
END_USER_DATA_REPORT
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"dataStartTime": "2023-09-10",
"dataEndTime": "2023-09-16",
"reportType": "END_USER_DATA_REPORT",
"reportOptions": {
"reportPeriod": "WEEK"
},
"marketplaceIds": [
"A1PA6795UKMFR9",
"APJ6JRA9NG5V4"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
reportPeriod | WEEK | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
marketplaceAsinPageViewMetrics.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:marketplaceAsinPageViewMetrics.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
Provides information on the ASIN page view (glance view) metrics for the DE, FR, IT, ES, NL, PL, SE, BE (EU-8) and UK marketplaces, with data available up to the last seven days. A page view is a customer view of the product's detail page for a given ASIN. Developers have the option to specify a start and end date to retrieve data within that range. If no dates are specified, the report will provide the data for the latest available day. For marketplaces and product categories where the seller does not have a meaningful presence (40 units sold), the report will not return any data.
对应 reportType(从 schema 中提取)
MARKETPLACE_ASIN_PAGE_VIEW_METRICS
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"dataStartTime": "2023-04-27",
"dataEndTime": "2023-05-03",
"reportType": "MARKETPLACE_ASIN_PAGE_VIEW_METRICS",
"reportOptions": {
"productType": "AUTO_BATTERY"
},
"marketplaceIds": [
"A1PA6795UKMFR9",
"APJ6JRA9NG5V4"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
productType | AUTO_BATTERY | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
promotionReport.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:promotionReport.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
The Promotion Performance report contains data to help vendors optimize their promotions and adjust their advertising strategies. Currently three promotion types are supported: Best Deal, Lightning Deal, and Price Discount. This report supports start dates up to two years before the current date.
对应 reportType(从 schema 中提取)
GET_PROMOTION_PERFORMANCE_REPORT
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"reportType": "GET_PROMOTION_PERFORMANCE_REPORT",
"reportOptions": {
"promotionStartDateFrom": "2020-11-23T15:33:26Z",
"promotionStartDateTo": "2020-12-06T15:33:26Z"
},
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
promotionStartDateFrom | 2020-11-23T15:33:26Z | 详见上游 schema reportSpecification.properties.reportOptions |
promotionStartDateTo | 2020-12-06T15:33:26Z | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
报告请求与文档格式(按 GitHub schema 分文件)
与 amzn/selling-partner-api-models/schemas/reports 中的 JSON Schema 一一对应。
reportType 全覆盖(含无 JSON 的 Flat File)
references/report-types.md 表格中的 每一个 reportType 均有专页 → [types/README.md](./types/README.md)(109 个:types/<REPORT_TYPE>.md)。 有 GitHub JSON 的条目会链回下表中的 *.md;其余条目给出最小 CreateReport 模板并指向 Report type values。
索引(仅含官方 schemas/reports/*.json)
| 文档 | 上游 Schema | 涉及 reportType |
|---|---|---|
| accountHealthReport-2020-11-18.md | `accountHealthReport-2020-11-18.json` | 见专页(账户状况结果 JSON;reportType 以官方 Report Type Values 为准) |
| b2bProductOpportunitiesNotYetOnAmazonReport-2020-11-19.md | `b2bProductOpportunitiesNotYetOnAmazonReport-2020-11-19.json` | GET_B2B_PRODUCT_OPPORTUNITIES_NOT_YET_ON_AMAZON |
| b2bProductOpportunitiesRecommendedForYouReport-2020-11-19.md | `b2bProductOpportunitiesRecommendedForYouReport-2020-11-19.json` | GET_B2B_PRODUCT_OPPORTUNITIES_RECOMMENDED_FOR_YOU |
| endUserDataReport.md | `endUserDataReport.json` | END_USER_DATA_REPORT |
| marketplaceAsinPageViewMetrics.md | `marketplaceAsinPageViewMetrics.json` | MARKETPLACE_ASIN_PAGE_VIEW_METRICS |
| promotionReport.md | `promotionReport.json` | GET_PROMOTION_PERFORMANCE_REPORT |
| sellerCouponReport.md | `sellerCouponReport.json` | GET_COUPON_PERFORMANCE_REPORT |
| sellerSalesAndTrafficReport.md | `sellerSalesAndTrafficReport.json` | GET_SALES_AND_TRAFFIC_REPORT |
| sellingPartnerMarketBasketAnalysisReport.md | `sellingPartnerMarketBasketAnalysisReport.json` | GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT(搜索词见 sellingPartnerSearchTermsReport) |
| sellingPartnerRepeatPurchaseReport.md | `sellingPartnerRepeatPurchaseReport.json` | GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT |
| sellingPartnerSearchCatalogPerformanceReport.md | `sellingPartnerSearchCatalogPerformanceReport.json` | GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT |
| sellingPartnerSearchQueryPerformanceReport.md | `sellingPartnerSearchQueryPerformanceReport.json` | GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT |
| sellingPartnerSearchTermsReport.md | `sellingPartnerSearchTermsReport.json` | GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT |
| vendorCouponReport.md | `vendorCouponReport.json` | GET_COUPON_PERFORMANCE_REPORT |
| vendorForecastingReport.md | `vendorForecastingReport.json` | GET_VENDOR_FORECASTING_REPORT |
| vendorInventoryReport.md | `vendorInventoryReport.json` | GET_VENDOR_INVENTORY_REPORT |
| vendorNetPureProductMarginReport.md | `vendorNetPureProductMarginReport.json` | GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT |
| vendorRealTimeInventoryReport.md | `vendorRealTimeInventoryReport.json` | GET_VENDOR_REAL_TIME_INVENTORY_REPORT |
| vendorRealTimeSalesReport.md | `vendorRealTimeSalesReport.json` | GET_VENDOR_REAL_TIME_SALES_REPORT |
| vendorRealTimeTrafficReport.md | `vendorRealTimeTrafficReport.json` | GET_VENDOR_REAL_TIME_TRAFFIC_REPORT |
| vendorSalesReport.md | `vendorSalesReport.json` | GET_VENDOR_SALES_REPORT |
| vendorTrafficReport.md | `vendorTrafficReport.json` | GET_VENDOR_TRAFFIC_REPORT |
通用说明
- 创建报告:
references/api.md中的developerProxy+path=reports/2021-06-30/reports+method=POST。 - 本目录:每个
*.md对应一个*.json,给出createReport请求体要点及 schema 摘要。 - 未出现在上表中的 reportType:见 [types/](./types/) 目录下按枚举命名的专页(全覆盖
report-types.md)。
sellerCouponReport.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:sellerCouponReport.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
This report contains data to help sellers optimize their coupons and adjust their advertising strategies. This report supports start dates up to two years before the current date.
对应 reportType(从 schema 中提取)
GET_COUPON_PERFORMANCE_REPORT
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"reportType": "GET_COUPON_PERFORMANCE_REPORT",
"reportOptions": {
"couponStartDateFrom": "2021-11-01T15:33:26Z",
"couponStartDateTo": "2021-11-30T15:33:26Z"
},
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
couponStartDateFrom | 2021-11-01T15:33:26Z | 详见上游 schema reportSpecification.properties.reportOptions |
couponStartDateTo | 2021-11-30T15:33:26Z | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
sellerSalesAndTrafficReport.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:sellerSalesAndTrafficReport.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
This report shares data on the sales performance and page traffic of the seller's items aggregated by date (across the seller's entire catalog of items) and aggregated by ASIN. Aggregated data is available at different date range aggregation levels: DAY, WEEK, MONTH. Per-ASIN data is available at different ASIN aggregation levels: PARENT, CHILD, SKU. Requests can span multiple date range periods.
对应 reportType(从 schema 中提取)
GET_SALES_AND_TRAFFIC_REPORT
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"reportType": "GET_SALES_AND_TRAFFIC_REPORT",
"reportOptions": {
"dateGranularity": "DAY",
"asinGranularity": "SKU"
},
"dataStartTime": "2021-06-11",
"dataEndTime": "2021-06-14",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
dateGranularity | DAY | 详见上游 schema reportSpecification.properties.reportOptions |
asinGranularity | SKU | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
sellingPartnerMarketBasketAnalysisReport.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:sellingPartnerMarketBasketAnalysisReport.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
The Market Basket report contains data on the items that are most commonly purchased in combination with the items in the customer's basket (cart) at checkout. The data is available across different reporting periods: DAY, WEEK, MONTH, and QUARTER. Requests can span multiple reporting periods. In this report, "asin" is an ASIN in the selling partner's catalog and "purchasedWithAsin" might or might not be an ASIN in the selling partner's catalog.
对应 reportType
- 本文件根级
reportSpecification.properties.reportType.enum为 `GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT`。 reportSpecification.examples中曾出现GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT示例,与 Search Terms 专用 schema `sellingPartnerSearchTermsReport.json` 对应;拉 搜索词 报告请以该文件及 `sellingPartnerSearchTermsReport.md` 为准。
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"reportType": "GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT",
"reportOptions": {
"reportPeriod": "WEEK"
},
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
reportPeriod | WEEK | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
sellingPartnerRepeatPurchaseReport.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:sellingPartnerRepeatPurchaseReport.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
The Repeat Purchase report shares data on the quantity of repeated purchases of the selling partner's items. Data is available at different date range aggregation levels: WEEK, MONTH, QUARTER. Requests can span multiple reporting periods. In this report, "asin" is an ASIN in the selling partner's catalog.
对应 reportType(从 schema 中提取)
GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"reportType": "GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT",
"reportOptions": {
"reportPeriod": "WEEK"
},
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-19",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
reportPeriod | WEEK | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
sellingPartnerSearchCatalogPerformanceReport.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:sellingPartnerSearchCatalogPerformanceReport.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
The Search Catalog Performance report provides search engagement metrics, such as impressions, clicks, cart adds, and purchases for a date range that you specify. The data is available at different reporting periods: WEEK, MONTH, and QUARTER. Requests cannot span multiple periods. For example, a request at the WEEK level cannot start on 2025-01-05 and end on 2025-01-18 as this request spans two weeks.
对应 reportType(从 schema 中提取)
GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"reportType": "GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT",
"reportOptions": {
"reportPeriod": "WEEK",
"asins": "B123456789 B987654321"
},
"dataStartTime": "2025-01-05",
"dataEndTime": "2025-01-11",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
reportPeriod | WEEK | 详见上游 schema reportSpecification.properties.reportOptions |
asins | B123456789 B987654321 | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
sellingPartnerSearchQueryPerformanceReport.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:sellingPartnerSearchQueryPerformanceReport.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
The Search Query Performance Report provides overall query performance, such as impressions, clicks, cart adds, and purchases for a list of Amazon Standard Identification Numbers (ASINs) and date range that you specify. Data is available at different reporting periods: WEEK, MONTH, and QUARTER. Requests cannot span multiple periods. For example, a request at the WEEK level cannot start on 2025-01-05 and end on 2025-01-18 as this request spans two weeks.
对应 reportType(从 schema 中提取)
GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"reportType": "GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT",
"reportOptions": {
"reportPeriod": "WEEK",
"asin": "B123456789 B987654321"
},
"dataStartTime": "2025-01-05",
"dataEndTime": "2025-01-11",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
reportPeriod | WEEK | 详见上游 schema reportSpecification.properties.reportOptions |
asin | B123456789 B987654321 | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
sellingPartnerSearchTermsReport.json — 报告格式说明
上游 JSON Schema 来自 Amazon selling-partner-api-models/schemas/reports。
- Raw:sellingPartnerSearchTermsReport.json
- 目录浏览:https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports
Schema 摘要
The Search Terms report shares data on the top-3 clicked ASINs by search keyword and department for a marketplace. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER. Requests cannot span multiple periods. For example, a request at WEEK level could not start on 2021-06-06 and end on 2021-06-19 as this would span two weeks.
对应 reportType(从 schema 中提取)
GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT
createReport 请求体(POST .../reports/2021-06-30/reports)
LinkFox 网关通过 developerProxy 转发时,body 为 JSON 字符串,对象字段与 SP-API CreateReport 一致,常用结构如下:
{
"reportType": "<REPORT_TYPE>",
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"dataStartTime": "2025-01-01T00:00:00Z",
"dataEndTime": "2025-01-31T23:59:59Z",
"reportOptions": {
"...": "..."
}
}- `reportType` / `marketplaceIds`:必填(多数报告)。
- `dataStartTime` / `dataEndTime`:ISO 8601;部分报告 schema 使用 仅日期
YYYY-MM-DD(Amazon 忽略时间分量),以本文件「官方示例」为准。 - `reportOptions`:对象,键名/枚举因报告而异;Brand Analytics 等 必填,见下节。
- `lastUpdatedDate`:部分 Vendor 报告使用(见 schema
reportSpecification),需与dataStartTime/dataEndTime按官方要求组合。
本仓库脚本 scripts/get_report.py 已支持:在 JSON 参数中传入 `reportOptions`(对象)以及 `lastUpdatedDate`(字符串),会合并进创建请求体。
官方 reportSpecification 示例(摘自 schema examples)
{
"reportType": "GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT",
"reportOptions": {
"reportPeriod": "WEEK"
},
"dataStartTime": "2021-06-06",
"dataEndTime": "2021-06-12",
"marketplaceIds": [
"ATVPDKIKX0DER"
]
}reportOptions 键说明(来自示例)
| 键 | 示例值 | 说明 |
|---|---|---|
reportPeriod | WEEK | 详见上游 schema reportSpecification.properties.reportOptions |
报告结果文档(下载/解压后的 JSON)
- 顶层字段以本 schema 的
properties/definitions为准(多为业务数据数组或对象)。 - 若 schema 内含
reportSpecification+ 数据数组(如dataByAsin),下载文件常为 带元数据包裹 的结构,与 TSV 类平面报告不同。
END_USER_DATA_REPORT
分类:12. Regulatory Compliance Reports
说明:End user data report
可用范围:Seller only
官方索引(Report type values)
- Schema 专页(请求体、`reportOptions`、结果 JSON):`endUserDataReport.md`
- Amazon 文档(权限/站点等;与 Schema 专页技术描述重复处以 Schema 专页为准):Regulatory Compliance Reports(章节:End User Data Report)
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Buyer Communication
- Availability:Sellers
- Marketplace availability:IE, ES, FR, BE, NL, DE, IT, SE, and PL.
- Requested/scheduled:This report can be requested or scheduled.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-regulatory-compliance#end-user-data-report>
官方 JSON Schema 与请求/结果说明
技术细节(reportSpecification、reportOptions、下载结果的 JSON 结构)见本节上方 Schema 专页链接,此处不重复列出。
CreateReport
请优先以专页中的官方示例构造请求体;下列仅为占位,可能缺少必填 `reportOptions` 或日期规则。
{
"reportType": "END_USER_DATA_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"]
}LinkFox
scripts/get_report.py、references/api.md。
另见
references/report-types.md
FBA_BULK_INVOICE
分类:12. Regulatory Compliance Reports
说明:FBA bulk invoice
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Regulatory Compliance Reports(章节:FBA Bulk Invoice)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:未在相邻 Note 中写明,但 Role 含 Restricted;仍可能需 RDT/额外审核,以官方为准
- Role:Tax Invoicing (Restricted)
- Availability:Sellers
- Requested/scheduled:This report can only be requested.
- 要点:Provides the invoices for a seller within a given date range. These invoices include customer orders served by the seller. This report type supports the following report options: A single report option value is limited to 200 characters. The TRANSPORTER_COPY and CUSTOMER_COPY invoiceTypes are only available for the MCF_SHIPMENT transactionType. For any other transactionTypes, SELLER_COPY is the only valid invoiceType. MCF_SHIPMENT will also support SELLER_COPY as the valid invoiceType. orderIds and shipmentId are mutually exclusive fields. Only one should be provided in the request. If both fields are given the request will fail. If none of the fields are set or the report options field itself is absent, then the request will return all the relevant invoices (SHIPMENT and MCF_SHIPMENT transaction types) in the requested date range.
- reportOptions(摘录):
- orderIds: A single string consisting of a comma separated list of order ids to filter. Example: 406-8193317-8698708, 408-0804227-3381000.
- shipmentIds: A single string consisting of a comma separated list of shipment ids to filter. Example: 64119752218302, 264552989124123.
- transactionTypes: A single string consisting of a comma separated list of transaction types to filter. The possible transactionTypes are SHIPMENT, REFUND, CANCEL, EINVOICE_CANCEL, FC_TRANSFER, FC_TRANSFER_CANCEL, FC_REMOVAL, FC_REMOVAL_CANCEL, MCF_SHIPMENT, MCF_CANCEL, and MCF_REFUND.
- invoiceTypes: A single string consisting of a comma separated list of invoice types to filter. Possible invoiceTypes include CUSTOMER_COPY, SELLER_COPY, and TRANSPORTER_COPY.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-regulatory-compliance#fba-bulk-invoice>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "FBA_BULK_INVOICE",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "FBA_BULK_INVOICE",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
FEE_DISCOUNTS_REPORT
分类:1. Amazon Business Reports
说明:Amazon Business fee discounts
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Amazon Business Reports(章节:Referral Fee Discounts Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Product Listing
- Availability:Amazon Business sellers
- Requested/scheduled:This report can be requested or scheduled.
- Report output type:Microsoft Excel Workbook file (.xlsx)
- 要点:Contains a summary of the seller's fee discounts. 📘NoteInformation in this report can be up to 24 hours old. Do not request a report more than once within a 24-hour period.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-amazon-business#referral-fee-discounts-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "FEE_DISCOUNTS_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "FEE_DISCOUNTS_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_AFN_INVENTORY_DATA_BY_COUNTRY
分类:6.2 FBA Inventory
说明:AFN inventory by country
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Fulfillment by Amazon (FBA) Reports(章节:FBA Multi-Country Inventory Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Availability:Seller Central sellers
- Marketplace availability:Europe (EU)
- Requested/scheduled:This report can only be requested.
- Report output type:Tab-delimited flat file
- Roles:Pricing, Amazon Fulfillment
- 要点:Contains quantity available for local fulfillment by country, helping Multi-Country Inventory sellers in Europe track their FBA inventory. Content updated in near real-time.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-fba#fba-multi-country-inventory-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_AFN_INVENTORY_DATA_BY_COUNTRY",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_AFN_INVENTORY_DATA_BY_COUNTRY",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_AFN_INVENTORY_DATA
分类:6.2 FBA Inventory
说明:Amazon Fulfilled Network inventory
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Fulfillment by Amazon (FBA) Reports(章节:FBA Amazon Fulfilled Inventory Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Amazon Fulfillment
- Availability:FBA sellers
- Requested/scheduled:This report can only be requested.
- Report output type:Tab-delimited flat file
- 要点:Content updated in near real-time.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-fba#fba-amazon-fulfilled-inventory-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_AFN_INVENTORY_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_AFN_INVENTORY_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL
分类:6.1 FBA Shipments
说明:FBA fulfilled shipments (general)
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Fulfillment by Amazon (FBA) Reports(章节:FBA Amazon Fulfilled Shipments Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Availability:FBA sellers
- Requested/scheduled:This report can only be requested.
- Report output type:Tab-delimited flat file
- Roles:Pricing, Amazon Fulfillment, Inventory and Order Tracking
- 要点:Contains detailed order/shipment/item information including price, courier, and tracking data. You can request up to one month of data in a single report. Content updated in near real-time in Europe (EU), Japan, and North America (NA). 📘NoteIn Japan, EU, and NA, in most cases, there will be a delay of approximately one to three hours from the time a fulfillment order ships and the time the items in the fulfillment order appear in the report. In some rare cases there could be a delay of up to 24 hours.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-fba#fba-amazon-fulfilled-shipments-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_AMAZON_FULFILLED_SHIPMENTS_DATA_INVOICING
分类:6.1 FBA Shipments
说明:FBA shipments for invoicing
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Fulfillment by Amazon (FBA) Reports(章节:FBA Amazon Fulfilled Shipments Report (Invoicing))。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:是(相邻 Note 标明 restricted:下载结果需 RDT,参见官方 Tokens API)
- Role:Tax Invoicing (Restricted)
- Availability:FBA sellers
- Requested/scheduled:This report can only be requested.
- Report output type:Tab-delimited flat file
- 要点:This report should be used to generate tax invoices in the EU region. You can request up to one month of data in a single report. Content updated in near real-time in Europe (EU), Japan, and North America (NA). 📘Note:In most cases, there will be a delay of approximately one to three hours from the time a fulfillment order ships and the time the items in the fulfillment order appear in the report. In some rare cases there could be a delay of up to 24 hours.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-fba#fba-amazon-fulfilled-shipments-report-invoicing>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_INVOICING",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_INVOICING",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_AMAZON_FULFILLED_SHIPMENTS_DATA_TAX
分类:6.1 FBA Shipments
说明:FBA shipments tax data
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Fulfillment by Amazon (FBA) Reports(章节:FBA Amazon Fulfilled Shipments Report (Tax))。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:是(相邻 Note 标明 restricted:下载结果需 RDT,参见官方 Tokens API)
- Role:Tax Remittance (Restricted)
- Availability:FBA sellers
- Requested/scheduled:This report can only be requested.
- Report output type:Tab-delimited flat file
- 要点:This report is for calculating and remitting taxes in the NA region. You can request up to one month of data in a single report. Content updated in near real-time in Europe (EU), Japan, and North America (NA). 📘Note:In most cases, there will be a delay of approximately one to three hours from the time a fulfillment order ships and the time the items in the fulfillment order appear in the report. In some rare cases there could be a delay of up to 24 hours.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-fba#fba-amazon-fulfilled-shipments-report-tax>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_TAX",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_TAX",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_B2B_PRODUCT_OPPORTUNITIES_NOT_YET_ON_AMAZON
分类:3. B2B Product Opportunities
说明:B2B opportunities not yet on Amazon
可用范围:Seller only
官方索引(Report type values)
- Schema 专页(请求体、`reportOptions`、结果 JSON):`b2bProductOpportunitiesNotYetOnAmazonReport-2020-11-19.md`
- Amazon 文档(权限/站点等;与 Schema 专页技术描述重复处以 Schema 专页为准):B2B Product Opportunities Reports(章节:B2B Product Opportunities - Not yet on Amazon)
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Product Listing
- Marketplace availability:This report is only available in the following marketplaces:
- Requested/scheduled:This report can only be requested.
- Report output type:Comma-separated flat file
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-b2b-product-opportunities#b2b-product-opportunities---not-yet-on-amazon>
官方 JSON Schema 与请求/结果说明
技术细节(reportSpecification、reportOptions、下载结果的 JSON 结构)见本节上方 Schema 专页链接,此处不重复列出。
CreateReport
请优先以专页中的官方示例构造请求体;下列仅为占位,可能缺少必填 `reportOptions` 或日期规则。
{
"reportType": "GET_B2B_PRODUCT_OPPORTUNITIES_NOT_YET_ON_AMAZON",
"marketplaceIds": ["ATVPDKIKX0DER"]
}LinkFox
scripts/get_report.py、references/api.md。
另见
references/report-types.md
GET_B2B_PRODUCT_OPPORTUNITIES_RECOMMENDED_FOR_YOU
分类:3. B2B Product Opportunities
说明:Personalized B2B product recommendations
可用范围:Seller only
官方索引(Report type values)
- Schema 专页(请求体、`reportOptions`、结果 JSON):`b2bProductOpportunitiesRecommendedForYouReport-2020-11-19.md`
- Amazon 文档(权限/站点等;与 Schema 专页技术描述重复处以 Schema 专页为准):B2B Product Opportunities Reports(章节:B2B Product Opportunities - Recommended for You Report)
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Product Listing
- Marketplace availability:This report is only available in the following marketplaces:
- Requested/scheduled:This report can only be requested.
- Report output type:Comma-separated flat file
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-b2b-product-opportunities#b2b-product-opportunities---recommended-for-you-report>
官方 JSON Schema 与请求/结果说明
技术细节(reportSpecification、reportOptions、下载结果的 JSON 结构)见本节上方 Schema 专页链接,此处不重复列出。
CreateReport
请优先以专页中的官方示例构造请求体;下列仅为占位,可能缺少必填 `reportOptions` 或日期规则。
{
"reportType": "GET_B2B_PRODUCT_OPPORTUNITIES_RECOMMENDED_FOR_YOU",
"marketplaceIds": ["ATVPDKIKX0DER"]
}LinkFox
scripts/get_report.py、references/api.md。
另见
references/report-types.md
GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT
分类:2. Analytics Reports
说明:Products frequently purchased together
可用范围:Both
官方索引(Report type values)
- Schema 专页(请求体、`reportOptions`、结果 JSON):`sellingPartnerMarketBasketAnalysisReport.md`
- Amazon 文档(权限/站点等;与 Schema 专页技术描述重复处以 Schema 专页为准):Analytics Reports(章节:Market Basket Analysis Report)
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Brand Analytics
- Availability:Sellers and vendors who have the Brand Analytics Selling Partner API role and are registered in Amazon Brand Registry.
- Marketplace availability:NA (all marketplaces), EU (Spain, United Kingdom, France, Netherlands, Germany, Italy, Sweden, Turkey, Saudi Arabia, United Arab Emirates, India), FE (all marketplaces).
- Requested/scheduled:This report can only be requested.
- Report output type:JSON
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-analytics#market-basket-analysis-report>
官方 JSON Schema 与请求/结果说明
技术细节(reportSpecification、reportOptions、下载结果的 JSON 结构)见本节上方 Schema 专页链接,此处不重复列出。
CreateReport
请优先以专页中的官方示例构造请求体;下列仅为占位,可能缺少必填 `reportOptions` 或日期规则。
{
"reportType": "GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"]
}LinkFox
scripts/get_report.py、references/api.md。
另见
references/report-types.md
GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT
分类:2. Analytics Reports
说明:Repeat purchase behavior analysis
可用范围:Both
官方索引(Report type values)
- Schema 专页(请求体、`reportOptions`、结果 JSON):`sellingPartnerRepeatPurchaseReport.md`
- Amazon 文档(权限/站点等;与 Schema 专页技术描述重复处以 Schema 专页为准):Analytics Reports(章节:Repeat Purchase)
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Brand Analytics
- Availability:Sellers and vendors who have the Brand Analytics Selling Partner API role and are registered in Amazon Brand Registry.
- Requested/scheduled:This report can only be requested.
- Report output type:JSON
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-analytics#repeat-purchase>
官方 JSON Schema 与请求/结果说明
技术细节(reportSpecification、reportOptions、下载结果的 JSON 结构)见本节上方 Schema 专页链接,此处不重复列出。
CreateReport
请优先以专页中的官方示例构造请求体;下列仅为占位,可能缺少必填 `reportOptions` 或日期规则。
{
"reportType": "GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"]
}LinkFox
scripts/get_report.py、references/api.md。
另见
references/report-types.md
GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT
分类:2. Analytics Reports
说明:Search catalog performance metrics
可用范围:Seller only
官方索引(Report type values)
- Schema 专页(请求体、`reportOptions`、结果 JSON):`sellingPartnerSearchCatalogPerformanceReport.md`
- Amazon 文档(权限/站点等;与 Schema 专页技术描述重复处以 Schema 专页为准):Analytics Reports(章节:Search Catalog Performance Report)
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Brand Analytics
- Availability:Sellers who have the Brand Analytics Selling Partner API role and are registered in Amazon Brand Registry.
- Marketplace availability:NA (all marketplaces), EU (Spain, United Kingdom, France, Netherlands, Germany, Italy, Sweden, Turkey, Saudi Arabia, United Arab Emirates, India), FE (all marketplaces).
- Requested/scheduled:This report can only be requested.
- Report output type:JSON
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-analytics#search-catalog-performance-report>
官方 JSON Schema 与请求/结果说明
技术细节(reportSpecification、reportOptions、下载结果的 JSON 结构)见本节上方 Schema 专页链接,此处不重复列出。
CreateReport
请优先以专页中的官方示例构造请求体;下列仅为占位,可能缺少必填 `reportOptions` 或日期规则。
{
"reportType": "GET_BRAND_ANALYTICS_SEARCH_CATALOG_PERFORMANCE_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"]
}LinkFox
scripts/get_report.py、references/api.md。
另见
references/report-types.md
GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT
分类:2. Analytics Reports
说明:Search query performance data
可用范围:Seller only
官方索引(Report type values)
- Schema 专页(请求体、`reportOptions`、结果 JSON):`sellingPartnerSearchQueryPerformanceReport.md`
- Amazon 文档(权限/站点等;与 Schema 专页技术描述重复处以 Schema 专页为准):Analytics Reports(章节:Search Query Performance Report)
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Brand Analytics
- Availability:Sellers who have the Brand Analytics Selling Partner API role and are registered in Amazon Brand Registry.
- Marketplace availability:NA (all marketplaces), EU (Spain, United Kingdom, France, Netherlands, Germany, Italy, Sweden, Turkey, Saudi Arabia, United Arab Emirates, India), FE (all marketplaces).
- Requested/scheduled:This report can only be requested.
- Report output type:JSON
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-analytics#search-query-performance-report>
官方 JSON Schema 与请求/结果说明
技术细节(reportSpecification、reportOptions、下载结果的 JSON 结构)见本节上方 Schema 专页链接,此处不重复列出。
CreateReport
请优先以专页中的官方示例构造请求体;下列仅为占位,可能缺少必填 `reportOptions` 或日期规则。
{
"reportType": "GET_BRAND_ANALYTICS_SEARCH_QUERY_PERFORMANCE_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"]
}LinkFox
scripts/get_report.py、references/api.md。
另见
references/report-types.md
GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT
分类:2. Analytics Reports
说明:Top search terms for products
可用范围:Both
官方索引(Report type values)
- Schema 专页(请求体、`reportOptions`、结果 JSON):`sellingPartnerSearchTermsReport.md`
- Amazon 文档(权限/站点等;与 Schema 专页技术描述重复处以 Schema 专页为准):Analytics Reports(章节:Amazon Search Terms Report)
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Brand Analytics
- Availability:Sellers and vendors who have the Brand Analytics Selling Partner API role, are registered in Amazon Brand Registry, and are a brand representative.
- Requested/scheduled:This report can only be requested.
- Report output type:JSON
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-analytics#amazon-search-terms-report>
官方 JSON Schema 与请求/结果说明
技术细节(reportSpecification、reportOptions、下载结果的 JSON 结构)见本节上方 Schema 专页链接,此处不重复列出。
CreateReport
请优先以专页中的官方示例构造请求体;下列仅为占位,可能缺少必填 `reportOptions` 或日期规则。
{
"reportType": "GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"]
}LinkFox
scripts/get_report.py、references/api.md。
另见
references/report-types.md
GET_CONVERGED_FLAT_FILE_PENDING_ORDERS_DATA
分类:9. Order Reports
说明:Converged pending orders
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Order Reports(章节:Converged Flat File Pending Orders Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Product Listing
- Order Fulfillment Channel:MFN
- Availability:Marketplace sellers
- Requested/scheduled:Requested or scheduled
- Report output type:Flat file
- 要点:Contains all pending orders.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-order#converged-flat-file-pending-orders-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_CONVERGED_FLAT_FILE_PENDING_ORDERS_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_CONVERGED_FLAT_FILE_PENDING_ORDERS_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_COUPON_PERFORMANCE_REPORT
分类:11. Performance Reports
说明:Coupon performance
可用范围:Both
说明:Seller 与 Vendor 共用同一 reportType 字符串时,请按账号类型阅读 Seller 或 Vendor 专页。官方索引(Report type values)
- Schema 专页(请求体、`reportOptions`、结果 JSON):`sellerCouponReport.md`、`vendorCouponReport.md`
- Amazon 文档(权限/站点等;与 Schema 专页技术描述重复处以 Schema 专页为准):Performance Reports(章节:Coupons Performance Report)
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Brand Analytics
- Availability:Sellers and Vendors
- Requested/scheduled:This report can only be requested.
- Report output type:JSON
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-performance#coupons-performance-report>
官方 JSON Schema 与请求/结果说明
技术细节(reportSpecification、reportOptions、下载结果的 JSON 结构)见本节上方 Schema 专页链接,此处不重复列出。
CreateReport
请优先以专页中的官方示例构造请求体;下列仅为占位,可能缺少必填 `reportOptions` 或日期规则。
{
"reportType": "GET_COUPON_PERFORMANCE_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"]
}LinkFox
scripts/get_report.py、references/api.md。
另见
references/report-types.md
GET_CSV_MFN_PRIME_RETURNS_REPORT
分类:13. Returns Reports
说明:MFN Prime returns (CSV)
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Returns Reports(章节:CSV Prime Returns Report by Return Date)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:未在相邻 Note 中写明,但 Role 含 Restricted;仍可能需 RDT/额外审核,以官方为准
- Role:Inventory and Order Tracking, Pricing, Direct to Consumer Shipping (Restricted)
- Requested/scheduled:This report can be requested or scheduled.
- Report output type:Comma-separated flat file
- 要点:Contains detailed Seller Fulfilled Prime returns information, including return request date, RMA ID, label details, ASIN, and return reason code. You can request up to 60 days of data in a single report.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-returns#csv-prime-returns-report-by-return-date>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_CSV_MFN_PRIME_RETURNS_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_CSV_MFN_PRIME_RETURNS_REPORT",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_DATE_RANGE_FINANCIAL_HOLDS_DATA
分类:10. Payment Reports
说明:Financial holds by date range
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Payment Reports(章节:Deferred Transaction Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Availability:Seller Central sellers
- Report output type:Comma-separated flat file
- Roles:Finance and Accounting
- 要点:A point-in-time report that contains a list of deferred transactions. A single report can provide up to 10 years of data. 🚧ImportantYou must request the Deferred Transaction Report through the Payments Reports Repository on Seller Central before you can use the Reports v2021-06-30 API to retrieve the Deferred Transaction Report.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-payment#deferred-transaction-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_DATE_RANGE_FINANCIAL_HOLDS_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_DATE_RANGE_FINANCIAL_HOLDS_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_EASYSHIP_DOCUMENTS
分类:5. Easy Ship Reports
说明:Easy Ship shipping documents
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Easy Ship Reports(章节:EasyShip Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:是(相邻 Note 标明 restricted:下载结果需 RDT,参见官方 Tokens API)
- Role:Tax Invoicing (Restricted), Direct to Consumer Shipping (Restricted)
- Report output type:PDF
- 要点:Contains the invoice, shipping label, and warranty (if available) documents for an Amazon EasyShip order.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-easy-ship#easyship-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_EASYSHIP_DOCUMENTS",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_EASYSHIP_DOCUMENTS",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_EASYSHIP_PICKEDUP
分类:5. Easy Ship Reports
说明:Easy Ship picked up orders
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Easy Ship Reports(章节:EasyShip Picked Up Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:未在相邻 Note 中写明,但 Role 含 Restricted;仍可能需 RDT/额外审核,以官方为准
- Role:Direct to Consumer Shipping (Restricted)
- Report output type:Tab-delimited file
- 要点:Contains all the seller-fulfilled orders that were picked up on the specified dates.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-easy-ship#easyship-picked-up-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_EASYSHIP_PICKEDUP",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_EASYSHIP_PICKEDUP",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_EASYSHIP_WAITING_FOR_PICKUP
分类:5. Easy Ship Reports
说明:Orders waiting for Easy Ship pickup
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Easy Ship Reports(章节:EasyShip Waiting for Pick Up Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:未在相邻 Note 中写明,但 Role 含 Restricted;仍可能需 RDT/额外审核,以官方为准
- Role:Direct to Consumer Shipping (Restricted)
- Report output type:Tab-delimited file
- 要点:Contains all of a seller's orders that are in the following status in Seller Central: "Waiting for pick up"
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-easy-ship#easyship-waiting-for-pick-up-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_EASYSHIP_WAITING_FOR_PICKUP",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_EASYSHIP_WAITING_FOR_PICKUP",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_EPR_ANNUAL_REPORTS
分类:12. Regulatory Compliance Reports
说明:EPR annual reports
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Regulatory Compliance Reports(章节:EPR Annual Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Product Listing
- Availability:Sellers
- Requested/scheduled:This report can only be requested.
- Report output type:Comma-separated flat file
- 要点:Contains data used to declare EPR compliance to regulatory bodies and pay EPR fees, aggregated by year. Amazon Extended Producer Responsibility Reports (Amazon EPR Reports) allow sellers to programmatically retrieve all the necessary data required for EPR reporting to regulatory bodies and pay EPR fees. Amazon EPR Reports offer a significant time savings to sellers by generating reports without requiring manual data compilation across several data sources and manual product classification.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-regulatory-compliance#epr-annual-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_EPR_ANNUAL_REPORTS",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_EPR_ANNUAL_REPORTS",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_EPR_MONTHLY_REPORTS
分类:12. Regulatory Compliance Reports
说明:Extended Producer Responsibility (monthly)
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Regulatory Compliance Reports(章节:EPR Monthly Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Product Listing
- Availability:Sellers
- Requested/scheduled:This report can only be requested.
- Report output type:Comma-separated flat file
- 要点:Contains data used to declare EPR compliance to regulatory bodies and pay EPR fees, aggregated by month. Amazon Extended Producer Responsibility Reports (Amazon EPR Reports) allow sellers to programmatically retrieve all the necessary data required for EPR reporting to regulatory bodies and pay EPR fees. Amazon EPR Reports offer a significant time savings to sellers by generating reports without requiring manual data compilation across several data sources and manual product classification.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-regulatory-compliance#epr-monthly-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_EPR_MONTHLY_REPORTS",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_EPR_MONTHLY_REPORTS",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_EPR_QUARTERLY_REPORTS
分类:12. Regulatory Compliance Reports
说明:EPR quarterly reports
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Regulatory Compliance Reports(章节:EPR Quarterly Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Role:Product Listing
- Availability:Sellers
- Requested/scheduled:This report can only be requested.
- Report output type:Comma-separated flat file
- 要点:Contains data used to declare EPR compliance to regulatory bodies and pay EPR fees, aggregated by quarter. Amazon Extended Producer Responsibility Reports (Amazon EPR Reports) allow sellers to programmatically retrieve all the necessary data required for EPR reporting to regulatory bodies and pay EPR fees. Amazon EPR Reports offer a significant time savings to sellers by generating reports without requiring manual data compilation across several data sources and manual product classification.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-regulatory-compliance#epr-quarterly-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_EPR_QUARTERLY_REPORTS",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_EPR_QUARTERLY_REPORTS",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA
分类:6.3 FBA Fees & Charges
说明:Estimated FBA fees
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Fulfillment by Amazon (FBA) Reports(章节:FBA Fee Preview Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Availability:FBA sellers
- Requested/scheduled:This report can only be requested.
- Report output type:Tab-delimited flat file
- Roles:Pricing, Amazon Fulfillment
- 要点:Contains the estimated Amazon Selling and Fulfillment Fees for the seller's FBA inventory with active offers. The content is updated at least once every 72 hours. To successfully generate a report, specify the dataStartTime parameter for a minimum 72 hours prior to NOW and dataEndTime to NOW. 🚧CautionThis report can only be requested once per day per seller.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-fba#fba-fee-preview-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA
分类:6.4 FBA Returns & Reimbursements
说明:FBA customer returns
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Fulfillment by Amazon (FBA) Reports(章节:FBA Returns Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Availability:FBA sellers
- Requested/scheduled:This report can only be requested.
- Report output type:Tab-delimited flat file
- Roles:Pricing, Amazon Fulfillment
- 要点:Contains customer returned items received at an Amazon fulfillment center, including Return Reason and Disposition. Content updated daily.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-fba#fba-returns-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md
GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA
分类:6.1 FBA Shipments
说明:FBA shipment promotion data
可用范围:Seller only
官方说明(Report type values)
以下内容整理自官方 Report type values 子页 Fulfillment by Amazon (FBA) Reports(章节:FBA Promotions Report)。与专页其它段落冲突时以官方英文文档为准。
- 受限报告:按当前小节文本为否(仍以官方为准)
- Availability:FBA sellers
- Marketplace availability:North America (NA)
- Requested/scheduled:This report can only be requested.
- Report output type:Tab-delimited flat file
- Roles:Pricing, Amazon Fulfillment
- 要点:Contains promotions applied to FBA customer orders sold through Amazon, such as Super Saver Shipping. Content updated daily.
- 官方直达:<https://developer-docs.amazon.com/sp-api/docs/report-type-values-fba#fba-promotions-report>
官方 schemas/reports JSON Schema
本 reportType 在 Amazon 仓库 https://github.com/amzn/selling-partner-api-models/tree/main/schemas/reports 中无与结果格式一一对应的独立 JSON 文件(多为 Flat File / TSV / XML 等)。请求参数、可选日期、`reportOptions`、列定义以官方为准:
CreateReport 请求体(最小常用)
多数此类报告可按下述最小结构创建(是否支持 dataStartTime/dataEndTime 及格式以官方文档为准):
{
"reportType": "GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"]
}支持日期范围时,可补充例如:
{
"reportType": "GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA",
"marketplaceIds": ["ATVPDKIKX0DER"],
"dataStartTime": "2024-01-01T00:00:00Z",
"dataEndTime": "2024-01-31T23:59:59Z"
}若官方要求 `reportOptions` 或其它字段,必须一并传入(见 Report type values)。
LinkFox
scripts/get_report.py:JSON 参数与 CreateReport 体字段同名;支持reportOptions、lastUpdatedDate。- 网关与代理:
references/api.md。
另见
- 全类型总表:
references/report-types.md - 带 JSON 结果 Schema 的报告:
references/report-requests/README.md