Документация API
Руководство по панели управления

Типы

Все типы TypeScript стартового проекта витрины по папкам. Откройте тип, чтобы увидеть его поля, комментарии и связанные типы.

accounts

  • IApiDateTimeФорматированные дата и время бэкенда.
  • IApiPaginationСостояние страниц в ответе бэкенда.
  • IApiPaginationRequestЗапрашиваемая страница и её размер.
  • IAuthOtpResendRequestПовторная отправка кода входа или регистрации.
  • IAuthOtpResendResponseКанал доставки и задержка повторной отправки.
  • ICaptchaResponseИзображение CAPTCHA текущей сессии.
  • IContactRequestПоля формы обратной связи.
  • ICustomerMutationResponseПри успехе возвращается `page_data: null`; дополнительных данных нет.
  • IEmailEnrollRequestЗапрос двухэтапного подтверждения email.
  • IEmailEnrollResponseСледующий шаг подтверждения email или завершение.
  • IEmailNotificationLocaleRequestИзменение языка email-уведомлений.
  • IEmailNotificationLocaleResponseСохранённый язык email-уведомлений.
  • IProfileAvatarRequestПользователь загружает изображение для своего аватара.
  • IProfileAvatarResponseОтвет загрузки изображения профиля.
  • IProfileDataПрофиль текущего покупателя.
  • IProfileDeleteRequestПокупатель удаляет свой аккаунт. Сеанс завершается.
  • IProfileEventRequestПользователь регистрируется для участия в активной промоакции магазина.
  • IProfileLogОдна запись успешного входа.
  • IProfileLogsRequestСписок успешных входов текущего покупателя с записанными сведениями о браузере и устройстве.
  • IProfileLogsResponse`page_data.data` содержит записи истории авторизации; `rpag` — пагинацию.
  • IProfileNotificationSettingДоступный тип email-уведомлений и его текущая настройка.
  • IProfileNotificationSettingsRequestНастройки отдельных типов email-уведомлений или всех необязательных уведомлений.
  • IProfileNotificationSettingsResponseТекущие настройки email-уведомлений после загрузки или сохранения.
  • IProfilePasswordRequestПользователь меняет свой пароль. Текущая сессия сохраняется.
  • IProfileRequestВозвращает личный профиль и настройку уведомлений текущего пользователя.
  • IProfileResponse`page_data.profile_info` — массив, обычно с одним профилем покупателя. Если фильтры не совпали, массив может быть пустым.
  • IProfileSearchHistoryRequestПоиск видимых сохранённых поисковых фраз текущего покупателя.
  • IProfileSearchHistoryResponse`page_data.data` содержит записи истории, а `page_data.rpag` описывает страницы. При отсутствии результатов массив `data` пуст.
  • IProfileSearchUpdateRequestПриложение дополняет историю поиска текущего пользователя переданными фразами.
  • IProfileSearchUpdateResponse`page_data.added_updated` содержит число обработанных фраз, добавленных или обновлённых. Это не обязательно число новых уникальных записей.
  • IProfileUpdateRequestПользователь меняет свои имя, фамилию, дату рождения и язык email-уведомлений.
  • IStorefrontProfileActionТипизированное действие формы профиля, различаемое по action.
  • IStorefrontProfileStateСостояние интерфейса аккаунта, управляемое страницей; не ответ сервера.
  • IUnsubscribeRequestТокен ссылки из письма и тип подписки для отмены.

