POST
https://api.nexscope.ai/sr/ozon/shopSearchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/sr/ozon/shopSearch |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | integer | required | Store (seller) ID, which is the `sellerId` returned by other SR Ozon tools; negative values are self-operated sellers on the Ozon platform, and positive values are third-party sellers. |
page | object | required | Paging and sorting: `{page, pageSize, orders[]}`. |
page.page | integer | optional | Page number, starting from 1. Example: 1 |
page.pageSize | integer | optional | The maximum number of items per page is 20. If exceeded, `errcode 1002` will be returned. Example: 20 |
page.orders | array | optional | Sorting rule, the element is `{field, direction}`; `direction` takes `DESC` or `ASC`. Commonly used fields: `sales`, `price`, `reviewRating`, `upTime`. |
uId | string | optional | User ID, up to 1000. |
memberId | string | optional | Member ID; a member's unique identifier, the data belongs to this member, the maximum number is 1000. |
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 (33 fields)
| Name | Type | Required | Description |
|---|---|---|---|
code | string | optional | Return code, `"200"` indicates success; returned when successful. |
errcode | integer | optional | Error code, `200` indicates success; only this field may be returned when there is a business error. |
msg | string | optional | Message; Success was `ok`. |
errmsg | string | optional | Error message; success is `ok`, business error is a reason description. |
total | integer | optional | The number of records returned on this page is equal to the number of data items on the current page, not the total number of items in the store. |
totalSales | integer | optional | The total sales volume of the store in the past 30 days. |
totalRevenue | integer | optional | Total store sales in rubles. |
dailySales | integer | optional | The average daily sales volume of the store. |
rating | number | optional | Store rating, 0–5. |
productCount | integer | optional | The total number of products in the store, the entire store, not the number of items on the current page. |
fulfillment | object | optional | The distribution of store delivery methods, the key is `FBO` / `FBS`, and the value is the number of corresponding products; it is different from the product-level delivery array. |
data | array | optional | Store product list, element fields are shown in the table below. |
products | array | optional | The store product list is completely consistent with the content of `data`. |
hasNextPage | boolean | optional | Is there a next page? |
columns | array | optional | Column definition, elements containing `field`, `title`, `cellType`, `sortable`, `filterable`. |
type | string | optional | Response display type, such as `productWorkbenches`. |
costTime | integer | optional | The interface consumes time in milliseconds. |
costToken | integer | optional | The number of tokens consumed. |
productId | integer | optional | Unified product ID, mapped from `sku`. |
sku | integer | optional | Product SKU. |
rating | number | optional | Unified scoring, mapped from `reviewRating`. |
reviewRating | number | optional | Rating |
weight | number | optional | Product weight, unit g. |
sales | integer | optional | Product sales in the past 30 days. |
monthlySalesUnits | integer | optional | Unified monthly sales, mapped from `sales`. |
upTime | integer | optional | Product shelf time, millisecond timestamp. |
price | number | optional | Commodity price in rubles. |
currency | string | optional | Currency, fixed to `₽`. |
imageUrl | string | optional | Unify the main image URL. |
fulfillment | array | optional | Product shipping method, such as `["FBO"]`, may contain multiple values. |
sellerType | integer | optional | Seller type: `0` local, `1` cross-border. |
returnCancellationRate | number | optional | Product return cancellation rate, percentage; may be missing for self-operated sellers on the Ozon platform. |
sourceType | string | optional | Data source, fixed to `ozon`. |
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.