Starting from December 31, push API methods will be unavailable. From October 1, they may be unstable.

To receive information about new orders, enable API notifications. How to do it

Transfer of the order and request for acceptance of the order

Submits a new order to the store and requests confirmation of order acceptance.

To cancel an order, use a request PUT v2/campaigns/{campaignId}/orders/{orderId}/status.

The request can be executed more than once

This is possible when responding to a request from the Market POST order/accept The store confirmed acceptance of the order, however, due to a technical glitch, the store's response was not recorded by the Market. Since it is not known whether the order acceptance request has reached the store or not, the Market can repeat this request. A response is expected from the store confirming the acceptance of this order.

When a new order appears, the Market sends you a request. If you don't respond to it within 10 seconds, the Market will start repeat the request. The first 3 times — every minute, after that — every 10 minutes.

If you do not respond to four repeated requests, The market will shut down the store and your products will disappear from the showcase. To connect again, respond correctly to all real or verification Market requests for order creation — by accepting or canceling. After that, your products will be returned to the showcase automatically.

Features of transferring data for orders to the Market pick-up point (DBS)

If the customer has chosen to deliver the order to a branded Market pick-up point, the request will be received without the parameter outlet. Type of delivery type corresponds to the value PICKUP. The address and date of delivery to the pick-up point will be shown in the elements address and dates.

For more information about delivery to the Market pick-up point, see in the Help of the Market for sellers.

Example

For ease of reading, the sample code is provided in an abbreviated format.

{
  ...
  "delivery":
    {
      "type": "PICKUP",
      "dispatchType": "MARKET_BRANDED_OUTLET",
      "deliveryPartnerType": "SHOP",
      "deliveryServiceId": 99,
      "price": 1200,
      "serviceName": "СПСР",
      "liftType": "NOT_NEEDED",
      "liftPrice": 0,
      "vat": "VAT_20",
      "dates": {
        "fromDate": "15-02-2022",
        "toDate": "15-02-2022",
        "fromTime": "10:00",
        "toTime": "21:00"
      }
    },
  ...
}

Request

POST

/order/accept

Body