address

  • IAddressCitySuggestionПодсказка города и почтовый индекс от плагина страны; индекс может отсутствовать.
  • IAddressCitySuggestionRequestОбязательные поля местоположения и поискового текста в корне JSON.
  • IAddressCitySuggestionResponseОболочка ответа с подсказками или ошибками API.
  • IAddressCountryСтрана в адресе или списке стран доставки.
  • IAddressCountryOptionСтрана в форме адреса.
  • IAddressLocationSuggestionАдресная подсказка сервиса геокодирования; поля адреса могут быть null.
  • IAddressLocationSuggestionRequestОбязательные долгота и широта в корне JSON для поиска адреса.
  • IAddressLocationSuggestionResponseОболочка ответа поиска адреса с подсказками или ошибками API.
  • IAddressRegionРегион с переводами названия и идентификаторами страны.
  • IAddressRegionLocaleПеревод названия региона для одного языка.
  • IAddressRegionSearchFiltersНеобязательные фильтры названия региона, ID страны и сортировки.
  • IAddressRegionSearchRequestТело JSON-запроса для поиска регионов.
  • IAddressRegionSearchResponseОболочка ответа поиска регионов с результатами или ошибками API.
  • IAddressSuggestionПодсказка улицы и почтовый индекс от плагина страны; индекс может отсутствовать.
  • IAddressSuggestionRequestОбязательные поля местоположения и поискового текста в корне JSON.
  • IAddressSuggestionResponseОболочка ответа с подсказками или ошибками API.
  • IUserAddressСохранённый адрес покупателя.
  • IUserAddressDeleteResponse`page_data` — `null` либо объект с `another_default`.
  • IUserAddressListRequestНеобязательные условия поиска адресов.
  • IUserAddressListResponse`page_data` содержит отдельные массивы `addresses` и `countries`. В адресе страна и регион представлены объектами, а в запросах сохранения передаются их ID.
  • IUserAddressRequestПоля для создания и полного обновления адреса.
  • IUserAddressSaveResponseПри успехе `page_data` — массив с сохранённым адресом. Его ID и нормализованные значения находятся в `page_data[0]`.
  • IUserAddressShippingRequestИзменение признака основного адреса доставки.
  • IUserAddressShippingResponseПри успехе возвращается сообщение и `page_data: null`. Обновлённый список адресов метод не возвращает.

apiBase

  • TMethodHTTP-методы, поддерживаемые эндпоинтом.

appBase

  • IAppLoadНачальные данные магазина, профиль покупателя и доступные эндпоинты API.
  • IAppLoadCommonОбщие настройки и начальное содержимое магазина.
  • IAppLoadCommonBannerИзображения баннера для разных размеров экрана.
  • IAppLoadCommonContactКонтакты и реквизиты компании.
  • IAppLoadCommonCurrencyСимволы валюты, коэффициент пересчёта и настройки выбора.
  • IAppLoadCommonCurrencyLocaleЛокализованное название валюты.
  • IAppLoadCommonEventsПромоматериалы и настройки их показа.
  • IAppLoadCommonLocaleЯзык магазина, его валюта и единицы измерения по умолчанию.
  • IAppLoadCommonLocaleNameЛокализованное название языка.
  • IAppLoadCommonLogosЛоготипы магазина и значок сайта.
  • IAppLoadCommonSeoМетаданные главной страницы магазина по языкам.
  • IAppLoadCommonSeoLocaleЗаголовок, описание и ключевые слова главной страницы на одном языке.
  • IAppLoadCommonSocialСоциальная ссылка, значок и локализованная подпись.
  • IAppLoadCommonSocialLocaleЛокализованные заголовок и подпись социальной ссылки.
  • IAppLoadCommonTariffНачальный список тарифов и сведения о подписках.
  • IAppLoadCommonUnitЕдиница измерения, коэффициент пересчёта и локализованные названия.
  • IAppLoadCommonUnitLocaleЛокализованное название и обозначение единицы измерения.
  • IAppLoadCommonVariablesСчётчики корзины и избранного, настройки функций магазина.
  • IAppLoadCommonVisualSettingsНастройки отображения каталога и магазина.
  • IAppLoadCommonWalletValueСумма в кошельке покупателя в определённой валюте.
  • IAppLoadPathИмя эндпоинта, URL, поддерживаемые методы и формы запроса.
  • IAppLoadPathObjectГруппы ресурсов и входящие в них эндпоинты.
  • IAppLoadPathsRecordДоступные эндпоинты API, сгруппированные по ресурсам.
  • IApploadUserProfileПрофиль авторизованного покупателя.
  • IDomainSeoOgСвойство Open Graph главной страницы и его содержимое по языкам.
  • IDomainSeoTwitterМетатег Twitter Card главной страницы и его содержимое по языкам.
  • IFormФорма запроса с полями действия и фильтрами.
  • IFormFieldПоле запроса: тип ввода, обязательность и доступные значения.
  • IFormFieldsИменованные поля запроса и вложенные группы полей.
  • ISeoOgМетаданные Open Graph категории с идентификаторами записи и категории.
  • ISeoOgLocaleЛокализованное значение свойства Open Graph.
  • ISeoTwitterМетаданные Twitter Card категории с идентификаторами записи и категории.
  • ITwitterLocaleЛокализованное содержимое метатега социальной карточки.
  • TBannerFormatsДоступные форматы изображений баннера.
  • TEventsFormatДоступные форматы изображений события.

