Акции

Метод позволяет Яндекс Еде запрашивать у Партнёра информацию о текущих скидках и акциях на товары.

Примечание

Простые абсолютные скидки на товары достаточно передавать в методе GET/nomenclature/{placeId}/prices с помощью полей oldPrice и price.

Request

GET

/nomenclature/{placeId}/discounts

Path parameters

Name

Description

placeId

Type: string

Уникальный идентификатор магазина в системе Партнёра.

Example: ``

Headers

Name

Description

Authorization

Type: string

Токен, полученный в ответе на запрос /security/oauth/token

Example: ``

Responses

200 OK

Список действующих скидок и акций.

Body

application/json
{
  "place_id": "1000",
  "discounts": [
    {
      "type": "product_discount",
      "conditions": {
        "discount_value": 100,
        "bundle": 3
      },
      "schedule": {
        "from": "10-11-2021 00:00:00",
        "to": "11-11-2021 00:00:00"
      },
      "origin_ids": [
        "948472729",
        "8365776837"
      ]
    }
  ]
}

Name

Description

discounts

Type: Discount[]

Список действующих скидок и акций

Example
[
  {
    "type": "product_discount",
    "conditions": {
      "discount_value": 100,
      "bundle": 3
    },
    "schedule": {
      "from": "10-11-2021 00:00:00",
      "to": "11-11-2021 00:00:00"
    },
    "origin_ids": [
      "948472729",
      "8365776837"
    ]
  }
]

place_id

Type: string

Идентификатор магазина в системе партнёра.

Example: 1000

Conditions

Условия для акции товарного типа.

Примеры значений полей

Для акции "2 по цене 1" в поле discount_value будет 100, в поле bundle 2
Для акции "3 по цене 2" в поле discount_value будет 100, в поле bundle 3
Для акции "4 по цене 2" в поле discount_value будет 200, в поле bundle 4

Name

Description

bundle

Type: integer

Количество товаров, необходимое для срабатывания акции.

discount_value

Type: integer

Cколько товаров пользователь получает в подарок * 100%.
Example
{
  "discount_value": 100,
  "bundle": 3
}

Schedule

Расписание действия скидки, пока поддерживаем только
UTC время начала и конца в формате DD-MM-YYYY HH:MM:SS. Если
оно не прислано, то в качестве расписания берутся текущие
сутки.

Name

Description

from

Type: string

Example: 10-11-2021 00:00:00

to

Type: string

Example: 11-11-2021 00:00:00
Example
{
  "from": "10-11-2021 00:00:00",
  "to": "11-11-2021 00:00:00"
}

ProductDiscount

Акция товарного типа "3 товара по цене 2".

Name

Description

conditions

Type: Conditions

Условия для акции товарного типа.

Примеры значений полей

Для акции "2 по цене 1" в поле discount_value будет 100, в поле bundle 2
Для акции "3 по цене 2" в поле discount_value будет 100, в поле bundle 3
Для акции "4 по цене 2" в поле discount_value будет 200, в поле bundle 4

Example
{
  "discount_value": 100,
  "bundle": 3
}

origin_ids

Type: string[]

Список идентификаторов товаров, участвующих в акции.

Example
[
  "948472729",
  "8365776837"
]

schedule

Type: Schedule

Расписание действия скидки, пока поддерживаем только
UTC время начала и конца в формате DD-MM-YYYY HH:MM:SS. Если
оно не прислано, то в качестве расписания берутся текущие
сутки.

Example
{
  "from": "10-11-2021 00:00:00",
  "to": "11-11-2021 00:00:00"
}

type

Type: string

Дискриминатор схемы обьекта, для ProductDiscount равен product_discount.

Example: product_discount
Example
{
  "type": "product_discount",
  "conditions": {
    "discount_value": 100,
    "bundle": 3
  },
  "schedule": {
    "from": "10-11-2021 00:00:00",
    "to": "11-11-2021 00:00:00"
  },
  "origin_ids": [
    "948472729",
    "8365776837"
  ]
}

DecimalPercentString

Строка, представляющая десятичное число от 0 до 100.

Type: string

Min length: 1

Example: 100.00

NonNegativeDecimalString

Строка, представляющая неотрицательное десятичное число.

Type: string

Min length: 1

Example: 1000.00

FractionValueWithMaximum

Процентная скидка с ограничением.

Name

Description

value

Type: DecimalPercentString

Значение скидки (проценты).

Строка, представляющая десятичное число от 0 до 100.

Min length: 1

Example: 100.00

value_type

Type: string

Тип значения. Дискриминатор схемы обьекта, для FractionValueWithMaximum равен fraction.

Example: fraction

maximum_discount

Type: NonNegativeDecimalString

Максимальное абсолютное значение скидки

Строка, представляющая неотрицательное десятичное число.

Min length: 1

