订单的详细信息
方法适用于所有模式.
如果您使用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和模块:
⚠️ 不要把它与:
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer 每页的值数。 Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 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> 生成订单的初始日期。 日期格式: 不能与参数一起使用 Example: |
|
dateTo |
Type: string<date> 生成订单的结束日期。 日期格式: 不能与参数一起使用 Example: |
|
hasCis |
Type: boolean 用于接收系统中包含至少一个带有识别码的产品的订单的过滤器。 «Честный ЗНАК» 或 «ASL BELGISI» (对于卖家 Market Yandex Go):
|
|
orders |
Type: integer[] | null 订单Id列表。 Min items: Unique items: Example
|
|
statuses |
Type: string[] | null 订单状态列表。 Min items: Unique items: Example
|
|
updateFrom |
Type: string<date> 对订单进行更改的期间的开始日期(例如,状态或付款信息)。 日期格式: 不能与参数一起使用 Example: |
|
updateTo |
Type: string<date> 更改订单的期间的结束日期(例如,状态或付款信息)。 日期格式: 不能与参数一起使用 Example: |
Responses
200 OK
有关订单的信息。
Body
application/json
{
"status": "OK",
"result": {
"orders": [
{
"id": 0,
"creationDate": "2025-01-01",
"statusUpdateDate": "2025-01-01T00:00:00Z",
"status": "CANCELLED_BEFORE_PROCESSING",
"partnerOrderId": "example",
"paymentType": "POSTPAID",
"fake": true,
"deliveryRegion": {},
"items": [
null
],
"initialItems": [
null
],
"payments": [
null
],
"commissions": [
null
],
"subsidies": [
null
],
"buyerType": "PERSON",
"currency": "RUR"
}
],
"paging": {
"nextPageToken": "example"
}
}
}
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
result
Type: object
orders
Type: object[]
commissions
Type: object[]
actual
Type: number
创建订单时已计费且需要支付的金额。 准确度 — 小数点后两位。
type
Type: string
服务:
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— 快递给买方(Express).AGENCY— 接受买方的付款。PAYMENT_TRANSFER— 买方付款的转让。RETURNED_ORDERS_STORAGE— 存储非购买和退款(FBS). 为 DBS 和 Express — 如果订单通过Yandex返回。 市场物流。SORTING— 订单处理(FBS).INTAKE_SORTING— 从卖方仓库提货的组织(FBS).RETURN_PROCESSING— 仓库中的订单处理(FBS). 为 DBS 和 Express — 如果订单通过Yandex返回。 市场物流。ILLIQUID_GOODS_SALE— 销售非出口货物的报酬。
Enum:
FEE,FULFILLMENT,LOYALTY_PARTICIPATION_FEE,AUCTION_PROMOTION,INSTALLMENT,DELIVERY_TO_CUSTOMER,EXPRESS_DELIVERY_TO_CUSTOMER,AGENCY,PAYMENT_TRANSFER,RETURNED_ORDERS_STORAGE,SORTING,INTAKE_SORTING,RETURN_PROCESSING,ILLIQUID_GOODS_SALE务的成本的信息。
Example
[ { "type": "FEE", "actual": 0.5 } ]currency
Type: string
货币代码:
RUR— 俄罗斯卢布。UAH— 乌克兰格里夫纳。BYR— 白俄罗斯卢布。KZT— 哈萨克斯坦坚戈。UZS— 乌兹别克总和。
Enum:
RUR,USD,EUR,UAH,AUD,GBP,BYR,BYN,DKK,ISK,KZT,CAD,CNY,NOK,XDR,SGD,TRY,SEK,CHF,JPY,AZN,ALL,DZD,AOA,ARS,AMD,AFN,BHD,BGN,BOB,BWP,BND,BRL,BIF,HUF,VEF,KPW,VND,GMD,GHS,GNF,HKD,GEL,AED,EGP,ZMK,ILS,INR,IDR,JOD,IQD,IRR,YER,QAR,KES,KGS,COP,CDF,CRC,KWD,CUP,LAK,LVL,SLL,LBP,LYD,SZL,LTL,MUR,MRO,MKD,MWK,MGA,MYR,MAD,MXN,MZN,MDL,MNT,NPR,NGN,NIO,NZD,OMR,PKR,PYG,PEN,PLN,KHR,SAR,RON,SCR,SYP,SKK,SOS,SDG,SRD,TJS,THB,TWD,BDT,TZS,TND,TMM,UGX,UZS,UYU,PHP,DJF,XAF,XOF,HRK,CZK,CLP,LKR,EEK,ETB,RSD,ZAR,KRW,NAD,TL,UEitems
Type: object[]
bidFee
Type: integer
最接近的竞争对手的扣除出价。
它表示为产品成本的百分比,乘以100。 例如,5%率表示为500。
Min value:
0Max value:
10000cisList
Type: string[] | null
系统中的产品识别码列表 «Честный ЗНАК» 或 «ASL BELGISI» (对于卖家 Market Yandex Go).
Min items:
1Unique items:
trueExample
[ "example" ]cofinanceThreshold
Type: number
与Yandex折扣的门槛。下订单时的市场。 這是什麼啊?
准确度 — 小数点后两位。
cofinanceValue
Type: number
折扣与Yandex的。 市场。 這是什麼啊?
准确度 — 小数点后两位。
count
Type: integer
产品单位的数量,包括删除的单位。
如果所有项目都从订单中删除,它将只包含在列表中。
initialItems.details
Type: object[]
itemCount
Type: integer
参数中指定状态的产品数量
itemStatus.itemStatus
Type: string
产品状况:
REJECTED— 产品已添加到创建的订单中,但未付款。RETURNED— 产品被退回。
Enum:
REJECTED,RETURNEDstockType
Type: string
产品类别:
-
FIT— 产品质量好。 -
DEFECT— 产品有缺陷。 -
EXPIRED— 过期的产品。
Enum:
FIT,DEFECT,EXPIREDupdateDate
Type: string<date>
只适用于型号 FBY
在市场仓库处理退款的日期。
日期格式:
YYYY-MM-DD.Example:
2025-01-01有关从订单中删除产品的信息。
Min items:
1Example
[ { "itemStatus": "REJECTED", "itemCount": 0, "updateDate": "2025-01-01", "stockType": "FIT" } ]initialCount
Type: integer
产品单元的初始数量。
marketSku
Type: integer
市场上的产品卡的ID。
Min value:
1offerName
Type: string
产品名称。
Example:
exampleprices
Type: object[]
costPerItem
Type: number
订单中每单位的价格或折扣。
准确度 — 小数点后两位。
包括增值税。
total
Type: number
订单中所有物品的总价或折扣。
准确度 — 小数点后两位。
包括增值税。
type
Type: string
折扣类型或产品价格:
BUYER— 产品的价格包括折扣,包括优惠券。CASHBACK— 加分。MARKETPLACE— 优惠券。
Enum:
BUYER,CASHBACK,MARKETPLACE产品的价格或折扣。
Min items:
1Example
[ { "type": "BUYER", "costPerItem": 0.5, "total": 0.5 } ]shopSku
Type: string
你的 SKU — 系统中的产品ID。
使用规则 SKU:
-
对于每个产品 SKU 一定有一个。
-
已经设置 SKU 它不能被释放并重新用于另一个产品。 每个产品都应该收到一个以前从未在目录中使用过的新标识符。
SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助.
重要
值开头和结尾的空格会自动删除。 例如,
" SKU123 "和"SKU123"它们将被视为相同的值。Min length:
1Max length:
255Pattern:
^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$Example:
examplewarehouse
Type: object
id
Type: integer
仓库ID。
name
Type: string
仓库的名称。
Example:
example有关存储产品的仓库的信息。
Example
{ "id": 0, "name": "example" }可能更改后的订单中的产品列表。
订单交付信息作为单独的元素添加到数组中
items— 参数offerName与值派递服务.Example
[ { "offerName": "example", "marketSku": 1, "shopSku": "example", "count": 0, "prices": [ { "type": "BUYER", "costPerItem": 0.5, "total": 0.5 } ], "warehouse": { "id": 0, "name": "example" }, "details": [ { "itemStatus": "REJECTED", "itemCount": 0, "updateDate": "2025-01-01", "stockType": "FIT" } ], "cisList": [ "example" ], "initialCount": 0, "bidFee": 570, "cofinanceThreshold": 0.5, "cofinanceValue": 0.5 } ]payments
Type: object[]
date
Type: string<date>
汇款日期。
日期格式:
YYYY-MM-DD.Example:
2025-01-01id
Type: string
的汇款ID。
Example:
examplepaymentOrder
Type: object
date
Type: string<date>
付款订单的日期。
日期格式:
YYYY-MM-DD.Example:
2025-01-01id
Type: string
支付订单的编号。
Example:
example支付订单的信息。
Example
{ "id": "example", "date": "2025-01-01" }source
Type: string
汇款方法:
BUYER— 以现金支付或退款。
过时的方法:
CASHBACK.MARKETPLACE.SPLIT.
Enum:
BUYER,CASHBACK,MARKETPLACE,SPLITtotal
Type: number
汇款的金额。
准确度 — 小数点后两位。
type
Type: string
汇款类型:
PAYMENT— 付款。REFUND— 退款。
Enum:
PAYMENT,REFUND有关订单计算的信息。
如果订单返回空:
- 他们刚刚开始处理它(即使它是付费的)。
- 取消,直到交货时间。
有关订单计算的最终信息将在其最终处理后(例如,切换到状态后)返回
DELIVERED).Example
[ { "id": "example", "date": "2025-01-01", "type": "PAYMENT", "source": "BUYER", "total": 0.5, "paymentOrder": { "id": "example", "date": "2025-01-01" } } ]buyerType
Type: string
买方类型:
-
PERSON— 一个自然人。 -
BUSINESS— 组织。
Enum:
PERSON,BUSINESScreationDate
Type: string<date>
创建订单的日期。
日期格式:
YYYY-MM-DD.Example:
2025-01-01deliveryRegion
Type: object
id
Type: integer
送区域的标识符。
name
Type: string
交付区域的名称。
Example:
example送区域的信息。
Example
{ "id": 0, "name": "example" }fake
Type: boolean
订单类型:
-
false— 真正的客户的订单。 -
true— 测试订单 燕基科斯. 市场。
id
Type: integer
的订单ID。
initialItems
Type: object[]
bidFee
Type: integer
最接近的竞争对手的扣除出价。
它表示为产品成本的百分比,乘以100。 例如,5%率表示为500。
Min value:
0Max value:
10000cisList
Type: string[] | null
系统中的产品识别码列表 «Честный ЗНАК» 或 «ASL BELGISI» (对于卖家 Market Yandex Go).
Min items:
1Unique items:
trueExample
[ "example" ]cofinanceThreshold
Type: number
与Yandex折扣的门槛。下订单时的市场。 這是什麼啊?
准确度 — 小数点后两位。
cofinanceValue
Type: number
折扣与Yandex的。 市场。 這是什麼啊?
准确度 — 小数点后两位。
count
Type: integer
产品单位的数量,包括删除的单位。
如果所有项目都从订单中删除,它将只包含在列表中。
initialItems.details
Type: object[]
itemCount
Type: integer
参数中指定状态的产品数量
itemStatus.itemStatus
Type: string
产品状况:
REJECTED— 产品已添加到创建的订单中,但未付款。RETURNED— 产品被退回。
Enum:
REJECTED,RETURNEDstockType
Type: string
产品类别:
-
FIT— 产品质量好。 -
DEFECT— 产品有缺陷。 -
EXPIRED— 过期的产品。
Enum:
FIT,DEFECT,EXPIREDupdateDate
Type: string<date>
只适用于型号 FBY
在市场仓库处理退款的日期。
日期格式:
YYYY-MM-DD.Example:
2025-01-01有关从订单中删除产品的信息。
Min items:
1Example
[ { "itemStatus": "REJECTED", "itemCount": 0, "updateDate": "2025-01-01", "stockType": "FIT" } ]initialCount
Type: integer
产品单元的初始数量。
marketSku
Type: integer
市场上的产品卡的ID。
Min value:
1offerName
Type: string
产品名称。
Example:
exampleprices
Type: object[]
costPerItem
Type: number
订单中每单位的价格或折扣。
准确度 — 小数点后两位。
包括增值税。
total
Type: number
订单中所有物品的总价或折扣。
准确度 — 小数点后两位。
包括增值税。
type
Type: string
折扣类型或产品价格:
BUYER— 产品的价格包括折扣,包括优惠券。CASHBACK— 加分。MARKETPLACE— 优惠券。
Enum:
BUYER,CASHBACK,MARKETPLACE产品的价格或折扣。
Min items:
1Example
[ { "type": "BUYER", "costPerItem": 0.5, "total": 0.5 } ]shopSku
Type: string
你的 SKU — 系统中的产品ID。
使用规则 SKU:
-
对于每个产品 SKU 一定有一个。
-
已经设置 SKU 它不能被释放并重新用于另一个产品。 每个产品都应该收到一个以前从未在目录中使用过的新标识符。
SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助.
重要
值开头和结尾的空格会自动删除。 例如,
" SKU123 "和"SKU123"它们将被视为相同的值。Min length:
1Max length:
255Pattern:
^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$Example:
examplewarehouse
Type: object
id
Type: integer
仓库ID。
name
Type: string
仓库的名称。
Example:
example有关存储产品的仓库的信息。
Example
{ "id": 0, "name": "example" }订单中的产品列表。
只有在货物数量发生变化时才退回。
Min items:
1Example
[ { "offerName": "example", "marketSku": 1, "shopSku": "example", "count": 0, "prices": [ { "type": "BUYER", "costPerItem": 0.5, "total": 0.5 } ], "warehouse": { "id": 0, "name": "example" }, "details": [ { "itemStatus": "REJECTED", "itemCount": 0, "updateDate": "2025-01-01", "stockType": "FIT" } ], "cisList": [ "example" ], "initialCount": 0, "bidFee": 570, "cofinanceThreshold": 0.5, "cofinanceValue": 0.5 } ]partnerOrderId
Type: string
商店信息系统中的订单ID。
Example:
examplepaymentType
Type: string
订购付款类别:
POSTPAID— 订单在收到后支付。PREPAID— 订单在收到之前已付款。UNKNOWN— 未知付款类型。 最有可能的是,买方取消或退回订单,或者没有付款。
Enum:
POSTPAID,PREPAID,UNKNOWNstatus
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,LOSTstatusUpdateDate
Type: string<date-time>
上次更改订单状态的日期和时间。
日期和时间格式: ISO 8601. 例如,
2017-11-21T00:00:00. 时区 — UTC+03:00(莫斯科)。Example:
2025-01-01T00:00:00Zsubsidies
Type: object[]
amount
Type: number
用于降低放置成本的点数,精确到小数点后两位。
operationType
Type: string
具有用于降低放置成本的点的操作类型:
ACCRUAL— 得分点。DEDUCTION— 扣分。
Enum:
ACCRUAL,DEDUCTIONtype
Type: string
用于降低放置成本的点的来源:
-
YANDEX_CASHBACK— Yandex Plus订阅折扣。 -
SUBSIDY— 燕基科斯. 市场折扣(促销、促销代码、优惠券等)) -
DELIVERY— 航运折扣(DBS).
Enum:
YANDEX_CASHBACK,SUBSIDY,DELIVERY用于降低安置成本的应计积分,以及在不购买或退款的情况下扣除积分。
Min items:
1Example
[ { "operationType": "ACCRUAL", "type": "YANDEX_CASHBACK", "amount": 0.5 } ]订单列表。
Example
[ { "id": 0, "creationDate": "2025-01-01", "statusUpdateDate": "2025-01-01T00:00:00Z", "status": "CANCELLED_BEFORE_PROCESSING", "partnerOrderId": "example", "paymentType": "POSTPAID", "fake": true, "deliveryRegion": { "id": 0, "name": "example" }, "items": [ { "offerName": "example", "marketSku": 1, "shopSku": "example", "count": 0, "prices": [ {} ], "warehouse": { "id": 0, "name": "example" }, "details": [ {} ], "cisList": [ "example" ], "initialCount": 0, "bidFee": 570, "cofinanceThreshold": 0.5, "cofinanceValue": 0.5 } ], "initialItems": [ { "offerName": "example", "marketSku": 1, "shopSku": "example", "count": 0, "prices": [ {} ], "warehouse": { "id": 0, "name": "example" }, "details": [ {} ], "cisList": [ "example" ], "initialCount": 0, "bidFee": 570, "cofinanceThreshold": 0.5, "cofinanceValue": 0.5 } ], "payments": [ { "id": "example", "date": "2025-01-01", "type": "PAYMENT", "source": "BUYER", "total": 0.5, "paymentOrder": { "id": "example", "date": "2025-01-01" } } ], "commissions": [ { "type": "FEE", "actual": 0.5 } ], "subsidies": [ { "operationType": "ACCRUAL", "type": "YANDEX_CASHBACK", "amount": 0.5 } ], "buyerType": "PERSON", "currency": "RUR" } ]paging
Type: object
nextPageToken
Type: string
下一个结果页面的ID。
Example:
example下一页的ID。
Example
{ "nextPageToken": "example" }有关订单的信息。
Example
{ "orders": [ { "id": 0, "creationDate": "2025-01-01", "statusUpdateDate": "2025-01-01T00:00:00Z", "status": "CANCELLED_BEFORE_PROCESSING", "partnerOrderId": "example", "paymentType": "POSTPAID", "fake": true, "deliveryRegion": { "id": 0, "name": "example" }, "items": [ { "offerName": "example", "marketSku": 1, "shopSku": "example", "count": 0, "prices": [ null ], "warehouse": {}, "details": [ null ], "cisList": [ null ], "initialCount": 0, "bidFee": 570, "cofinanceThreshold": 0.5, "cofinanceValue": 0.5 } ], "initialItems": [ { "offerName": "example", "marketSku": 1, "shopSku": "example", "count": 0, "prices": [ null ], "warehouse": {}, "details": [ null ], "cisList": [ null ], "initialCount": 0, "bidFee": 570, "cofinanceThreshold": 0.5, "cofinanceValue": 0.5 } ], "payments": [ { "id": "example", "date": "2025-01-01", "type": "PAYMENT", "source": "BUYER", "total": 0.5, "paymentOrder": {} } ], "commissions": [ { "type": "FEE", "actual": 0.5 } ], "subsidies": [ { "operationType": "ACCRUAL", "type": "YANDEX_CASHBACK", "amount": 0.5 } ], "buyerType": "PERSON", "currency": "RUR" } ], "paging": { "nextPageToken": "example" } }Example
{ "result": { "orders": [ { "id": 0, "creationDate": "2025-01-01", "statusUpdateDate": "2025-01-01T00:00:00Z", "status": "CANCELLED_BEFORE_PROCESSING", "partnerOrderId": "example", "paymentType": "POSTPAID", "fake": true, "deliveryRegion": { "id": 0, "name": "example" }, "items": [ {} ], "initialItems": [ {} ], "payments": [ {} ], "commissions": [ {} ], "subsidies": [ {} ], "buyerType": "PERSON", "currency": "RUR" } ], "paging": { "nextPageToken": "example" } } }
400 Bad Request
请求包含不正确的数据。 详细了解报告和文档中的错误
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
500 Internal Server Error
Yandex中的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
No longer supported, please use an alternative and newer version.