Information about orders in the cabinet

The method is available for models: FBY, 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

Returns information about orders in the merchant profile. The query can be used to track orders and their statuses.

You can also set up API notifications.

Yandex.Market will send you request when a new order appears or its status changes. And full information can be obtained using this method.

How to work with notifications

Filtering by parameters is available:

  • the date of the order.

  • date and time of the order update;

  • date of shipment;

  • order statuses (statuses);

  • stages of processing or reasons for cancellation (substatuses);

  • campaign IDs;

  • order IDs;

  • external order IDs;

  • the type of order (real or test);

  • type of buyer;

  • placement models;

  • the availability of requests from customers to cancel the order.

Maximum date range per request — 30 days (passed in the parameters fromDate and toDate). If they are not transmitted, the information for the last 30 days is returned.

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

You can get more detailed information about the buyer and his phone number by requesting GET v2/campaigns/{campaignId}/orders/{orderId}/buyer.

Restriction for the parameter limit

Do not transmit a value greater than 50.

⚙️ Limit: 10,000 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v1/businesses/{businessId}/orders

Path parameters

Name

Description

businessId

Type: integer

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Query parameters

Name

Description

limit

Type: integer

The number of values per page.

Min value: 1

page_token

Type: string

ID of the results page.

If the parameter is omitted, the first page is returned.

We recommend transmitting the value of the output parameter nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
  "orderIds": [
    0
  ],
  "externalOrderIds": [
    "example"
  ],
  "programTypes": [
    "FBY"
  ],
  "campaignIds": [
    1
  ],
  "statuses": [
    "PLACING"
  ],
  "substatuses": [
    "RESERVATION_EXPIRED"
  ],
  "dates": {
    "creationDateFrom": "2025-01-01",
    "creationDateTo": "2025-01-01",
    "shipmentDateFrom": "2025-01-01",
    "shipmentDateTo": "2025-01-01",
    "updateDateFrom": "2025-01-01T00:00:00Z",
    "updateDateTo": "2025-01-01T00:00:00Z"
  },
  "fake": true,
  "waitingForCancellationApprove": true,
  "sourcePlatforms": [
    "MARKET"
  ]
}

Name

Description

campaignIds

Type: integer[] | null

IDs of store campaigns.

Min items: 1

Max items: 50

Unique items: true

Example
[
  1
]

dates
Type: object

creationDateFrom

Type: string<date>

The initial date of the order (YYYY-MM-DD).

Example: 2025-01-01

creationDateTo

Type: string<date>

The end date of the order (YYYY-MM-DD).

Example: 2025-01-01

shipmentDateFrom

Type: string<date>

The initial date of shipment (YYYY-MM-DD).

Example: 2025-01-01

shipmentDateTo

Type: string<date>

The final date of shipment (YYYY-MM-DD).

Example: 2025-01-01

updateDateFrom

Type: string<date-time>

The initial date of the order update (ISO 8601).

Example: 2025-01-01T00:00:00Z

updateDateTo

Type: string<date-time>

The end date of the order update (ISO 8601).

Example: 2025-01-01T00:00:00Z

Filter by order dates.

Example
{
  "creationDateFrom": "2025-01-01",
  "creationDateTo": "2025-01-01",
  "shipmentDateFrom": "2025-01-01",
  "shipmentDateTo": "2025-01-01",
  "updateDateFrom": "2025-01-01T00:00:00Z",
  "updateDateTo": "2025-01-01T00:00:00Z"
}

externalOrderIds

Type: string[] | null

External order IDs.

Min items: 1

Max items: 50

Unique items: true

Example
[
  "example"
]

fake

Type: boolean

Order type:

  • false — the real customer's order.

  • true — test order Yandex. Market.

orderIds

Type: integer[] | null

Order IDs.

Min items: 1

Max items: 50

Unique items: true

Example
[
  0
]

programTypes

Type: string[] | null

Models of the store's operation on the Market.

Min items: 1

Unique items: true

Example
[
  "FBY"
]

sourcePlatforms

Type: string[] | null

Platforms are sources of orders.

Min items: 1

Unique items: true

Example
[
  "MARKET"
]