blog

  • EBlogAccessTypeРежим доступа к статье.
  • EBlogCommentStatusСостояние модерации комментария.
  • EBlogPublishingStateСостояние публикации статьи.
  • EBlogViewTypeРежимы отображения анонсов блога.
  • IBlogCategoryПубличная категория блога.
  • IBlogCommentПользовательский комментарий блога.
  • IBlogCommentCreateRequestПередайте `for_post`, необязательный `parent` и `text` в корне JSON.
  • IBlogCommentEditRequestПередайте `comment_id` в URL, полный новый `text` — в корне. Публикация и родитель здесь не меняются.
  • IBlogCommentRemovalResponseОтвет возвращает только удалённый ID.
  • IBlogCommentResponseОтвет содержит обновлённый комментарий пользователя.
  • IBlogCommentsRequestПередайте условия в `filters`, пагинацию в `paginate`. Корневые комментарии и ответы загружаются отдельными запросами.
  • IBlogCommentsResponseВ `page_data.data` находится список комментариев без вложенных ответов. Данные пагинации — в `page_data.rpag`.
  • IBlogPostАнонс или полная статья блога.
  • IBlogPostPreviewПоля анонса публикации, используемые магазином.
  • IBlogPostsRequestПередайте условия в `filters`, пагинацию в `paginate`.
  • IBlogPostsResponseОтвет содержит блок `posts` с пагинацией и отдельное дерево категорий. Поля полной статьи возвращаются условно.
  • IBlogReadingDataСчётчики премиального чтения.
  • IBlogReadingRequestПередайте только `post` в корне JSON. Прошедшие секунды, ID пользователя и сессии не являются входными полями. Песочница отправляет один запрос на каждое нажатие «Отправить».
  • IBlogReadingResponse`page_data` содержит ограниченные счётчики чтения, а не текст статьи или денежное вознаграждение.
  • IMyBlogCommentsRequestПередайте условия в `filters`, пагинацию в `paginate`. Корневые комментарии и ответы загружаются отдельными запросами.

