Detailed information on orders
The method is available for all models.
If you are using an API Key token, one of the accesses in the list is required to call the method
- inventory-and-order-processing — Order processing and inventory
- inventory-and-order-processing:read-only — View order information
- all-methods — Full account management
- all-methods:read-only — View all data
Returns information about orders on the Market that contain your products.
You can use it to collect statistics on your orders and find out, for example, which of the products are most often returned by customers, which, on the contrary, are in high demand, etc.
Information on created or updated orders may appear with a delay of up to 40 minutes.
To get the data without delay, use the method POST v1/businesses/{businessId}/orders.
You can get information on up to 200 orders in one request.
| ⚙️ Limit: 1,000,000 orders per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/orders
Path parameters
|
Name |
Description |
|
campaignId |
Type: integer The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction. You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
⚠️ Do not confuse it with:
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer The number of values per page. Min value: |
|
page_token |
Type: string ID of the results page. If the parameter is omitted, the first page is returned. We recommend transmitting the value of the output parameter If set Example: |
Body
application/json
{
"dateFrom": "2025-01-01",
"dateTo": "2025-01-01",
"updateFrom": "2025-01-01",
"updateTo": "2025-01-01",
"orders": [
0
],
"statuses": [
"CANCELLED_BEFORE_PROCESSING"
],
"hasCis": true
}
|
Name |
Description |
|
dateFrom |
Type: string<date> The initial date when the order was generated. Date format: Cannot be used together with parameters Example: |
|
dateTo |
Type: string<date> The end date when the order was generated. Date format: Cannot be used together with parameters Example: |
|
hasCis |
Type: boolean A filter for receiving orders that contain at least one product with an identification code in the system. «Честный ЗНАК» or «ASL BELGISI» (for sellers Market Yandex Go):
|
|
orders |
Type: integer[] | null List of order IDs. Min items: Unique items: Example
|
|
statuses |
Type: string[] | null List of order statuses. Min items: Unique items: Example
|
|
updateFrom |
Type: string<date> The start date of the period for which changes were made to the order (for example, status or payment information). Date format: Cannot be used together with parameters Example: |
|
updateTo |
Type: string<date> The end date of the period for which the order was changed (for example, the status or payment information). Date format: Cannot be used together with parameters Example: |
Responses
200 OK
Information about orders.
Body
application/json
{
"status": "OK"
}
Type: object
400 Bad Request
The request contains incorrect data. Learn more about errors in reports and documents
Body
application/json
{
"status": "OK"
}
Type: object
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
404 Not Found
The requested resource was not found. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Internal error of the Market. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
pathParams:
- description: "The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) or find it in the seller's office on the Market. Click on your account icon → **Settings** and in the menu on the left, select **APIs and modules**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
name: campaignId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
searchParams:
- name: page_token
description: >
ID of the results page.
If the parameter is omitted, the first page is returned.
We recommend transmitting the value of the output parameter
`nextPageToken`, received during the last request.
If set `page_token` and the request has parameters
`page` and `pageSize` they are ignored.
in: query
required: false
example: eyBuZXh0SWQ6IDIzNDIgfQ==
schema:
type: string
- name: limit
description: |
The number of values per page.
in: query
required: false
example: 20
schema:
type: integer
format: int32
minimum: 1
headers: []
body: |-
{
"dateFrom": "2025-01-01",
"dateTo": "2025-01-01",
"updateFrom": "2025-01-01",
"updateTo": "2025-01-01",
"orders": [
0
],
"statuses": [
"CANCELLED_BEFORE_PROCESSING"
],
"hasCis": true
}
schema:
description: Request information on orders.
type: object
properties:
dateFrom:
description: >
The initial date when the order was generated.
Date format: `YYYY‑MM‑DD`.
Cannot be used together with parameters `updateFrom` and
`updateTo`.
type: string
format: date
dateTo:
description: >
The end date when the order was generated.
Date format: `YYYY‑MM‑DD`.
Cannot be used together with parameters `updateFrom` and
`updateTo`.
type: string
format: date
updateFrom:
description: >
The start date of the period for which changes were made to the order
(for example, status or payment information).
Date format: `YYYY‑MM‑DD`.
Cannot be used together with parameters `dateFrom` and
`dateTo`.
type: string
format: date
updateTo:
description: >
The end date of the period for which the order was changed (for example,
the status or payment information).
Date format: `YYYY‑MM‑DD`.
Cannot be used together with parameters `dateFrom` and
`dateTo`.
type: string
format: date
orders:
description: List of order IDs.
type: array
nullable: true
minItems: 1
uniqueItems: true
items:
description: >
The list of products in the order after possible changes.
During order processing, the Market can delete items from it.
— in case of problems in the warehouse or at the
initiative of the user.
* If all items are deleted from the order, it will not be in the list.
`items` — only in the list
`initialItems`.
* If there is at least one item left in the order, it will be in the
list. `items` (with a reduced number of units
`count`), and in the list `initialItems`
(with the initial number of units `initialCount`).
type: integer
format: int64
statuses:
description: List of order statuses.
type: array
nullable: true
minItems: 1
uniqueItems: true
items:
description: >
Current order status:
* `CANCELLED_BEFORE_PROCESSING` — the
order was cancelled before it was processed.
* `CANCELLED_IN_DELIVERY` — the order is
cancelled during its delivery.
* `CANCELLED_IN_PROCESSING` — the order
was cancelled during its processing.
* `DELIVERY` — the order has been
transferred to the delivery service.
* `DELIVERED` — the order has been
delivered.
* `PARTIALLY_DELIVERED` — the order has
been partially delivered.
{% note warning "The order status can change to `PARTIALLY_DELIVERED` Not immediately" %}
If there was a non-purchase in the delivered order, the status will change only after the order is received at the Market warehouse.
{% endnote %}
* `PARTIALLY_RETURNED` — the order was
partially refunded by the buyer.
* `PENDING` — the order is awaiting
confirmation.
* `PICKUP` — The order has been
delivered to the pick-up point.
* `PROCESSING` — the order is in
processing.
* `RESERVED` — the product is reserved
in the warehouse.
* `RETURNED` — The order has been fully
refunded by the buyer.
* `UNKNOWN` — unknown order status.
* `UNPAID` — An order from a legal
entity is awaiting payment.
* `LOST` — the order is lost.
type: string
enum:
- CANCELLED_BEFORE_PROCESSING
- CANCELLED_IN_DELIVERY
- CANCELLED_IN_PROCESSING
- DELIVERY
- DELIVERED
- PARTIALLY_DELIVERED
- PARTIALLY_RETURNED
- PENDING
- PICKUP
- PROCESSING
- RESERVED
- RETURNED
- UNKNOWN
- UNPAID
- LOST
hasCis:
description: >
A filter for receiving orders that contain at least one product with an
identification code in the system. [«Честный
ЗНАК»](https://честныйзнак.рф/) or [«ASL
BELGISI»](https://aslbelgisi.uz) (for sellers
Market Yandex Go):
* `true` — Yes.
* `false` — No.
Such codes are assigned to products that are subject to labeling and
belong to certain categories.
type: boolean
bodyType: application/json
method: post
security:
- type: apiKey
name: 'Api-Key'
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/campaigns/{campaignId}/stats/orders
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.