statuses

Type: string[] | null

Order statuses.

Min items: 1

Unique items: true

Example
[
  "PLACING"
]

substatuses

Type: string[] | null

Stages of processing or reasons for canceling orders.

Min items: 1

Unique items: true

Example
[
  "RESERVATION_EXPIRED"
]

waitingForCancellationApprove

Type: boolean

For the model only DBS

A filter for receiving orders that have cancellation requests.

With the value true only those orders that are in the status are returned. DELIVERY or PICKUP, and the users decided to cancel them.

Responses

200 OK

The list of orders in the cabinet.

Body

application/json
{
  "orders": [
    {
      "orderId": 0,
      "campaignId": 1,
      "programType": "FBY",
      "externalOrderId": "example",
      "status": "PLACING",
      "substatus": "RESERVATION_EXPIRED",
      "creationDate": "2020-02-02T14:30:30+03:00",
      "updateDate": "2020-02-02T14:30:30+03:00",
      "paymentType": "PREPAID",
      "paymentMethod": "CASH_ON_DELIVERY",
      "fake": true,
      "items": [
        {
          "id": 0,
          "offerId": "example",
          "offerName": "example",
          "count": 0,
          "prices": {},
          "instances": [
            null
          ],
          "requiredInstanceTypes": [
            null
          ],
          "tags": [
            null
          ]
        }
      ],
      "prices": {
        "payment": {
          "value": 0.5,
          "currencyId": "RUR"
        },
        "subsidy": {
          "value": 0.5,
          "currencyId": "RUR"
        },
        "cashback": {
          "value": 0.5,
          "currencyId": "RUR"
        },
        "delivery": {
          "payment": {},
          "subsidy": {},
          "vat": "NO_VAT"
        }
      },
      "delivery": {
        "type": "DELIVERY",
        "serviceName": "example",
        "deliveryServiceId": 0,
        "warehouseId": "example",
        "deliveryPartnerType": "SHOP",
        "dispatchType": "UNKNOWN",
        "dates": {
          "fromDate": "2025-01-01",
          "toDate": "2025-01-01",
          "fromTime": "12:00:00",
          "toTime": "12:00:00",
          "realDeliveryDate": "2025-01-01"
        },
        "shipment": {
          "id": 0,
          "shipmentDate": "2025-01-01",
          "shipmentTime": "12:00:00"
        },
        "courier": {
          "address": {},
          "region": {}
        },
        "pickup": {
          "address": {},
          "region": {},
          "logisticPointId": 1,
          "outletCode": "example",
          "outletStorageLimitDate": "2025-01-01"
        },
        "transfer": {
          "courier": {},
          "eac": {}
        },
        "boxesLayout": [
          {}
        ],
        "tracks": [
          {}
        ],
        "estimated": true,
        "receiveCode": "example"
      },
      "services": {
        "liftType": "NOT_NEEDED"
      },
      "buyerType": "PERSON",
      "notes": "example",
      "cancelRequested": true,
      "sourcePlatform": "MARKET"
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

Name

Description

orders
Type: object[]

campaignId

Type: integer

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

Min value: 1

creationDate

Type: string<date-time>

The date and time of the order.

Date format: ISO 8601 with an offset relative to UTC.

Example: 2020-02-02T14:30:30+03:00

delivery
Type: object

dates
Type: object

fromDate

Type: string<date>

The nearest delivery date.

Date format: YYYY-MM-DD.

Example: 2025-01-01

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.

Example: 12:00:00

realDeliveryDate

Type: string<date>

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

Date format: YYYY-MM-DD.

Example: 2025-01-01

toDate

Type: string<date>

The latest delivery date.

If toDate omitted, the date in the parameter is considered fromDate.

Date format: YYYY-MM-DD.

Example: 2025-01-01

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.

Example: 12:00:00

The range of delivery dates.

Example
{
  "fromDate": "2025-01-01",
  "toDate": "2025-01-01",
  "fromTime": "12:00:00",
  "toTime": "12:00:00",
  "realDeliveryDate": "2025-01-01"
}

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

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

boxesLayout
Type: object[]

barcode

Type: string

ID of the cargo space in the store's system.

Example: example

boxId

Type: integer

The ID of the box.

items
Type: object[]

id

Type: integer

The product ID in the order.

Parameter id in items.

fullCount

Type: integer

The number of items in a box.

Min value: 1

instances
Type: object[]

cis

Type: string

[Identification code](*cis-regular-value) product units in the system "An honest SIGN" or «ASL BELGISI» (for sellers of the Yandex Go Market).

Do not escape the slash in the separator character code. \u001d

✅ 01030410947874432155Qbag!\u001d93Zjqw

❌ 01030410947874432155Qbag!\\u001d93Zjqw

Escape slashes and quotation marks in other places according to the JSON rules.: \\ and \"

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 a slash: 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

The unique identification number of the jewelry.

It is a 16-digit number.

Example: example

Transmitted marking codes.

Min items: 1

Example
[
  {
    "cis": "example",
    "uin": "example",
    "rnpt": "example",
    "gtd": "example",
    "countryCode": "RU"
  }
]

partialCount
Type: object

current

Type: integer

The part number, starting from 1.

Min value: 1

total

Type: integer

The total number of parts the product is divided into.

Min value: 2

Information about the part of the product in the box.

Example
{
  "current": 1,
  "total": 2
}

The list of products in the box.

If there is a part of a large product in the box, there can be only one item in the list.

Min items: 1

Example
[
  {
    "id": 0,
    "fullCount": 1,
    "partialCount": {
      "current": 1,
      "total": 2
    },
    "instances": [
      {
        "cis": "example",
        "uin": "example",
        "rnpt": "example",
        "gtd": "example",
        "countryCode": "RU"
      }
    ]
  }
]

The layout of goods in boxes.

Min items: 1

Example
[
  {
    "items": [
      {
        "id": 0,
        "fullCount": 1,
        "partialCount": {
          "current": 1,
          "total": 2
        },
        "instances": [
          {}
        ]
      }
    ],
    "boxId": 0,
    "barcode": "example"
  }
]

courier
Type: object

address
Type: object

apartment

Type: string

Apartment or office number.

Example: example

block

Type: string

Body.

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

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

postcode

Type: string

Postal code.

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.

Example
{
  "country": "example",
  "postcode": "example",
  "city": "example",
  "district": "example",
  "subway": "example",
  "street": "example",
  "house": "example",
  "block": "example",
  "entrance": "example",
  "entryphone": "example",
  "floor": "example",
  "apartment": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

region
Type: object

id

Type: integer

ID of the region.

name

Type: string

The name of the region.

Example: example

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

Information about the parent region.

Parent regions are specified up to the country level.

Example: null

The delivery region.

Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}

Information about courier delivery.

Example
{
  "address": {
    "country": "example",
    "postcode": "example",
    "city": "example",
    "district": "example",
    "subway": "example",
    "street": "example",
    "house": "example",
    "block": "example",
    "entrance": "example",
    "entryphone": "example",
    "floor": "example",
    "apartment": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "region": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  }
}

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

estimated

Type: boolean

Whether the delivery date is approximate.

pickup
Type: object

address
Type: object

apartment

Type: string

Apartment or office number.

Example: example

block

Type: string

Body.

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

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

postcode

Type: string

Postal code.

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.

Example
{
  "country": "example",
  "postcode": "example",
  "city": "example",
  "district": "example",
  "subway": "example",
  "street": "example",
  "house": "example",
  "block": "example",
  "entrance": "example",
  "entryphone": "example",
  "floor": "example",
  "apartment": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

logisticPointId

Type: integer

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.

Example: example

outletStorageLimitDate

Type: string<date>

The date until which the order will be stored at the pick-up point. Returned when the order status changes to PICKUP.

You can change the date once using the method PUT v2/campaigns/{campaignId}/orders/{orderId}/delivery/storage-limit.

Date format: YYYY-MM-DD.

Example: 2025-01-01

region
Type: object

id

Type: integer

ID of the region.

name

Type: string

The name of the region.

Example: example

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

Information about the parent region.

Parent regions are specified up to the country level.

Example: null

The delivery region.

Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}

Information about delivery to the pick-up point.

Example
{
  "address": {
    "country": "example",
    "postcode": "example",
    "city": "example",
    "district": "example",
    "subway": "example",
    "street": "example",
    "house": "example",
    "block": "example",
    "entrance": "example",
    "entryphone": "example",
    "floor": "example",
    "apartment": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "region": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  },
  "logisticPointId": 1,
  "outletCode": "example",
  "outletStorageLimitDate": "2025-01-01"
}

receiveCode

Type: string

Only for the LaaS model

The order receipt code for the PVZ.

Example: example

shipment
Type: object

shipmentDate

Type: string<date>

Date of shipment.

Date format: YYYY-MM-DD.

Example: 2025-01-01

id

Type: integer | null

Shipment ID.

shipmentTime

Type: string<time> | null

Shipping time.

Example: 12:00:00

Information about the shipment of the order.

Example
{
  "id": 0,
  "shipmentDate": "2025-01-01",
  "shipmentTime": "12:00:00"
}

tracks
Type: object[]

deliveryServiceId

Type: integer

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
  }
]

transfer
Type: object

courier
Type: object

fullName

Type: string

Full name.

Example: example

phone

Type: string

Phone number.

Example: example

phoneExtension

Type: string

The extension phone number.

Example: example

vehicleDescription

Type: string

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

Example: example

vehicleNumber

Type: string

Vehicle number.

Example: example

Information about the courier.

Example
{
  "fullName": "example",
  "phone": "example",
  "phoneExtension": "example",
  "vehicleNumber": "example",
  "vehicleDescription": "example"
}

eac
Type: object

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

eacCode

Type: string

EAPP confirmation code (for type MERCHANT_TO_COURIER).

Example: example

Information about the confirmation code.

Example
{
  "eacType": "MERCHANT_TO_COURIER",
  "eacCode": "example"
}

Information about the courier and the confirmation code.

Example
{
  "courier": {
    "fullName": "example",
    "phone": "example",
    "phoneExtension": "example",
    "vehicleNumber": "example",
    "vehicleDescription": "example"
  },
  "eac": {
    "eacType": "MERCHANT_TO_COURIER",
    "eacCode": "example"
  }
}

warehouseId

Type: string

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

Example: example

Order delivery information.

Example
{
  "type": "DELIVERY",
  "serviceName": "example",
  "deliveryServiceId": 0,
  "warehouseId": "example",
  "deliveryPartnerType": "SHOP",
  "dispatchType": "UNKNOWN",
  "dates": {
    "fromDate": "2025-01-01",
    "toDate": "2025-01-01",
    "fromTime": "12:00:00",
    "toTime": "12:00:00",
    "realDeliveryDate": "2025-01-01"
  },
  "shipment": {
    "id": 0,
    "shipmentDate": "2025-01-01",
    "shipmentTime": "12:00:00"
  },
  "courier": {
    "address": {
      "country": "example",
      "postcode": "example",
      "city": "example",
      "district": "example",
      "subway": "example",
      "street": "example",
      "house": "example",
      "block": "example",
      "entrance": "example",
      "entryphone": "example",
      "floor": "example",
      "apartment": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      }
    },
    "region": {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    }
  },
  "pickup": {
    "address": {
      "country": "example",
      "postcode": "example",
      "city": "example",
      "district": "example",
      "subway": "example",
      "street": "example",
      "house": "example",
      "block": "example",
      "entrance": "example",
      "entryphone": "example",
      "floor": "example",
      "apartment": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      }
    },
    "region": {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "parent": null
    },
    "logisticPointId": 1,
    "outletCode": "example",
    "outletStorageLimitDate": "2025-01-01"
  },
  "transfer": {
    "courier": {
      "fullName": "example",
      "phone": "example",
      "phoneExtension": "example",
      "vehicleNumber": "example",
      "vehicleDescription": "example"
    },
    "eac": {
      "eacType": "MERCHANT_TO_COURIER",
      "eacCode": "example"
    }
  },
  "boxesLayout": [
    {
      "items": [
        {
          "id": 0,
          "fullCount": 1,
          "partialCount": {},
          "instances": [
            null
          ]
        }
      ],
      "boxId": 0,
      "barcode": "example"
    }
  ],
  "tracks": [
    {
      "trackCode": "example",
      "deliveryServiceId": 0
    }
  ],
  "estimated": true,
  "receiveCode": "example"
}