cart

  • DeliveryMapFactoryСоздаёт карту доставки.
  • ECartPromoNoticeReasonПричины сообщения о промокоде корзины.
  • ECartStateСостояния выбора товаров и оформления корзины.
  • EPromoProductDiscountСовместимость со скидками товаров.
  • EPromoTypeТипы расчёта акции.
  • ICarrierBoxРазмеры и ограничения упаковки доставки.
  • ICartAddressСнимок адреса в корзине.
  • ICartAddressLocationКоординаты адреса корзины.
  • ICartAddressRequestID адреса из аккаунта пользователя.
  • ICartCheckoutProductТовар, назначенный группе отправки при оформлении.
  • ICartCommentRequestКомментарий корзины или пустой текст для очистки.
  • ICartContactКонтакт покупателя или получателя корзины.
  • ICartDeliveryГруппа отправки оформляемой корзины.
  • ICartDeliveryDataВыбранная доставка и её текущий признак изменения.
  • ICartDeliveryPointПункт выдачи в едином формате.
  • ICartDeliveryPointsRequestНеобязательный номер страницы провайдера; поддержка и значения по умолчанию зависят от плагина перевозчика.
  • ICartDeliveryPointsResponseОшибки полей или общие ошибки.
  • ICartDeliveryPricesСуммы товаров, опций и доставки группы отправки.
  • ICartDeliverySelectionRequestID группы оформления и способа доставки.
  • ICartDeliverySelectionResponseОшибки полей или общие ошибки.
  • ICartDeliveryTypesRequestУсловия отбора способов доставки; пагинация не используется.
  • ICartDeliveryTypesResponseОтвет выборки способов доставки.
  • ICartGetRequestДля полной корзины отправьте `{}`; обязательных полей нет.
  • ICartGetResponseПолная корзина с содержимым в зависимости от этапа оформления.
  • ICartItemMutationResponseРезультат изменения позиции корзины.
  • ICartLinePricesСуммы основных и дополнительных товаров без доставки.
  • ICartModalResponseТовары предпросмотра корзины с подробным количеством и суммами.
  • ICartOptionВыбираемый товар в группе опций корзины.
  • ICartOptionDataResponseОшибки полей или общие ошибки.
  • ICartOptionGroupГруппа опций корзины с текстом, файлом или выбором товаров.
  • ICartOptionPricesПоля стоимости товара-опции.
  • ICartOptionQuantityRequestНовое итоговое количество этой опции; ноль снимает выбор. Отрицательное значение отклоняется.
  • ICartOptionTypeМетаданные типа опции.
  • ICartOptionUploadRequestJSON, сериализованный в поле data части multipart.
  • ICartPaymentRequestID доступного способа оплаты.
  • ICartPickupSelectionRequestОбъект пункта из `cart_customer_delivery_points_get`. Его `code`, `city_code` и `address` используются, если соответствующие корневые поля ниже пусты.
  • ICartPreviewStateСостояние краткой корзины: открыта ли она, идёт ли загрузка, её товары и выполняемые удаления.
  • ICartPricesТекущие суммы корзины.
  • ICartPromoNoticeПромокод без скидки, удалённый или отклонённый код.
  • ICartQuantityRequestУстановить итоговое количество товара в корзине.
  • ICartReceiverRequestКорректный телефон получателя. Международный формат позволяет не зависеть от настроенного региона по умолчанию.
  • ICartStateRequestЗапрашиваемое состояние корзины.
  • ICartStateResponseРезультат изменения состояния корзины.
  • ICartStoreСведения о магазине с вариантами доставки для корзины.
  • ICartSummaryСостояние корзины, суммы, адрес и варианты оплаты.
  • ICategoryDirectoryEntryСведения о категории в результатах поиска товаров и подборках для акций.
  • ICurrencyAmountsПересчитанные значения по ID валюты.
  • IDeliveryMapMarkerМетка карты доставки.
  • IDeliveryMapOptionsНастройки, передаваемые поставщику карты.
  • IDeliveryMapPositionКоординаты на карте.
  • IDeliveryMapViewУправление созданной картой.
  • IDeliveryTypeПубличный тариф доставки.
  • IPaymentMethodПубличные сведения о способе оплаты.
  • IPromoDefinitionОписание акции для покупателя.
  • IUnitValuesПересчитанные измерения по ID единицы.

catalog

  • ICatalogLoadResponseДерево категорий в `tree`, ID категорий без подкатегорий в `childfree` и ID всех возвращённых категорий в `unique_ids`.
  • IManufacturerЗапись производителя для публичного справочника.
  • IManufacturerIndexGroupБуква, общий счётчик и предварительный список производителей.
  • IManufacturerIndexRequestПолучение непустых буквенных групп с предварительным списком производителей в каждой.
  • IManufacturerIndexResponse`page_data` — массив буквенных групп. Каждая содержит не более 42 производителей, даже если счётчик группы больше.
  • IManufacturerIndexStateСостояние загрузки указателя производителей.
  • IManufacturerSearchRequestПоиск производителей, просмотр буквенной группы или получение производителя по ID.
  • IManufacturerSearchResponseРезультаты вложены в `page_data.manufactures`: `data` содержит записи, `rpag` — сведения о страницах.
  • TManufacturerAlphabetАлфавит указателя: латиница, кириллица или цифры.