application/json
{
    "order": {
        "businessId": 0,
        "id": 0,
        "status": "PLACING",
        "substatus": "RESERVATION_EXPIRED",
        "creationDate": "23-09-2022 09:12:41",
        "currency": "RUR",
        "itemsTotal": 0,
        "total": 0,
        "deliveryTotal": 0,
        "subsidyTotal": 0,
        "totalWithSubsidy": 0,
        "subsidies": [
            {
                "type": "YANDEX_CASHBACK",
                "amount": 0
            }
        ],
        "buyerItemsTotal": 0,
        "buyerTotal": 0,
        "buyerItemsTotalBeforeDiscount": 0,
        "buyerTotalBeforeDiscount": 0,
        "paymentType": "PREPAID",
        "paymentMethod": "SHOP_PREPAID",
        "fake": false,
        "shopOrderId": "string",
        "items": [
            {
                "id": 0,
                "feedId": 0,
                "offerId": "string",
                "feedCategoryId": "string",
                "offerName": "string",
                "fulfilmentShopId": 0,
                "price": 0,
                "buyerPrice": 0,
                "buyerPriceBeforeDiscount": 0,
                "priceBeforeDiscount": 0,
                "count": 0,
                "delivery": false,
                "vat": "NO_VAT",
                "shopSku": "string",
                "sku": "string",
                "subsidy": 0,
                "subsidies": [
                    {
                        "type": "YANDEX_CASHBACK",
                        "amount": 0
                    }
                ],
                "warehouseId": 0,
                "partnerWarehouseId": "string",
                "params": "string",
                "promos": [
                    {
                        "type": "DIRECT_DISCOUNT",
                        "subsidy": 0,
                        "marketPromoId": "string"
                    }
                ],
                "instances": [
                    {
                        "cis": "string",
                        "cisFull": "string",
                        "uin": "string",
                        "rnpt": "string",
                        "gtd": "string",
                        "countryCode": "RU"
                    }
                ],
                "tags": [
                    "ULTIMA"
                ]
            }
        ],
        "notes": "string",
        "taxSystem": "OSN",
        "expiryDate": "23-09-2022",
        "electronicAcceptanceCertificateCode": "string",
        "tags": [
            "ULTIMA"
        ],
        "buyer": {
            "type": "PERSON"
        },
        "delivery": {
            "shopDeliveryId": "string",
            "type": "DELIVERY",
            "serviceName": "string",
            "price": 0,
            "subsidy": 0,
            "deliveryPartnerType": "SHOP",
            "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"
                }
            },
            "vat": "NO_VAT",
            "deliveryServiceId": 0,
            "liftType": "NOT_NEEDED",
            "liftPrice": 0,
            "outlet": {
                "code": "string"
            },
            "dispatchType": "UNKNOWN",
            "shipments": [
                {
                    "id": 0,
                    "status": "NEW",
                    "shipmentDate": "23-09-2022",
                    "shipmentTime": "string",
                    "weight": 0,
                    "width": 0,
                    "height": 0,
                    "depth": 0,
                    "boxes": [
                        {
                            "id": 0,
                            "weight": 0,
                            "width": 0,
                            "height": 0,
                            "depth": 0,
                            "items": [
                                {
                                    "id": 0,
                                    "count": 0
                                }
                            ]
                        }
                    ]
                }
            ],
            "estimated": false,
            "eacType": "MERCHANT_TO_COURIER",
            "address": {
                "country": "string",
                "postcode": "string",
                "city": "string",
                "district": "string",
                "subway": "string",
                "street": "string",
                "house": "string",
                "block": "string",
                "entrance": "string",
                "entryphone": "string",
                "floor": "string",
                "apartment": "string",
                "lat": 0,
                "lon": 0,
                "notes": "string",
                "outletPhones": [
                    "string"
                ],
                "schedule": [
                    {
                        "fromDay": "MONDAY",
                        "toDay": "MONDAY",
                        "fromTime": "string",
                        "toTime": "string"
                    }
                ]
            }
        }
    }
}

Name

Description

order*

Type: ShopOrderAcceptDTO

Order.

ShopOrderAcceptDTO

Name

Description

businessId

Type: integer<int64>

Cabinet ID.

buyer

Type: OrderBuyerWithoutPersonalDataDTO

Information about the buyer.

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.

buyerItemsTotalBeforeDiscount

Type: number<decimal>

The cost of all items in the order in the buyer's currency before 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 the discounts are applied and including the shipping cost.

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.

Takes the value RUR — the Russian ruble.

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: OrderAcceptDeliveryDTO

Delivery information.

deliveryTotal

Type: number<decimal>

The cost of delivery in the currency of the order.

electronicAcceptanceCertificateCode

Type: string

Only for the FBS model

A six-digit confirmation code for:

  • transfer of the express order to the courier;
  • receiving an outstanding express order from a courier.

Detailed information about working with codes is provided in the Help for sellers.

expiryDate

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

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

Date format: DD-MM-YYYY.

Example: 23-09-2022

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: ShopOrderItemDTO[]

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

itemsTotal

Type: number<decimal>

The total amount of the order in the order currency, excluding the cost of delivery and remuneration to the seller for discounts on promo codes, coupons and promotions (parameter subsidyTotal).

notes

Type: string

Comment on the order.

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: SHOP_PREPAID, BANK_CARD, YANDEX_MONEY, CASH_ON_DELIVERY, CARD_ON_DELIVERY, BOUND_CARD_ON_DELIVERY, BNPL_BANK_ON_DELIVERY, BNPL_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, INSTALLMENT, 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

shopOrderId

Type: string

The order ID in the store.

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. You don't need to process them.

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

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).

subsidyTotal

Type: number<decimal>

Total remuneration to the seller for discounts:

  • by promo codes;
  • by coupons;
  • for shares;
  • subsidy for delivery.

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.

    • INCORRECT_PERSONAL_DATA — incorrect personal data has been entered.

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

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

tags

Type: OrderTag[]

Signs of the order.
Order attribute:

  • ULTIMA — order with a premium product.