fake

Type: boolean

Order type:

  • false — the real customer's order.

  • true — test order Yandex. Market.

items
Type: object[]

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.

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

Warning

Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

What is SKU and how to assign it

Min length: 1

Max length: 255

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

Example: example

offerName

Type: string

Product name.

Example: example

instances
Type: object[]

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

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 a slash: 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. PUT v2/campaigns/{campaignId}/orders/{orderId}/identifiers.

If the store has not sent the codes for this order yet, instances absent.

Min items: 1

Example
[
  {
    "cis": "example",
    "cisFull": "example",
    "uin": "example",
    "rnpt": "example",
    "gtd": "example",
    "countryCode": "RU"
  }
]

prices
Type: object

cashback
Type: object

currencyId

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

value

Type: number

Meaning.

Currency and its value.

Example
{
  "value": 0.5,
  "currencyId": "RUR"
}

payment
Type: object

currencyId

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

value

Type: number

Meaning.

Currency and its value.

Example
{
  "value": 0.5,
  "currencyId": "RUR"
}

subsidy
Type: object

currencyId

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

value

Type: number

Meaning.

Currency and its value.

Example
{
  "value": 0.5,
  "currencyId": "RUR"
}

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

Information about payments and rewards.

How is the cost of all units of goods and the seller's remuneration calculated?

  • The cost of all units of the product consists of the parameters payment and cashback.
  • The total amount of rewards to the seller is returned in the parameter subsidy.
  • Meaning payment, cashback and subsidy it may differ from the price in the catalog, because information about the store's promotions is not returned.
  • If there are several items in the order, the total value is returned in the parameters.
  • All amounts are indicated in the store's currency.
