Information about multiple 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

Returns information about orders. You can use the query to find out if there are any new orders.

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 this method or GET campaigns/{campaignId}/orders/{orderId}.

How to work with notifications

Filtering by several order characteristics is available:

  • the date of registration;

  • status;

  • order IDs;

  • the stage of processing or the reason for cancellation;

  • type (real or test);

  • the date of shipment to the delivery service;

  • the date and time of the order update.

Information about orders delivered or cancelled more than 30 days ago will not be refunded. It can be obtained by requesting information about a particular order. GET campaigns/{campaignId}/orders/{orderId} (if you have an order ID) or request an order report POST campaigns/{campaignId}/stats/orders.

The maximum date range for a single resource request is 30 days.

The results are returned page by page. To navigate through the pages, use the parameters page_token and limit.

You can get more detailed information about the buyer and his phone number by requesting GET 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/campaigns/{campaignId}/orders

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:

  • Modules and APIs → block Sending data to Yandex.Market.
  • Query log → drop-down list in the block Show logs.

, Do not send the store's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports.

Min value: 1

Query parameters

Name

Description

buyerType

Type: OrderBuyerType

Filtering orders by customer type.

dispatchType

Type: OrderDeliveryDispatchType

Shipping method

fake

Type: boolean

Filtering orders by type:

  • false — the real customer's order.

  • true — test the Market order.

Default: false

fromDate

Type: string<date>

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.

hasCis

Type: boolean

Do I need to return only those orders that contain at least one item with an identification code in the system? "An honest SIGN" or «ASL BELGISI» (for sellers of the Yandex Go Market):

  • true - yes.

  • false - no.

Such codes are assigned to products that are subject to labeling and belong to certain categories.

Default: false

limit

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

onlyEstimatedDelivery

Type: boolean

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.

Default: false

onlyWaitingForCancellationApprove

Type: boolean

Only for the DBS model

Filtering orders based on customer requests for cancellation.

With the value true only orders with the following status are returned DELIVERY or PICKUP and which the users decided to cancel.

To confirm or reject the cancellation, send a request PUT campaigns/{campaignId}/orders/{orderId}/cancellation/accept.

Default: false

orderIds

Type: integer<int64>[]

Filtering orders by IDs.

, Do not use this field at the same time as other filters. If you want to use them, leave the field empty.

Min items: 1

Max items: 50

page

Type: integer<int32>

If the method has page_token

Use it instead of the parameter page.

Learn more about the types of pagination and their use

The number of the results page.

Used together with the parameter pageSize.

page ignored if specified page_token or limit.

Default: 1

Max value: 10000

pageSize

Type: integer<int32>

Page size.

Used together with the parameter page.

pageSize ignored if specified page_token or limit.

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 nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

status

Type: OrderStatusType[]

Order status:

  • CANCELLED — the order has been cancelled.

  • DELIVERED — the order has been 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).

substatus

Type: OrderSubstatusType[]

