订单的详细信息

方法适用于所有模式.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

返回市场上包含您的产品的订单信息。

你可以用它来收集你的订单的统计数字,例如,哪些产品最常被顾客退回,而哪些产品则是需求量很大的,等等。

有关已创建或更新订单的信息可能会出现最多40分钟的延迟。

要无延迟地获取数据,请使用以下方法 POST v1/businesses/{businessId}/orders.

您可以在一个请求中获得最多200个订单的信息。

⚙️ 限制: 每小时1,000,000份订单

Request

POST

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/orders

Path parameters

Name

Description

campaignId

Type: integer

广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:

  • 运动ID;
  • 标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要把它与:

  • 商店的标识符,显示在商家的个人帐户中。
  • 广告活动。

Min value: 1

Query parameters

Name

Description

limit

Type: integer

每页的值数。

Min value: 1

page_token

Type: string

结果页面的ID。

如果省略该参数,则返回第一页。

我们建议传输输出参数的值 nextPageToken,在最后一次请求期间接收。

如果设置 page_token 并且请求有参数 pagepageSize 它们被忽略了。

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

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>

生成订单的初始日期。

日期格式: YYYY-MM-DD.

不能与参数一起使用 updateFromupdateTo.

Example: 2025-01-01

dateTo

Type: string<date>

生成订单的结束日期。

日期格式: YYYY-MM-DD.

不能与参数一起使用 updateFromupdateTo.

Example: 2025-01-01

hasCis

Type: boolean

用于接收系统中包含至少一个带有识别码的产品的订单的过滤器。 «Честный ЗНАК»«ASL BELGISI» (对于卖家 Market Yandex Go):

  • true — 是的.
  • false — 非也。. 这些代码被分配给需要贴标签并属于某些类别的产品。

orders

Type: integer[] | null

订单Id列表。

Min items: 1

Unique items: true

Example
[
  0
]

statuses

Type: string[] | null

订单状态列表。

Min items: 1

Unique items: true

Example
[
  "CANCELLED_BEFORE_PROCESSING"
]

updateFrom

Type: string<date>

对订单进行更改的期间的开始日期(例如,状态或付款信息)。

日期格式: YYYY-MM-DD.

不能与参数一起使用 dateFromdateTo.

Example: 2025-01-01

updateTo

Type: string<date>

更改订单的期间的结束日期(例如,状态或付款信息)。

日期格式: YYYY-MM-DD.

不能与参数一起使用 dateFromdateTo.

Example: 2025-01-01

Responses

200 OK

有关订单的信息。

Body

application/json
{
  "status": "OK"
}

Type: object

400 Bad Request

请求包含不正确的数据。 详细了解报告和文档中的错误

Body

application/json
{
  "status": "OK"
}

Type: object

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

Body

application/json
{
  "status": "OK"
}

Type: object

404 Not Found

找不到请求的资源。 有关错误的更多信息

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

Yandex中的内部错误。 市场。 有关错误的更多信息

Body

application/json
{
  "status": "OK"
}

Type: object

pathParams:
  - description: "广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。\n\n您可以使用查询找到它 [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ **设置** 在左边的菜单中,选择 **Api和模块**:\n\n* 座 **运动ID**;\n* 标签 **查询日志** →块中的下拉列表 **显示日志**.\n\n⚠️ 不要把它与:\n- 商店的标识符,显示在商家的个人帐户中。\n- 广告活动。\n"
    name: campaignId
    in: path
    required: true
    schema:
      type: integer
      format: int64
      minimum: 1
searchParams:
  - name: page_token
    description: >
      结果页面的ID。


      如果省略该参数,则返回第一页。


      我们建议传输输出参数的值 `nextPageToken`,在最后一次请求期间接收。


      如果设置 `page_token` 并且请求有参数 `page` 和
      `pageSize` 它们被忽略了。
    in: query
    required: false
    example: eyBuZXh0SWQ6IDIzNDIgfQ==
    schema:
      type: string
  - name: limit
    description: |
      每页的值数。
    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: 请求有关订单的信息。
  type: object
  properties:
    dateFrom:
      description: |
        生成订单的初始日期。

        日期格式: `YYYY-MM-DD`.

        不能与参数一起使用 `updateFrom` 和 `updateTo`.
      type: string
      format: date
    dateTo:
      description: |
        生成订单的结束日期。

        日期格式: `YYYY-MM-DD`.

        不能与参数一起使用 `updateFrom` 和 `updateTo`.
      type: string
      format: date
    updateFrom:
      description: |
        对订单进行更改的期间的开始日期(例如,状态或付款信息)。

        日期格式: `YYYY-MM-DD`.

        不能与参数一起使用 `dateFrom` 和 `dateTo`.
      type: string
      format: date
    updateTo:
      description: |
        更改订单的期间的结束日期(例如,状态或付款信息)。

        日期格式: `YYYY-MM-DD`.

        不能与参数一起使用 `dateFrom` 和 `dateTo`.
      type: string
      format: date
    orders:
      description: 订单Id列表。
      type: array
      nullable: true
      minItems: 1
      uniqueItems: true
      items:
        description: >
          可能更改后的订单中的产品列表。


          在订单处理过程中,市场可以从中删除商品。 — 在仓库或在用户的主动问题的情况下。


          * 如果所有项目都从订单中删除,它将不在列表中。 `items` — 仅在列表中
          `initialItems`.


          * 如果订单中至少剩下一个项目,它将在列表中。 `items` (单位数量减少
          `count`),并在列表中 `initialItems` (与单位的初始数量
          `initialCount`).
        type: integer
        format: int64
    statuses:
      description: 订单状态列表。
      type: array
      nullable: true
      minItems: 1
      uniqueItems: true
      items:
        description: >
          当前订单状态:


          * `CANCELLED_BEFORE_PROCESSING` —
          订单在处理之前已被取消。


          * `CANCELLED_IN_DELIVERY` — 订单在交货期间被取消.


          * `CANCELLED_IN_PROCESSING` —
          订单在处理过程中被取消。


          * `DELIVERY` — 订单已转移到送货服务.


          * `DELIVERED` — 订单已经交付。


          * `PARTIALLY_DELIVERED` — 订单已部分交付。

              {% note warning "订单状态可以更改为 `PARTIALLY_DELIVERED` 不是马上" %}

              如果已交付的订单中存在非购买,则只有在市场仓库收到订单后,状态才会更改。

              {% endnote %}

          * `PARTIALLY_RETURNED` — 买方部分退还了订单。


          * `PENDING` — 订单正在等待确认。


          * `PICKUP` — 订单已送到提货点。


          * `PROCESSING` — 订单正在处理中。


          * `RESERVED` — 产品保留在仓库中。


          * `RETURNED` — 订单已由买方全额退款。


          * `UNKNOWN` — 未知订单状态。


          * `UNPAID` — 来自法律实体的订单正在等待付款。


          * `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: >
        用于接收系统中包含至少一个带有识别码的产品的订单的过滤器。 [«Честный
        ЗНАК»](https://честныйзнак.рф/) 或 [«ASL
        BELGISI»](https://aslbelgisi.uz) (对于卖家
        Market Yandex Go):


        * `true` — 是的.

        * `false` — 非也。.

        这些代码被分配给需要贴标签并属于某些类别的产品。
      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.