Example
{
  "payment": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "subsidy": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "cashback": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "vat": "NO_VAT"
}

requiredInstanceTypes

Type: string[] | null

A list of required product markings.

Min items: 1

Unique items: true

Example
[
  "CIS"
]

tags

Type: string[] | null

Product attributes.

Min items: 1

Unique items: true

Example
[
  "ULTIMA"
]

The list of products in the order.

Example
[
  {
    "id": 0,
    "offerId": "example",
    "offerName": "example",
    "count": 0,
    "prices": {
      "payment": {
        "value": 0.5,
        "currencyId": "RUR"
      },
      "subsidy": {
        "value": 0.5,
        "currencyId": "RUR"
      },
      "cashback": {
        "value": 0.5,
        "currencyId": "RUR"
      },
      "vat": "NO_VAT"
    },
    "instances": [
      {
        "cis": "example",
        "cisFull": "example",
        "uin": "example",
        "rnpt": "example",
        "gtd": "example",
        "countryCode": "RU"
      }
    ],
    "requiredInstanceTypes": [
      "CIS"
    ],
    "tags": [
      "ULTIMA"
    ]
  }
]

orderId

Type: integer

The order ID.

paymentMethod

Type: string

Order payment method:

  • 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

buyerType

Type: string

Type of buyer:

  • PERSON — a natural person.

  • BUSINESS — organization.