category

  • ICategoryКатегория каталога, локализованное содержимое и дочерние категории.
  • ICategoryLocaleТексты, метаданные и баннер категории на одном языке.

domains

  • IDomainМагазин, связанный с подпиской и её дополнительными опциями.
  • IDomainExtrasСтоимость и срок дополнительной опции подписки.

forms

marketing

orders

  • EOrderPaymentStatusСостояние заказа либо группировка списка.
  • EOrderStatusСостояние заказа либо группировка списка.
  • EOrderTabСостояние заказа либо группировка списка.
  • EPreorderStateСостояние обработки предзаказа.
  • IOrderЗаказ покупателя с оплатой, контактами и отправлениями.
  • IOrderCreatedСозданный заказ и данные перехода к оплате.
  • IOrderCreateFailureСведения восстановления при ошибке создания заказа.
  • IOrderCreateResponseСозданный заказ и ссылка оплаты либо сведения ошибки для восстановления оформления.
  • IOrderDeliveryMethodТип доставки и данные связи с пунктом отправления перевозчика.
  • IOrderDigitalAttachmentПриобретённый цифровой текст либо файл позиции заказа.
  • IOrderDigitalFileRequestПередавайте `attached_stock` в корне JSON. Успешный ответ содержит бинарные данные файла.
  • IOrderFileErrorResponseJSON-оболочка ошибки вместо запрошенного файла.
  • IOrderFileResponseУспешный ответ использует `application/octet-stream` и имя вложения. Ошибки API остаются JSON-оболочками; перед сохранением проверяйте HTTP-статус и тип содержимого.
  • IOrderHistoryRequestФильтры заказов и пагинация.
  • IOrderHistoryResponseЗаказы покупателя с суммами оплаты и вложенными отправлениями.
  • IOrderItemRefundStatsСчётчики возврата одной приобретённой позиции либо опции.
  • IOrderLinePricesСуммы товаров и опций позиции отправления по валютам.
  • IOrderOptionДополнительный товар, приобретённый через группу опций.
  • IOrderOptionFileRequestПередавайте `option_group` в корне JSON. Успешный ответ содержит бинарные данные файла.
  • IOrderOptionGroupПриобретённая группа опций: введённый текст, загруженный файл и выбранные дополнительные товары.
  • IOrderOptionPricesСуммы приобретённых дополнительных товаров по валютам.
  • IOrderPaymentMethodsResponse`page_data` — словарь записей `IPaymentMethod` с ID способа оплаты в качестве ключа.
  • IOrderPaymentRequestПередайте `order` и `payment` в корне JSON. Сумма берётся из неоплаченного остатка заказа.
  • IOrderPaymentResponseЧитайте `link` и `link_type` вместе. Пустая ссылка с null в типе допустима для способов без внешней страницы оплаты.
  • IOrderPricesИтоги заказа, платежи и возвраты по валютам.
  • IOrderRefundStatsСчётчики возврата позиций и средств заказа либо отправления.
  • IOrderRepeatRequestПередайте ID заказа пользователя в `order` в корне JSON. Новый заказ этот метод не оформляет.
  • IOrderShipmentОдно отправление с адресом доставки и приобретёнными позициями.
  • IOrderShipmentAddressСохранённый адрес заказа с массивами стран и регионов в ветви отправления.
  • IOrderShipmentItemОдна позиция приобретённого товара в отправлении.
  • IOrderShipmentPricesИтоги отправления, суммы доставки и возврата по валютам.
  • IProductPreorderRequestТовар, необязательные контакты гостя и валюта.
  • IProductPreorderResponseID предзаказа, товар, сохранённая цена USD и состояние.
  • OrderRefundWindowЗаявка на возврат, которую доставленная позиция принимает сейчас: 'regular' или 'defect'.

payments

