reports_createReport

Submit one SP-API report request; returns reportId at once.

readAmazon Seller (SP-API)sp.reports_2021-06-30

Check reports_getReports first for a recent DONE report to reuse, then poll reports_getReport until processingStatus is DONE. Many report types are already synced into SellerSheet's warehouse — query_report_data answers from it without an Amazon request (list_report_syncs shows which types the store syncs); request a report only for a type or window the warehouse lacks. Amazon SP-API · createReport · POST /reports/2021-06-30/reports

Call it

In an AI client (MCP)

tools/call
{
  "name": "reports_createReport",
  "arguments": {
    "store": "myStore-US",
    "reportType": "<reportType>"
  }
}

From code (Tool API)

curl -X POST https://api.sellersheetai.com/api/v1/tools/reports_createReport \
  -H "Authorization: Bearer $SELLERSHEET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"store":"myStore-US","reportType":"<reportType>"}'
Early access — the Tool API is open on request, contact us.

Arguments

NameTypeDescription
storerequiredstringthe store ref `<store>-<CC>` (name-country, e.g. 'myStore-US') — one of get_user_context's store_refs, verbatim.
reportTyperequiredstringthe SP-API reportType constant (e.g. 'GET_MERCHANT_LISTINGS_ALL_DATA') or its human-readable name ('All Listings Report'). An open set of 100+ values — pick by intent; reports_getReports shows what already exists for the store.
dataStartTimestring · date-timeISO 8601 window ('2024-01-01T00:00:00Z'), required for date-range report types; omit for snapshot reports.
dataEndTimestring · date-timeISO 8601 window ('2024-01-01T00:00:00Z'), required for date-range report types; omit for snapshot reports.
marketplaceIdsstring[]optional 1–25 marketplaceId strings; omit and the server uses the store's own marketplace — pass a list only to span extra marketplaces.
reportOptionsobjectoptional {key: value}, free-form per reportType; the known analytics and vendor types are validated before the call. Brand Analytics SEARCH_TERMS, MARKET_BASKET and REPEAT_PURCHASE require {"reportPeriod": DAY | WEEK | MONTH | QUARTER} (REPEAT_PURCHASE: WEEK | MONTH | QUARTER) with aligned dates (WEEK = Sunday to Saturday, MONTH = 1st to last day); SEARCH_QUERY_PERFORMANCE also requires "asin"; GET_SALES_AND_TRAFFIC_REPORT takes {"dateGranularity": DAY | WEEK | MONTH, "asinGranularity": PARENT | CHILD | SKU}; vendor sales and inventory require {"reportPeriod", "distributorView": MANUFACTURING | SOURCING, "sellingProgram": RETAIL | BUSINESS | FRESH}. Omit for reports without options (orders, inventory, listings …).

Result

Every tool answers {notification, data, human_action}; data carries:

  • data.reportId — poll it with reports_getReport.
  • data.processingStatus — always the literal 'IN_QUEUE' — Amazon's createReport carries only reportId; never treat it as a poll result.
  • data.reportType — the normalised constant. data.marketplaceIds: the list used.

On this page

Actions

View as Markdown

Ask an assistant

Ask ChatGPTAsk Claude