Enum: ULTIMA

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 system of taxation (OSN).

  • 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

total

Type: number<decimal>

The total amount of the order in the currency of the order, including the cost of delivery, but excluding remuneration to the seller for discounts on promo codes, coupons, cashback and promotions (parameter subsidyTotal).

totalWithSubsidy

Type: number<decimal>

The sum of the cost of all the goods in the order and the remuneration for them in the store's currency (the sum of the parameters total and subsidyTotal).

OrderBuyerWithoutPersonalDataDTO

Information about the buyer.

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

CurrencyType

Currency codes:

  • RUR — the 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

OrderAcceptDeliveryDTO

Name

Description

address

Type: DeliveryAddressWithoutPersonalDataDTO

Only for the DBS model

The delivery address. Passed if the parameter type it matters DELIVERY.
Address.

dates

Type: OrderDeliveryDatesDTO

Only for the DBS model

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. Information about the delivery service can be obtained by requesting GET delivery/services.

dispatchType

Type: OrderDeliveryDispatchType

Only for the DBS model

Shipping method.

Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET

eacType

Type: OrderDeliveryEacType

Only for the Express model

The type of the EAPP confirmation code.

Enum: MERCHANT_TO_COURIER, COURIER_TO_MERCHANT, CHECKING_BY_MERCHANT

estimated

Type: boolean

Only for the DBS model

A flag that indicates that the delivery date for the order has not been confirmed. It is transmitted for products on order with a long delivery time (31-60 days). The final delivery date must be sent to Yandex.Market within 7 days from the date of placing the order in the request. PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/date.

liftPrice

Type: number<decimal>

Only for the DBS model

The cost of going up to the floor.

liftType

Type: OrderLiftType

Only for the DBS model

The type of lifting the order to the floor.

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

outlet

Type: ShopOutletDTO

Only for the DBS model

The pick-up point selected by the buyer to receive the order. It is not returned in the response if the customer has chosen to receive the order at a branded Market order pick-up point (value MARKET_BRANDED_OUTLET the parameter dispatchType).

price

⦸

Type: number<decimal>

Do not use this option.

region

Type: ShopRegionDTO

The delivery region.

serviceName

Type: string

The name of the delivery service.

shipments

Type: ShopOrderShipmentDTO[]

Information about parcels.

For the DBS model: It is transmitted if the order was created at the Market pick-up point.
The package list.

shopDeliveryId

Type: string

Only for the DBS model

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 in the parameter id, embedded in deliveryOptions.

subsidy

Type: number<decimal>

Subsidy for delivery.

type

Type: OrderDeliveryType

Order delivery method:

  • DELIVERY — courier delivery.

  • PICKUP — pickup.

  • POST — mail.

  • DIGITAL — for digital goods.

  • UNKNOWN — unknown type.

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

vat

Type: OrderVatType

Only for the DBS model

Value added tax (VAT) on the order delivery service.

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

ShopOrderItemDTO

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.

Backward compatibility

The outdated parameter is also filled in. buyer-price. Use the parameter buyerPrice.

buyerPriceBeforeDiscount

Type: number<decimal>

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

count

Type: integer

The number of product units.

delivery

Type: boolean

Only for the FBS model

Delivery of the product to the region specified in the request:

  • false — the product is not being delivered to the specified region.
  • true — default value, the product is delivered to the specified region.

Takes the value that you passed in the parameter delivery, embedded in items, in response to the request POST cart.

feedCategoryId

Type: string

Only for the DBS model

The ID of the category specified in the folder.

feedId

Type: integer<int64>

ID of the product catalog.

fulfilmentShopId

Type: integer<int64>

The product supplier's ID.

To find out, log in to the seller's account on the Market and click on its name. The ID is specified in the field Store ID in the row of the desired warehouse.

id

Type: integer<int64>

The product ID in the order.

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

instances

Type: OrderItemInstanceDTO[]

Information about the labeling of product units.

The tagging data passed in the request is returned. PUT v2/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.

offerId

Type: string

Your SKU is the product identifier in your system.