Enum: PERSON, BUSINESS

cancelRequested

Type: boolean

For the model only DBS

Whether a cancellation has been requested.

externalOrderId

Type: string

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

Min length: 1

Example: example

notes

Type: string

Comment on the order.

Example: example

prices
Type: object

cashback
Type: object

currencyId

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

value

Type: number

Meaning.

Currency and its value.

Example
{
  "value": 0.5,
  "currencyId": "RUR"
}

delivery
Type: object

payment
Type: object

currencyId

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

value

Type: number

Meaning.

Currency and its value.

Example
{
  "value": 0.5,
  "currencyId": "RUR"
}

subsidy
Type: object

currencyId

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

value

Type: number

Meaning.

Currency and its value.

Example
{
  "value": 0.5,
  "currencyId": "RUR"
}

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

Information about the cost of delivery, including going up to the floor.

How is the shipping cost calculated?

  • The cost of delivery consists of the parameters payment and subsidy.
  • All amounts are indicated in the store's currency.
Example
{
  "payment": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "subsidy": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "vat": "NO_VAT"
}

payment
Type: object

currencyId

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

value

Type: number

Meaning.

Currency and its value.

Example
{
  "value": 0.5,
  "currencyId": "RUR"
}

subsidy
Type: object

currencyId

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

value

