POST
https://api.nexscope.ai/api/skill-api/v1/skills/ozon-brand-products/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/ozon-brand-products/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
brandName | string | required | Ozon brand display name (Russian or Latin) Example: COMMO |
startDate | string | optional | Statistics start date, YYYY-MM-DD; latest is yesterday Example: 2026-01-01 |
endDate | string | optional | Statistics end date, YYYY-MM-DD; latest is yesterday Example: 2026-01-01 |
page | integer | optional | Page number, starting from 1 Example: 1 |
pageSize | integer | optional | Rows per page, 1-100, default 100 Example: 10 |
sortField | string | optional | Sort column name (snake_case), e.g., sales, revenue, final_price, balance, rating |
sortDirection | string | optional | asc ascending / desc descending |
currency | string | optional | Currency code for result amounts, default RUB, e.g., USD / EUR / CNY |
currencyRate | integer | optional | Custom exchange rate (for non-default currency) Example: 1 |
includeFbs | boolean | optional | Whether to include FBS data Example: false |
filters | array | optional | List of numeric filter conditions, each {field, op, value, value2?}, multiple conditions AND Example: [] |
Request example
{
"startDate": "2026-01-01",
"includeFbs": false,
"pageSize": 10,
"endDate": "2026-01-31",
"page": 1,
"brandName": "COMMO",
"currencyRate": 1
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | any | required | Data value used by this API operation. |
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
msg | string | null | required | Msg value used by this API operation. |
ts | string | required | Epoch milliseconds. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
traceId | string | null | required | Trace id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.total | integer | optional | Total number of matched products under the brand Example: 1 |
data.products | array | optional | Product list (see details below) Example: [] |
data.columns | array | optional | Rendered column definitions Example: [] |
data.costTime | integer | optional | API latency (milliseconds) Example: 1 |
data.costToken | integer | optional | Tokens consumed Example: 1 |
data.type | string | optional | Response type Example: null |
data.products[].productId | integer | optional | SKU ID Example: 1 |
data.products[].title | string | optional | Product name (Russian) Example: null |
data.products[].brand | string | optional | Brand Example: null |
data.products[].brandId | integer | optional | Brand ID Example: 1 |
data.products[].sellerName | string | optional | Seller name Example: null |
data.products[].sellerId | integer | optional | Seller ID Example: 1 |
data.products[].category | string | optional | Category path (Russian, / separated) Example: null |
data.products[].nicheName | string | optional | Niche path (Russian) Example: null |
data.products[].nicheId | integer | optional | Niche ID Example: 1 |
data.products[].country | string | optional | Country of sale, always RU for Ozon Example: null |
data.products[].firstDate | string | optional | Listing date (yyyy-MM-dd) Example: 2026-01-01 |
data.products[].imageUrl | string | optional | Main image URL Example: https://example.com/image.jpg |
data.products[].productPageUrl | string | optional | Product page URL Example: https://example.com/image.jpg |
data.products[].sourceTool/sourceType | string | optional | Source tool / data source identifier Example: null |
data.products[].price | number | optional | Current selling price Example: 1 |
data.products[].oldPrice | number | optional | Original price before discount Example: 1 |
data.products[].ozonCardPrice | number | optional | Ozon Card price Example: 1 |
data.products[].minPrice/maxPrice/averagePrice | number | optional | Minimum / maximum / average price during the statistics period Example: 1 |
data.products[].currency | string | optional | Currency symbol (₽ / $ / €) Example: null |
data.products[].rating | number | optional | Rating, 0-5 Example: 1 |
data.products[].reviewCount | integer | optional | Number of reviews Example: 1 |
data.products[].balance | integer | optional | Current stock (units) Example: 1 |
data.products[].balanceFbs | integer | optional | FBS stock (seller self-ship units) Example: 1 |
data.products[].frozenStocks | integer | optional | Slow-moving stock Example: 1 |
data.products[].warehousesCount | integer | optional | Number of FBO warehouses Example: 1 |
data.products[].isFbs | boolean | optional | Whether shipped via FBS Example: false |
data.products[].salesPerDay | number | optional | Average daily sales (units/day) Example: 1 |
data.products[].monthlySalesUnits | integer | optional | Sales volume during the statistics period (units) Example: 1 |
data.products[].monthlySalesRevenue | number | optional | Sales revenue during the statistics period Example: 1 |
data.products[].lostProfit | number | optional | Lost revenue (due to stockouts, etc.) Example: 1 |
data.products[].daysInSite | integer | optional | Days on sale (statistics period, including out-of-stock days) Example: 1 |
data.products[].daysInStock | integer | optional | Days in stock Example: 1 |
data.products[].turnoverDays | number | optional | Turnover days (lower is faster) Example: 1 |
data.products[].position | integer | optional | Ranking within the current query dimension (brand for this endpoint) Example: 1 |
data.products[].categoryPosition | integer | optional | Ranking within the category Example: 1 |
data.products[].revenueSharePercent | number | optional | Revenue share of this SKU within the current query dimension, 0-100 Example: 1 |
data.title | string | optional | Provider-specific response title. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"data": {
"total": 1,
"products": [
{
"productId": 1,
"brandId": 1,
"sellerId": 1,
"nicheId": 1,
"firstDate": "2026-01-01",
"imageUrl": "https://example.com/image.jpg",
"productPageUrl": "https://example.com/image.jpg",
"price": 1,
"oldPrice": 1,
"ozonCardPrice": 1,
"minPrice/maxPrice/averagePrice": 1,
"rating": 1,
"reviewCount": 1,
"balance": 1,
"balanceFbs": 1,
"frozenStocks": 1,
"warehousesCount": 1,
"isFbs": false,
"salesPerDay": 1,
"monthlySalesUnits": 1,
"monthlySalesRevenue": 1,
"lostProfit": 1,
"daysInSite": 1,
"daysInStock": 1,
"turnoverDays": 1,
"position": 1,
"categoryPosition": 1,
"revenueSharePercent": 1
}
],
"columns": [],
"costTime": 1,
"costToken": 1
},
"code": 0,
"msg": null,
"ts": "0",
"time": "2026-01-01 00:00:00",
"cost": "-1",
"traceId": null
}Responses
| Code | Description |
|---|---|
| 200 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
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.