SKU Usage Rules:

  • Each product must have its own SKU.

  • An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

The SKU of 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.

What is a SKU and how to assign it

Min length: 1

Max length: 255

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

offerName

Type: string

Only for the DBS model

Product name.

params

Type: string

Product characteristics (for example, its color).

partnerWarehouseId

⦸

Type: string

Only for the FBS model

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

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 subsidy).

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.

shopSku

Type: string

Your SKU is the product identifier in your system.

SKU Usage Rules:

  • Each product must have its own SKU.

  • An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

The SKU of 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.

What is a SKU and how to assign it

Min length: 1

Max length: 255

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

sku

Type: string

SKU on the Market is the identifier of the current product card on the Market.

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.

subsidy

⦸

Type: number<decimal>

Instead, use subsidies.

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

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

tags

Type: ItemTag[]

Product attributes.
Product attribute:

  • ULTIMA — premium product.
  • SAFE_TAG — product with a protective label. It helps to eliminate the substitution of goods upon return. You will not be able to return the product without the protective tag that was present at the time of purchase.
  • TURBO — a product that sells out quickly.

Enum: ULTIMA, SAFE_TAG, TURBO

vat

Type: OrderVatType

Value added tax (VAT) on the product.

Used only in conjunction with the parameter "paymentMethod": "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

warehouseId

Type: integer<int64>

Only for the FBS model

The ID of the warehouse on the Market.

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: SHOP_PREPAID, BANK_CARD, YANDEX_MONEY, CASH_ON_DELIVERY, CARD_ON_DELIVERY, BOUND_CARD_ON_DELIVERY, BNPL_BANK_ON_DELIVERY, BNPL_ON_DELIVERY, YANDEX, APPLE_PAY, EXTERNAL_CERTIFICATE, CREDIT, INSTALLMENT, 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

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. You don't need to process them.

Type

Description

OrderStatusType

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

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).

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

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.

    • INCORRECT_PERSONAL_DATA — incorrect personal data has been entered.

  • 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

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

OrderTag

Order attribute:

  • ULTIMA — order with a premium product.

Type

Description

OrderTag

Enum: ULTIMA

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

OrderBuyerType

Type of buyer:

  • PERSON — an individual.

  • BUSINESS — organization.

Type

Description

OrderBuyerType

Enum: PERSON, BUSINESS

DeliveryAddressWithoutPersonalDataDTO

The delivery address. Passed if the parameter type it matters DELIVERY.

Name

Description

apartment

Type: string

Apartment or office number.

block

Type: string

A building or building.

city

Type: string

A city or locality.

Required parameter.

country

Type: string

A country.

Optional parameter if order delivery to the pick-up point is selected.

district

Type: string

District.

entrance

Type: string

Entrance number.

entryphone

Type: string

The intercom code.

floor

Type: string

Floor.

house

Type: string

The number of the house or property.

Required parameter.

lat

Type: number<decimal>

Width.

This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.

We do not guarantee that it will be filled in, as this is an optional field.

lon

Type: number<decimal>

Longitude.

This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.

We do not guarantee that it will be filled in, as this is an optional field.

notes

Type: string

A note to the address. For example, Entrance from the courtyard.

This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.

outletPhones

Type: string[]

Phone numbers of the pick-up point in the format 8 812 123-45-67 890 (890 — extension).

This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.

postcode

Type: string

Postal code.

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

schedule

Type: ShopOutletScheduleItemDTO[]

The opening hours of the pick-up point.

This parameter is specified if the customer has chosen to deliver the order to a branded Market pick-up point.
The opening hours of the point of sale.

street

Type: string

Street.

subway

Type: string

The metro station.

OrderDeliveryDatesDTO

The range of delivery dates.

Name

Description

fromDate*

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

The nearest delivery date.

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>

The date when the product is delivered to the pick-up point (in case of pickup) or to the buyer (if the order is delivered by a courier).

Example: 23-09-2022

toDate

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

The latest delivery date.

If the parameter toDate not specified, the only possible delivery date is the date specified in the parameter fromDate.

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

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

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

