Information about orders in the store
Deprecated
The method is available for models: FBY, FBS, Express and DBS.
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
- finance-and-accounting — View financial data and reports
- communication — Customer communication
- all-methods — Full account management
- all-methods:read-only — View all data
Which method should I use instead of the outdated one?
Returns information about orders in the store. The query can be used to track orders and their statuses.
By default, data about test orders is not received. To get them, pass the value true in the parameter fake.
You can also set up API notifications.
Yandex.Market will send you request when a new order appears or its status changes. And full information can be obtained using the method POST v1/businesses/{businessId}/orders.
Filtering by parameters is available:
-
the date of the order.
-
date and time of the order update;
-
date of shipment;
-
order statuses (
statuses); -
stages of processing or reasons for cancellation (
substatuses); -
order IDs;
-
the type of order (real or test).
Information about orders that were delivered or cancelled more than 30 days ago is not returned. How to get it:
Maximum date range per request — 30 days (passed in the parameters fromDate and toDate). If they are not transmitted, the information for the last 30 days is returned.
The results are returned page by page. To navigate, use the parameters page_token and limit.
You can get more detailed information about the buyer and his phone number by requesting GET v2/campaigns/{campaignId}/orders/{orderId}/buyer.
Restriction for the parameter limit
Do not transmit a value greater than 50.
| ⚙️ Limit: 100,000 requests per hour |
|---|
Request
GET
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/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 |
|
buyerType |
Type: string Filtering orders by customer type. Type of buyer:
Enum: |
|
dispatchType |
Type: string Shipping method Shipping method:
Enum: |
|
fake |
Type: boolean Filtering orders by type:
Default: |
|
fromDate |
Type: string<date> The starting date for filtering orders by checkout date. Date format: Between the start and end date (parameter Default value: 30 days ago from the current date. 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):
Such codes are assigned to products that are subject to labeling and belong to certain categories. Default: |
|
limit |
Type: integer The number of values per page. Min value: |
|
onlyEstimatedDelivery |
Type: boolean Filtering orders with long delivery (31-60 days) by confirmed delivery date:
Default: |
|
onlyWaitingForCancellationApprove |
Type: boolean For the model only DBS A filter for receiving orders for which there was a cancellation request. With the value To confirm or reject the cancellation, send a request PUT v2/campaigns/{campaignId}/orders/{orderId}/cancellation/accept. Default: |
|
orderIds |
Type: integer[] Filtering orders by IDs.
Min items: Max items: Example: `` |
|
page |
Type: integer If the method has Use it instead of the parameter The number of the results page. Used together with the parameter
Default: Max 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: |
|
pageSize |
Type: integer Page size. Used together with the parameter
|
|
status |
Type: string[] Order status:
Unique items: Example: `` |
|
substatus |
Type: string[] Order processing stage (status Possible values for the order in the status
Possible values for the order in the status
Unique items: Example: `` |
|
supplierShipmentDateFrom |
Type: string<date> The starting date for filtering orders by the date of shipment to the delivery service (parameter Date format: Between the start and end date (parameter The start date is included in the interval for filtering. Example: `` |
|
supplierShipmentDateTo |
Type: string<date> The end date for filtering orders by the date of shipment to the delivery service (parameter Date format: Between the initial (parameter The end date is not included in the filtering interval. If the time interval between Example: `` |
|
toDate |
Type: string<date> The end date for filtering orders by checkout date. Orders created before 00:00 of the specified day are shown. Date format: Between the initial (parameter Default value: current date. If the time interval between Example: `` |
|
updatedAtFrom |
Type: string<date-time> The starting date for filtering orders by date and time of the update (parameter Date format: ISO 8601 with an offset relative to UTC. For example, Between the start and end date (parameter The start date is included in the interval for filtering. Example: `` |
|
updatedAtTo |
Type: string<date-time> The end date for filtering orders by date and time of the update (parameter Date format: ISO 8601 with an offset relative to UTC. For example, Between the initial (parameter The end date is not included in the filtering interval. Example: `` |
Responses
200 OK
Information about orders.
Body
application/json
{
"pager": {
"total": 0,
"from": 0,
"to": 0,
"currentPage": 0,
"pagesCount": 0,
"pageSize": 0
},
"orders": [
{
"id": 0,
"externalOrderId": "example",
"status": "PLACING",
"substatus": "RESERVATION_EXPIRED",
"creationDate": "23-09-2022 09:12:41",
"updatedAt": "23-09-2022 09:12:41",
"currency": "RUR",
"itemsTotal": 0.5,
"deliveryTotal": 0.5,
"buyerItemsTotal": 0.5,
"buyerTotal": 0.5,
"buyerItemsTotalBeforeDiscount": 0.5,
"buyerTotalBeforeDiscount": 0.5,
"paymentType": "PREPAID",
"paymentMethod": "CASH_ON_DELIVERY",
"fake": true,
"items": [
{
"id": 0,
"offerId": "example",
"offerName": "example",
"price": 0.5,
"buyerPrice": 0.5,
"buyerPriceBeforeDiscount": 0.5,
"priceBeforeDiscount": 0.5,
"count": 0,
"vat": "NO_VAT",
"shopSku": "example",
"subsidy": 0.5,
"partnerWarehouseId": "example",
"promos": [
null
],
"instances": [
null
],
"details": [
null
],
"subsidies": [
null
],
"requiredInstanceTypes": [
null
],
"tags": [
null
]
}
],
"subsidies": [
{
"type": "YANDEX_CASHBACK",
"amount": 0.5
}
],
"delivery": {
"id": "example",
"type": "DELIVERY",
"serviceName": "example",
"price": 0.5,
"deliveryPartnerType": "SHOP",
"courier": {
"fullName": "example",
"phone": "example",
"phoneExtension": "example",
"vehicleNumber": "example",
"vehicleDescription": "example"
},
"dates": {
"fromDate": "23-09-2022",
"toDate": "23-09-2022",
"fromTime": "12:00:00",
"toTime": "12:00:00",
"realDeliveryDate": "23-09-2022"
},
"region": {
"id": 0,
"name": "example",
"type": "OTHER",
"parent": null
},
"address": {
"country": "example",
"postcode": "example",
"city": "example",
"district": "example",
"subway": "example",
"street": "example",
"house": "example",
"estate": "example",
"block": "example",
"building": "example",
"entrance": "example",
"entryphone": "example",
"floor": "example",
"apartment": "example",
"phone": "example",
"recipient": "example",
"gps": {}
},
"vat": "NO_VAT",
"deliveryServiceId": 0,
"logisticPointId": 1,
"liftType": "NOT_NEEDED",
"liftPrice": 0.5,
"outletCode": "example",
"outletStorageLimitDate": "23-09-2022",
"dispatchType": "UNKNOWN",
"tracks": [
{}
],
"shipments": [
{}
],
"estimated": true,
"eacType": "MERCHANT_TO_COURIER",
"eacCode": "example",
"receiveCode": "example"
},
"buyer": {
"id": "example",
"lastName": "example",
"firstName": "example",
"middleName": "example",
"email": "example",
"type": "PERSON"
},
"notes": "example",
"taxSystem": "OSN",
"cancelRequested": true,
"expiryDate": "23-09-2022 09:12:41",
"sourcePlatform": "MARKET"
}
],
"paging": {
"nextPageToken": "example"
}
}
|
Name |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
orders |
Type: object[]
The order model. Max items: Example
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
pager |
Type: object
A model for pagination. Example
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
paging |
Type: object
The ID of the next page. Example
|
400 Bad Request
The request contains incorrect data. Learn more about errors when working with orders
Body
application/json
{
"status": "OK"
}
Type: object
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
404 Not Found
The requested resource was not found. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Internal error of the Market. More information about the error
Body
application/json
{
"status": "OK"
}
Type: object
pathParams:
- description: "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.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) 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**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
name: campaignId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
searchParams:
- description: >
Filtering orders by IDs.
<br><br>
⚠️ Do not use this field at the same time as other filters.
If you want to use them, leave the field blank.
name: orderIds
in: query
required: false
schema:
type: array
items:
type: integer
format: int64
minItems: 1
maxItems: 50
- description: >
Order status:
* `CANCELLED` — The order has been
cancelled.
* `DELIVERED` — the order was received by
the buyer.
* `DELIVERY` — The order has been sent to
the delivery service.
* `PICKUP` — The order has been delivered to
the pick-up point.
* `PROCESSING` — the order is being
processed.
* `UNPAID` — the order has been placed, but
not yet paid (if payment is selected at checkout).
name: status
in: query
required: false
schema:
type: array
uniqueItems: true
items:
description: >
Order status:
* `PLACING` — It is being processed and
is being prepared for reservation.
* `RESERVED` — reserved, but
under-booked.
* `UNPAID` — issued, but not yet paid
(if payment is selected at checkout).
* `PROCESSING` — it is under processing.
* `DELIVERY` — transferred to the
delivery service.
* `PICKUP` — delivered to the pick-up
point.
* `DELIVERED` — received by the buyer.
* `CANCELLED` — cancelled.
* `PENDING` — awaiting processing by the
seller.
* `PARTIALLY_RETURNED` — partially
returned.
* `RETURNED` — returned in full.
* `UNKNOWN` — unknown status.
Other values may also be returned. You don't need to process them.
type: string
enum:
- PLACING
- RESERVED
- UNPAID
- PROCESSING
- DELIVERY
- PICKUP
- DELIVERED
- CANCELLED
- PENDING
- PARTIALLY_RETURNED
- RETURNED
- UNKNOWN
- description: >
Order processing stage (status `PROCESSING`) or the reason
for the cancellation of the order (status `CANCELLED`).
Possible values for the order in the status `PROCESSING`:
* `STARTED` — The order has been confirmed,
and it can be processed.
* `READY_TO_SHIP` — the order is assembled
and ready for shipment.
* `SHIPPED` — the order has been transferred
to the delivery service.
Possible values for the order in the status `CANCELLED`:
* `RESERVATION_EXPIRED` — The customer did
not complete the reserved order within 10 minutes.
* `USER_NOT_PAID` — the buyer did not pay
for the order (for the type of payment `PREPAID`) for 30
minutes.
* `USER_UNREACHABLE` — couldn't contact the
buyer. To cancel with this reason, the following conditions must be met:
* at least 3 calls from 8 to 21 in the buyer's time zone;
* the break between the first and third calls is at least 90 minutes;
* the connection is no shorter than 5 seconds.
If at least one of these conditions is not met (except when the number is unavailable), you will not be able to cancel the order. A response with error code 400 will be returned.
* `USER_CHANGED_MIND` — the customer
cancelled the order for personal reasons.
* `USER_REFUSED_DELIVERY` — the buyer was
not satisfied with the terms of delivery.
* `USER_REFUSED_PRODUCT` — the product did
not fit the buyer.
* `SHOP_FAILED` — the store cannot complete
the order.
* `USER_REFUSED_QUALITY` — the buyer was not
satisfied with the quality of the product.
* `REPLACING_ORDER` — the buyer decided to
replace the product with another one on his own initiative.
* `PROCESSING_EXPIRED` — the value is no
longer used.
* `PICKUP_EXPIRED` — the storage period of
the order in the PVZ has expired.
* `DELIVERY_SERVICE_UNDELIVERED` — The
delivery service was unable to deliver the order.
* `CANCELLED_COURIER_NOT_FOUND` — couldn't
find the courier.
* `USER_WANTS_TO_CHANGE_DELIVERY_DATE` — the
customer wants to receive the order on another day.
* `RESERVATION_FAILED` — The Market cannot
continue further processing of the order.
name: substatus
in: query
required: false
schema:
type: array
uniqueItems: true
items:
description: >
Order processing stage (status `PROCESSING`) or the
reason for the cancellation of the order (status
`CANCELLED`).
* Order values in the status `PROCESSING`:
* `STARTED` — The order has been confirmed, and it can be processed.
* `READY_TO_SHIP` — the order is assembled and ready for shipment.
* Order values in the status `CANCELLED`:
* `RESERVATION_EXPIRED` — The customer did not complete the reserved order within 10 minutes.
* `USER_NOT_PAID` — the buyer did not pay for the order (for the payment type `PREPAID`) for 30 minutes.
* `USER_UNREACHABLE` — couldn't contact the buyer. To cancel with this reason, the following conditions must be met:
* at least 3 calls from 8 to 21 in the buyer's time zone;
* the break between the first and third calls is at least 90 minutes;
* the connection is no shorter than 5 seconds.
If at least one of these conditions is not met (except when the number is unavailable), you will not be able to cancel the order. A response with the error code 400 will be returned.
* `USER_CHANGED_MIND` — the customer cancelled the order for personal reasons.
* `USER_REFUSED_DELIVERY` — the buyer was not satisfied with the terms of delivery.
* `USER_REFUSED_PRODUCT` — the product did not fit the buyer.
* `SHOP_FAILED` — the store cannot complete the order.
* `USER_REFUSED_QUALITY` — the buyer was not satisfied with the quality of the product.
* `REPLACING_ORDER` — the buyer decided to replace the product with another one on his own initiative.
* `PROCESSING_EXPIRED` — the value is no longer used.
* `PICKUP_EXPIRED` — The shelf life of the order at the pick-up point has expired.
* `TOO_MANY_DELIVERY_DATE_CHANGES` — the order has been postponed too many times.
* `TOO_LONG_DELIVERY` — The order is taking too long to be delivered.
* `INCORRECT_PERSONAL_DATA` — For an order from abroad, the recipient's information is incorrect, and the order will not be checked at customs.
* `TECHNICAL_ERROR` — a technical error
on the Market's side. Contact support.
Other values may also be returned. You don't need to process them.
type: string
enum:
- RESERVATION_EXPIRED
- USER_NOT_PAID
- USER_UNREACHABLE
- USER_CHANGED_MIND
- USER_REFUSED_DELIVERY
- USER_REFUSED_PRODUCT
- SHOP_FAILED
- USER_REFUSED_QUALITY
- REPLACING_ORDER
- PROCESSING_EXPIRED
- PENDING_EXPIRED
- SHOP_PENDING_CANCELLED
- PENDING_CANCELLED
- USER_FRAUD
- RESERVATION_FAILED
- USER_PLACED_OTHER_ORDER
- USER_BOUGHT_CHEAPER
- MISSING_ITEM
- BROKEN_ITEM
- WRONG_ITEM
- PICKUP_EXPIRED
- DELIVERY_PROBLEMS
- LATE_CONTACT
- CUSTOM
- DELIVERY_SERVICE_FAILED
- WAREHOUSE_FAILED_TO_SHIP
- DELIVERY_SERVICE_UNDELIVERED
- PREORDER
- AWAIT_CONFIRMATION
- STARTED
- PACKAGING
- READY_TO_SHIP
- SHIPPED
- ASYNC_PROCESSING
- WAITING_USER_INPUT
- WAITING_BANK_DECISION
- BANK_REJECT_CREDIT_OFFER
- CUSTOMER_REJECT_CREDIT_OFFER
- CREDIT_OFFER_FAILED
- AWAIT_DELIVERY_DATES_CONFIRMATION
- SERVICE_FAULT
- DELIVERY_SERVICE_RECEIVED
- USER_RECEIVED
- WAITING_FOR_STOCKS
- AS_PART_OF_MULTI_ORDER
- READY_FOR_LAST_MILE
- LAST_MILE_STARTED
- ANTIFRAUD
- DELIVERY_USER_NOT_RECEIVED
- DELIVERY_SERVICE_DELIVERED
- DELIVERED_USER_NOT_RECEIVED
- USER_WANTED_ANOTHER_PAYMENT_METHOD
- USER_RECEIVED_TECHNICAL_ERROR
- USER_FORGOT_TO_USE_BONUS
- DELIVERY_SERVICE_NOT_RECEIVED
- DELIVERY_SERVICE_LOST
- SHIPPED_TO_WRONG_DELIVERY_SERVICE
- DELIVERED_USER_RECEIVED
- WAITING_TINKOFF_DECISION
- COURIER_SEARCH
- COURIER_FOUND
- COURIER_IN_TRANSIT_TO_SENDER
- COURIER_ARRIVED_TO_SENDER
- COURIER_RECEIVED
- COURIER_NOT_FOUND
- COURIER_NOT_DELIVER_ORDER
- COURIER_RETURNS_ORDER
- COURIER_RETURNED_ORDER
- WAITING_USER_DELIVERY_INPUT
- PICKUP_SERVICE_RECEIVED
- PICKUP_USER_RECEIVED
- CANCELLED_COURIER_NOT_FOUND
- COURIER_NOT_COME_FOR_ORDER
- DELIVERY_NOT_MANAGED_REGION
- INCOMPLETE_CONTACT_INFORMATION
- INCOMPLETE_MULTI_ORDER
- INAPPROPRIATE_WEIGHT_SIZE
- TECHNICAL_ERROR
- SORTING_CENTER_LOST
- COURIER_SEARCH_NOT_STARTED
- LOST
- AWAIT_PAYMENT
- AWAIT_LAVKA_RESERVATION
- USER_WANTS_TO_CHANGE_ADDRESS
- FULL_NOT_RANSOM
- PRESCRIPTION_MISMATCH
- DROPOFF_LOST
- DROPOFF_CLOSED
- DELIVERY_TO_STORE_STARTED
- USER_WANTS_TO_CHANGE_DELIVERY_DATE
- WRONG_ITEM_DELIVERED
- DAMAGED_BOX
- AWAIT_DELIVERY_DATES
- LAST_MILE_COURIER_SEARCH
- PICKUP_POINT_CLOSED
- LEGAL_INFO_CHANGED
- USER_HAS_NO_TIME_TO_PICKUP_ORDER
- DELIVERY_CUSTOMS_ARRIVED
- DELIVERY_CUSTOMS_CLEARED
- FIRST_MILE_DELIVERY_SERVICE_RECEIVED
- AWAIT_AUTO_DELIVERY_DATES
- AWAIT_USER_PERSONAL_DATA
- NO_PERSONAL_DATA_EXPIRED
- CUSTOMS_PROBLEMS
- AWAIT_CASHIER
- WAITING_POSTPAID_BUDGET_RESERVATION
- AWAIT_SERVICEABLE_CONFIRMATION
- POSTPAID_BUDGET_RESERVATION_FAILED
- AWAIT_CUSTOM_PRICE_CONFIRMATION
- READY_FOR_PICKUP
- TOO_MANY_DELIVERY_DATE_CHANGES
- TOO_LONG_DELIVERY
- DEFERRED_PAYMENT
- POSTPAID_FAILED
- INCORRECT_PERSONAL_DATA
- UNKNOWN
- description: >
The starting date for filtering orders by checkout date.
Date format: `DD-MM-YYYY`.
Between the start and end date (parameter `toDate`) should
be no more than 30 days old.
Default value: 30 days ago from the current date.
name: fromDate
in: query
required: false
schema:
type: string
format: date
- description: >
The end date for filtering orders by checkout date.
Orders created before 00:00 of the specified day are shown.
Date format: `DD-MM-YYYY`.
Between the initial (parameter `fromDate`) and the end date
should be no more than 30 days.
Default value: current date.
If the time interval between `toDate` and
`fromDate` less than a day, then `toDate`
equal to `fromDate` + a day.
name: toDate
in: query
required: false
schema:
type: string
format: date
- description: >
The starting date for filtering orders by the date of shipment to the
delivery service (parameter `shipmentDate`).
Date format: `DD-MM-YYYY`.
Between the start and end date (parameter
`supplierShipmentDateTo`) should be no more than 30 days
old.
The start date is included in the interval for filtering.
name: supplierShipmentDateFrom
in: query
required: false
schema:
type: string
format: date
- description: >
The end date for filtering orders by the date of shipment to the delivery
service (parameter `shipmentDate`).
Date format: `DD-MM-YYYY`.
Between the initial (parameter `supplierShipmentDateFrom`)
and the end date should be no more than 30 days.
The end date is not included in the filtering interval.
If the time interval between `supplierShipmentDateTo` and
`supplierShipmentDateFrom` less than a day, then
`supplierShipmentDateTo` equal to
`supplierShipmentDateFrom` + a day.
name: supplierShipmentDateTo
in: query
required: false
schema:
type: string
format: date
- description: >
The starting date for filtering orders by date and time of the update
(parameter `updatedAt`).
Date format: ISO 8601 with an offset relative to
UTC. For example, `2017-11-21T00:42:42+03:00`.
Between the start and end date (parameter `updatedAtTo`)
should be no more than 30 days old.
The start date is included in the interval for filtering.
name: updatedAtFrom
in: query
required: false
schema:
type: string
format: date-time
- description: >
The end date for filtering orders by date and time of the update
(parameter `updatedAt`).
Date format: ISO 8601 with an offset relative to
UTC. For example, `2017-11-21T00:42:42+03:00`.
Between the initial (parameter `updatedAtFrom`) and the end
date should be no more than 30 days.
The end date is not included in the filtering interval.
name: updatedAtTo
in: query
required: false
schema:
type: string
format: date-time
- description: Shipping method
name: dispatchType
in: query
required: false
schema:
description: >
Shipping method:
* `BUYER` — courier delivery to the buyer.
* `MARKET_BRANDED_OUTLET` — delivery to
the pick-up point of the Market.
* `SHOP_OUTLET` — delivery to the store's
order pick-up point.
* `UNKNOWN` — unknown type.
type: string
enum:
- UNKNOWN
- BUYER
- MARKET_BRANDED_OUTLET
- SHOP_OUTLET
- description: >
Filtering orders by type:
* `false` — the real customer's order.
* `true` — [test
order](../../concepts/sandbox.md) Yandex. Market.
name: fake
in: query
required: false
schema:
type: boolean
default: false
- description: >
A filter for receiving orders that contain at least one product with an
identification code in the system. [«Честный
ЗНАК»](https://честныйзнак.рф/) or [«ASL
BELGISI»](https://aslbelgisi.uz) (for sellers
Market Yandex Go):
* `true` — Yes.
* `false` — No.
Such codes are assigned to products that are subject to labeling and
belong to certain categories.
name: hasCis
in: query
required: false
schema:
type: boolean
default: false
- description: "**For the model only DBS**\n\nA filter for receiving orders for which there was a cancellation request.\n\nWith the value `true` only orders with the following status are returned `DELIVERY` or `PICKUP` and which the users decided to cancel.\n\nTo confirm or reject the cancellation, send a request [PUT\_v2/campaigns/{campaignId}/orders/{orderId}/cancellation/accept](../../reference/orders/acceptOrderCancellation).\n"
name: onlyWaitingForCancellationApprove
in: query
required: false
schema:
type: boolean
default: false
- description: >
Filtering orders with long delivery (31-60 days) by confirmed delivery
date:
* `true` — Only orders with an unconfirmed
delivery date are returned.
* `false` — filtering is not applied.
name: onlyEstimatedDelivery
in: query
required: false
schema:
type: boolean
default: false
- description: |
Filtering orders by customer type.
name: buyerType
in: query
required: false
schema:
description: |
Type of buyer:
* `PERSON` — a natural person.
* `BUSINESS` — organization.
type: string
enum:
- PERSON
- BUSINESS
- name: page
description: >
{% note warning "If the method has `page_token`" %}
Use it instead of the parameter `page`.
[Learn more about the types of pagination and their
use](../../concepts/pagination.md)
{% endnote %}
The number of the results page.
Used together with the parameter `pageSize`.
`page` ignored if specified `page_token` or
`limit`.
in: query
required: false
schema:
type: integer
format: int32
default: 1
maximum: 10000
- name: pageSize
description: >
Page size.
Used together with the parameter `page`.
`pageSize` ignored if specified `page_token`
or `limit`.
in: query
required: false
schema:
type: integer
format: int32
- name: page_token
description: >
ID of the results page.
If the parameter is omitted, the first page is returned.
We recommend transmitting the value of the output parameter
`nextPageToken`, received during the last request.
If set `page_token` and the request has parameters
`page` and `pageSize` they are ignored.
in: query
required: false
example: eyBuZXh0SWQ6IDIzNDIgfQ==
schema:
type: string
- name: limit
description: |
The number of values per page.
in: query
required: false
example: 20
schema:
type: integer
format: int32
minimum: 1
headers: []
body: null
schema: {}
method: get
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}/orders
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.
The security tag helps to prevent the product from being replaced upon return. You will not be able to return the product without the protective tag that was present at the time of purchase.