The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
block Campaign ID;
tab Query log → drop-down list in the block Show logs.
⚠️ Do not confuse it with:
the store's identifier, which is displayed in the merchant's personal account.
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
The delivery service ID.
serviceName
Type: string
The name of the delivery service.
Example:example
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.
Example:example
block
Type: string
Body.
Example:example
building
Type: string
Building.
Example:example
city
Type: string
A city or locality.
Example:example
country
Type: string
A country.
Example:example
district
Type: string
District.
Example:example
entrance
Type: string
Entrance number.
Example:example
entryphone
Type: string
The intercom code.
Example:example
estate
Type: string
Ownership number.
Example:example
floor
Type: string
Floor.
Example:example
gps
Type: object
latitude
Type: number
Width.
longitude
Type: number
Longitude.
GPS coordinates of latitude and longitude.
Example
{"latitude":0.5,"longitude":0.5}
house
Type: string
The house number.
Example:example
phone
Type: string
The phone number of the recipient of the order.
Example:example
postcode
Type: string
Postal code.
Indicated if mail delivery is selected (delivery type=POST).
Example:example
recipient
Type: string
Last name, first name and patronymic of the recipient of the order.
Example:example
street
Type: string
Street.
Example:example
subway
Type: string
The metro station.
Example:example
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.
The time by which the store must package the order and convert it to the status READY_TO_SHIP. After the status change, a courier will arrive to pick up the order.
The field may not appear immediately. Request information about the order within 5-10 minutes until it is returned.
Time format: 24-hour, HH:MM.
If the order is made by an organization, the parameter is not returned until the delivery date is agreed.
Example:example
tracks
Type: object[]
deliveryServiceId
Type: integer
The delivery service ID. Information about the delivery service can be obtained by requesting GET delivery/services.
The delivery service ID. Information about the delivery service can be obtained by requesting GET delivery/services.
trackCode
Type: string
The parcel's track number.
Example:example
Information for tracking the parcel.
Min items:1
Example
[{"trackCode":"example","deliveryServiceId":0}]
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.
The price of the product in the buyer's currency. The price already includes discounts on:
shares;
coupons;
promo codes.
buyerPriceBeforeDiscount
Type: number
The cost of the product in the buyer's currency before applying discounts on:
shares;
coupons;
promo codes.
count
Type: integer
The number of product units.
id
Type: integer
The product ID in the order.
Allows you to identify the product within the order.
offerId
Type: string
Your SKU — the product ID in your system.
Usage rules SKU:
For each product SKU there must be one.
Already set SKU it 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 price of the product in the order currency, excluding remuneration to the seller for discounts on promo codes, coupons and promotions (parameter subsidies).
The unit identification code in the system "An honest SIGN" without a cryptotail or «ASL BELGISI» (for sellers of the Yandex Go Market).
Example:example
cisFull
Type: string
The unit identification code in the system "An honest SIGN" with a cryptotail.
Example:example
countryCode
Type: string
The country of manufacture is in the ISO 3166-1 alpha-2 format. How to get
Min length:2
Max length:2
Pattern:^[A-Z]{2}$
Example:RU
gtd
Type: string
Cargo customs declaration.
It is a string of three numbers separated by a slash: XXXXXXXXXX/XXXXXXXX/XXXXXXXX.
The first part — the code of the customs office that registered the declaration for imported goods. Further — date and number of the declaration.
Example:example
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 — the code of the customs office that registered the declaration for the shipment. Further — the date, number of the declaration and the number of the marked product in the declaration.
Example:example
uin
Type: string
Jewelry's UIN (16-digit code)
The manufacturer receives a WIN when he registers the product in the control system for the turnover of precious metals and stones. — GIIS DMDK.
Example:example
Information about the labeling of product units.
The tagging data passed in the request is returned:
The amount of the user discount in the buyer's currency.
marketPromoId
Type: string
The identifier of the promotion within the framework of the agreement for the provision of services for the promotion of the service between the Market and the seller.
Example:example
shopPromoId
Type: string
The ID of the supplier's promotion.
Example:example
Information about the remuneration to the seller for discounts on goods using promo codes, coupons, and promotions.
Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.
Total remuneration to the seller for DBS-delivery and all discounts on the product:
by promo codes;
by coupons;
by Plus points;
on shares.
tags
Type: string[] | null
Product attributes.
Min items:1
Unique items:true
Example
["ULTIMA"]
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.
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.
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).
No longer supported, please use an alternative and newer version.
The security tag helps to prevent the product from being replaced upon return. You will not be able to return the product without the protective tag that was present at the time of purchase.