v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

Report

Request Report

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

post/v1/seller/report/request

Request body

channelstring required

This is the unique Channel name.

sellerIdstring 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

startDatestring date nullable

endDatestring date nullable

Example request

{
  "channel": "MYBESTDEALCOMDE",
  "sellerId": "4711"
}

Response

Report request accepted; identifier returned for later download

sellerIdstring

A unique Id identify a Seller on a specific SalesChannel. The SellerId is generated from the Channel itself during the Seller SignUp Process.

channelstring

This is the unique Channel name.

reportIdstring

A system wide unique Id to identify and download a report

createdboolean

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.

expiresIninteger

Seconds until the report is deleted from the system. Default TTL is 48h.

Example response

{
  "sellerId": "4711",
  "channel": "MYBESTDEALCOMDE",
  "reportId": "910390cc-c3b3-45ba-8be2-ab1824b6c499",
  "created": true,
  "expiresIn": 172500
}