products

  • EProductFeedbackStatusСтатус отзыва: `EProductFeedbackStatus.DENIED`, `EProductFeedbackStatus.PENDING` или `EProductFeedbackStatus.APROOVED`.
  • EProductStatusСостояния доступности товара.
  • IAppLoadProductДанные товара из загрузки приложения со ссылкой на продавца.
  • IMyProductFeedbacksResponseОтзывы с пагинацией в `page_data.feedbacks`.
  • IProcessingProductИдентификатор товара и коллекция магазина, в которой он обновляется.
  • IProductДанные товара, цены, изображения и доступные варианты.
  • IProductAttributeГруппа характеристик товара с названиями и значениями.
  • IProductAttributeNameОдна характеристика товара и её переведённое значение.
  • IProductCartCountsКоличество и цены товара в позиции корзины.
  • IProductDimensionsДлина, ширина и высота товара.
  • IProductFeedbackОтзыв покупателя, оценка и приложенные изображения.
  • IProductFeedbackCountersResponseСчётчики реакций и ответов одного одобренного отзыва; `total_c_aprooved_replies` повторяет `total_c_approved_replies` под старым написанием.
  • IProductFeedbackCreateRequestОтправляется `multipart/form-data`: `data` содержит показанный объект JSON, выбранные файлы идут отдельными частями `feedback_images`. Не задавайте границу multipart вручную.
  • IProductFeedbackCreateResponseОтвет содержит состояние модерации `state` и массив `feedback` с сохранённым отзывом. Создание также возвращает отдельный `id`.
  • IProductFeedbackDateДата и время создания отзыва и относительные значения времени.
  • IProductFeedbackEditRequestОтправляется `multipart/form-data`: `data` содержит показанный объект JSON, выбранные файлы идут отдельными частями `feedback_images`. Не задавайте границу multipart вручную.
  • IProductFeedbackEditResponseСостояние модерации и сохранённый отзыв; изменённый отзыв снова проходит модерацию.
  • IProductFeedbackImageID и URL изображения, прикреплённого к отзыву о товаре.
  • IProductFeedbackImagesRequestНеобязательные условия передаются в `filters`, параметры страницы — в `paginate`. Пустые фильтры выбирают все доступные изображения.
  • IProductFeedbackImagesResponseЧитайте изображения в `page_data.data`, пагинацию — в `page_data.rpag`. Возвращаются только изображения одобренных отзывов этой группы магазинов.
  • IProductFeedbackListRequestУсловия отбора передаются в `filters`, параметры страницы — в `paginate`. Пустые фильтры допустимы.
  • IProductFeedbackListResponseОтзывы с пагинацией в `page_data.feedbacks`.
  • IProductFeedbackPreloadRequestПередайте `reply_id` в корне JSON — ID своего отзыва или ответа. Без него или с неизвестным ID возвращается ошибка поля.
  • IProductFeedbackPreloadResponse`page_data` — ваш отзыв. Для чужого отзыва возвращается ошибка «Отзыв не найден.»
  • IProductFeedbackReactionRequestПередайте `feedback` и логическое `like_or_dislike` в корне JSON.
  • IProductFeedbackReactionResponseОбновлённые счётчики `likes` и `dislikes`.
  • IProductFeedbacksОтзывы о товаре, пагинация и сводная статистика.
  • IProductFeedbackStatКоличество отзывов и средняя оценка товара по одобренным отзывам группы магазинов этой витрины, как в публичном списке.
  • IProductFeedbackUserПубличные данные автора, передаваемые с отзывом о товаре.
  • IProductFlagsМетки товара: новинка, популярный или заканчивающийся товар.
  • IProductImagesURL изображений товара, сгруппированные по допуску к уменьшенным превью.
  • IProductLocaleТексты и метаданные страницы товара на одном языке.
  • IProductManufactureПроизводитель товара и изображения бренда.
  • IProductPaginationТекущая страница, число результатов и возможность перехода между страницами.
  • IProductRefundsСроки возврата обычных товаров и товаров с дефектом.
  • IProductRelatedКоллекция связанных товаров.
  • IProductReviewОтзыв о товаре, автор, вложения и состояние обсуждения.
  • IProductReviewImageИзображение одобренного отзыва и ссылка на его владельца.
  • IProductSearchChoicesСвязанные варианты текущей подборки товаров.
  • IProductSearchFacetsВарианты фильтров и счётчики из selects и variants.
  • IProductSearchFiltersФильтры поиска товаров. Выбранные цвета, размеры и другие варианты передаются в `variant_*`.
  • IProductSearchRangesМинимальные и максимальные цены и размеры в доступных валютах/единицах.
  • IProductSearchRequestКритерии поиска товаров, динамические варианты и пагинация.
  • IProductSearchResponseТовары текущей страницы находятся в `page_data.products.data`, параметры страницы — в `page_data.products.rpag`.
  • IProductSearchSellerПоля продавца из поиска товаров для заполнения разрешения предзаказа в товаре.
  • IProductSecondaryVariantТовар, соответствующий значению дополнительного варианта.
  • IProductSecondaryVariantInfoДополнительное свойство варианта: тип, переводы названия и признак цвета.
  • IProductSecondaryVariantRequestПараметры загрузки дополнительных вариантов выбранного основного значения.
  • IProductSecondaryVariantsДополнительные варианты и соответствующие товары.
  • IProductSecondaryVariantsRequestПередайте `product_group` и `main_variant_value` в корне JSON. Выбор товара ниже только предоставляет варианты этих полей и не включается в запрос.
  • IProductSecondaryVariantsResponse`page_data.secondary` описывает вторичный тип; `variants` связывает каждое значение с записью товара.
  • IProductSecondaryVariantStateСостояние загрузки и ответ для одной группы дополнительных вариантов.
  • IProductSecondaryVariantValueЛокализованное значение дополнительного варианта и его цвет.
  • IProductSellerПубличные сведения о продавце товара.
  • IProductsListNamesНазвания коллекций товаров в магазине.
  • IProductSpecificationGroupИменованная группа характеристик товара, показанных вместе на странице товара.
  • IProductSpecificationRowОдна характеристика товара: название, значение и адрес, который открывает значение.
  • IProductStatusКод доступности товара и его подпись для интерфейса.
  • IProductVariantОсновное свойство варианта: тип, переводы названия и доступные значения.
  • IProductVariantFilterОдин тип варианта и доступные значения.
  • IProductVariantsОсновная характеристика для выбора варианта товара.
  • IProductVariantValueЗначение варианта товара и данные для его отображения.
  • IProductVideoВидео товара и изображение для превью.
  • IWishlistAddRequestДобавить товар в избранное покупателя.
  • IWishlistAddResponseРезультат добавления в избранное и текущий счётчик.
  • IWishlistRemoveResponseРезультат удаления из избранного и текущий счётчик.
  • ProductFacetSelectionМассивы выбранных ID по названиям полей фильтра.