ShopOutletDTO

The pick-up point selected by the buyer to receive the order. It is not returned in the response if the customer has chosen to receive the order at a branded Market order pick-up point (value MARKET_BRANDED_OUTLET the parameter dispatchType).

Name

Description

code

Type: string

The pick-up point ID assigned by the store.

ShopRegionDTO

The delivery region.

Name

Description

name*

Type: string

The name of the region.

type*

Type: ShopRegionType

The type of region.

Enum: OTHER, CITY_DISTRICT, CITY, CONTINENT, COUNTRY_DISTRICT, COUNTRY, REGION, METRO_STATION, MONORAIL_STATION, OVERSEAS_TERRITORY, SECONDARY_DISTRICT, SETTLEMENT, SUBJECT_FEDERATION, SUBJECT_FEDERATION_DISTRICT, VILLAGE, SUBURB

id

Type: integer<int64>

ID of the region.

parent

Type: ShopRegionDTO

Information about the parent region.

Parent regions are specified up to the country level.

ShopOrderShipmentDTO

The package list.

Name

Description

boxes

Type: ShopOrderParcelBoxDTO[]

List of cargo locations.
Information about the cargo location.

depth

Type: integer<int64>

The depth of the packed order in centimeters.

It is indicated if the order is delivered by the partner service of the Market (deliveryPartnerType=YANDEX_MARKET).

height

Type: integer<int64>

The height of the packed order in centimeters.

It is indicated if the order is delivered by the partner service of the Market (deliveryPartnerType=YANDEX_MARKET).

id

Type: integer<int64>

The parcel ID assigned by Yandex.Market.

shipmentDate

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

The day on which the order needs to be shipped to the delivery service.

Date format: DD-MM-YYYY.

For the FBS model: if the order is made by an organization, the parameter is not returned until the delivery date is agreed.

For the DBS model: if you did not pass the parameter shipmentDate, then the date that precedes the date of delivery in will be considered the day of shipment . fromDate.

Example: 23-09-2022

shipmentTime

Type: string<time>

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.

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.

status

⦸

Type: OrderParcelStatusType

Order status in the partner delivery service:

  • NEW — a new one.

  • CREATED — created in the delivery service.

  • READY_TO_SHIP — ready to transfer to the delivery service.

  • ERROR — order creation error.

  • UNKNOWN — unknown status.

Enum: NEW, CREATED, READY_TO_SHIP, ERROR, UNKNOWN

weight

Type: integer<int64>

The weight of the packed order in grams.

It is indicated if the order is delivered by the partner service of the Market (deliveryPartnerType=YANDEX_MARKET).

width

Type: integer<int64>

The width of the packed order in centimeters.

It is indicated if the order is delivered by the partner service of the Market (deliveryPartnerType=YANDEX_MARKET).

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

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

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

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

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.

subsidy

Type: number<decimal>

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

OrderItemSubsidyDTO

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

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

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

ItemTag

Product attribute:

  • ULTIMA — premium product.
  • SAFE_TAG — product with a protective label. It helps to eliminate the substitution of goods upon return. You will not be able to return the product without the protective tag that was present at the time of purchase.
  • TURBO — a product that sells out quickly.

Type

Description

ItemTag

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

ShopOutletScheduleItemDTO

The opening hours of the point of sale.

Name

Description

fromDay*

Type: DayOfWeekType

The day of the week on which the pick-up point starts working:

  • MONDAY — Monday.
  • TUESDAY "Tuesday."
  • WEDNESDAY — Wednesday.
  • THURSDAY — Thursday.
  • FRIDAY — Friday.
  • SATURDAY "Saturday."
  • SUNDAY — Sunday.

Required parameter.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

fromTime*

Type: string

The start time of the pick-up point. Time format: 24-hour, HH:MM.

Required parameter.

Min length: 1

toDay*

Type: DayOfWeekType

The day of the week on which the pick-up point stops working:

  • MONDAY — Monday.
  • TUESDAY "Tuesday."
  • WEDNESDAY — Wednesday.
  • THURSDAY — Thursday.
  • FRIDAY — Friday.
  • SATURDAY "Saturday."
  • SUNDAY — Sunday.