The stage of order processing (if it has the status PROCESSING) or the reason for the cancellation of the order (if it has the 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 collected 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 has not paid 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 could not 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.

supplierShipmentDateFrom

Type: string<date>

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.

supplierShipmentDateTo

Type: string<date>

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.

toDate

Type: string<date>

The end date for filtering orders by checkout date.

Orders created before 00:00 on 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.

updatedAtFrom

Type: string<date-time>

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.

updatedAtTo

Type: string<date-time>

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.

OrderBuyerType

Type of buyer:

  • PERSON — an individual.

  • BUSINESS — organization.

Type

Description

OrderBuyerType

Enum: PERSON, BUSINESS

OrderDeliveryDispatchType

Shipping method:

  • BUYER — 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

Description

OrderDeliveryDispatchType

Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET

OrderStatusType

Order status:

  • PLACING — it is being processed, preparing for the 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. They do not need to be processed.

Type

Description

OrderStatusType

Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

OrderSubstatusType

The stage of order processing (if it has the status PROCESSING) or the reason for the cancellation of the order (if it has the 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 collected 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 has not paid 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 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 storage period of the order in the PVZ 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.

  • TECHNICAL_ERROR — a technical error on the Market's side. Contact support.

Other values may also be returned. They do not need to be processed.

Type

Description

OrderSubstatusType

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, UNKNOWN

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": "string",
            "status": "PLACING",
            "substatus": "RESERVATION_EXPIRED",
            "creationDate": "23-09-2022 09:12:41",
            "updatedAt": "23-09-2022 09:12:41",
            "currency": "RUR",
            "itemsTotal": 0,
            "deliveryTotal": 0,
            "buyerItemsTotal": 0,
            "buyerTotal": 0,
            "buyerItemsTotalBeforeDiscount": 0,
            "buyerTotalBeforeDiscount": 0,
            "paymentType": "PREPAID",
            "paymentMethod": "CASH_ON_DELIVERY",
            "fake": false,
            "items": [
                {
                    "id": 0,
                    "offerId": "string",
                    "offerName": "string",
                    "price": 0,
                    "buyerPrice": 0,
                    "buyerPriceBeforeDiscount": 0,
                    "priceBeforeDiscount": 0,
                    "count": 0,
                    "vat": "NO_VAT",
                    "shopSku": "string",
                    "subsidy": 0,
                    "partnerWarehouseId": "string",
                    "promos": [
                        {
                            "type": "DIRECT_DISCOUNT",
                            "discount": 0,
                            "subsidy": 0,
                            "shopPromoId": "string",
                            "marketPromoId": "string"
                        }
                    ],
                    "instances": [
                        {
                            "cis": "string",
                            "cisFull": "string",
                            "uin": "string",
                            "rnpt": "string",
                            "gtd": "string",
                            "countryCode": "RU"
                        }
                    ],
                    "details": [
                        {
                            "itemCount": 0,
                            "itemStatus": "REJECTED",
                            "updateDate": "23-09-2022"
                        }
                    ],
                    "subsidies": [
                        {
                            "type": "YANDEX_CASHBACK",
                            "amount": 0
                        }
                    ],
                    "requiredInstanceTypes": [
                        "CIS"
                    ],
                    "tags": [
                        "ULTIMA"
                    ]
                }
            ],
            "subsidies": [
                {
                    "type": "YANDEX_CASHBACK",
                    "amount": 0
                }
            ],
            "delivery": {
                "id": "string",
                "type": "DELIVERY",
                "serviceName": "string",
                "price": 0,
                "deliveryPartnerType": "SHOP",
                "courier": {
                    "fullName": "string",
                    "phone": "string",
                    "phoneExtension": "string",
                    "vehicleNumber": "string",
                    "vehicleDescription": "string"
                },
                "dates": {
                    "fromDate": "23-09-2022",
                    "toDate": "23-09-2022",
                    "fromTime": "string",
                    "toTime": "string",
                    "realDeliveryDate": "23-09-2022"
                },
                "region": {
                    "id": 0,
                    "name": "string",
                    "type": "OTHER",
                    "parent": {
                        "id": 0,
                        "name": "string",
                        "type": "OTHER",
                        "children": [
                            null
                        ]
                    },
                    "children": [
                        null
                    ]
                },
                "address": {
                    "country": "string",
                    "postcode": "string",
                    "city": "string",
                    "district": "string",
                    "subway": "string",
                    "street": "string",
                    "house": "string",
                    "estate": "string",
                    "block": "string",
                    "building": "string",
                    "entrance": "string",
                    "entryphone": "string",
                    "floor": "string",
                    "apartment": "string",
                    "phone": "string",
                    "recipient": "string",
                    "gps": {
                        "latitude": 0,
                        "longitude": 0
                    }
                },
                "vat": "NO_VAT",
                "deliveryServiceId": 0,
                "liftType": "NOT_NEEDED",
                "liftPrice": 0,
                "outletCode": "string",
                "outletStorageLimitDate": "23-09-2022",
                "dispatchType": "UNKNOWN",
                "tracks": [
                    {
                        "trackCode": "string",
                        "deliveryServiceId": 0
                    }
                ],
                "shipments": [
                    {
                        "id": 0,
                        "shipmentDate": "23-09-2022",
                        "shipmentTime": "string",
                        "tracks": [
                            {
                                "trackCode": "string",
                                "deliveryServiceId": 0
                            }
                        ],
                        "boxes": [
                            {
                                "id": 0,
                                "fulfilmentId": "string"
                            }
                        ]
                    }
                ],
                "estimated": false,
                "eacType": "MERCHANT_TO_COURIER",
                "eacCode": "string"
            },
            "buyer": {
                "id": "string",
                "lastName": "string",
                "firstName": "string",
                "middleName": "string",
                "type": "PERSON"
            },
            "notes": "string",
            "taxSystem": "OSN",
            "cancelRequested": false,
            "expiryDate": "23-09-2022 09:12:41"
        }
    ],
    "paging": {
        "nextPageToken": "string"
    }
}

Name

Description

orders*

Type: OrderDTO[]

The order model.
Order.

Max items: 50

pager

Type: FlippingPagerDTO

A model for pagination.

paging

Type: ForwardScrollingPagerDTO

Information about the result pages.

OrderDTO

Order.

Name

Description

buyer*

Type: OrderBuyerDTO

Information about the buyer.

Parameters id, lastName, firstName and middleName they are returned only if you use the DBS model.
Information about the buyer with basic fields.

buyerItemsTotalBeforeDiscount*

Type: number<decimal>

The cost of all items in the order in the buyer's currency, excluding shipping costs and before applying discounts on:

  • shares;
  • coupons;
  • promo codes.

creationDate*

Type: string<date-dd-MM-yyyy-HH-mm-ss>

The date and time of the order.

Date and time format: DD-MM-YYYY HH:MM:SS. The time zone is UTC+03:00 (Moscow).

Example: 23-09-2022 09:12:41

currency*

Type: CurrencyType

The currency in which the prices of the goods in the order are indicated.

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, UE

delivery*

Type: OrderDeliveryDTO

Delivery information.

deliveryTotal*

Type: number<decimal>

The cost of delivery.

fake*

Type: boolean

Order type:

  • false — the real customer's order.

  • true — test the Market order.

id*

Type: integer<int64>

The order ID.

items*

Type: OrderItemDTO[]

The list of products in the order.
The list of products in the order.

itemsTotal*

Type: number<decimal>

Buyer's payment.

paymentMethod*

Type: OrderPaymentMethodType