sellers

shared

  • IBreadcrumbОдин элемент пути к открытой странице: его текст и адрес, на который он ведёт.
  • IBreadcrumbTargetАдрес элемента пути: адрес страницы и добавляемые к нему значения.
  • IGeoCoordinatesДолгота и широта точки на карте.
  • IStorefrontPaginationСостояние навигации по страницам.
  • IStorefrontPaymentСсылка и режим отображения оплаты.
  • ITransformValueЧисловое значение после пересчёта.

state

  • AppLoadLoaderАсинхронная функция, которая выполняет загрузку приложения и возвращает её результат.
  • AppLoadStatusСостояния инициализации: ожидание, загрузка, успех или ошибка.

stores

subscribeOptions

  • ISubscribeOptionОпция подписки с локализованным описанием.
  • ISubscribeOptionLocaleЛокализованные название и описание опции подписки.

subscribes

subscribeTariff

  • ISubscribeTariffЦены тарифа, пробный период и включённые опции.
  • ISubscribeTariffImagesМаленькие и полноразмерные изображения тарифа.
  • ISubscribeTariffLocalesНазвание, описание и метаданные тарифа на одном языке.
  • ISubscribeTariffOptionОпция тарифа, доступность пробного периода и доплаты за периоды.
  • ISubscribeTariffPriceЦена тарифа и длительность оплачиваемого периода.
  • ISubscribeTariffVideoВидео тарифа, изображение предпросмотра и порядок отображения.
  • ITariffSelectionВыбор тарифа и платного или пробного периода.
  • ITariffSubscribeRequestПоля оформления подписки через subscriptions_subscribe.

