Bungly boo!
Пустой ответ сервера
Body
AddressResponse
Ответ на запрос заказа
Модель ответа запроса корзины
Ответ на запрос оплаты. Может содержать данные необходимые для подтверждения оплаты.
VerifySendCodeResponse
Body
Идентификатор (передается в запросе подтверждения кода)
Длительность в секундах, через сколько можно отправить новую смс.
Ответ на запрос проверки кода верификации
Body
Токен подтверждающая операции (одноразовый в общем случая, для операции auth - двухразовый)
SettingsResponse
Body
Список настроек подписок пользователя
Список настроек уведомлений пользователя
ProfileResponse
{addressId}{addressId}{promoId}{id}{serviceId}/points{serviceId}/points/filters{id}{id}{id}{id}{orderId}/review{orderId}/review/upload{type}{id}{type}{id}{id}/reviews{id}/reviews{id}/sizeTables{item}/set{id}/activate{id}{id}{id}/pay{cardId}{query}При первом запуске приложение вызывает данный запрос, тем самым устройство регистрируется на сервере. Так же создается временный пользователь на сервере.
Request body
Responses
Успешный запрос
Authentication
Метод должен вызываться каждый запуск, если на девайсе есть access token. Если передаем пустую строку в какой то параметр, то сервер затирает значение на эту пустую строку. Значения, которые не передаются не изменяются.
Request body
Responses
Успешный запрос
Authentication
Пароли передаются в зашифрованном виде, алгоритм шифрования HMAC-SHA256, в качестве ключа используется уникальный идентификатор устройства присвоенный сервером serverId.
Request body
Токен подтверждений операции passwordRecovery
Пароль, зашифрованный алгоритмом (HMAC-SHA256)
Новый пароль, зашифрованный алгоритмом (HMAC-SHA256)
Responses
default response
Авторизация по номеру телефона. В случае если пользователь не был ранее зарегистрирован в приложении, неявно происходит регистрация пользователя.
Request body
Токен подтверждений операции auth
Responses
OK
Параметр password содержить пароль пользователя, зашифрованный алгоритмом HMAC-SHA256, в качестве ключа шифрования используется уникальный идентификатор устройства присвоенный сервером serverId.
Коды ошибок:
- ERROR_EMAIL_INVALID - Пользователя с таким e-mail не существует
- ERROR_PASSWORD_INVALID - Неверный пароль
Request body
Адрес электронной почты
Пароль, зашифрованный алгоритмом (HMAC-SHA256)
Responses
OK
Request parameters
Токен доступа
Responses
OK
Request parameters
Токен доступа
Responses
OK
Request parameters
Токен доступа
Responses
OK
Авторизация через систему авторизации Apple
Request body
Код авторизации
Responses
OK
При логауте происходит создание нового временного пользователя, который возвращается в ответе
Responses
OK
Получить список адресов пользователя
Request parameters
Смещенеи начала выборки
Максимальное число элементов в выборке
Responses
OK
Body
Список адресов
Признак наличия допольнительных элементов сверх выборки
Общее число элементов
Добавление адреса
Request body
Идентификатор города
Почтовый индекс
Улица
Дом
Номер квартиры или офиса
Этаж
Комментарий к адресу
Request parameters
Айди города для выдачи адресов по конкретному городу
Поисковый запрос для фильтрации подсказок адресов
Responses
OK
Body
Список подсказок адресов
{addressId}Редактирование существующего адреса пользователя. Изменяются только передаваемые поля.
Path variables
Идентификатор адреса
Request body
Идентификатор города
Почтовый индекс
Улица
Дом
Номер квартиры или офиса
Этаж
Комментарий к адресу
Запрос возвращает список действующих акций
Responses
OK
Body
Список действующих акций
{promoId}Path variables
Responses
OK
Получить информацию о сервисах доставки. Возвращается информация актуальная для текущей корзины пользователя.
Request parameters
Идентификатор города
Responses
OK
Body
Список сервисов для доставки
Список сервисов для самовывоза
{id}Path variables
Идентификатор сервиса доставки
Request parameters
Идентификатор адреса доставки
Responses
OK
{serviceId}/pointsПолучить список точек самовывоза для сервиса доставки, в соответствии с выбранными фильтрами. Возвращается информация актуальная для текущей корзины пользователя.
В первом релизе serviceId всегда равно cdek
Path variables
Идентификатор сервиса доставки
Request parameters
Идентификатор города
Поисковый запрос для фильтрации ПВЗ
Список идентификаторов примененных фильтров
Responses
OK
Body
Список точек самовывоза
{serviceId}/points/filtersПолучить список групп фильтров для точек самовывоза выбранного сервиса доставки
Path variables
Идентификатор сервиса доставки
Request parameters
Идентификатор города
Responses
OK
Body
Список групп фильтров
Получить главную страницу
Responses
OK
{id}Получить заказ по идентификатору
Path variables
Идентификатор заказа
Responses
OK
{id}Изменить заказ
Path variables
Идентификатор заказа
Request parameters
Тип оплаты
Responses
OK
{id}Отменить заказ
Path variables
Идентификатор заказа
Responses
OK
{id}Запрос на повторение заказа – МП ожидает, что все позиции из повторяемого заказа попадут в текущую корзину. В случае совпадения сочетаний “товар-размер” количества суммируются
Path variables
ID заказа для повторения
Получение информации о возможных способах оплаты для выбранного сервиса доставки и точки самовывоза. Информация актуальна для текущей корзины пользователя.
Request parameters
Идентификатор сервиса доставки
Идентификатор точки самовывоза указанного сервиса доставки.
Responses
OK
Body
Список способов оплаты
Запрос создания заказа
Request body
Получение списка заказов пользователя. Первыми в списке возвращаются активные заказы отсортированные по дате. Затем оставшиеся заказы.
Request parameters
Смещение выборки от начала списка
Максимальное число элементов в выборке
Responses
OK
Body
Список заказов
Признак наличия дополнительных элементов сверх выборки
Общее число элементов в выборке
Получение активных заказов пользователя
Responses
OK
{orderId}/reviewСоздание отзыва о заказа
Path variables
Идентификатор заказа
Request body
Оценка
Сообщение
Список ссылок на изображения, прикреплённые к отзыву
{orderId}/review/uploadЗагрузка изображения для отзыва на заказ
Path variables
Идентификатор заказа
Request body
Файл изображения в формате PNG
Responses
Created
Body
Ссылка на загруженное изображение
Получение списка информационных страниц
Responses
OK
Body
Список информационных страниц
{type}Path variables
Тип информационной страницы
Responses
OK
{id}Path variables
ID информационной страницы
Responses
OK
Получить список категорий в каталоге
Responses
OK
Body
Список категорий
Список баннеров/акций для каталога
Запрос возвращает список товаров для выбранной категории categoryId, выборки selection или акции promoId, в соответствии с выбранными фильтрами и порядком сортировки. В список товаров встраиваются акции.
Request parameters
Идентификатор категории
Тип подборки
Идентифакатор акции
Минимальная цена товара в выборке
Максимальная цена товара в выборке
Список идентификаторов примененных фильтров
Идентификатор выбранного типа сортировки товаров в выборке
Смещение начала выборки
Максимальное число элементов в выборке
Responses
OK
Body
Список товаров со встроенными акциями
Признак наличия дополнительных товаров сверх выдачи
Общее количество товаров в выборке
Списко примененных фильтров
Название категории
{type}Запрос возвращает подборку товаров заданного типа
Path variables
Тип подборки товаров
Request parameters
Идентификатор товара для типа подборки product
Responses
OK
Запрос возвращает количество товары для выбранной категории categoryId, выборки selection или акции promoId, в соответствии с примененными фильтрами и типом сортировки.
Request parameters
Идентификатор категории
Тип выборки
Идентификатор акции
Минимальная цена товара в выборке
Максимальная цена товара в выборке
Список идентификаторов примененных фильтров
Responses
OK
Body
Количество товаров в выбранной категории
Получить список типов сортировки товаров
Responses
OK
Body
Список типов сортировки товара
Получить фильтры для избранного
Responses
OK
Body
Максимальная цена товара в кетегории
Список независимых фильтров
Список групп фильтров
{id}Запрос возвращает детальную информацию о товаре
Path variables
Идентификатор товара
Responses
OK
{id}/reviewsЗапрос возвращает список отзывов о товаре
Path variables
Идентификатор товара
Request parameters
Смещение начала выборки
Максимальное число элементов в выборке
Responses
OK
Body
Список отзывов
Признак наличия элементов сверх выборки
Общее количество отзывов о товаре
{id}/reviewsСоздание отзыва о товаре
Path variables
Идентификатор товара
Request parameters
Имя
Адрес электронной почты
Содержание отзыва
Согласие с правилами публикации отзыва
Responses
OK
{id}/sizeTablesЗапрос возвращает ссылку на изображение таблицы размеров для товара
Path variables
Идентификатор
Responses
OK
Body
Ссылка на изображение таблицы размеров
Получить список избранного
Request parameters
Responses
OK
Body
Список товаров со встроенными акциями
Списко примененных фильтров
Добавить товар в избранное
Request body
Идентификатор товара
Responses
OK
Запрос возвращает корзину пользователя, даже в случае отсутствия товаров в корзине.
Request parameters
Флаг о необходимости резервировать товары в корзине, true когда выполняем этот запрос на экране корзины
{item}/setЗапрос изменяет количество позиции товара в корзине. Если параметр qunatity равен 0, позиция удаляется из корзины.
Path variables
Идентификатор позиции товара в корзине
Request body
Количество
Пересчет корзины осуществляется при любых действиях пользователя изменяющих конечную стоимость заказа. Изменение города, выбор адреса доставки, выбор сервиса доставки и точки самовывоза, выбор типа оплаты.
Request body
Запрос возвращает ближайшую страну для заданных координат, страну определенную по IP, если координаты не заданы, или страну по умолчанию.
Request parameters
Широта
Долгота
Responses
OK
Запрос возвращает ближайщий город для заданных координат, город определенный по IP, если координаты не заданы, или город по умолчанию.
Request parameters
Широта
Долгота
Responses
OK
Получить список доступных стран. Если задан параметр query, возвращаются доступные страны, соответствующие строке поиска.
Request parameters
Строка поиска
Responses
OK
Получить список подcказок городов, соответствующих query
Request parameters
Идентификатор страны
Поисковый запрос для подсказок
Responses
OK
Получить список популярных городов, сформированных из наиболее частых запросов
Request parameters
Идентификатор страны для отображения городов
Responses
OK
Body
Список популярных городов
Получение списка образов
Responses
OK
{id}Получение образа по идентификатору
Path variables
Идентификатор образа
Responses
OK
Получить данные для экранов онбординга
Responses
OK
Body
Список экранов онбординга
Получение списка страниц обратной связи
Responses
OK
Body
Список страниц обратной связи
Отправить обращение
Request body
Responses
Created
{id}/payОплата через SDK ЮКасса [НЕОБХОДИМО УТОЧНИТЬ ИСПОЛЬЗУЕМЫЙ ЭКВАЙРИНГ]
Path variables
Идентификатор заказа
Request body
Токен оплаты
Responses
OK
Request parameters
Номер промокода
Responses
OK
Метод возвращает открытый ключ, который используется для шифрования карточных данных и создание криптограммы при добавлении карты.
Responses
OK
Body
Открытый ключ
Подтверждение платежа с 3-D Secure аутентификацией
Request body
Идентификатор транзакции
Значение одноименного параметра, полученного при запросе оплаты /payment в параметрах подтверждения платежа.
Responses
OK
{cardId}Выбрать карту для использования по умолчанию
Path variables
Идентификатор карты
Responses
OK
Authentication
Отправка SMS c кодом для подтверждения действия на указанный номер телефона. Если вызвать этот запрос с того же девайса для такой же операции до того, как истечет время жизни прошлой смс, то смс на самом деле не отправляется, а в ответе указывается актуальное время, когда реально можно будет отправить новую смс.
Коды ошибок:
- ERROR_DEVICE_BLOCKED - Девайс заблокирован, потому что много раз пытался выполнить одно и тоже действие
Authentication
Отправка письма c кодом для подтверждения действия на указанный адрес электронной почты. Если вызвать этот запрос с того же девайса для такой же операции до того, как истечет время жизни прошлой смс, то смс на самом деле не отправляется, а в ответе указывается актуальное время, когда реально можно будет отправить новую смс.
Коды ошибок:
- ERROR_DEVICE_BLOCKED - Девайс заблокирован, потому что много раз пытался выполнить одно и тоже действие
Request body
Адрес эклектронной почты, на который будет отправлен код подтверждения.
Authentication
Проверка кода подетверждения операции, отправленого на телефон или e-mail. Коды ошибок:
- ERROR_DEVICE_BLOCKED - Девайс заблокирован, потому что много раз пытался выполнить одно и тоже действие
- ERROR_VERIFICATION_CODE_INCORRECT - Введен неверный код
- ERROR_VERIFICATION_CODE_EXPIRY - Время проверки данного кода истекло.
Request body
Идентификатор полученный в запросе отправки кода
Код введенный пользователем.
Получить популярные поисковые запросы
Responses
OK
Поиск товаров в каталоге. Поиск осуществляется от одно символа.
Request parameters
Строка поиска
Спещение выборки
Максимальное число элементов в выборке
Responses
OK
Body
Список товаров
Признак наличия дополнительных элементов сверх выборки
Поиск товаров и категорий по каталогу. Поиск осуществляется от одного символа.
Request parameters
Строка поиска
Responses
OK
Body
Список категорий
Список товаров
Поиск категорий товаров в каталоге Поиск осуществляется от одно символа.
Request parameters
Строка поиска
Responses
OK
Body
Список категорий
Получить историю поисковых запросов для пользователя (до 3 штук). Если история пустая – сервер возвращает популярные поисковые запросы (до 4 штук).
Responses
OK
Очистить историю поисковых запросов
Responses
OK
{query}Удалить поисковый запрос из истории
Path variables
Поисковый запрос
Responses
OK
Обновление данных профиля. Обновляются только поля переданные в запросе.
Request body
Изменение номера телефона
Request body
Токен подтверждений операции editPhone
Изменение адреса электронной почты
Request body
Токен подтверждений операции editPhone
Адрес электронной почты (должен совпадать с номером, для которого был получен confirmationToken)
Пароли передаются в зашифрованном виде, алгоритм шифрования HMAC-SHA256, в качестве ключа используется уникальный идентификатор устройства присвоенный сервером serverId.
Request body
Пароль, зашифрованный алгоритмом (HMAC-SHA256)
Новый пароль, зашифрованный алгоритмом (HMAC-SHA256)
Responses
default response
Изменение настроек пользователя. Передаются только изменяемые параметры.
Request body
Параметры настройки уведомлений
Параметры настройки подписок
Информация об устройстве
Идентификатор устройства присвоенный сервером
Уникальный идентификатор устройства для которого регистрируется сессия. Генерируется на клиенте
Язык системы, ISO 639
Токен PUSH уведомлений
Зона времени устройства (https://gist.github.com/arpit/1035596)
Версия приложения
Модель адреса
Идентификатор адреса, в подсказках будет null
Описание адреса (содержит полное описание адреса для отображения на клиенте), в подсказках будет null
Почтовый индекс
Улица
Номер дома
Номер квартиры/офиса
Этаж
Комментарий к адресу
Рекламный баннер (используется как ссылка для категории)
Идентификатор банера
Ссылка на изображение банера
Название банера
Описание банера
Тип старницы
Идентификатор категории
Акция
Идентификатор акции
Ссылка на изображение акции для экрана акции
Название акции
Описание акции
Размер скидки в процентах
список продуктов акции
Итем для отображения в слайдере подборки. Если promo = null, отобразим banner, если banner = null, отобразим promo
Служба доставки
Идентификатор службы доставки
Название службы доставки заказов
Описание / дополнительная информация о доставке
Признак наличия возможности выбора точки самовывоза
Информация о сервисе доставки
Пункт выдачи заказов
Идентификатор точки самовывоза
Название точки самовывоза
Адрес точки самовывоза
Описание режима работы точки самовывоза
Описание маршрута (как добраться).
Контакты
Доступные типы оплаты
Название типа оплаты
Станции метро
Информация о точке самовывоза
Группа фильтров точек самовывоза
Идентификатор группы фильтров
Название группы фильтров
Список фильтров
Данные для главного экрана приложения
Объекты для отображения в верхнем слайдере: баннеры либо акции
Объекты для отображения в нижнем слайдере: баннеры либо акции
Список категорий номенклатуры
Список образов
Подборки товаров
Заказ
Список позиций в заказе
Идентификатор заказа
Номер заказа
Трек номер
Ссылка на отслеживание заказа
Список ссылок на изображение товров
Признак возможности сделать отзыв
Позиция в корзине
Идентификатор позиции в корзине
Количество товара
Контактные данные
Имя
Фамилия
Отчество
Адрес электронной почты
Телефон
Флаг для получения заказа другим получателем
Имя другого получателя
Номер другого получателя
Информация об оплате
Ссылка на электронный чек
Параметры пересчета корзины
Идентификатор города
Идентификатор адреса доставки
Идентификатор выбранной точки самовывоза
Комментарий к заказу
Отзыв о заказе
Идентификатор отзыва
Оценка
Сообщение
Признак согласия с правилами публикации отзыва
Ссылки на изображения, прикрепленные к отзыву
Данные для заполнения экрана оформления заказа при первом попадании на него. Берутся из предыдущего заказа/профиля
Информационная страница
Идентификатор информационной страницы
Название инфорационной страницы
Ссылка на информационную страницу (для отображения в WebView)
Модель товара
Список ссылок на изображение товара
Ссылка на полноэкранное изображение товара
Ссылка на превью изображения
Блок описания
Ссылка на видео c описание товара
Описание товара
Короткая модель товара
Идентификатор товара
Артикул
Название товара
Ссылка на маленькое изображение товара для отображения маленькими плитками в два столбца
Ссылка на крупное изображение товара для отображения в виде списка
Список доступных цветов товара. Ссылки на изображения с цветными текстурами
Признак наличия товара в избранном
Список всех размеров товара
Количество товаров данного размера, доступных к заказу
Список цен товара c учетом скидки
Список цен товара без учета скидки
Список маркеров товара
Модель ответа для карточки товара
Список товаров, принадлежащих к данной модели, отличающихся цветом
Превью
Список законченных образов с товаром
Список рекоммендованных подборок
Количество отзывов о товаре
Модель категории товаров
Идентификтор категории
Название категории
Ссылка на изображение категории
Список дочерних категорий
Группа фильтров товаров
Идентификатор группы фильтров
Тип группы фильтров
Список фильтров
Подборка товаров
Название подборки
Товары входящие в подборку
Отзыв о товаре
Идентификатор отзыва
Имя лица, оставившего отзыв
Содержание отзыва
Модель корзины
Идентификатор корзины
Список позиций в корзине
Общая сумма количеств каждого CartItem
Информация о стоимости корзины
Список записей в таблице стоимости корзины
Запись в таблице стоимости корзины
Название
Позиция в корзине
Идентификатор позиции в корзине
Количество товара
Количество товара доступное для заказа
Идентификатор промокода
Номер промокода
Описание промокода
Статус промокода
Параметры пересчета корзины
Идентификатор города
Идентификатор адреса доставки
Идентификатор выбранной точки самовывоза
Город
Идентификатор города
Название города
Слайд для лука, картинка и массив товаров
Изображение слайда
Массив товаров для слайда
Обращение
Идентификатор отзыва
Содержание отзыва
Форма обращения
Реквизиты получателя
Имя получателя
Фамилия получателя
Отчество получателя
Адрес регистрации получателя
ИНН получателя
Наименование банка получателя
БИК банка получателя
Номер расчетного счета получателя
Данные необходимые для подтверждения платежа (для оплаты с 3-D Secure аутентификацией).
Адрес 3DS формы для подтверждения платежаURL - подтверждения
Одноименный параметр из ответа сервера
Идентификатор транзакции
Тип оплаты
Идентификатор типа оплаты
Название типа оплаты
Описание типа оплаты / дополнительная информация
Платежная карта
Идентифкатор платежной карты
Номер платежной карты с маской
Признак карты, используемой по умолчанию.
Список поисковых подсказок
Модель пользователя
Идентификатор пользователя
Имя
Фамилия
Отчество
Адрес электронной почты
Флаг, оповещающий о наличии у пользователя непрочитанных сообщений
Хэша вычисленные по алогритму HMAC-SHA256. Для полей id, name, phone, email. Для идентификации пользователя в систем Webim. https://webim.ru/kb/dev/identification/8265-id-2-0/