Changing the status of an order

The method is available for models: FBS, Express and DBS.

If you are using an API Key token, one of the accesses in the list is required to call the method

Changes the order status. Possible status changes:

  • If the store has confirmed and prepared the order for shipment, then the order from the status "status": "PROCESSING" and the processing stage "substatus": "STARTED" it needs to be converted to the status "status": "PROCESSING" and the processing stage "substatus": "READY_TO_SHIP".
  • If the store has confirmed the order, but cannot fulfill it (for example, the product is listed in the database, but is not in stock or does not have the desired color), then the order status "status": "PROCESSING" and the processing stage "substatus": "STARTED" it needs to be converted to the status "status": "CANCELLED" with the reason for the cancellation of the order "substatus": "SHOP_FAILED".
  • If the store has prepared an order for shipment, but cannot complete it (for example, the last item was damaged or defective), then the order status is "status": "PROCESSING" and the processing stage "substatus": "READY_TO_SHIP" it needs to be converted to the status "status": "CANCELLED" with the reason for the cancellation of the order "substatus": "SHOP_FAILED".
⚙️ Limit: 100,000 requests per hour

Request

PUT

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/{orderId}/status

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market — click on your account icon → Settings and in the menu on the left, select APIs and modules:

  • block Campaign ID;
  • tab Query log → drop-down list in the block Show logs.

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

Min value: 1

orderId*

Type: integer<int64>

The order ID.

Body

application/json
{
    "order": {
        "status": "PLACING",
        "substatus": "RESERVATION_EXPIRED",
        "delivery": {
            "dates": {
                "realDeliveryDate": "string"
            }
        }
    }
}

Name

Description

order*
Type: object

status*

Type: string

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

  • 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

delivery
Type: object

dates
Type: object

realDeliveryDate

Type: string<date>

For the model only DBS

The actual delivery date.

When to pass the parameter realDeliveryDate:

  • Do not pass the parameter if:

    • transfer the order to any status except PICKUP or DELIVERED;
    • changing the order status to PICKUP or DELIVERED on the day of delivery — the request completion date will be indicated.

  • Transmit the delivery date if you are converting the order to the status PICKUP or DELIVERED not on the day of delivery. You cannot specify a future delivery date.

    Transferring the status after the deadline reduces the quality index

    Read about the deadlines in the Help of the Market for sellers.

    Date format: YYYY-MM-DD.

The range of delivery dates.

Delivery information.

substatus

Type: string

Order processing stage (status PROCESSING) or the reason for the cancellation of the order (status CANCELLED).

  • Order values in the status PROCESSING:

    • STARTED — The order has been confirmed, and it can be processed.

    • READY_TO_SHIP — the order is assembled and ready for shipment.

  • Order values in the status CANCELLED:

    • RESERVATION_EXPIRED — The customer did not complete the reserved order within 10 minutes.

    • USER_NOT_PAID — the buyer did not pay for the order (for the payment type PREPAID) for 30 minutes.

    • USER_UNREACHABLE — couldn't contact the buyer. To cancel with this reason, the following conditions must be met:

      • at least 3 calls from 8 to 21 in the buyer's time zone;
      • the break between the first and third calls is at least 90 minutes;
      • the connection is no shorter than 5 seconds.

      If at least one of these conditions is not met (except when the number is unavailable), you will not be able to cancel the order. A response with the error code 400 will be returned.

    • USER_CHANGED_MIND — the customer cancelled the order for personal reasons.

    • USER_REFUSED_DELIVERY — the buyer was not satisfied with the terms of delivery.

    • USER_REFUSED_PRODUCT — the product did not fit the buyer.

    • SHOP_FAILED — the store cannot complete the order.

    • USER_REFUSED_QUALITY — the buyer was not satisfied with the quality of the product.

    • REPLACING_ORDER — the buyer decided to replace the product with another one on his own initiative.

    • PROCESSING_EXPIRED — the value is no longer used.

    • PICKUP_EXPIRED — The shelf life of the order at the pick-up point has expired.

    • TOO_MANY_DELIVERY_DATE_CHANGES — the order has been postponed too many times.

    • TOO_LONG_DELIVERY — The order is taking too long to be delivered.

    • INCORRECT_PERSONAL_DATA — For an order from abroad, the recipient's information is incorrect, and the order will not be checked at customs.

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

