https://api.nexscope.ai/mp/ozon/brandProductsRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/mp/ozon/brandProducts |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
brandName | string | required | Ozon brand display name (Russian or Latin) |
startDate | string | optional | Statistics starting date, `YYYY-MM-DD`; latest yesterday |
endDate | string | optional | Statistics end date, `YYYY-MM-DD`; latest yesterday |
page | integer | optional | Page number, starting from 1 |
pageSize | integer | optional | Number of lines per page, 1-100 Example: 100 |
sortField | string | optional | Sorting column name (snake_case), such as `sales`, `revenue`, `final_price`, `balance`, `rating` |
sortDirection | string | optional | `asc` ascending order / `desc` descending order |
currency | string | optional | Result amount currency code, such as `USD` / `EUR` / `CNY` Example: RUB |
currencyRate | integer | optional | Custom exchange rate (with non-default currency) |
includeFbs | boolean | optional | Whether to include FBS data |
filters | array | optional | Numeric filter list, each item is `{field, op, value, value2?}`, multi-condition AND |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (42 fields)
| Name | Type | Required | Description |
|---|---|---|---|
code | string | optional | Return code, `"200"` successful |
msg | string | optional | Message; success is `ok` |
total | integer | optional | The total number of hits under the brand |
products | array | optional | Product list |
columns | array | optional | Render column definition |
costTime | integer | optional | Interface time (milliseconds) |
costToken | integer | optional | Amount of Token consumed |
type | string | optional | response type |
productId | integer | optional | SKU ID |
title | string | optional | Product name (Russian) |
brand | string | optional | brand |
brandId | integer | optional | Brand ID |
sellerName | string | optional | Seller name |
sellerId | integer | optional | Seller ID |
category | string | optional | Category path (Russian, `/` separated) |
nicheName | string | optional | Track path (Russian) |
nicheId | integer | optional | Track ID |
country | string | optional | Country of sale, Ozon Hengwei `RU` |
firstDate | string | optional | Release date (`yyyy-MM-dd`) |
imageUrl | string | optional | Main image URL |
productPageUrl | string | optional | Product page URL |
price | number | optional | Current selling price |
oldPrice | number | optional | Original price before discount |
ozonCardPrice | number | optional | Ozon Card Price |
currency | string | optional | Currency symbol (`₽` / `$` / `€`) |
rating | number | optional | Rating, 0-5 |
reviewCount | integer | optional | Number of comments |
balance | integer | optional | Current inventory (pieces) |
balanceFbs | integer | optional | FBS inventory (number of items shipped by the seller) |
frozenStocks | integer | optional | slow-moving inventory |
warehousesCount | integer | optional | Number of FBO positions |
isFbs | boolean | optional | Whether to ship by FBS |
salesPerDay | number | optional | Average daily sales volume (pieces/day) |
monthlySalesUnits | integer | optional | Sales volume during the statistical period (pieces) |
monthlySalesRevenue | number | optional | Sales during the statistical period |
lostProfit | number | optional | Lost sales (caused by stockouts, etc.) |
daysInSite | integer | optional | Number of days on sale (statistical period, including out-of-stock days) |
daysInStock | integer | optional | days in stock |
turnoverDays | number | optional | Turnaround days (the smaller, the faster) |
position | integer | optional | Ranking within the current query dimension (this endpoint is brand) |
categoryPosition | integer | optional | Ranking within category |
revenueSharePercent | number | optional | The sales ratio of this SKU in the current query dimension, 0-100 |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.