Skip to main content

Export Settlements

POST 

/v1/export/settlements

Request an emailed statement-history export for the required calendar window. Background output is capped at 100000 rows; narrow a larger scope.

Requires profitability.read.

Request and response fields at a glance
  • Query parameters: sortBy (string), sortOrder (string), page (integer), limit (integer), brandIds (array), saleChannelIds (array), startDate (string, required), endDate (string, required).
  • 201 response (application/json): success (boolean, required).

Request​