Other values may also be returned. You don't need to process them.

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

Order.

Responses

200 OK

If the order status is successfully changed, the updated order information is returned.

Body

application/json
{
    "order": {
        "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"
            },
            "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,
            "logisticPointId": 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"
    },
    "operation": {
        "id": "string",
        "type": "ORDER_RECIPIENT_UPDATE"
    }
}

Name

Description

operation
Type: object

id*

Type: string

ID of the operation.

Min length: 1

Max length: 1000

type*

Type: string

Type of operation:

  • ORDER_RECIPIENT_UPDATE — changing the recipient's data.

  • ORDER_DELIVERY_INTERVAL_UPDATE — changing the delivery date interval.

  • ORDER_STATUS_UPDATE — updating the order status to cancel it.

  • RETURN_CANCELLATION — cancellation of the refund.

Enum: ORDER_RECIPIENT_UPDATE, ORDER_DELIVERY_INTERVAL_UPDATE, ORDER_STATUS_UPDATE, RETURN_CANCELLATION

Information about the operation.

order
Type: object

buyer*
Type: object

type*

Type: string

Type of buyer:

  • PERSON — a natural person.

  • BUSINESS — organization.

Enum: PERSON, BUSINESS

firstName

Type: string

Name.

id

Type: string

The buyer's ID.

lastName

Type: string

Surname.

middleName

Type: string

Middle name.

Information about the buyer.

Parameters id, lastName, firstName and middleName They are returned only if you work according to the model. DBS.
Information about the buyer with basic fields.

buyerItemsTotalBeforeDiscount*

Type: number

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>

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

currency*

Type: string

Currency codes:

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

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

delivery*
Type: object

dates*
Type: object

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 with the parameter type=DELIVERY.

Time format: 24-hour, HH:MM. Instead of mm always specify 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 with the parameter type=DELIVERY.

Time format: 24-hour, HH:MM. Instead of mm always specify 00 (exception — 23:59).

Maximum value: 23:59.

The range of delivery dates.

deliveryPartnerType*

Type: string

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.

Enum: SHOP, YANDEX_MARKET, UNKNOWN

deliveryServiceId*

Type: integer<int64>

The delivery service ID.

serviceName*

Type: string

The name of the delivery service.

type*

Type: string

Order delivery method:

  • DELIVERY — courier delivery.

  • PICKUP — pickup.

  • POST — mail.

  • DIGITAL — for digital goods.

  • UNKNOWN — unknown type.

Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN

address
Type: object

apartment

Type: string

Apartment or office number.

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

entryphone

Type: string

The intercom code.

estate

Type: string

Ownership number.

floor

Type: string

Floor.

gps
Type: object

latitude*

Type: number

Width.

longitude*

Type: number

Longitude.

GPS coordinates of latitude and longitude.

house

Type: string

The house number.

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.

The delivery address.

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

courier
Type: object

fullName

Type: string

Full name.

phone

Type: string

Phone number.

phoneExtension

Type: string

The extension phone number.

vehicleDescription

Type: string

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

vehicleNumber

Type: string

Vehicle number.

Information about the courier.

dispatchType

Type: string

Shipping method:

  • BUYER — courier delivery to the buyer.

  • MARKET_BRANDED_OUTLET — delivery to the pick-up point of the Market.

  • SHOP_OUTLET — delivery to the store's order pick-up point.

  • UNKNOWN — unknown type.

Enum: UNKNOWN, BUYER, MARKET_BRANDED_OUTLET, SHOP_OUTLET

eacCode

Type: string

EAPP confirmation code (for type MERCHANT_TO_COURIER).

eacType

Type: string

The type of the EAPP confirmation code:

  • MERCHANT_TO_COURIER (temporarily non-refundable) — the seller transmits 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.

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

The cost of going up to the floor.

liftType

Type: string

The type of lifting the order to the floor:

  • NOT_NEEDED — not required.

  • MANUAL — manual.

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

logisticPointId

Type: integer<int64>

ID of the pick-up point.

It can be found using the method POST v1/businesses/{businessId}/logistics-points.

Min value: 1

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

See the shipping cost in the parameter deliveryTotal.

The cost of delivery in the currency of the order.