tickets

  • ECustomerTicketSolutionСостояние обращения покупателя или возврата.
  • ECustomerTicketStatusСостояние обращения покупателя или возврата.
  • ECustomerTicketTypeСостояние обращения покупателя или возврата.
  • EOrderRefundShipmentStatusСостояние обращения покупателя или возврата.
  • ETicketReplyDirectionСостояние обращения покупателя или возврата.
  • ICustomerTicketОбращение покупателя: состояние, счётчики и ссылки на покупку.
  • ICustomerTicketCreatedResponse`page_data` содержит обращение. Для загрузки переписки используйте `customer_tickets_reply_getall`.
  • ICustomerTicketCreateRequestОтправляйте `multipart/form-data`: часть `data` содержит поля JSON, повторяющиеся части `ticket_images` — файлы.
  • ICustomerTicketImageResponseБайты изображения с `Content-Type: image/jpeg`. Отсутствующее изображение или изображение вне обращений пользователя возвращает HTTP 404 с текстом `Not found`.
  • ICustomerTicketOrderItemRequestОтправляйте `multipart/form-data`: часть `data` содержит поля JSON, повторяющиеся части `ticket_images` — файлы.
  • ICustomerTicketOrderOptionRequestОтправляйте `multipart/form-data`: часть `data` содержит поля JSON, повторяющиеся части `ticket_images` — файлы.
  • ICustomerTicketRatingRequestПередайте `ticket_id` в URL, а `rating` — в корне JSON.
  • ICustomerTicketRefundДанные отправления возврата, отслеживания и необязательного связанного заказа.
  • ICustomerTicketRepliesPageRequestПередайте ID обращения пользователя в `filters.ticket`, параметры страницы — в `paginate`.
  • ICustomerTicketRepliesPageResponse`page_data.data` — текущая страница, `rpag` — параметры пагинации.
  • ICustomerTicketRepliesRequestПередайте ID обращения пользователя в `filters.ticket`. Этот метод игнорирует пагинацию.
  • ICustomerTicketRepliesResponseВсе сообщения обращения после добавления ответа.
  • ICustomerTicketReplyОдно сообщение покупателя или поддержки и ссылки на изображения.
  • ICustomerTicketReplyRequestОтправляйте `multipart/form-data`: часть `data` содержит поля JSON, повторяющиеся части `ticket_images` — файлы.
  • ICustomerTicketReplyWaitПочему покупатель сейчас не может добавить сообщение в обращение.
  • ICustomerTicketsRequestИспользуйте `filters` для отбора и `paginate` для страниц. Пустые фильтры показывают все обращения пользователя.
  • ICustomerTicketsResponseОбращения покупателя, пагинация и необязательные счётчики открытых/закрытых обращений первой страницы.
  • ICustomerTicketSubscriptionRequestОтправляйте `multipart/form-data`: часть `data` содержит поля JSON, повторяющиеся части `ticket_images` — файлы.
  • TicketReplyWaitReasonПричина ожидания ответа: `support_reply` или `delay`.

transport

  • ApiFormErrorСообщение об ошибке проверки и её код.
  • AppLoadFailureОшибка инициализации: категория, статус и ошибки полей.
  • AppLoadRequestПараметры запроса инициализации: детализация и обход кэша.
  • AppLoadResponseОболочка ответа API с данными загрузки приложения или ошибками.
  • AppLoadResultРезультат загрузки приложения с HTTP-статусом и временем получения.
  • JsonValueЗначение, которое можно представить в JSON.