Type: number

Meaning.

Currency and its value.

Example
{
  "value": 0.5,
  "currencyId": "RUR"
}

Information about the cost of the order.

How is the cost of the order, delivery and remuneration to the seller calculated?

  • The cost of the goods in the order consists of the parameters payment and cashback.
  • The total amount of rewards to the seller is returned in the parameter subsidy.
  • Meaning payment, cashback and subsidy it may differ from the price in the catalog, because information about the store's promotions is not returned.
  • The cost of delivery consists of the parameters payment and subsidy in delivery.
  • All amounts are indicated in the store's currency.
Example
{
  "payment": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "subsidy": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "cashback": {
    "value": 0.5,
    "currencyId": "RUR"
  },
  "delivery": {
    "payment": {
      "value": 0.5,
      "currencyId": "RUR"
    },
    "subsidy": {
      "value": 0.5,
      "currencyId": "RUR"
    },
    "vat": "NO_VAT"
  }
}

programType

Type: string

Working model:

  • FBY — FBY.
  • FBS — FBS.
  • DBS — DBS.
  • EXPRESS — Express.

Enum: FBY, FBS, DBS, EXPRESS, LAAS

services
Type: object

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

Services added to the order.

Example
{
  "liftType": "NOT_NEEDED"
}

sourcePlatform

Type: string

The site is the source of the order:

  • MARKET — an order placed on the Market.

  • OZON — LaaS is an order placed on Ozon.

  • WILDBERRIES — LaaS is an order placed on Wildberries.

  • OTHER — LaaS is an order created by the seller.

Enum: MARKET, OZON, WILDBERRIES, OTHER

updateDate

Type: string<date-time>

The date and time of the last order update.

Date format: ISO 8601 with an offset relative to UTC.

Example: 2020-02-02T14:30:30+03:00

The list of orders in the cabinet.

Max items: 50