Order payment method:

  • Values if payment is selected at checkout ("paymentType": "PREPAID"):

    • YANDEX — by bank card.

    • APPLE_PAY — Apple Pay.

    • GOOGLE_PAY — Google Pay.

    • CREDIT — on credit.

    • TINKOFF_CREDIT — on credit at Tinkoff Bank.

    • TINKOFF_INSTALLMENTS — installments at Tinkoff Bank.

    • EXTERNAL_CERTIFICATE — a gift certificate (for example, from the Sberbank Online application).

    • SBP — through the fast payment system.

    • B2B_ACCOUNT_PREPAYMENT — the organization pays for the order.

  • Values if payment is selected upon receipt of the order ("paymentType": "POSTPAID"):

    • CARD_ON_DELIVERY — by bank card.

    • BOUND_CARD_ON_DELIVERY — linked bank card upon receipt.

    • BNPL_BANK_ON_DELIVERY — super Split.

    • BNPL_ON_DELIVERY — Split.

    • CASH_ON_DELIVERY — in cash.

    • B2B_ACCOUNT_POSTPAYMENT — the order is paid for by the organization after delivery.

  • UNKNOWN — unknown type.

Default value: CASH_ON_DELIVERY.

Enum: CASH_ON_DELIVERY, CARD_ON_DELIVERY, BOUND_CARD_ON_DELIVERY, BNPL_BANK_ON_DELIVERY, BNPL_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, UNKNOWN

paymentType*

Type: OrderPaymentType

Order payment type:

  • PREPAID — payment at checkout.

  • POSTPAID — payment upon receipt of the order.

  • UNKNOWN — unknown type.

If this parameter is omitted, the order will be paid upon receipt.

Enum: PREPAID, POSTPAID, UNKNOWN

status*

Type: OrderStatusType

Order status:

  • PLACING — it is being processed, preparing for the 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. They do not need to be processed.

Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

substatus*

Type: OrderSubstatusType

