- Request
- Responses
- 200 OK
- Body
- ApiResponseStatusType
- OrdersStatsDTO
- OrdersStatsOrderDTO
- ForwardScrollingPagerDTO
- OrdersStatsCommissionDTO
- CurrencyType
- OrdersStatsItemDTO
- OrdersStatsPaymentDTO
- OrdersStatsDeliveryRegionDTO
- OrdersStatsOrderPaymentType
- OrdersStatsSubsidyDTO
- OrdersStatsCommissionType
- OrdersStatsDetailsDTO
- OrdersStatsPriceDTO
- OrdersStatsWarehouseDTO
- OrdersStatsPaymentOrderDTO
- OrdersStatsPaymentSourceType
- OrdersStatsPaymentType
- OrdersStatsSubsidyOperationType
- OrdersStatsSubsidyType
- OrdersStatsItemStatusType
- OrdersStatsStockType
- OrdersStatsPriceType
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 420 Method Failure
- 500 Internal Server Error
订单的详细信息
方法适用于所有模式.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回市场上包含您的产品的订单信息。
有了它,您可以收集订单的统计数据,例如,哪些产品最常被客户退回,相反,哪些产品需求量很大,等等。
有关已创建或更新订单的信息可能会出现最多40分钟的延迟。
要毫不延迟地获取数据,请使用 获取订单信息的方法.
您可以在一个请求中获得多达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。 您可以使用查询找到它 :no-translate[GET v2/campaigns] 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。
Min value: |
Query parameters
Name |
Description |
limit |
Type: integer<int32> 每页的值数。
Min value: |
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 |
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> 生成订单的初始日期。 日期格式: 不能与参数一起使用 |
dateTo |
Type: string<date> 生成订单的结束日期。 日期格式: 不能与参数一起使用 |
hasCis |
Type: boolean 我是否需要只退回系统中至少包含一个带有识别码的商品的订单? «Честный ЗНАК» 或 «ASL BELGISI» (对于卖家 Market Yandex Go):
|
orders |
Type: integer<int64>[] 订单Id列表。 在订单处理过程中,yandex的。市场可以删除项目从它的情况下,在仓库或在用户的主动问题。
Min items: Unique items |
statuses |
Type: OrderStatsStatusType[] 订单状态列表。
Enum: Min items: Unique items |
updateFrom |
Type: string<date> 对订单进行更改的期间的开始日期(例如,状态或付款信息)。 日期格式: 不能与参数一起使用 |
updateTo |
Type: string<date> 更改订单的期间的结束日期(例如,状态或付款信息)。 日期格式: 不能与参数一起使用 |
OrderStatsStatusType
当前订单状态:
-
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
-订单丢失了。
Type |
Description |
Enum: |
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
}
],
"currency": "RUR"
}
],
"paging": {
"nextPageToken": "string"
}
}
}
Name |
Description |
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
result |
Type: OrdersStatsDTO 有关订单的信息。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK
-没有错误。ERROR
-处理请求时发生错误。
Type |
Description |
Enum: |
OrdersStatsDTO
有关订单的信息。
Name |
Description |
orders* |
Type: OrdersStatsOrderDTO[] 订单列表。 |
paging |
Type: ForwardScrollingPagerDTO 下一页的ID。 |
OrdersStatsOrderDTO
订单信息。
Name |
Description |
commissions* |
Type: OrdersStatsCommissionDTO[] 务的成本的信息。 |
currency* |
Type: CurrencyType Валюта, в которой указаны цены в заказе. Enum: |
items* |
Type: OrdersStatsItemDTO[] 可能更改后的订单中的产品列表。 订单交付信息作为单独的元素添加到数组中 在订单处理过程中,yandex的。市场可以删除项目从它的情况下,在仓库或在用户的主动问题。
|
payments* |
Type: OrdersStatsPaymentDTO[] 有关订单计算的信息。 如果订单返回空:
有关订单计算的最终信息将在其最终处理后(例如,切换到状态后)返回 |
creationDate |
Type: string<date> 创建订单的日期。 日期格式: |
deliveryRegion |
Type: OrdersStatsDeliveryRegionDTO 送区域的信息。 |
fake |
Type: boolean 订单类型:
|
id |
Type: integer<int64> 的订单ID。 |
initialItems |
Type: OrdersStatsItemDTO[] 订单中的产品列表。 只有在货物数量发生变化时才退回。
在订单处理过程中,yandex的。市场可以删除项目从它的情况下,在仓库或在用户的主动问题。
Min items: |
partnerOrderId |
Type: string 商店信息系统中的订单ID。 |
paymentType |
Type: OrdersStatsOrderPaymentType Тип оплаты заказа. Enum: |
status |
Type: OrderStatsStatusType 当前订单状态:
Enum: |
statusUpdateDate |
Type: string<date-time> 上次更改订单状态的日期和时间。 日期和时间格式: ISO 8601. 例如, |
subsidies |
Type: OrdersStatsSubsidyDTO[] 用于降低安置成本的应计积分,以及在不购买或退款的情况下扣除积分。 Min items: |
ForwardScrollingPagerDTO
下一页的ID。
Name |
Description |
nextPageToken |
Type: string 下一个结果页面的ID。 |
OrdersStatsCommissionDTO
务的成本的信息。
Name |
Description |
actual |
Type: number 创建订单时已计费且需要支付的金额。 精度为小数点后两位。 |
type |
Type: OrdersStatsCommissionType Услуга. Enum: |
CurrencyType
货币代码:
RUR
-俄罗斯卢布。UAH
-乌克兰格里夫纳。BYR
-白俄罗斯卢布。KZT
-哈萨克斯坦坚戈。UZS
-乌兹别克总和。
Type |
Description |
Enum: |
OrdersStatsItemDTO
可能更改后的订单中的产品列表。
在订单处理过程中,yandex的。市场可以删除项目从它的情况下,在仓库或在用户的主动问题。
-
如果所有项目都从订单中删除,它将不在列表中。
items
-仅在列表中initialItems
. -
如果订单中至少剩下一个项目,它将在列表中。
items
(单位数量减少count
),并在列表中initialItems
(与单位的初始数量initialCount
).
Name |
Description |
bidFee |
Type: integer<int32> 最接近的竞争对手的扣除出价。 它表示为产品成本的百分比,乘以100。 例如,5%率表示为500。 Example: Min value: Max value: |
cisList |
Type: string[] 系统中的产品识别码列表 «Честный ЗНАК» 或 «ASL BELGISI» (对于卖家 Market Yandex Go). Min items: Unique items |
cofinanceThreshold |
Type: number 与Yandex折扣的门槛。下订单时的市场。 這是什麼啊? 精度为小数点后两位。 |
cofinanceValue |
Type: number 折扣与Yandex的。 市场。 這是什麼啊? 精度为小数点后两位。 |
count |
Type: integer<int32> 产品单位的数量,包括删除的单位。 如果所有项目都从订单中删除,它将只包含在列表中。 |
details |
Type: OrdersStatsDetailsDTO[] 有关从订单中删除产品的信息。 Min items: |
initialCount |
Type: integer<int32> 产品单元的初始数量。 |
marketSku |
Type: integer<int64> 市场上的产品卡的ID。 Min value: |
offerName |
Type: string 产品名称。 |
prices |
Type: OrdersStatsPriceDTO[] 产品的价格或折扣。 Min items: |
shopSku |
Type: string 你的 SKU -系统中的产品ID。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
warehouse |
Type: OrdersStatsWarehouseDTO Информация о складе, на котором хранится товар. |
OrdersStatsPaymentDTO
有关按订单转账的信息。
Name |
Description |
date |
Type: string<date> 汇款日期。 日期格式: |
id |
Type: string 的汇款ID。 |
paymentOrder |
Type: OrdersStatsPaymentOrderDTO Информация о платежном поручении. |
source |
Type: OrdersStatsPaymentSourceType Способ денежного перевода. Enum: |
total |
Type: number 汇款的金额。 精度为小数点后两位。 |
type |
Type: OrdersStatsPaymentType Тип денежного перевода. Enum: |
OrdersStatsDeliveryRegionDTO
送区域的信息。
Name |
Description |
id |
Type: integer<int64> 送区域的标识符。 |
name |
Type: string 交付区域的名称。 |
OrdersStatsOrderPaymentType
订购付款类别:
POSTPAID
-订单在收到后支付。PREPAID
-订单在收到之前已付款。UNKNOWN
-未知类型的付款。 最有可能的是,买方取消或退回订单,或者没有付款。
Type |
Description |
Enum: |
OrdersStatsSubsidyDTO
有关用于降低安置成本的积分累积的信息,以及在不购买或退款的情况下扣除的信息。
Name |
Description |
amount* |
Type: number 用于降低放置成本的点数,精确到小数点后两位。 |
operationType* |
Type: OrdersStatsSubsidyOperationType Тип операции c баллами, которые используются для уменьшения стоимости размещения. Enum: |
type* |
Type: OrdersStatsSubsidyType Источник баллов, которые используются для уменьшения стоимости размещения. Enum: |
OrdersStatsCommissionType
服务:
FEE
-产品在市场上的放置。FULFILLMENT
-仓库处理。 自2024年1月1日起不予退款。LOYALTY_PARTICIPATION_FEE
-参与忠诚度计划并反馈积分。AUCTION_PROMOTION
-通过按销售付费来促进销售。INSTALLMENT
-分期付款。 自2022年2月24日以来一直没有归还。DELIVERY_TO_CUSTOMER
-交付给买方 (FBY, FBS). 对于DBS和Express,如果订单通过Yandex退回。市场物流。EXPRESS_DELIVERY_TO_CUSTOMER
-快递给买方(快递)。AGENCY
-接受买方的付款。PAYMENT_TRANSFER
-转让买方的付款。RETURNED_ORDERS_STORAGE
-存储非购买和退款(FBS). 为 DBS 和快递-如果订单通过市场的物流退回。SORTING
-订单处理(FBS).INTAKE_SORTING
-从卖方仓库提货订单的组织(FBS).RETURN_PROCESSING
-在仓库处理订单(FBS). 为 DBS 和快递-如果订单通过Yandex返回。市场物流。ILLIQUID_GOODS_SALE
-销售非出口货物的报酬。
Type |
Description |
Enum: |
OrdersStatsDetailsDTO
有关从订单中删除产品的信息。
Name |
Description |
itemCount |
Type: integer<int64> 参数中指定状态的产品数量 |
itemStatus |
Type: OrdersStatsItemStatusType Статус товара. Enum: |
stockType |
Type: OrdersStatsStockType Тип товара. Enum: |
updateDate |
Type: string<date> 产品收到参数中指定的状态的日期 日期格式: |
OrdersStatsPriceDTO
产品的价格或折扣。
Name |
Description |
costPerItem |
Type: number 订单中每单位的价格或折扣。 精度为小数点后两位。 包括增值税。 |
total |
Type: number 订单中所有物品的总价或折扣。 精度为小数点后两位。 包括增值税。 |
type |
Type: OrdersStatsPriceType Тип скидки или цена товара. Enum: |
OrdersStatsWarehouseDTO
有关存储产品的仓库的信息。
Name |
Description |
id |
Type: integer<int64> 仓库ID。 |
name |
Type: string 仓库的名称。 |
OrdersStatsPaymentOrderDTO
支付订单的信息。
Name |
Description |
date |
Type: string<date> 付款订单的日期。 日期格式: |
id |
Type: string 支付订单的编号。 |
OrdersStatsPaymentSourceType
汇款方法:
BUYER
-以现金付款或退款。
过时的方法:
CASHBACK
.MARKETPLACE
.SPLIT
.
Type |
Description |
Enum: |
OrdersStatsPaymentType
汇款类型:
PAYMENT
-付款。REFUND
-退款。
Type |
Description |
Enum: |
OrdersStatsSubsidyOperationType
具有用于降低放置成本的点的操作类型:
ACCRUAL
-得分。DEDUCTION
-扣分。
Type |
Description |
Enum: |
OrdersStatsSubsidyType
用于降低放置成本的点的来源:
-
YANDEX_CASHBACK
-Yandex Plus订阅折扣。 -
SUBSIDY
-Yandex的。 市场折扣(促销、促销代码、优惠券等)) -
DELIVERY
-航运折扣(DBS).
Type |
Description |
Enum: |
OrdersStatsItemStatusType
产品状况:
REJECTED
-产品已添加到创建的订单中,但未付款。RETURNED
-产品已退回。
Type |
Description |
Enum: |
OrdersStatsStockType
产品类别:
-
FIT
-产品质量好。 -
DEFECT
-产品有缺陷。 -
EXPIRED
-过期产品。
Type |
Description |
Enum: |
OrdersStatsPriceType
折扣类型或产品价格:
BUYER
-产品的价格,包括折扣,包括优惠券。CASHBACK
-加分。MARKETPLACE
-优惠券。
Type |
Description |
Enum: |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
ApiErrorDTO
一般错误格式。
Name |
Description |
code* |
Type: string 的错误代码。 |
message |
Type: string 错误的描述。 |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
Yandex中的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.