Example
[
  {
    "orderId": 0,
    "campaignId": 1,
    "programType": "FBY",
    "externalOrderId": "example",
    "status": "PLACING",
    "substatus": "RESERVATION_EXPIRED",
    "creationDate": "2020-02-02T14:30:30+03:00",
    "updateDate": "2020-02-02T14:30:30+03:00",
    "paymentType": "PREPAID",
    "paymentMethod": "CASH_ON_DELIVERY",
    "fake": true,
    "items": [
      {
        "id": 0,
        "offerId": "example",
        "offerName": "example",
        "count": 0,
        "prices": {
          "payment": {},
          "subsidy": {},
          "cashback": {},
          "vat": "NO_VAT"
        },
        "instances": [
          {}
        ],
        "requiredInstanceTypes": [
          "CIS"
        ],
        "tags": [
          "ULTIMA"
        ]
      }
    ],
    "prices": {
      "payment": {
        "value": 0.5,
        "currencyId": "RUR"
      },
      "subsidy": {
        "value": 0.5,
        "currencyId": "RUR"
      },
      "cashback": {
        "value": 0.5,
        "currencyId": "RUR"
      },
      "delivery": {
        "payment": {
          "value": 0.5,
          "currencyId": "RUR"
        },
        "subsidy": {
          "value": 0.5,
          "currencyId": "RUR"
        },
        "vat": "NO_VAT"
      }
    },
    "delivery": {
      "type": "DELIVERY",
      "serviceName": "example",
      "deliveryServiceId": 0,
      "warehouseId": "example",
      "deliveryPartnerType": "SHOP",
      "dispatchType": "UNKNOWN",
      "dates": {
        "fromDate": "2025-01-01",
        "toDate": "2025-01-01",
        "fromTime": "12:00:00",
        "toTime": "12:00:00",
        "realDeliveryDate": "2025-01-01"
      },
      "shipment": {
        "id": 0,
        "shipmentDate": "2025-01-01",
        "shipmentTime": "12:00:00"
      },
      "courier": {
        "address": {
          "country": "example",
          "postcode": "example",
          "city": "example",
          "district": "example",
          "subway": "example",
          "street": "example",
          "house": "example",
          "block": "example",
          "entrance": "example",
          "entryphone": "example",
          "floor": "example",
          "apartment": "example",
          "gps": {}
        },
        "region": {
          "id": 0,
          "name": "example",
          "type": "OTHER",
          "parent": null
        }
      },
      "pickup": {
        "address": {
          "country": "example",
          "postcode": "example",
          "city": "example",
          "district": "example",
          "subway": "example",
          "street": "example",
          "house": "example",
          "block": "example",
          "entrance": "example",
          "entryphone": "example",
          "floor": "example",
          "apartment": "example",
          "gps": {}
        },
        "region": {
          "id": 0,
          "name": "example",
          "type": "OTHER",
          "parent": null
        },
        "logisticPointId": 1,
        "outletCode": "example",
        "outletStorageLimitDate": "2025-01-01"
      },
      "transfer": {
        "courier": {
          "fullName": "example",
          "phone": "example",
          "phoneExtension": "example",
          "vehicleNumber": "example",
          "vehicleDescription": "example"
        },
        "eac": {
          "eacType": "MERCHANT_TO_COURIER",
          "eacCode": "example"
        }
      },
      "boxesLayout": [
        {
          "items": [
            null
          ],
          "boxId": 0,
          "barcode": "example"
        }
      ],
      "tracks": [
        {
          "trackCode": "example",
          "deliveryServiceId": 0
        }
      ],
      "estimated": true,
      "receiveCode": "example"
    },
    "services": {
      "liftType": "NOT_NEEDED"
    },
    "buyerType": "PERSON",
    "notes": "example",
    "cancelRequested": true,
    "sourcePlatform": "MARKET"
  }
]

paging
Type: object

nextPageToken

Type: string

ID of the next results page.

Example: example

The ID of the next page.

Example
{
  "nextPageToken": "example"
}

400 Bad Request

The request contains incorrect data. Learn more about errors when working with orders

Body

application/json
{
  "status": "OK"
}

Type: object

401 Unauthorized

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

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

404 Not Found

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

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

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

Body

application/json
{
  "status": "OK"
}

Type: object

pathParams:
  - description: "Cabinet ID. To find out, use the request [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [What is a cabinet and a store on the Market?](https://yandex.ru/support/marketplace/account/introduction.html)\n"
    name: businessId
    in: path
    required: true
    schema:
      type: integer
      format: int64
      minimum: 1
searchParams:
  - name: page_token
    description: >
      ID of the results page.


      If the parameter is omitted, the first page is returned.


      We recommend transmitting the value of the output parameter
      `nextPageToken`, received during the last request.


      If set `page_token` and the request has parameters
      `page` and `pageSize` they are ignored.
    in: query
    required: false
    example: eyBuZXh0SWQ6IDIzNDIgfQ==
    schema:
      type: string
  - name: limit
    description: |
      The number of values per page.
    in: query
    required: false
    example: 20
    schema:
      type: integer
      format: int32
      minimum: 1
headers: []
body: |-
  {
    "orderIds": [
      0
    ],
    "externalOrderIds": [
      "example"
    ],
    "programTypes": [
      "FBY"
    ],
    "campaignIds": [
      1
    ],
    "statuses": [
      "PLACING"
    ],
    "substatuses": [
      "RESERVATION_EXPIRED"
    ],
    "dates": {
      "creationDateFrom": "2025-01-01",
      "creationDateTo": "2025-01-01",
      "shipmentDateFrom": "2025-01-01",
      "shipmentDateTo": "2025-01-01",
      "updateDateFrom": "2025-01-01T00:00:00Z",
      "updateDateTo": "2025-01-01T00:00:00Z"
    },
    "fake": true,
    "waitingForCancellationApprove": true,
    "sourcePlatforms": [
      "MARKET"
    ]
  }