The stage of order processing (if it has the status PROCESSING) or the reason for the cancellation of the order (if it has the 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 collected 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 has not paid 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 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 storage period of the order in the PVZ 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.

  • TECHNICAL_ERROR — a technical error on the Market's side. Contact support.

Other values may also be returned. They do not need to be processed.

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, UNKNOWN

taxSystem*

Type: OrderTaxSystemType

The store's taxation system at the time of placing the order:

  • ECHN — the Unified Agricultural Tax (UST).

  • ENVD — the unified imputed income tax (UTII).

  • OSN — the general taxation system.

  • PSN — Patent Taxation System (PSN).

  • USN — simplified taxation system (STS).

  • USN_MINUS_COST — simplified taxation system, income reduced by the amount of expenses (USN "Income minus expenses").

  • NPD — Professional Income Tax (NAP).

  • UNKNOWN_VALUE — unknown value. Used only in conjunction with the parameter payment-method=YANDEX.

Enum: OSN, USN, USN_MINUS_COST, ENVD, ECHN, PSN, NPD, UNKNOWN_VALUE

buyerItemsTotal

⦸

Type: number<decimal>

The cost of all items in the order is in the buyer's currency after applying discounts and excluding shipping costs.

buyerTotal

⦸

Type: number<decimal>

The cost of all items in the order in the buyer's currency after applying the discounts and taking into account the shipping cost.

buyerTotalBeforeDiscount

⦸

Type: number<decimal>

The cost of all items in the order in the buyer's currency before applying discounts and including shipping costs (buyerItemsTotalBeforeDiscount + shipping cost).

cancelRequested

Type: boolean

Only for the DBS model

Whether a cancellation has been requested.

expiryDate

Type: string<date-dd-MM-yyyy-HH-mm-ss>

The date after which the order will be cancelled if the status does not change.

Date format: DD-MM-YYYY.

Example: 23-09-2022 09:12:41

externalOrderId

Type: string

The external ID of the order that you submitted to POST campaigns/{campaignId}/orders/{orderId}/external-id.

Min length: 1

notes

Type: string

Comment on the order.

subsidies

Type: OrderSubsidyDTO[]

List of subsidies by type.
Total remuneration to the seller for DBS delivery and all discounts on the product:

  • by promo codes, coupons, and promotions;
  • by Plus points;
  • on Delivery (DBS).

Includes VAT.

Min items: 1

updatedAt

Type: string<date-dd-MM-yyyy-HH-mm-ss>

The date and time of the last order update.

Date and time format: DD-MM-YYYY HH:MM:SS. The time zone is UTC+03:00 (Moscow).

Example: 23-09-2022 09:12:41

FlippingPagerDTO

A model for pagination.

Name

Description

currentPage

Type: integer<int32>

The current page.

from

Type: integer<int32>

The initial number of the found element on the page.

pageSize

Type: integer<int32>

Page size.

pagesCount

Type: integer<int32>

The total number of pages.

to

Type: integer<int32>

The final number of the found element on the page.

total

Type: integer<int32>

How many items were found in total.

ForwardScrollingPagerDTO

The ID of the next page.

Name

Description

nextPageToken

Type: string

ID of the next results page.

OrderBuyerDTO

Information about the buyer.

Parameters id, lastName, firstName and middleName they are returned only if you use the DBS model.

Name

Description

type*

Type: OrderBuyerType

Buyer type: individual or organization. This parameter is used by FBS and FBY stores that place products on the business.market showcase.yandex.ru.

Enum: PERSON, BUSINESS

firstName

Type: string

The buyer's name.

id

Type: string

The buyer's ID.

lastName

Type: string

Last name of the buyer.

middleName

Type: string

Patronymic of the buyer.

CurrencyType

Currency codes:

  • RUR — Russian ruble.
  • UAH — the Ukrainian hryvnia.
  • BYR — Belarusian ruble.
  • KZT — Kazakhstani tenge.
  • UZS — Uzbek sum.

Type

Description

CurrencyType

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, UE

OrderDeliveryDTO

Delivery information.

Name

Description

dates*

Type: OrderDeliveryDatesDTO

The range of delivery dates.

deliveryPartnerType*

Type: OrderDeliveryPartnerType

The type of cooperation with the delivery service within a specific order.

Enum: SHOP, YANDEX_MARKET, UNKNOWN

deliveryServiceId*

Type: integer<int64>

The delivery service ID.

serviceName*

Type: string

The name of the delivery service.

type*

Type: OrderDeliveryType

Order delivery method.

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

address

Type: OrderDeliveryAddressDTO

The delivery address.

Is specified if the parameter type takes the value DELIVERY, POST or PICKUP (only for the DBS model). If type=PICKUP, the address of the pick-up point is returned.

courier

Type: OrderCourierDTO

Information about the courier.

dispatchType

Type: OrderDeliveryDispatchType

Shipping method:

  • BUYER — 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.

Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET

eacCode

Type: string

EAPP confirmation code (for type MERCHANT_TO_COURIER).

eacType

Type: OrderDeliveryEacType

The type of the EAPP confirmation code.

Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

estimated

Type: boolean

Whether the delivery date is approximate.

id

⦸

Type: string

The delivery ID assigned by the store.

It is specified only if the store passed this identifier in the response to the request using the method POST cart.

liftPrice

Type: number<decimal>

The cost of going up to the floor.

liftType

Type: OrderLiftType

The type of lifting the order to the floor:

  • NOT_NEEDED — not required.

  • MANUAL — manual.

  • ELEVATOR — the elevator.

  • CARGO_ELEVATOR — freight elevator.

  • FREE — any of the above, if the free lift option is enabled.

  • UNKNOWN — unknown type.

Enum: NOT_NEEDED, MANUAL, ELEVATOR, CARGO_ELEVATOR, FREE, UNKNOWN

outletCode

Type: string

The pick-up point ID assigned by the store.

outletStorageLimitDate

Type: string<date-dd-MM-yyyy>

Date format: DD-MM-YYYY.

Example: 23-09-2022

price

⦸

Type: number<decimal>

See the shipping cost in the parameter deliveryTotal.

The cost of delivery in the currency of the order.

region

Type: RegionDTO

The delivery region.

shipments

Type: OrderShipmentDTO[]

Information about parcels.
The package list.

Multiple parcels can be specified in the parameter.

Min items: 1

tracks

Type: OrderTrackDTO[]

Information for tracking parcel movements.
Information about the parcel's track number (DBS).

Min items: 1

vat

Type: OrderVatType

Value added tax (VAT) on the product:

  • NO_VAT — VAT is not charged, it is used only for certain types of services.

  • VAT_0 — 0% VAT. For example, it is used for the sale of goods exported in the customs procedure of export, or for the provision of services for the international transportation of goods.

  • VAT_10 — 10% VAT. For example, it is used in the sale of certain food and medical products.

  • VAT_10_110 — VAT 10/110. 10% VAT, applicable only for prepayment.

  • VAT_20 — 20% VAT. Basic VAT starting in 2019.

  • VAT_20_120 — VAT 20/120. VAT is 20%, applicable only for prepayment.

  • VAT_18 — VAT 18%. Basic VAT until 2019.

  • VAT_18_118 — VAT 18/118. VAT was used until January 1, 2019 for prepayment.

  • VAT_12 — 12% VAT. It is used only in Uzbekistan.

  • VAT_05 — 5% VAT. VAT for the simplified taxation system (USN).

  • VAT_07 — 7% VAT. VAT for the simplified taxation system (USN).

  • UNKNOWN_VALUE — unknown type.

Used only in conjunction with the parameter payment-method=YANDEX.

Enum: NO_VAT, VAT_0, VAT_10, VAT_10_110, VAT_20, VAT_20_120, VAT_18, VAT_18_118, VAT_12, VAT_05, VAT_07, UNKNOWN_VALUE

OrderItemDTO

The list of products in the order.

Name

Description

buyerPrice*

Type: number<decimal>

The price of the product in the buyer's currency. The price already includes discounts on:

  • shares;
  • coupons;
  • promo codes.

buyerPriceBeforeDiscount*

Type: number<decimal>

The cost of the product in the buyer's currency before applying discounts on:

  • shares;
  • coupons;
  • promo codes.

count*

Type: integer

The number of product units.

id*

Type: integer<int64>

The product ID in the order.

Allows you to identify the product within the scope of this order.

offerId*

Type: string

The ID of your product offer for a specific product. Description of the field in the Help of the Market for sellers

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

offerName*

Type: string

Product name.

price*

Type: number<decimal>

The price of the product in the order currency, excluding remuneration to the seller for discounts on promo codes, coupons and promotions (parameter subsidies).

Includes VAT.

vat*

Type: OrderVatType

Value added tax (VAT) on the product.

Enum: NO_VAT, VAT_0, VAT_10, VAT_10_110, VAT_20, VAT_20_120, VAT_18, VAT_18_118, VAT_12, VAT_05, VAT_07, UNKNOWN_VALUE

details

⦸

Type: OrderItemDetailDTO[]

To get information about non-purchases and refunds, use GET campaigns/{campaignId}/returns.

Information about non-purchased or returned items in the order.
Product details in the order.

Min items: 1

instances

Type: OrderItemInstanceDTO[]

Information about the labeling of product units.

The tagging data passed in the request is returned. PUT campaigns/{campaignId}/orders/{orderId}/identifiers.

If the store has not sent the codes for this order yet, instances absent.
The marking or fault codes you have provided for this position. The "Honest Sign" codes are returned in two versions — with and without a cryptotail.

Min items: 1

partnerWarehouseId

⦸

Type: string

The ID of the warehouse in the store's system that the order was placed for.

priceBeforeDiscount

⦸

Type: number<decimal>

The cost of the product in the store's currency before applying the discounts.

promos

Type: OrderItemPromoDTO[]

Information about rewards to the seller for discounts on goods using promo codes, coupons, and promotions.
Information about rewards to the seller for discounts on goods using promo codes, coupons, and promotions.

Min items: 1

requiredInstanceTypes

Type: OrderItemInstanceType[]

A list of required product markings.
Type of product labeling:

  • CIS — KIZ, the identifier of the product unit in the system "An honest SIGN" or «ASL BELGISI» (for sellers of the Yandex Go Market). Required to fill in.

  • CIS_OPTIONAL — KIZ, the identifier of the product unit in the system "An honest SIGN". It is optional to fill out, but it will be required to transfer it in the near future.

  • UIN — WIN, a unique identification number.

  • RNPT — RNPT, the batch registration number.

  • GTD — GTD number, cargo customs declaration.

Enum: CIS, CIS_OPTIONAL, UIN, RNPT, GTD

Min items: 1

Unique items  

shopSku

⦸

Type: string

Instead, use offerId.

Your SKU is the product identifier in your system.

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

subsidies

Type: OrderItemSubsidyDTO[]

List of subsidies by type.
Total remuneration to the seller for all discounts on the product:

  • by promo codes, coupons, and promotions;
  • Plus points.

Includes VAT.

Min items: 1

subsidy

⦸

Type: number<decimal>

Instead, use subsidies.

Total remuneration to the seller for DBS delivery and all discounts on the product:

  • by promo codes;
  • by coupons;
  • by Plus points;
  • on shares.

tags

Type: OrderItemTagType[]

Product attributes.
Product attribute:

  • ULTIMA — premium product.
  • SAFE_TAG — product with a protective tag.
  • TURBO — a product that sells out quickly.

Enum: ULTIMA, SAFE_TAG, TURBO

Min items: 1

Unique items  

OrderPaymentMethodType

Order payment method:

  • Values if payment is selected at checkout ("paymentType": "PREPAID"):

    • YANDEX — by bank card.

    • APPLE_PAY — Apple Pay.

    • GOOGLE_PAY — Google Pay.

    • CREDIT — on credit.

    • TINKOFF_CREDIT — on credit at Tinkoff Bank.

    • TINKOFF_INSTALLMENTS — installments at Tinkoff Bank.

    • EXTERNAL_CERTIFICATE — a gift certificate (for example, from the Sberbank Online application).

    • SBP — through the fast payment system.

    • B2B_ACCOUNT_PREPAYMENT — the organization pays for the order.

  • Values if payment is selected upon receipt of the order ("paymentType": "POSTPAID"):

    • CARD_ON_DELIVERY — by bank card.

    • BOUND_CARD_ON_DELIVERY — linked bank card upon receipt.

    • BNPL_BANK_ON_DELIVERY — super Split.

    • BNPL_ON_DELIVERY — Split.

    • CASH_ON_DELIVERY — in cash.

    • B2B_ACCOUNT_POSTPAYMENT — the order is paid for by the organization after delivery.

  • UNKNOWN — unknown type.

Default value: CASH_ON_DELIVERY.

Type

Description

OrderPaymentMethodType

Enum: CASH_ON_DELIVERY, CARD_ON_DELIVERY, BOUND_CARD_ON_DELIVERY, BNPL_BANK_ON_DELIVERY, BNPL_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, GOOGLE_PAY, TINKOFF_CREDIT, SBP, TINKOFF_INSTALLMENTS, B2B_ACCOUNT_PREPAYMENT, B2B_ACCOUNT_POSTPAYMENT, UNKNOWN

OrderPaymentType

Order payment type:

  • PREPAID — payment at checkout.

  • POSTPAID — payment upon receipt of the order.

  • UNKNOWN — unknown type.

If this parameter is omitted, the order will be paid upon receipt.

Type

Description

OrderPaymentType

Enum: PREPAID, POSTPAID, UNKNOWN

OrderTaxSystemType

The store's taxation system at the time of placing the order:

  • ECHN — the Unified Agricultural Tax (UST).

  • ENVD — the unified imputed income tax (UTII).

  • OSN — the general system of taxation.

  • PSN — Patent Taxation System (PSN).

  • USN — simplified taxation system (STS).

  • USN_MINUS_COST — simplified taxation system, income reduced by the amount of expenses (USN "Income minus expenses").

  • NPD — Professional Income Tax (NAP).

  • UNKNOWN_VALUE — unknown value. Used only in conjunction with the parameter payment-method=YANDEX.

Type

Description

OrderTaxSystemType

Enum: OSN, USN, USN_MINUS_COST, ENVD, ECHN, PSN, NPD, UNKNOWN_VALUE

OrderSubsidyDTO

Total remuneration to the seller for DBS delivery and all discounts on the product:

  • by promo codes, coupons, and promotions;
  • by Plus points;
  • on Delivery (DBS).

Includes VAT.

Name

Description

amount*

Type: number<decimal>

The amount of the subsidy.

type*

Type: OrderSubsidyType

Type of subsidy:

  • 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, DELIVERY

OrderDeliveryDatesDTO

The range of delivery dates.

Name

Description

fromDate*

Type: string<date-dd-MM-yyyy>

Date format: DD-MM-YYYY.

Example: 23-09-2022

fromTime

Type: string<time>

The beginning of the delivery time interval.

It is passed only in conjunction with the parameter type=DELIVERY.

Time format: 24-hour, HH:MM. The minutes should always be specified 00 (exception — 23:59).

Minimum value: 00:00.

realDeliveryDate

Type: string<date-dd-MM-yyyy>

Date format: DD-MM-YYYY.

Example: 23-09-2022

toDate

Type: string<date-dd-MM-yyyy>

Date format: DD-MM-YYYY.

Example: 23-09-2022

toTime

Type: string<time>

The end of the delivery time interval.

It is passed only in conjunction with the parameter type=DELIVERY.

Time format: 24-hour, HH:MM. The minutes should always be specified 00 (exception — 23:59).

Maximum value: 23:59.

OrderDeliveryPartnerType

Type of cooperation with the delivery service within a specific order:

  • SHOP — the store works with the delivery service directly or delivers orders independently.

  • YANDEX_MARKET — the store works with a delivery service through the Market.

  • UNKNOWN — unknown type.

Type

Description

OrderDeliveryPartnerType

Enum: SHOP, YANDEX_MARKET, UNKNOWN

OrderDeliveryType

Order delivery method:

  • DELIVERY — courier delivery.

  • PICKUP — pickup.

  • POST — mail.

  • DIGITAL — for digital goods.

  • UNKNOWN — unknown type.

Type

Description

OrderDeliveryType

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

OrderDeliveryAddressDTO

The delivery address.

Is specified if the parameter type takes the value DELIVERY, POST or PICKUP (only for the DBS model). If type=PICKUP, the address of the pick-up point is returned.

Name

Description

apartment

Type: string

Apartment or office.

block

Type: string

Body.

building

Type: string

Building.

city

Type: string

A city or locality.

country

Type: string

A country.

district

Type: string

District.

entrance

Type: string

Entrance.

entryphone

Type: string

The intercom code.

estate

Type: string

Ownership.

floor

Type: string

Floor.

gps

Type: GpsDTO

GPS coordinates.

house

Type: string

House.

phone

Type: string

The phone number of the recipient of the order.

postcode

Type: string

Postal code.

Indicated if mail delivery is selected (delivery type=POST).

recipient

Type: string

Last name, first name and patronymic of the recipient of the order.

street

Type: string

Street.

subway

Type: string

The metro station.

OrderCourierDTO

Information about the courier.

Name

Description

fullName

Type: string

The courier's full name.

phone

Type: string

The courier's phone number.

phoneExtension

Type: string

The extension phone number.

vehicleDescription

Type: string

Description of the car. For example, the model and color.

vehicleNumber

Type: string

Vehicle number.

OrderDeliveryEacType

The type of the EAPP confirmation code:

  • MERCHANT_TO_COURIER (temporarily non—refundable) - the seller sends the code to the courier to receive a non-purchase.

  • COURIER_TO_MERCHANT — the courier transmits the code to the seller to receive the order.

  • CHECKING_BY_MERCHANT — the seller checks the code on his side.

Type

Description

OrderDeliveryEacType

Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

OrderLiftType

The type of lifting the order to the floor:

  • NOT_NEEDED — not required.

  • MANUAL — manual.

  • ELEVATOR — the elevator.

  • CARGO_ELEVATOR — freight elevator.

  • FREE — any of the above, if the free lift option is enabled.

  • UNKNOWN — unknown type.

Type

Description

OrderLiftType

Enum: NOT_NEEDED, MANUAL, ELEVATOR, CARGO_ELEVATOR, FREE, UNKNOWN

RegionDTO

The delivery region.

Name

Description

id*

Type: integer<int64>

ID of the region.

name*

Type: string

The name of the region.

type*

Type: RegionType

The type of region.

Possible values:

  • CITY_DISTRICT — the area of the city.

  • CITY — a large city.

  • CONTINENT — the continent.

  • COUNTRY_DISTRICT — area.

  • COUNTRY — country.

  • REGION — region.

  • REPUBLIC_AREA — district of the subject of the federation.

  • REPUBLIC — the subject of the Federation.

  • SUBWAY_STATION — the metro station.

  • VILLAGE — the city.

  • OTHER — unknown region.

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

children

Type: RegionDTO[]

Child regions.
The delivery region.

Min items: 1

parent

Type: RegionDTO

Information about the parent region.

Parent regions are specified up to the country level.

OrderShipmentDTO

The package list.

Multiple parcels can be specified in the parameter.

Name

Description

boxes

Type: OrderParcelBoxDTO[]

List of cargo locations.
Information about the cargo location.

Min items: 1

id

Type: integer<int64>

The parcel ID assigned by Yandex.Market.

shipmentDate

Type: string<date-dd-MM-yyyy>

Date format: DD-MM-YYYY.

Example: 23-09-2022

shipmentTime

Type: string

Only for the Express model

The time by which the store must package the order and set it to the status READY_TO_SHIP. After the status change, a courier will arrive to pick up the order.

The field may not appear immediately. Request information about the order within 5-10 minutes until it is returned.

Time format: 24-hour, HH:MM.

If the order is made by an organization, the parameter is not returned until the delivery date is agreed.

tracks

Type: OrderTrackDTO[]

Only for the DBS model

Information for tracking parcel movements.
Information about the parcel's track number (DBS).

Min items: 1

OrderTrackDTO

Information about the parcel's track number (DBS).

Name

Description

deliveryServiceId*

Type: integer<int64>

The delivery service ID. Information about the delivery service can be obtained by requesting GET delivery/services.

trackCode

Type: string

The parcel's track number.

OrderVatType

Value added tax (VAT) on the product:

  • NO_VAT — VAT is not charged, it is used only for certain types of services.

  • VAT_0 — 0% VAT. For example, it is used for the sale of goods exported in the customs procedure of export, or for the provision of services for the international transportation of goods.

  • VAT_10 — 10% VAT. For example, it is used in the sale of certain food and medical products.

  • VAT_10_110 — VAT 10/110. 10% VAT, applicable only for prepayment.

  • VAT_20 — 20% VAT. Basic VAT starting in 2019.

  • VAT_20_120 — VAT 20/120. VAT is 20%, applicable only for prepayment.

  • VAT_18 — VAT 18%. Basic VAT until 2019.

  • VAT_18_118 — VAT 18/118. VAT was used until January 1, 2019 for prepayment.

  • VAT_12 — 12% VAT. It is used only in Uzbekistan.

  • VAT_05 — 5% VAT. VAT for the simplified taxation system (USN).

  • VAT_07 — 7% VAT. VAT for the simplified taxation system (USN).

  • UNKNOWN_VALUE — unknown type.

Used only in conjunction with the parameter payment-method=YANDEX.

Type

Description

OrderVatType

Enum: NO_VAT, VAT_0, VAT_10, VAT_10_110, VAT_20, VAT_20_120, VAT_18, VAT_18_118, VAT_12, VAT_05, VAT_07, UNKNOWN_VALUE

OrderItemDetailDTO

Product details in the order.

Name

Description

itemCount*

Type: integer<int64>

The number of product units.

itemStatus*

Type: OrderItemStatusType

Non-purchased or returned goods:

  • REJECTED — not bought.

  • RETURNED — returned.

Enum: REJECTED, RETURNED

updateDate*

Type: string<date-dd-MM-yyyy>

Date format: DD-MM-YYYY.

Example: 23-09-2022

OrderItemInstanceDTO

The marking or fault codes you have provided for this position. The "Honest Sign" codes are returned in two versions — with and without a cryptotail.

Name

Description

cis

Type: string

The unit identification code in the system "An honest SIGN" without a cryptotail or «ASL BELGISI» (for sellers of the Yandex Go Market).

cisFull

Type: string

The unit identification code in the system "An honest SIGN" with a cryptotail.

countryCode

Type: string

The country of manufacture is in the ISO 3166-1 alpha-2 format. How to get

Example: RU

Min length: 2

Max length: 2

Pattern: ^[A-Z]{2}$

gtd

Type: string

Cargo customs declaration.

It is a string of three numbers separated by a slash: XXXXXXXXXX/XXXXXXXX/XXXXXXXX.

The first part is the code of the customs office that registered the declaration for imported goods. Next is the date and number of the declaration.

rnpt

Type: string

The registration number of the product batch.

It is a string of four numbers separated by slashes: XXXXXXXXXX/XXXXXXXX/XXXXXXXX/XXX.

The first part is the code of the customs office that registered the declaration for the shipment. Next is the date, the number of the declaration and the number of the marked product in the declaration.

uin

Type: string

Jewelry's UIN (16-digit code) The manufacturer receives the UIN when he registers the product in the system of control over the turnover of precious metals and stones — GIIS DMDK.

OrderItemPromoDTO

Information about rewards to the seller for discounts on goods using promo codes, coupons, and promotions.

Name

Description

subsidy*

Type: number<decimal>

Remuneration to the seller from the Market for the product sold as part of the promotion.

type*

Type: OrderPromoType

The type of discount.

Enum: DIRECT_DISCOUNT, BLUE_SET, BLUE_FLASH, GENERIC_BUNDLE, MARKET_COUPON, MARKET_PROMOCODE, MARKET_BLUE, MARKET_COIN, PRICE_DROP_AS_YOU_SHOP, SECRET_SALE, CHEAPEST_AS_GIFT, CASHBACK, SPREAD_DISCOUNT_COUNT, SPREAD_DISCOUNT_RECEIPT, DISCOUNT_BY_PAYMENT_TYPE, PERCENT_DISCOUNT, DCO_EXTRA_DISCOUNT, UNKNOWN

discount

Type: number<decimal>

The amount of the user discount in the buyer's currency.

marketPromoId

Type: string

The identifier of the promotion within the framework of the agreement for the provision of services for the promotion of the service between the Market and the seller.

shopPromoId

Type: string

The ID of the supplier's promotion.

OrderItemInstanceType

Type of product labeling:

  • CIS — KIZ, the identifier of the product unit in the system "An honest SIGN" or «ASL BELGISI» (for sellers of the Yandex Go Market). Required to fill in.

  • CIS_OPTIONAL — KIZ, the identifier of the product unit in the system "An honest SIGN". It is optional to fill out, but it will be required to transfer it in the near future.

  • UIN — WIN, a unique identification number.

  • RNPT — RNPT, the batch registration number.

  • GTD — GTD number, cargo customs declaration.

Type

Description

OrderItemInstanceType

Enum: CIS, CIS_OPTIONAL, UIN, RNPT, GTD

OrderItemSubsidyDTO

Total remuneration to the seller for all discounts on the product:

  • by promo codes, coupons, and promotions;
  • Plus points.

Includes VAT.

Name

Description

amount*

Type: number<decimal>

The amount of the subsidy.

type*

Type: OrderItemSubsidyType

Type of subsidy:

  • YANDEX_CASHBACK — discount on Yandex Plus subscription.

  • SUBSIDY — discount Market (for promotions, promo codes, coupons, etc.).

Enum: YANDEX_CASHBACK, SUBSIDY

OrderItemTagType

Product attribute:

  • ULTIMA — premium product.
  • SAFE_TAG — product with a protective tag.
  • TURBO — a product that sells out quickly.

Type

Description

OrderItemTagType

Enum: ULTIMA, SAFE_TAG, TURBO

OrderSubsidyType

Type of subsidy:

  • YANDEX_CASHBACK — discount on Yandex Plus subscription.

  • SUBSIDY — Yandex. Market discount (for promotions, promo codes, coupons, etc.)

  • DELIVERY — discount for shipping (DBS).

Type

Description

OrderSubsidyType

Enum: YANDEX_CASHBACK, SUBSIDY, DELIVERY

GpsDTO

GPS coordinates of latitude and longitude.

Name

Description

latitude*

Type: number<decimal>

Width.

longitude*

Type: number<decimal>

Longitude.

RegionType

The type of region.

Possible values:

  • CITY_DISTRICT — the area of the city.

  • CITY — a large city.

  • CONTINENT — the continent.

  • COUNTRY_DISTRICT — area.

  • COUNTRY — country.

  • REGION — region.

  • REPUBLIC_AREA — district of the subject of the federation.

  • REPUBLIC — the subject of the Federation.

  • SUBWAY_STATION — the metro station.

  • VILLAGE — the city.

  • OTHER — unknown region.

Type

Description

RegionType

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

OrderParcelBoxDTO

Information about the cargo location.

Name

Description

fulfilmentId*

Type: string

The identifier of the cargo space in the store's information system.

id*

Type: integer<int64>

The cargo location ID.

OrderItemStatusType

Non-purchased or returned goods:

  • REJECTED — not bought.

  • RETURNED — returned.

Type

Description

OrderItemStatusType

Enum: REJECTED, RETURNED

OrderPromoType

Discount type:

  • DIRECT_DISCOUNT — direct discount, which is set by the seller or the Market.

  • BLUE_SET — kits.

  • BLUE_FLASH — flash promotion.

  • MARKET_COUPON — discount on the promo code of the Market.

  • MARKET_PROMOCODE — discount on the store's promo code.

  • MARKET_BLUE — discount on the Market.

  • CHEAPEST_AS_GIFT — the cheapest item as a gift.

  • CASHBACK — cashback.

  • SPREAD_DISCOUNT_COUNT — discount for the number of identical items.

  • SPREAD_DISCOUNT_RECEIPT — discount on the amount of the receipt.

  • DISCOUNT_BY_PAYMENT_TYPE — direct discount when paying with a Plus card.

  • PERCENT_DISCOUNT — direct percentage discount.

  • DCO_EXTRA_DISCOUNT — an additional discount required to calculate the subsidy from the Market.

  • UNKNOWN — unknown type.

Obsolete types:

  • GENERIC_BUNDLE.

  • MARKET_COIN.

  • PRICE_DROP_AS_YOU_SHOP.

  • SECRET_SALE.

Type

Description

OrderPromoType

Enum: DIRECT_DISCOUNT, BLUE_SET, BLUE_FLASH, GENERIC_BUNDLE, MARKET_COUPON, MARKET_PROMOCODE, MARKET_BLUE, MARKET_COIN, PRICE_DROP_AS_YOU_SHOP, SECRET_SALE, CHEAPEST_AS_GIFT, CASHBACK, SPREAD_DISCOUNT_COUNT, SPREAD_DISCOUNT_RECEIPT, DISCOUNT_BY_PAYMENT_TYPE, PERCENT_DISCOUNT, DCO_EXTRA_DISCOUNT, UNKNOWN

OrderItemSubsidyType

Type of subsidy:

  • YANDEX_CASHBACK — discount on Yandex Plus subscription.

  • SUBSIDY — discount Market (for promotions, promo codes, coupons, etc.).

Type

Description

OrderItemSubsidyType

Enum: YANDEX_CASHBACK, SUBSIDY

400 Bad Request

The request contains incorrect data. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error in Yandex. Market. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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.

Previous
About one order
Next
Order preparation