Example: 1000.00
Example
{
  "value_type": "fraction",
  "value": "100.00",
  "maximum_discount": "1000.00"
}

AbsoluteValue

Абсолютное значение скидки.

Name

Description

value

Type: NonNegativeDecimalString

Значение скидки

Строка, представляющая неотрицательное десятичное число.

Min length: 1

Example: 1000.00

value_type

Type: string

Тип значения. Дискриминатор схемы обьекта, для AbsoluteValue равен absolute.

Example: absolute
Example
{
  "value_type": "absolute",
  "value": "1000.00"
}

DiscountValue

Значение скидки.

One of 2 types

  • Type: FractionValueWithMaximum

    Процентная скидка с ограничением.

    Example
    {
  "value_type": "fraction",
  "value": "100.00",
  "maximum_discount": "1000.00"
}

  • Type: AbsoluteValue

    Абсолютное значение скидки.

    Example
    {
  "value_type": "absolute",
  "value": "1000.00"
}
Example
{
  "value_type": "fraction",
  "value": "100.00",
  "maximum_discount": "1000.00"
}

PriceDiscount

Абсолютная или процентная скидка товара.

Name

Description

money_value

Type: DiscountValue

Значение скидки.

Example
{
  "value_type": "fraction",
  "value": "100.00",
  "maximum_discount": "1000.00"
}

origin_ids

Type: string[]

Список, содержащий идентификаторы товаров которые подпадают под скидку.

Example
[
  "948472729",
  "8365776837"
]

schedule

Type: Schedule

Расписание действия скидки, пока поддерживаем только
UTC время начала и конца в формате DD-MM-YYYY HH:MM:SS. Если
оно не прислано, то в качестве расписания берутся текущие
сутки.

Example
{
  "from": "10-11-2021 00:00:00",
  "to": "11-11-2021 00:00:00"
}

type

Type: string

Дискриминатор схемы обьекта, для PriceDiscount равен price_discount.

Example: price_discount
Example
{
  "type": "price_discount",
  "money_value": {
    "value_type": "fraction",
    "value": "100.00",
    "maximum_discount": "1000.00"
  },
  "schedule": {
    "from": "10-11-2021 00:00:00",
    "to": "11-11-2021 00:00:00"
  },
  "origin_ids": [
    "948472729",
    "8365776837"
  ]
}

Discount

Скидка типа ProductDiscount или PriceDiscount.

One of 2 types

  • Type: ProductDiscount

    Акция товарного типа "3 товара по цене 2".

    Example
    {
  "type": "product_discount",
  "conditions": {
    "discount_value": 100,
    "bundle": 3
  },
  "schedule": {
    "from": "10-11-2021 00:00:00",
    "to": "11-11-2021 00:00:00"
  },
  "origin_ids": [
    "948472729",
    "8365776837"
  ]
}

  • Type: PriceDiscount

    Абсолютная или процентная скидка товара.

    Example
    {
  "type": "price_discount",
  "money_value": {
    "value_type": "fraction",
    "value": "100.00",
    "maximum_discount": "1000.00"
  },
  "schedule": {
    "from": "10-11-2021 00:00:00",
    "to": "11-11-2021 00:00:00"
  },
  "origin_ids": [
    "948472729",
    "8365776837"
  ]
}
Example
{
  "type": "product_discount",
  "conditions": {
    "discount_value": 100,
    "bundle": 3
  },
  "schedule": {
    "from": "10-11-2021 00:00:00",
    "to": "11-11-2021 00:00:00"
  },
  "origin_ids": [
    "948472729",
    "8365776837"
  ]
}

400 Bad Request

Ошибка в запросе. В ответе ожидается массив с объектом из списка ошибок.

Body

application/json
[
  {
    "code": 400,
    "description": "Description of error"
  }
]

Type: ErrorItem[]

ErrorItem

Name

Description

code

Type: integer

Согласованный с Яндекс Едой числовой код ошибки.

description

Type: string

Описание ошибки

Example: Description of error
Example
{
  "code": 400,
  "description": "Description of error"
}

401 Unauthorized

Не пройдена авторизация.

Body

application/json
{
  "reason": "Access token has been expired. You should request a new one"
}

Name

Description

reason

Type: string

Причина, по которой не прошла авторизация.

Example: Access token has been expired. You should request a new one

404 Not Found

Не найден ресурс. В ответе ожидается массив с объектом из списка ошибок.

Body

application/json
[
  {
    "code": 400,
    "description": "Description of error"
  }
]

Type: ErrorItem[]

500 Internal Server Error

Внутренние ошибки сервера. В ответе ожидается массив с объектом из списка ошибок.

Body

application/json
[
  {
    "code": 400,
    "description": "Description of error"
  }
]

Type: ErrorItem[]

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

Предыдущая
❗️Цены товаров
Следующая
Остатки товаров