schema:
  type: object
  description: Request for information about business orders.
  properties:
    orderIds:
      description: Order IDs.
      nullable: true
      uniqueItems: true
      type: array
      items:
        type: integer
        format: int64
      minItems: 1
      maxItems: 50
    externalOrderIds:
      description: External order IDs.
      nullable: true
      uniqueItems: true
      type: array
      items:
        description: "The external ID of the order that you submitted to [POST\_v2/campaigns/{campaignId}/orders/{orderId}/external-id](../../reference/orders/updateExternalOrderId.md)."
        type: string
        minLength: 1
      minItems: 1
      maxItems: 50
    programTypes:
      description: Models of the store's operation on the Market.
      nullable: true
      uniqueItems: true
      type: array
      items:
        description: |
          Working model:

          * `FBY` — FBY.
          * `FBS` — FBS.
          * `DBS` — DBS.
          * `EXPRESS` — Express.
        type: string
        enum:
          - FBY
          - FBS
          - DBS
          - EXPRESS
          - LAAS
      minItems: 1
    campaignIds:
      description: IDs of store campaigns.
      nullable: true
      uniqueItems: true
      type: array
      items:
        description: "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.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) 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**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
        type: integer
        format: int64
        minimum: 1
      minItems: 1
      maxItems: 50
    statuses:
      description: Order statuses.
      nullable: true
      uniqueItems: true
      type: array
      items:
        description: >
          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.
        type: string
        enum:
          - PLACING
          - RESERVED
          - UNPAID
          - PROCESSING
          - DELIVERY
          - PICKUP
          - DELIVERED
          - CANCELLED
          - PENDING
          - PARTIALLY_RETURNED
          - RETURNED
          - UNKNOWN
      minItems: 1
    substatuses:
      description: Stages of processing or reasons for canceling orders.
      nullable: true
      uniqueItems: true
      type: array
      items:
        description: >
          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.
        type: string
        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
      minItems: 1
    dates:
      type: object
      description: Filter by order dates.
      properties:
        creationDateFrom:
          description: The initial date of the order (YYYY-MM-DD).
          type: string
          format: date
        creationDateTo:
          description: The end date of the order (YYYY-MM-DD).
          type: string
          format: date
        shipmentDateFrom:
          description: The initial date of shipment (YYYY-MM-DD).
          type: string
          format: date
        shipmentDateTo:
          description: The final date of shipment (YYYY-MM-DD).
          type: string
          format: date
        updateDateFrom:
          description: The initial date of the order update (ISO 8601).
          type: string
          format: date-time
        updateDateTo:
          description: The end date of the order update (ISO 8601).
          type: string
          format: date-time
    fake:
      description: >
        Order type:


        * `false` — the real customer's order.


        * `true` — [test
        order](../../concepts/sandbox.md) Yandex. Market.
      type: boolean
    waitingForCancellationApprove:
      description: >
        **For the model only DBS**


        A filter for receiving orders that have cancellation requests.


        With the value `true` only those orders that are in the
        status are returned. `DELIVERY` or
        `PICKUP`, and the users decided to cancel them.
      type: boolean
    sourcePlatforms:
      x-hidden: true
      description: Platforms are sources of orders.
      nullable: true
      uniqueItems: true
      type: array
      items:
        x-hidden: true
        description: >
          The site is the source of the order:


          * `MARKET` — an order placed on the
          Market.


          * `OZON` — LaaS is an order placed on
          Ozon.


          * `WILDBERRIES` — LaaS is an order
          placed on Wildberries.


          * `OTHER` — LaaS is an order created by
          the seller.
        type: string
        enum:
          - MARKET
          - OZON
          - WILDBERRIES
          - OTHER
      minItems: 1
bodyType: application/json
method: post
security:
  - type: apiKey
    name: 'Api-Key'
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v1/businesses/{businessId}/orders
host: https://api.partner.market.yandex.ru

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

The security tag helps to prevent the product from being replaced upon return. You will not be able to return the product without the protective tag that was present at the time of purchase.

Previous
Removing products from the promotion
Next
Order preparation