Объекты массива catalogs

Массив catalogs содержит список объектов, описывающих каталоги с акционными товарами. Описание каталога включает условия и сроки действия, список регионов или магазинов, список товаров в каталоге, обложку каталога.

  • В одном файле выгрузки можно передать несколько каталогов, которые имеют разные сроки действия или действуют в разных регионах.
  • В файле выгрузки могут присутствовать каталоги, которые действуют в настоящий момент или начнут действовать в ближайшем будущем — наши модераторы смогут заранее проверить каталог, и он появится в приложении, когда начнется его срок действия.
  • Если в файле выгрузки присутствует каталог, срок действия которого прошел, это допустимо. Но такой каталог увеличивает размер файла, на его обработку тратятся вычислительные ресурсы.
  • Чтобы отредактировать каталог товаров или добавить новый, следуйте рекомендациям в разделе Изменить или добавить каталог товаров.

    Важно.

    Если в течение срока действия каталога передать файл выгрузки, который содержит каталог с тем же идентификатором (параметр id) и другим составом предложений, существующий каталог будет перезаписан. В приложении Едадил будет отображаться последняя загруженная версия каталога.

  1. Пример
  2. Описание параметров

Пример

Пример объекта, описывающего каталог:

   {
      "conditions": "Предложения действительны для Москвы, Переславль-Залесского и Костромской области. Информацию об ассортименте товаров, участвующих в акции, уточняйте в магазине. Количество товаров ограничено, не является публичной офертой.",
      "date_end": "2020-06-12T23:59:59+03:00",
      "date_start": "2020-06-05T00:00:00+03:00",
      "id": "1234",
      "image": "https://retailer1234.ru/catalogs/1234.jpg",
      "is_main": true,
      "offers": [
        "11111",
        "22222",
        "33333"
      ],
      "target_regions": [
        "Россия, Москва",
        "Россия, Ярославская область, Переславль-Залесский",
        "Россия, Костромская область, Островский район, село Адищево"
      ]
    }

Описание параметров

Параметр Тип Описание Обязательность

id

string

Произвольный идентификатор каталога со стороны сети. Требования к идентификатору:

  • максимальная длина — 32 символа;
  • содержит только буквы и цифры из кодировки ACSII;
  • уникален в пределах одного файла выгрузки.

При обновлении информации в существующем каталоге сохраняйте прежнее значение id.

Обязательный

conditions

string

Условия действия каталога. Обязательно добавьте в условия информацию о городах и регионах действия каталога. Даты действия каталога и ссылки добавлять не следует. В условиях действия каталога недопустимо упоминание рекламы.

Пример: «Акция действует в магазинах торговой сети в Саратове и Саратовской области. Информацию об ассортименте товаров, участвующих в акции, уточняйте в магазине. Количество товаров ограничено, не является публичной офертой.».

Если в каталоге есть товары, для которых условия акции отличаются от условий всего каталога, создайте для таких товаров отдельный каталог и укажите особые условия в его описании.

Обязательный

date_start

string

Дата начала действия каталога. Должна быть не позже даты окончания действия каталога. Период от даты начала до даты окончания действия каталога не должен превышать 2 месяца.

Дата должна включать время: 00:00:00 в часовом поясе Москвы (UTC+3). Формат даты должен соответствовать RFC 3339.

Например: "2020-06-05T00:00:00+03:00"

Обязательный

date_end

string

Дата окончания действия каталога. Должна быть не раньше даты начала действия каталога. Период от даты начала до даты окончания действия каталога не должен превышать 2 месяца.

Дата должна включать время: 23:59:59 в часовом поясе Москвы (UTC+3). Формат даты должен соответствовать RFC 3339.

Например: "2020-06-12T23:59:59+03:00"

Обязательный

is_main

boolean

Признак основного/дополнительного каталога. Обложка основного каталога будет показана в мобильном приложении.

Обязательный

image

string

Ссылка на изображение — обложку каталога.

Требования к размещению изображения:

  • Ссылка на изображение должна иметь формат корректного URI. Hапример: https://retailer1234.ru/catalogs/1234.jpg.
  • Изображение не должно быть размещено на публичных ресурсах, таких как альбом в ВК, Яндекс.Диск, Dropbox и так далее.
  • Изображение должно быть доступно по портам 80, 443 или 8080.
  • В ответ на запрос GET или HEAD в заголовке content-type сервер должен возвращать значение image/png или image/jpeg.

Требования к изображению:

  • Формат: файлы с расширением .jpg, .jpeg или .png.
  • Размер файла не более 50 МБ.
  • Вертикальная ориентация, отношение высоты к ширине приблизительно 10:7. Например, 1540×1080 точек.
  • Фон изображения не должен быть белым или прозрачным.
  • Изображение не должно иметь водяных знаков.
  • Все товары с ценниками, изображенные на обложке, должны быть обязательно внесены в каталог.
Обязательный

target_regions

array of string

Для розничной сети — список регионов (областей, городов), в которых действует каталог. Для онлайн-магазина — список регионов, в которых действует доставка.

Название региона или населенного пункта должно быть однозначным и совпадать с названием в сервисе Яндекс.Карты.

Если в России несколько населенных пунктов с таким названием, обязательно укажите страну и регион в следующем порядке: страна, регион, населенный пункт. Например: Россия, Оренбургская область, Орск.

Не объединяйте несколько регионов в одном пункте. Например, название «Москва и область» некорректно. Правильно: «Москва», «Московская область».

Если название региона указано некорректно и неоднозначно, каталог не будет отображаться в сервисе Едадил в этом регионе.

Обязательный, если не указан параметр target_shops

target_shops

array of string

Список полных адресов магазинов, в которых действует каталог.

Все указанные магазины должны быть добавлены в Яндекс.Справочник, адреса магазинов в файле выгрузки должны совпадать с адресами в Справочнике.

Магазины, адреса которых указаны неверно или отсутствуют в Яндекс.Справочнике, не будут отображаться в сервисе Едадил.

Обязательный, если не указан параметр target_regions

offers

array of string

Список идентификаторов акционных товаров, входящих в данный каталог.

Описания товаров должны быть приведены в массиве offers:

Общее количество акционных товаров во всех каталогах торговой сети должно быть не менее 10.

Обязательный