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.
With it, you can 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",
"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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
result
Type: object
orders
Type: object[]
commissions
Type: object[]
actual
Type: number
The amount that was billed at the time the order was created and that needs to be paid. Accuracy — two decimal places.
type
Type: string
Service:
FEE— product placement on the Market.FULFILLMENT— warehouse handling. Non-refundable since January 1, 2024.LOYALTY_PARTICIPATION_FEE— participation in the loyalty program and feedback for points.AUCTION_PROMOTION— boost sales with pay-per-sales.INSTALLMENT— installment plan. It has not been returned since February 24, 2022.DELIVERY_TO_CUSTOMER— delivery to the buyer (FBY, FBS). For DBS and Express — if the order is returned through Yandex. Market logistics.EXPRESS_DELIVERY_TO_CUSTOMER— express delivery to the buyer (Express).AGENCY— acceptance of the buyer's payment.PAYMENT_TRANSFER— transfer of the buyer's payment.RETURNED_ORDERS_STORAGE— storage of non-purchases and refunds (FBS). For DBS and Express — if the order is returned through Yandex. Market logistics.SORTING— order processing (FBS).INTAKE_SORTING— organization of picking up orders from the seller's warehouse (FBS).RETURN_PROCESSING— order processing in the warehouse (FBS). For DBS and Express — if the order is returned through Yandex. Market logistics.ILLIQUID_GOODS_SALE— remuneration for the sale of non-exported goods.
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_SALEInformation about the cost of services.
Example
[ { "type": "FEE", "actual": 0.5 } ]currency
Type: string
Currency codes:
RUR— the Russian ruble.UAH— the Ukrainian hryvnia.BYR— the Belarusian ruble.KZT— Kazakhstani tenge.UZS— Uzbek sum.
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
The deducted bid of the nearest competitor.
It is indicated as a percentage of the cost of the product and multiplied by 100. For example, the 5% rate is indicated as 500.
Min value:
0Max value:
10000cisList
Type: string[] | null
List of product identification codes in the system «Честный ЗНАК» or «ASL BELGISI» (for sellers Market Yandex Go).
Min items:
1Unique items:
trueExample
[ "example" ]cofinanceThreshold
Type: number
The threshold for discounts with Yandex.Market at the time of placing the order. What is it?
Accuracy — two decimal places.
cofinanceValue
Type: number
Discount with Yandex. Market. What is it?
Accuracy — two decimal places.
count
Type: integer
The number of product units, including deleted units.
If all the items are removed from the order, it will only be included in the list.
initialItems.details
Type: object[]
itemCount
Type: integer
The quantity of the product with the status specified in the parameter
itemStatus.itemStatus
Type: string
Product status:
REJECTED— the product was added to the created order, but was not paid for.RETURNED— the product was returned.
Enum:
REJECTED,RETURNEDstockType
Type: string
Product Type:
-
FIT— the product is of good quality. -
DEFECT— the product is defective. -
EXPIRED— an expired product.
Enum:
FIT,DEFECT,EXPIREDupdateDate
Type: string<date>
For the model only FBY
The date when the refund was processed at the Market warehouse.
Date format:
YYYY-MM-DD.Example:
2025-01-01Information about the removal of the product from the order.
Min items:
1Example
[ { "itemStatus": "REJECTED", "itemCount": 0, "updateDate": "2025-01-01", "stockType": "FIT" } ]initialCount
Type: integer
The initial number of product units.
marketSku
Type: integer
The ID of the product card on the Market.
Min value:
1offerName
Type: string
Product name.
Example:
exampleprices
Type: object[]
costPerItem
Type: number
The price or discount per unit in the order.
Accuracy — two decimal places.
Includes VAT.
total
Type: number
The total price or discount for all items in the order.
Accuracy — two decimal places.
Includes VAT.
type
Type: string
Discount type or product price:
BUYER— the price of the product includes discounts, including coupons.CASHBACK— Plus points.MARKETPLACE— coupons.
Enum:
BUYER,CASHBACK,MARKETPLACEThe price or discounts on the product.
Min items:
1Example
[ { "type": "BUYER", "costPerItem": 0.5, "total": 0.5 } ]shopSku
Type: string
Your SKU — the product ID in your system.
Usage rules SKU:
-
For each product SKU there must be one.
-
Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.
SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.
Warning
Spaces at the beginning and end of the value are automatically deleted. For example,
" SKU123 "and"SKU123"they will be treated as identical values.What is SKU and how to assign it
Min length:
1Max length:
255Pattern:
^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$Example:
examplewarehouse
Type: object
id
Type: integer
The warehouse ID.
name
Type: string
The name of the warehouse.
Example:
exampleInformation about the warehouse where the product is stored.
Example
{ "id": 0, "name": "example" }The list of products in the order after possible changes.
The order delivery information is added as a separate element in the array
items— parameterofferNamewith the valueDelivery.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>
Date of the money transfer.
Date format:
YYYY-MM-DD.Example:
2025-01-01id
Type: string
The money transfer ID.
Example:
examplepaymentOrder
Type: object
date
Type: string<date>
The date of the payment order.
Date format:
YYYY‑MM‑DD.Example:
2025-01-01id
Type: string
The number of the payment order.
Example:
exampleInformation about the payment order.
Example
{ "id": "example", "date": "2025-01-01" }source
Type: string
Money transfer method:
BUYER— payment or refund in cash.
Outdated methods:
CASHBACK.MARKETPLACE.SPLIT.
Enum:
BUYER,CASHBACK,MARKETPLACE,SPLITtotal
Type: number
The amount of the money transfer.
Accuracy — two decimal places.
type
Type: string
Type of money transfer:
PAYMENT— payment.REFUND— refund.
Enum:
PAYMENT,REFUNDInformation about the calculations for the order.
It is returned empty if the order:
- they just started processing it (even if it's been paid for).
- cancelled until the time of delivery.
The final information about the calculations for the order will be returned after its final processing (for example, after switching to the status
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
Type of buyer:
-
PERSON— a natural person. -
BUSINESS— organization.
Enum:
PERSON,BUSINESScreationDate
Type: string<date>
The date the order was created.
Date format:
YYYY-MM-DD.Example:
2025-01-01deliveryRegion
Type: object
id
Type: integer
The identifier of the delivery region.
name
Type: string
The name of the delivery region.
Example:
exampleInformation about the delivery region.
Example
{ "id": 0, "name": "example" }fake
Type: boolean
Order type:
-
false— the real customer's order. -
true— test order Yandex. Market.
id
Type: integer
The order ID.
initialItems
Type: object[]
bidFee
Type: integer
The deducted bid of the nearest competitor.
It is indicated as a percentage of the cost of the product and multiplied by 100. For example, the 5% rate is indicated as 500.
Min value:
0Max value:
10000cisList
Type: string[] | null
List of product identification codes in the system «Честный ЗНАК» or «ASL BELGISI» (for sellers Market Yandex Go).
Min items:
1Unique items:
trueExample
[ "example" ]cofinanceThreshold
Type: number
The threshold for discounts with Yandex.Market at the time of placing the order. What is it?
Accuracy — two decimal places.
cofinanceValue
Type: number
Discount with Yandex. Market. What is it?
Accuracy — two decimal places.
count
Type: integer
The number of product units, including deleted units.
If all the items are removed from the order, it will only be included in the list.
initialItems.details
Type: object[]
itemCount
Type: integer
The quantity of the product with the status specified in the parameter
itemStatus.itemStatus
Type: string
Product status:
REJECTED— the product was added to the created order, but was not paid for.RETURNED— the product was returned.
Enum:
REJECTED,RETURNEDstockType
Type: string
Product Type:
-
FIT— the product is of good quality. -
DEFECT— the product is defective. -
EXPIRED— an expired product.
Enum:
FIT,DEFECT,EXPIREDupdateDate
Type: string<date>
For the model only FBY
The date when the refund was processed at the Market warehouse.
Date format:
YYYY-MM-DD.Example:
2025-01-01Information about the removal of the product from the order.
Min items:
1Example
[ { "itemStatus": "REJECTED", "itemCount": 0, "updateDate": "2025-01-01", "stockType": "FIT" } ]initialCount
Type: integer
The initial number of product units.
marketSku
Type: integer
The ID of the product card on the Market.
Min value:
1offerName
Type: string
Product name.
Example:
exampleprices
Type: object[]
costPerItem
Type: number
The price or discount per unit in the order.
Accuracy — two decimal places.
Includes VAT.
total
Type: number
The total price or discount for all items in the order.
Accuracy — two decimal places.
Includes VAT.
type
Type: string
Discount type or product price:
BUYER— the price of the product includes discounts, including coupons.CASHBACK— Plus points.MARKETPLACE— coupons.
Enum:
BUYER,CASHBACK,MARKETPLACEThe price or discounts on the product.
Min items:
1Example
[ { "type": "BUYER", "costPerItem": 0.5, "total": 0.5 } ]shopSku
Type: string
Your SKU — the product ID in your system.
Usage rules SKU:
-
For each product SKU there must be one.
-
Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.
SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.
Warning
Spaces at the beginning and end of the value are automatically deleted. For example,
" SKU123 "and"SKU123"they will be treated as identical values.What is SKU and how to assign it
Min length:
1Max length:
255Pattern:
^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$Example:
examplewarehouse
Type: object
id
Type: integer
The warehouse ID.
name
Type: string
The name of the warehouse.
Example:
exampleInformation about the warehouse where the product is stored.
Example
{ "id": 0, "name": "example" }The list of products in the order.
It is returned only if there was a change in the quantity of goods.
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
The order ID in the store's information system.
Example:
examplepaymentType
Type: string
Order payment type:
POSTPAID— The order is paid for after it has been received.PREPAID— the order was paid for before it was received.UNKNOWN— unknown payment type. Most likely, the buyer canceled or returned the order, or there was no payment for it.
Enum:
POSTPAID,PREPAID,UNKNOWNstatus
Type: string
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.The order status can change to
PARTIALLY_DELIVEREDNot immediatelyIf there was a non-purchase in the delivered order, the status will change only after the order is received at the Market warehouse.
-
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 being processed. -
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.
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>
The date and time when the order status was last changed.
Date and time format: ISO 8601. For example,
2017-11-21T00:00:00. Time zone — UTC+03:00 (Moscow).Example:
2025-01-01T00:00:00Zsubsidies
Type: object[]
amount
Type: number
The number of points that are used to reduce the cost of placement, accurate to two decimal places.
operationType
Type: string
The type of operation with points that are used to reduce the cost of placement:
ACCRUAL— scoring points.DEDUCTION— deduction of points.
Enum:
ACCRUAL,DEDUCTIONtype
Type: string
The source of the points that are used to reduce the cost of placement:
-
YANDEX_CASHBACK— discount on Yandex Plus subscription. -
SUBSIDY— Yandex. Market discount (for promotions, promo codes, coupons, etc.) -
DELIVERY— discount for shipping (DBS).
Enum:
YANDEX_CASHBACK,SUBSIDY,DELIVERYAccrual of points that are used to reduce the cost of placement, and their deduction in case of non-purchase or refund.
Min items:
1Example
[ { "operationType": "ACCRUAL", "type": "YANDEX_CASHBACK", "amount": 0.5 } ]The list of orders.
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 of the next results page.
Example:
exampleThe ID of the next page.
Example
{ "nextPageToken": "example" }Information about orders.
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
The request contains incorrect data. Learn more about errors in reports and documents
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
401 Unauthorized
The authorization data is not specified in the request. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
404 Not Found
The requested resource was not found. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
420 Method Failure
The resource access limit has been exceeded. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
500 Internal Server Error
Internal error of Yandex. Market. More information about the error
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
The type of response. Possible values:
OK— There are no errors.ERROR— an error occurred while processing the request.
Enum:
OK,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
A standard wrapper for server errors.
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
No longer supported, please use an alternative and newer version.