订单的详细信息

方法适用于所有模式.

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

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

有了它,您可以收集订单的统计数据,例如,哪些产品最常被客户退回,相反,哪些产品需求量很大,等等。

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

要无延迟地获取数据,请使用以下方法 GET v2/campaigns/{campaignId}/ordersPOST 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<int64>

活动ID。

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

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

⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

每页的值数。

Min value: 1
Example: 20

page_token

Type: string

结果页面的ID。

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

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

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

Body

application/json
{
    "dateFrom": "string",
    "dateTo": "string",
    "updateFrom": "string",
    "updateTo": "string",
    "orders": [
        0
    ],
    "statuses": [
        "CANCELLED_BEFORE_PROCESSING"
    ],
    "hasCis": false
}

Name

Description

dateFrom

Type: string<date>

生成订单的初始日期。

日期格式: YYYY-MM-DD.

不能与参数一起使用 updateFromupdateTo.

dateTo

Type: string<date>

生成订单的结束日期。

日期格式: YYYY-MM-DD.

不能与参数一起使用 updateFromupdateTo.

hasCis

Type: boolean

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

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

orders

Type: integer[]

订单Id列表。
可能更改后的订单中的产品列表。

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

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

  • 如果订单中至少剩下一个项目,它将在列表中。 items (单位数量减少 count),并在列表中 initialItems (与单位的初始数量 initialCount).

Min items: 1

Unique items  

statuses

Type: string[]

订单状态列表。
当前订单状态:

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

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

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

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

  • DELIVERED — 订单已经交付。

  • PARTIALLY_DELIVERED — 订单部分交付。

    订单状态可以更改为 PARTIALLY_DELIVERED 不是马上

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

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

  • PENDING — 订单正在等待确认。

  • PICKUP — 订单已送到提货点。

  • PROCESSING — 订单正在处理中。

  • RESERVED — 产品保留在仓库中。

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

  • UNKNOWN — 未知订单状态。

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

  • LOST — 订单丢失。

Enum: CANCELLED_BEFORE_PROCESSING, CANCELLED_IN_DELIVERY, CANCELLED_IN_PROCESSING, DELIVERY, DELIVERED, PARTIALLY_DELIVERED, PARTIALLY_RETURNED, PENDING, PICKUP, PROCESSING, RESERVED, RETURNED, UNKNOWN, UNPAID, LOST

Min items: 1

Unique items  

updateFrom

Type: string<date>

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

日期格式: YYYY-MM-DD.

不能与参数一起使用 dateFromdateTo.

updateTo

Type: string<date>

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

日期格式: YYYY-MM-DD.

不能与参数一起使用 dateFromdateTo.

Responses

200 OK

有关订单的信息。

Body

application/json
{
    "status": "OK",
    "result": {
        "orders": [
            {
                "id": 0,
                "creationDate": "string",
                "statusUpdateDate": "2022-12-29T18:02:01Z",
                "status": "CANCELLED_BEFORE_PROCESSING",
                "partnerOrderId": "string",
                "paymentType": "POSTPAID",
                "fake": false,
                "deliveryRegion": {
                    "id": 0,
                    "name": "string"
                },
                "items": [
                    {
                        "offerName": "string",
                        "marketSku": 0,
                        "shopSku": "string",
                        "count": 0,
                        "prices": [
                            {
                                "type": "BUYER",
                                "costPerItem": 0,
                                "total": 0
                            }
                        ],
                        "warehouse": {
                            "id": 0,
                            "name": "string"
                        },
                        "details": [
                            {
                                "itemStatus": "REJECTED",
                                "itemCount": 0,
                                "updateDate": "string",
                                "stockType": "FIT"
                            }
                        ],
                        "cisList": [
                            "string"
                        ],
                        "initialCount": 0,
                        "bidFee": 570,
                        "cofinanceThreshold": 0,
                        "cofinanceValue": 0
                    }
                ],
                "initialItems": [
                    {
                        "offerName": "string",
                        "marketSku": 0,
                        "shopSku": "string",
                        "count": 0,
                        "prices": [
                            {
                                "type": "BUYER",
                                "costPerItem": 0,
                                "total": 0
                            }
                        ],
                        "warehouse": {
                            "id": 0,
                            "name": "string"
                        },
                        "details": [
                            {
                                "itemStatus": "REJECTED",
                                "itemCount": 0,
                                "updateDate": "string",
                                "stockType": "FIT"
                            }
                        ],
                        "cisList": [
                            "string"
                        ],
                        "initialCount": 0,
                        "bidFee": 570,
                        "cofinanceThreshold": 0,
                        "cofinanceValue": 0
                    }
                ],
                "payments": [
                    {
                        "id": "string",
                        "date": "string",
                        "type": "PAYMENT",
                        "source": "BUYER",
                        "total": 0,
                        "paymentOrder": {
                            "id": "string",
                            "date": "string"
                        }
                    }
                ],
                "commissions": [
                    {
                        "type": "FEE",
                        "actual": 0
                    }
                ],
                "subsidies": [
                    {
                        "operationType": "ACCRUAL",
                        "type": "YANDEX_CASHBACK",
                        "amount": 0
                    }
                ],
                "buyerType": "PERSON",
                "currency": "RUR"
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

result

Type: object

orders*

Type: object[]

订单列表。
订单信息。

paging

Type: object

nextPageToken

Type: string

下一个结果页面的ID。

下一页的ID。

有关订单的信息。

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

401 Unauthorized

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

403 Forbidden

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

404 Not Found

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

420 Method Failure

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.