|
order*
|
Type: object
|
businessId
|
Type: integer<int64>
Cabinet ID.
|
|
buyer
|
Type: object
|
type*
|
Type: string
Type of buyer:
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.
|
|
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>
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
|
address
|
Type: object
|
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.
|
|
phone
|
Type: string
The phone number of the recipient of the order.
Required parameter.
|
|
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.
Required parameter.
|
|
schedule
|
Type: object[]
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.
|
The delivery address. Passed if the parameter type it matters DELIVERY.
|
|
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.
|
|
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:
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: 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
|
|
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
For the model only DBS
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 the order was placed in the request. PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/date.
|
|
liftPrice
|
Type: number<decimal>
For the model only DBS
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
|
|
outlet
|
Type: object
|
code
|
Type: string
The pick-up point ID assigned by the store.
|
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>
|
|
region
|
Type: any
The delivery region.
|
|
serviceName
|
Type: string
The name of the delivery service.
|
|
shipments
|
Type: object[]
Information about parcels.
For the model DBS: is transmitted if the order was created at the Market pick-up point.
The package list.
|
|
shopDeliveryId
|
Type: string
For the model only DBS
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: string
Order delivery method:
Enum: DELIVERY, PICKUP, POST, DIGITAL, UNKNOWN
|
|
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 from 2019 to January 1, 2026.
-
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).
-
VAT_22 — VAT is 22%. Basic VAT starting from January 1, 2026.
-
UNKNOWN_VALUE — unknown type.
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, VAT_22, UNKNOWN_VALUE
|
Delivery information.
|
|
deliveryTotal
|
Type: number<decimal>
The cost of delivery in the currency of the order.
|
|
electronicAcceptanceCertificateCode
|
Type: string
For the model only FBS
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 of the Market for sellers.
|
|
expiryDate
|
Type: string<date-dd-MM-yyyy>
Date format: DD-MM-YYYY.
Example: 23-09-2022
|
|
fake
|
Type: boolean
Order type:
|
|
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<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: string
Payment method for the order:
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: string
Order payment 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: 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
|
|
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).
|
|
subsidyTotal
|
Type: number<decimal>
Total remuneration to the seller for discounts:
- by promo codes;
- by coupons;
- for shares;
- subsidy for delivery.
|
|
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
|
|
tags
|
Type: string[]
Signs of the order. Order attribute:
ULTIMA — an order with a premium product.
Enum: ULTIMA
|
|
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 taxation system.
-
PSN — patent Taxation System (PSN).
-
USN — simplified Taxation System (STS).
-
USN_MINUS_COST — simplified taxation system, income reduced by the amount of expenses (USN "Income minus expenses").
-
NPD — the tax on professional income (NAP).
-
UNKNOWN_VALUE — unknown value.
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).
|
Order.
|