Required parameter.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

toTime*

Type: string

The end time of the pick-up point. Time format: 24-hour, HH:MM.

Required parameter.

Min length: 1

ShopRegionType

Type of region:

  • CITY_DISTRICT — the area of the city.

  • CITY — a large city.

  • CONTINENT — the continent.

  • COUNTRY_DISTRICT — the federal district.

  • COUNTRY — country.

  • REGION — region.

  • METRO_STATION — the metro station.

  • MONORAIL_STATION — monorail station.

  • OVERSEAS_TERRITORY — a separate territory of a state located in another part of the world (for example, Anguilla, Greenland, Bermuda, etc.).

  • SECONDARY_DISTRICT — the second-level city district (for example, for the Moscow Autonomous District, the second-level districts are Izmailovo, Novokosino, Perovo, etc.).

  • SETTLEMENT — settlement.

  • SUBJECT_FEDERATION — the subject of the Federation.

  • SUBJECT_FEDERATION_DISTRICT — district of the subject of the federation.

  • VILLAGE — the city.

  • SUBURB — the suburbs.

  • OTHER — unknown region.

Type

Description

ShopRegionType

Enum: OTHER, CITY_DISTRICT, CITY, CONTINENT, COUNTRY_DISTRICT, COUNTRY, REGION, METRO_STATION, MONORAIL_STATION, OVERSEAS_TERRITORY, SECONDARY_DISTRICT, SETTLEMENT, SUBJECT_FEDERATION, SUBJECT_FEDERATION_DISTRICT, VILLAGE, SUBURB

ShopOrderParcelBoxDTO

Information about the cargo location.

Name

Description

depth

Type: integer<int64>

The depth of the cargo area in centimeters.

height

Type: integer<int64>

The height of the cargo area in centimeters.

id

Type: integer<int64>

ID of the cargo area.

items

Type: ShopOrderBoxItemDTO[]

Information about the box.

weight

Type: integer<int64>

The weight of the cargo area in grams.

width

Type: integer<int64>

The width of the cargo area in centimeters.

OrderParcelStatusType

Order status in the partner delivery service:

  • NEW — a new one.

  • CREATED — created in the delivery service.

  • READY_TO_SHIP — ready to transfer to the delivery service.

  • ERROR — order creation error.

  • UNKNOWN — unknown status.

Type

Description

OrderParcelStatusType

Enum: NEW, CREATED, READY_TO_SHIP, ERROR, UNKNOWN

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

DayOfWeekType

Day of the week:

  • MONDAY — Monday.
  • TUESDAY "Tuesday."
  • WEDNESDAY — Wednesday.
  • THURSDAY — Thursday.
  • FRIDAY — Friday.
  • SATURDAY "Saturday."
  • SUNDAY — Sunday.

Type

Description

DayOfWeekType

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

ShopOrderBoxItemDTO

Information about the box.

Name

Description

count

Type: integer

The quantity of the product in the box.

id

Type: integer<int64>

The ID of the box.

Responses

200 OK

The store's response about accepting the order.

Body

application/json
{
    "order": {
        "id": "string",
        "shipmentDate": "23-09-2022"
    }
}

Name

Description

order

Type: OrderAcceptResponseDTO

Description of the order.

OrderAcceptResponseDTO

Name

Description

id

Type: string

The order ID assigned by the store.

The maximum ID length is 50 characters.

If you did not pass the parameter id, the order identifier on the Market is used.

shipmentDate

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

Only for the DBS model

The day on which you will ship the orders to the delivery service.

Date format: DD-MM-YYYY.

Example: 23-09-2022

400 Bad Request

If the store considers the request received from Yandex. Market to be incorrect, the store must return the response status 400 with a description of the reason for the error in the response body. Such responses will be analyzed for API violations and flaws on the part of the Market.

500 Internal Server Error

In case of a technical error on the store's side, it should return the response status 500. Stores with a large number of such responses may be disconnected from the Market.

No longer supported, please use an alternative and newer version.