---
title: "Request Report"
method: POST
path: "/v1/seller/report/request"
tags: ["Report"]
---

# Request Report

`POST /v1/seller/report/request`

Request a new report from channel. 
Reports a valid for 48 hours after request indicated by expiresIn.

## Request body

- SellerReportRequest — Seller request to generate a marketplace report (e.g. inventory, orders) for a specific channel.
  - `channel` string, required — This is the unique Channel name.
  - `sellerId` string, required — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process.
  - `reportType` 'SELLER_INVENTORY', required
  - `options` object
    - `ResultsAsChannelEvent` boolean — If true, the report will be generated as a channel event. This means that the report will be sent to the seller via the channel event system. If false, the report will be generated as a file. This means that the report will be available for download via the report endpoint.
  - `startDate` string, date, nullable
  - `endDate` string, date, nullable

## Response `200`

Report request accepted; identifier returned for later download

- ReportRequestResult — Acknowledgement of a report request — returns the reportId, whether it is newly created (vs. deduplicated) and a TTL.
  - `sellerId` string — A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process.
  - `channel` string — This is the unique Channel name.
  - `reportId` string — A system wide unique Id to identify and download a report
  - `created` boolean — Indicates if the report request was created as with new reportId. SCX Seller Api is doing a deduplication and will return value `false` if there is an existing not yet processed report with the same parameters. The reportId returned is same from the open report.
  - `expiresIn` integer — Seconds until the report is deleted from the system. Default TTL is 48h.

## Other responses

- `400` — Bad Request
- `401` — Access forbidden, invalid or unknown Token was used.
- `429` — User has send to many requests
- `500` — Unexpected Server Error

---

[API](https://skmtc.net/jtl-software/apis/scx-authentication-api.md) · [All operations](https://skmtc.net/jtl-software/apis/scx-authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jtl-software/scx-authentication-api/revisions/f979b1ea6951/schema)