region
Type: object

id*

Type: integer<int64>

ID of the region.

name*

Type: string

The name of the region.

type*

Type: string

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 — the district of the subject of the federation.

  • REPUBLIC — the subject of the Federation.

  • SUBWAY_STATION — the metro station.

  • VILLAGE — city.

  • OTHER — unknown region.

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

parent

Type: any

Information about the parent region.

Parent regions are specified up to the country level.

The delivery region.

shipments

Type: object[]

Information about parcels.
The package list.

Multiple parcels can be specified in the parameter.

Min items: 1

tracks

Type: object[]

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

Min items: 1

vat

Type: string

VAT on the product or delivery:

  • 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 — VAT 20%. 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 — VAT is 12%. It is used only in Uzbekistan.

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

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

  • UNKNOWN_VALUE — unknown type.

It is only used together 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

Delivery information.

deliveryTotal*

Type: number

The cost of delivery.

fake*

Type: boolean

Order type:

  • false — the real customer's order.

  • true — test order Yandex. Market.

id*

Type: integer<int64>

The order ID.

items*

Type: object[]

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

itemsTotal*

Type: number

Buyer's payment.

paymentMethod*

Type: string

Payment method for the order:

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

    • YANDEX — by bank card.

    • APPLE_PAY — Apple Pay (not in use).

    • GOOGLE_PAY — Google Pay (not in use).

    • CREDIT — on credit.

    • TINKOFF_CREDIT — on credit from Tinkoff Bank.

    • TINKOFF_INSTALLMENTS — installments at Tinkoff Bank.

    • EXTERNAL_CERTIFICATE — with 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 — with a 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: string

Order payment type:

  • PREPAID — payment at checkout.

  • POSTPAID — payment is made 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: string

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

  • 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

substatus*

Type: string

Order processing stage (status PROCESSING) or the reason for the cancellation of the order (status CANCELLED).

  • Order values in the status PROCESSING:

    • STARTED — The order has been confirmed, and it can be processed.

    • READY_TO_SHIP — the order is assembled and ready for shipment.

  • Order values in the status CANCELLED:

    • RESERVATION_EXPIRED — The customer did not complete the reserved order within 10 minutes.

    • USER_NOT_PAID — the buyer did not pay for the order (for the payment type PREPAID) for 30 minutes.

    • USER_UNREACHABLE — couldn't contact the buyer. To cancel with this reason, the following conditions must be met:

      • at least 3 calls from 8 to 21 in the buyer's time zone;
      • the break between the first and third calls is at least 90 minutes;
      • the connection is no shorter than 5 seconds.

      If at least one of these conditions is not met (except when the number is unavailable), you will not be able to cancel the order. A response with the error code 400 will be returned.

    • USER_CHANGED_MIND — the customer cancelled the order for personal reasons.

    • USER_REFUSED_DELIVERY — the buyer was not satisfied with the terms of delivery.

    • USER_REFUSED_PRODUCT — the product did not fit the buyer.

    • SHOP_FAILED — the store cannot complete the order.

    • USER_REFUSED_QUALITY — the buyer was not satisfied with the quality of the product.

    • REPLACING_ORDER — the buyer decided to replace the product with another one on his own initiative.

    • PROCESSING_EXPIRED — the value is no longer used.

    • PICKUP_EXPIRED — The shelf life of the order at the pick-up point has expired.

    • TOO_MANY_DELIVERY_DATE_CHANGES — the order has been postponed too many times.

    • TOO_LONG_DELIVERY — The order is taking too long to be delivered.

    • INCORRECT_PERSONAL_DATA — For an order from abroad, the recipient's information is incorrect, and the order will not be checked at customs.

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

Other values may also be returned. You don't need to process them.

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

taxSystem*

Type: string

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 — the tax on professional income (NAP).

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

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

buyerItemsTotal

⦸

Type: number

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

buyerTotal

⦸

Type: number

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

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

For the model only DBS

Whether a cancellation has been requested.

expiryDate

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

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

externalOrderId

Type: string

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

Min length: 1

notes

Type: string

Comment on the order.

subsidies

Type: object[]

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>

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

Order.

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

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

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

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of the Market. More information about the error

Body

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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

Previous
Transmitting an external order ID
Next
Massive changes in order statuses