Sportmaster OpenAPI with speca ext import

400 EmptyResponse

Пустой ответ сервера

Body

application/json

Object

data

Object required

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

Body

application/json

Object

error

Object

code

string

Enumeration:

UNAUTHORIZED_REQUEST

message

string

Operations: v2 Список магазинов v3 Список магазинов Авторизация по смс Авторизация через соцсети Изменить список избранных сервисов Краткая информация о бонусной программе Логаут Поиск города по ID Поиск городов по названию Полный логаут Получить адрес по местоположению Получить данные о товарах стрима Получить доступные группы сервисов Получить секции экрана сервисов Получить список секций по идентификаторам Регистрация по смс Регистрация через соцсети

400 EmptyRequestParamError

Ошибка, которая возникает, если фронт не передаёт обязательный параметр запроса.

Body

application/json

Object

error

Object required

code

string required

Enumeration:

EMPTY_REQUEST_PARAM

message

string required

Example:

"Один из обязательных параметров запроса null или отсутствует."

Operations: DEP v1 Найти связанный сервис по URL v2 Найти связанный сервис по URL Получить данные о товарах стрима

400 ErrorUnderMaintenance

Проходит сервисное обслуживание серверов.

Body

application/json

Object

error

Object

code

string

Example:

UNDER_MAINTENANCE

message

string

Example:

Попробуйте зайти через 15 минут, должно получиться

Operations: DEP v4 Конфигурация модуля App DEP Конфигурация модуля Afisha DEP Конфигурация модуля App DEP Конфигурация модуля Streams

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

Body

application/json

Object

error

Object required

code

string required

Меняется в зависимости от условия

message

string required

Меняется в зависимости от условия

Operations: DEP v1 Восстановить удаленный товар cart2 DEP v1 Изменить чекбоксы товаров в корзине cart2 DEP v1 Скрыть удаленный товар cart2 DEP v1 Установить количество товара в корзине cart2 DEP Сохранить выбранную услугу товара cart2 DEP Удалить выбранную услугу товара cart2 v2 Восстановить удаленный товар cart2 v2 Изменить чекбоксы товаров в корзине cart2 v2 Скрыть удаленный товар cart2 v2 Установить количество товара в корзине cart2 Детальные данные о наличии товаров в ПВЗ cart2 Добавить товар в корзину cart2 Изменить список избранных сервисов Изменить флаг использования бонусов cart2 Получить адрес по местоположению Получить данные о товарах стрима Получить корзину cart2 Получить секции экрана сервисов Получить список секций по идентификаторам Применить промокод cart2 Применить слепок корзины cart2 Проведение оплаты по подписке СБП Расформировать потенциальные заказы cart2 Редактировать адрес доставки потенциальных заказов cart2 Сохранить выбранные сервисные услуги cart2 Список магазинов с доступностью товаров cart2 Список ПВЗ с доступностью товаров cart2 Удалить выбранные услуги cart2 Удалить товары из корзины cart2 Установить дату и время у потенциального заказа cart2 Установить получателя корзины cart2 Установить способ доставки у товаров курьерская доставка cart2 Установить способ доставки у товаров ПВЗ cart2

400 ErrorBannerNotFound

Баннер не найден.

Body

application/json

Object

error

Object

code

string

Example:

BANNER_NOT_FOUND

message

string

Example:

Не удалось найти баннер.

Operations: Получить баннер по слоту Получить баннеры каталога

400 ErrorFileIsBad

ErrorFileIsBad

Body

application/json

Object

error

string

Код ошибки

Enumeration:

FILE_IS_BAD

message

string

Текст ошибки

Example:

Ошибка передачи файла

Operations: DEP Редактировать информацию о возвращаемых товарах Редактировать информацию о возвращаемых товарах v2

400 ErrorMaxFilesLimitExceeded

ErrorMaxFilesLimitExceeded

Body

application/json

Object

error

string

Код ошибки

Enumeration:

MAX_FILES_LIMIT_EXCEEDED

message

string

Текст ошибки

Example:

Превышено допустимое количество файлов

400 ProfileConfigurationResponse

Конфигурация для модуля Профиля пользователя

Body

application/json

Object

data

ProfileConfigurationModel required

Operations: DEP Конфигурация модуля Profile v1 Конфигурация модуля Profile

400 OrderingConfigResponse

Конфигурация для модуля оформления и корзины.

Body

application/json

Object

data

OrderingConfigurationModel required

Operations: v1 Конфигурация модуля Ordering

400 AppConfigResponse

Конфигурация для общих вещей приложения.

Body

application/json

Object

data

Object required

appReview

ReviewsConfiguration

appUpdate

AppUpdateConfiguration

services

ServicesConfiguration

servicesItems

Array of ServiceItem

Элементы на экране сервисов. Сортируются согласно приоритету баннеров на стороне бекенда. Отправляются только включенные сервисы

bannerBonuses

BannerBonuses

bannerSliderTimer

integer

Время (в секундах) переключения баннеров в слайдере на Главной (не в шапке)

useBigQrForBonuses

boolean required

[Начиная с 4.21]

Флаг, использовать ли большой QR код или нет.

Если true, то бэкенд должен исключить бонусы из servicesItems

amountBonus

integer required

Количество бонусов

Example:

500

geoFencesEnabled

boolean required

Фича тоггл геозон

Operations: DEP Конфигурация модуля App

400 AppConfigResponseV4

Конфигурация для общих вещей приложения. Версия (v4).

Body

application/json

Object

data

AppConfigurationModel required

Operations: DEP v4 Конфигурация модуля App

400 CatalogConfigResponse

CatalogConfigResponse

Body

application/json

Object

data

CatalogConfigurationModel required

Operations: DEP Конфигурация модуля Catalog Конфигурация модуля Catalog

400 StoresConfigResponse

StoresConfigResponse

Body

application/json

Object

data

StoresConfiguration required

Operations: Конфигурация модуля Stores

400 StreamsConfigResponse

Конфигурация для модуля Streams

Body

application/json

Object

data

StreamsConfigurationModel required

Operations: DEP Конфигурация модуля Streams

400 AfishaConfigResponse

Конфигурация для модуля Afisha

Body

application/json

Object

data

AfishaConfigurationModel required

Operations: DEP Конфигурация модуля Afisha

400 ChatConfigurationResponse

ChatConfigurationResponse

Body

application/json

Object

data

ChatConfigurationModel required

Operations: DEP Конфигурация модуля Chat

400 AllConfigurationsResponse

Ответ на общий запрос конфигурации модулей.

Body

application/json

Object

data

AllConfigurationsData

Operations: Получить конфигурации модулей

400 PopupsConfigResponse

Конфигурация для модуля всплывающих окон

Body

application/json

Object

data

PopupsConfigurationModel required

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

ERROR_BASKET_IS_EMPTY

message

string

Текст ошибки

Example:

Корзина пуста

Operations: Изменить флаг использования бонусов корзины услуг Оформить корзину услуг Получить корзину услуг Применить промокод в корзине услуг Способы оплаты потенциального заказа корзины услуг Удалить промокод в корзине услуг Установить дату и время у потенциального заказа корзины услуг Установить получателя корзины услуг Установить способ оказания услуг в сервисном центре Установить способ оплаты у заказа корзины услуг

400 ErrorOrderCostIsExceeded

ErrorOrderCostIsExceeded

Body

application/json

Object

error

Object

code

string

Enumeration:

ORDER_COST_IS_EXCEEDED

message

string

Example:

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

Operations: Оформить корзину

400 ErrorPromocodForInstallment

ErrorPromocodForInstallment

Body

application/json

Object

error

Object

code

string

Enumeration:

PROMOCODE_IS_NOT_AVAILABLE_FOR_INSTALLMENT

message

string

Example:

"Невозможно применить промокод для способа оплаты "Рассрочка"."

Operations: Применить промокод cart2

400 ErrorPromocodeIsNotValid

ErrorPromocodeIsNotValid

Body

application/json

Object

error

Object

code

string

Enumeration:

PROMOCODE_IS_NOT_VALID

message

string

Значение берется из Запрос к гейту. Response body. errorMessage, если значение отсутствует, то “Невозможно применить указанный промокод. Возможно, в нем допущена ошибка или его срок годности истек.”

Example:

Купон [BV64SMC7GT] зарезервирован в другом заказе [2700923-993085].

Operations: Добавить товар в корзину cart2 Применить промокод cart2 Применить промокод в корзине услуг

400 ErrorDeletedLinesAreNotFound

ErrorDeletedLinesAreNotFound

Body

application/json

Object

error

Object

code

string

Enumeration:

DELETED_ITEM_IS_NOT_FOUND

message

string

Example:

"Невозможно скрыть указанный товар. Данный товар отсутствует в корзине."

Operations: DEP v1 Скрыть удаленный товар cart2 v2 Скрыть удаленный товар cart2 Скрыть удаленный товар в корзине редактирования

400 ErrorSomeBasketLinesIsSoldout

ErrorSomeBasketLinesIsSoldout

Body

application/json

Object

error

Object

code

string

Enumeration:

SOME_BASKETLINES_IS_SOLDOUT

message

string

Example:

"Невозможно выполнить запрос, так как один из товаров распродан."

Operations: Детальные данные о наличии товаров в ПВЗ cart2 Получить доступность адресов получения cart2 Список магазинов с доступностью товаров cart2 Список ПВЗ с доступностью товаров cart2 Установить способ доставки у товаров курьерская доставка cart2 Установить способ доставки у товаров ПВЗ cart2 Установить способ доставки у товаров самовывоз cart2

400 ErrorFio

ErrorFio

Body

application/json

Object

error

Object

code

string

Enumeration:

FIO_MUST_CONTAIN_2_WORDS

message

string

Example:

"Поле ФИО получателя должно содержать как минимум два слова."

400 ErrorReceiverDataIsRequired

ErrorReceiverDataIsRequired

Body

application/json

Object

error

Object

code

string

Enumeration:

RECEIVER_DATA_IS_REQUIRED

message

string

Example:

"Не заполнены данные получателя."

Operations: Оформить корзину

400 ErrorAdressIsRequired

ErrorAdressIsRequired

Body

application/json

Object

error

Object

code

string

Enumeration:

ADRESS_FIELDS_IS_REQUIRED

message

string

Example:

"Адрес доставки не указан."

Operations: Оформить корзину

400 ErrorDeliveryTimeIsRequired

ErrorDeliveryTimeIsRequired

Body

application/json

Object

error

Object

code

string

Enumeration:

DELIVERY_TIME_IS_REQUIRED

message

string

Example:

"Время доставки не указано."

400 ErrorDeliveryDateIsRequired

ErrorDeliveryDateIsRequired

Body

application/json

Object

error

Object

code

string

Enumeration:

DELIVERY_DATE_IS_REQUIRED

message

string

Example:

Дата доставки не выбрана.

Operations: Оформить корзину

400 ErrorPaymentMethodIsRequired

ErrorPaymentMethodIsRequired

Body

application/json

Object

error

Object

code

string

Enumeration:

PAYMENT_METHOD_IS_REQUIRED

message

string

Example:

"Не выбран способ оплаты."

Operations: Оформить корзину Оформить корзину редактирования Оформить корзину услуг

400 ErrorAgreeToTerms

ErrorAgreeToTerms

Body

application/json

Object

error

Object

code

string

Enumeration:

AGREE_TO_TERMS_IS_REQUIRED

message

string

Example:

"Необходимо дать согласие на обработку персональных данных."

400 ErrorProfileIdIsEmpty

ErrorProfileIdIsEmpty

Body

application/json

Object

error

Object

code

string

Enumeration:

PROFILE_ID_IS_EMPTY

message

string

Example:

"ID профиля не может быть пустым."

Operations: Оформить корзину

400 ErrorOwnerDataIsRequired

ErrorOwnerDataIsRequired

Body

application/json

Object

error

Object

code

string

Enumeration:

OWNER_DATA_IS_REQUIRED

message

string

Example:

Контактные данные должны быть заполнены

Operations: Оформить корзину Оформить корзину возврата Оформить корзину редактирования Оформить корзину услуг

400 ErrorEmailIsRequired

ErrorEmailIsRequired

Body

application/json

Object

error

Object

code

string

Enumeration:

EMAIL_IS_REQUIRED

message

string

Example:

Email покупателя должен быть заполнен.

Operations: Оформить корзину

400 ErrorBasketVersionIsNotValid

ErrorBasketVersionIsNotValid

Body

application/json

Object

error

Object

code

string

Enumeration:

BASKET_VERSION_IS_NOT_VALID

message

string

Example:

"Версия корзины неактуальна."

Operations: Оформить корзину Оформить корзину возврата Оформить корзину редактирования Оформить корзину услуг

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

Body

application/json

Object

error

Object

code

string

Enumeration:

OBTAINING_METHOD_IS_NOT_VALID

message

string

Example:

"Передаваемый заказ не доставляется курьерской службой."

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

Body

application/json

Object

error

Object

code

string

Enumeration:

SOME_BASKETLINES_IS_NOT_FOUND

message

string

Example:

"Невозможно получить список точек получения для выбранных товаров. Один из указанных товаров отсутствует в корзине."

Operations: DEP Установить способ возврата курьером DEP Установить способ возврата ПВЗ Детальные данные о наличии товаров в ПВЗ cart2 Получить доступность адресов получения cart2 Список магазинов с доступностью товаров cart2 Список ПВЗ с доступностью товара для возврата Список ПВЗ с доступностью товаров cart2 Установить способ возврата курьером v2 Установить способ возврата ПВЗ v2 Установить способ доставки у товаров курьерская доставка cart2 Установить способ доставки у товаров ПВЗ cart2 Установить способ доставки у товаров самовывоз cart2

400 ErrorRestoredItemIfNotFound

ErrorRestoredItemIfNotFound

Body

application/json

Object

error

Object

code

string

Enumeration:

RESTORED_ITEM_IS_NOT_FOUND

message

string

Example:

"Невозможно восстановить указанный товар. Данный товар не числится среди удаленных."

Operations: DEP v1 Восстановить удаленный товар cart2 v2 Восстановить удаленный товар cart2 Восстановить удаленный товар в корзине редактирования

400 ErrorEmptyPromocode

ErrorEmptyPromocode

Body

application/json

Object

error

Object

code

string

Enumeration:

EMPTY_PROMOCODE

message

string

Example:

"Невозможно применить этот промокод. Введена пустая строка или недопустимые символы."

Operations: Применить промокод cart2

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

Body

application/json

Object

error

Object

code

string

Enumeration:

LINES_ARE_NOT_FOUND

message

string

Example:

cart1: "Невозможно удалить указанный товар. Данный товар отсутствует в корзине."

Operations: DEP v1 Изменить чекбоксы товаров в корзине cart2 DEP v1 Установить количество товара в корзине cart2 DEP Редактировать информацию о возвращаемых товарах DEP Сохранить выбранную услугу товара cart2 DEP Установить способ возврата в магазин v2 Изменить чекбоксы товаров в корзине cart2 v2 Установить количество товара в корзине cart2 Редактировать информацию о возвращаемых товарах v2 Сохранить выбранные сервисные услуги cart2 Удалить товары из корзины cart2 Удалить товары из корзины редактирования Установить количество товара в корзине редактирования Установить способ возврата в магазин v2

400 ErrorTooManyLinesInBasket

ErrorTooManyLinesInBasket

Body

application/json

Object

error

Object

code

string

Enumeration:

TOO_MANY_LINES_IN_BASKET

message

string

Example:

"Невозможно добавить в корзину товар в указанном количестве."

Operations: DEP v1 Установить количество товара в корзине cart2 v2 Установить количество товара в корзине cart2 Добавить товар в корзину cart2 Применить слепок корзины cart2 Установить количество товара в корзине редактирования

400 ErrorBasketState

ErrorBasketState

Body

application/json

Object

error

Object

code

string

Enumeration:

BASKET_STATE_IS_NOT_VALID

message

string

Example:

"Данное действие с корзиной невозможно выполнить. Её состояние не соответствует ожидаемому (в рамках выполняемого запроса)."

400 ErrorProductIsNotAvailable

ErrorProductIsNotAvailable

Body

application/json

Object

error

Object

code

string

Enumeration:

PRODUCT_IS_NOT_AVAILABLE

message

string

Example:

"Интересующий вас товар недоступен для покупки."

Operations: Добавить товар в корзину cart2

400 ErrorProductIsNotActive

ErrorProductIsNotActive

Body

application/json

Object

error

Object

code

string

Enumeration:

PRODUCT_IS_NOT_ACTIVE

message

string

Example:

"Интересующий вас товар неактивен."

Operations: Добавить товар в корзину cart2

400 ErrorProductIsNotFound

ErrorProductIsNotFound

Body

application/json

Object

error

Object

code

string

Enumeration:

PRODUCT_ID_IS_NOT_FOUND

message

string

Example:

"Интересующий вас товар не найден."

Operations: Добавить товар в корзину cart2

400 ErrorDeliveryDateIsExpired

ErrorDeliveryDateIsExpired

Body

application/json

Object

error

Object

code

string

Enumeration:

DELIVERY_DATE_IS_EXPIRED

message

string

Example:

"Невозможно выполнить оформление заказов, так как выбрана недоступная дата или недоступное время доставки."

Operations: Оформить корзину

400 SubmitCartResponse

SubmitCartResponse

Body

application/json

Object

data

Object required

orders

Array of OrderSimpleModel required

Operations: Оформить корзину Оформить корзину возврата Оформить корзину услуг

400 SnapshotResponse

SnapshotResponse

Body

application/json

Object

data

Object required

snapshotUrl

string required

Ссылка на слепок корзины

Example:

https://www.sportmaster.ru/basket/checkout.do?specificationId=1f9dea2e-68d7-4b14-ad8f-88a8a619e46c

Operations: Создать слепок корзины

400 CartResponse2

Возвращает корзину (основную корзину). Возвращется только одна из моделей. Какая - зависит от входного параметра в запрос.

Body

application/json

Object

data

Object required

cartFull

CartFull2

cartLite

CartLite

Operations: DEP v1 Установить количество товара в корзине cart2 v2 Установить количество товара в корзине cart2 Добавить товар в корзину cart2 Получить корзину cart2 Удалить товары из корзины cart2

400 FullCartResponse2

FullCartResponse2

Body

application/json

Object

data

Object required

cart

CartFull2 required

Operations: DEP v1 Восстановить удаленный товар cart2 DEP v1 Изменить чекбоксы товаров в корзине cart2 DEP v1 Скрыть удаленный товар cart2 DEP v1 Удалить промокод в корзине cart2 DEP Сохранить выбранную услугу товара cart2 DEP Удалить выбранную услугу товара cart2 v2 Восстановить удаленный товар cart2 v2 Изменить чекбоксы товаров в корзине cart2 v2 Скрыть удаленный товар cart2 v2 Удалить промокод в корзине cart2 Изменить флаг использования бонусов cart2 Применить промокод cart2 Применить слепок корзины cart2 Распределить товары на самовывоз из текущего магазина Расформировать потенциальные заказы cart2 Редактировать адрес доставки потенциальных заказов cart2 Сохранить выбранные сервисные услуги cart2 Удалить выбранные услуги cart2 Установить дату и время у потенциального заказа cart2 Установить получателя корзины cart2 Установить способ доставки у товаров курьерская доставка cart2 Установить способ доставки у товаров ПВЗ cart2 Установить способ доставки у товаров самовывоз cart2 Установить способ оплаты у заказа cart2 Установить уровень сервиса у потенциального заказа

400 EmptyPhoneErrorResponse

EmptyPhoneErrorResponse

Body

application/json

Object

error

Object

code

string required

Example:

OWNER_EMPTY_PHONE

message

string

Example:

Укажите номер телефона

400 ErrorApplicationSnapshot

ErrorApplicationSnapshot

Body

application/json

Object

error

Object

code

string

Example:

ERROR_APPLICATION_SNAPSHOT

message

string

Example:

Невозможно применить слепок корзины

Operations: Применить слепок корзины cart2

400 CartItemsDeliveryTypes

CartItemsDeliveryTypes

Body

application/json

Object

data

Object required

list

Array of DeliveryTypeEnum required

Operations: Получить варианты доставки для товаров cart2

400 ErrorPhoneInBasket

Кейс 1. Ошибка, если для неавторизованного пользователя не передан токен и у владельца корзины нет телефона // Кейс 2. Ошибка, если для авторизованного пользователя не передан номер телефона

Body

application/json

Object

error

Object

code

string

Example:

ERROR_PHONE_IN_BASKET

string

Example:

У владельца корзины нет номера телефона

Operations: Установить получателя корзины cart2 Установить получателя корзины услуг

400 ErrorInvalidQuantity

Ошибка, возвращаемая при некорректном значение количества товара.

Body

application/json

Object

error

Object

code

string required

Enumeration:

INVALID_QUANTITY

message

string required

Example:

Невозможно установить количество товара. Минимальное значение - 1, максимальное - 50.

Operations: DEP v1 Установить количество товара в корзине cart2 v2 Установить количество товара в корзине cart2

400 ErrorOrderWeightExceeded

ErrorOrderWeightExceeded

Body

application/json

Object

error

Object

code

string

Enumeration:

ORDER_WEIGHT_EXCEEDED

message

string

Example:

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

Operations: Оформить корзину

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

BASKET_IS_NOT_EXIST

message

string

Текст ошибки

Example:

Невозможно выполнить запрос, корзину не удалось найти

Operations: v2 Получить документ по URL Детальные данные о наличии товаров в ПВЗ cart2 Изменить флаг использования бонусов корзины услуг Оформить корзину услуг Получить корзину услуг Применить промокод в корзине услуг Список ПВЗ с доступностью товаров cart2 Способы оплаты потенциального заказа корзины услуг Удалить промокод в корзине услуг Установить дату и время у потенциального заказа корзины услуг Установить получателя корзины услуг Установить способ оказания услуг в сервисном центре Установить способ оплаты у заказа корзины услуг

400 ErrorExceedLimitOnActiveOrders

ErrorExceedLimitOnActiveOrders

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

EXCEED_LIMIT_ON_ACTIVE_ORDERS

message

string

Текст ошибки

Example:

Лимит на заказы. Выкупите или отмените текущий

Operations: Оформить корзину

400 InternalPickupErrorResponse

InternalPickupErrorResponse

Body

application/json

Object

error

Object

code

string

Enumeration:

INT_PICKUP_FROM_SHOP_IS_NOT_AVAILABLE

message

string

Example:

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

Operations: Распределить товары на самовывоз из текущего магазина Установить способ доставки у товаров самовывоз cart2 Установить уровень сервиса у потенциального заказа

400 ErrorInternalPickupAvailability

ErrorInternalPickupAvailability

Body

application/json

Object

error

Object

code

string

Enumeration:

EMPTY_INTERNAL_PICKUP_AVAILABILITY

message

string

Example:

"Для выбранных товаров нет доступных магазинов с возможностью самовывоза."

Operations: Список магазинов с доступностью товаров cart2

400 InternalPickupAvailabilityResponse2

InternalPickupAvailabilityResponse2

Body

application/json

Object

data

Object required

list

Array of CartItemInternalAvailability2

Operations: Список магазинов с доступностью товаров cart2

400 ErrorObtainPointIsNotSelfDelivery

ErrorObtainPointIsNotSelfDelivery

Body

application/json

Object

error

Object

code

string

Enumeration:

OBTAIN_POINT_IS_NOT_SELF_DELIVERY

message

string

Example:

Выбранный заказ не является заказом на самовывоз

Operations: Установить уровень сервиса у потенциального заказа

400 ErrorServiceLevelCodeIsNotValid

ErrorServiceLevelCodeIsNotValid

Body

application/json

Object

error

Object

code

string

Enumeration:

SERVICE_LEVEL_CODE_IS_NOT_VALID

message

string

Example:

"Некорректный уровень сервиса"

Operations: Установить уровень сервиса у потенциального заказа

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

Body

application/json

Object

error

Object

code

string

Enumeration:

ACTION_IS_NOT_AVAILABLE

message

string

Example:

"Действие недоступно"

Operations: Изменить флаг использования бонусов корзины услуг Отправить причину редактирования заказа Оформить корзину услуг Получить корзину услуг Применить промокод в корзине услуг Создать корзину услуг Список сервисных центров с доступностью услуг Способы оплаты потенциального заказа корзины услуг Удалить промокод в корзине услуг Установить дату и время у потенциального заказа корзины услуг Установить получателя корзины услуг Установить способ оказания услуг в сервисном центре Установить способ оплаты у заказа корзины услуг Установить уровень сервиса у потенциального заказа

400 ErrorExternalPickupAvailability

ErrorExternalPickupAvailability

Body

application/json

Object

error

Object

code

string

Enumeration:

EMPTY_EXTERNAL_PICKUP_AVAILABILITY

message

string

Example:

"Для выбранного товара нет доступных пунктов выдачи"

Operations: DEP Установить дату и время у потенциального заказа на возврат DEP Установить способ возврата ПВЗ Детальные данные о наличии товаров в ПВЗ cart2 Список ПВЗ с доступностью товара для возврата Список ПВЗ с доступностью товаров cart2 Установить дату и время у потенциального заказа на возврат v2 Установить способ возврата ПВЗ v2

400 ExternalPickupAvailabilityResponse2

ExternalPickupAvailabilityResponse2

Body

application/json

Object

data

Object required

list

Array of CartItemExternalAvailability2 required

serviceIconsList

Array of PickpointServiceIcons required

Иконки услуг, доступных в ПВЗ

Operations: Список ПВЗ с доступностью товаров cart2

400 ExternalPickupAvailabilityDetailResponse

ExternalPickupAvailabilityDetailResponse

Body

application/json

Object

data

Object required

detail

CartItemExternalAvailabilityDetail

Operations: Детальные данные о наличии товаров в ПВЗ cart2

400 ReceivingAddressAvailabilityResponse

ReceivingAddressAvailabilityResponse

Body

application/json

Object

data

Object required

list

Array of CartItemAddressAvailability

Список сущностей (адрес получения и какие товары доступны по этому адресу)

Operations: Получить доступность адресов получения cart2

400 ErrorAddressesListIncorrect

ErrorAddressesListIncorrect

Body

application/json

Object

error

Object

code

string required

Enumeration:

ADDRESSES_LIST_INCORRECT

message

string required

Example:

Ошибка в составе переданных адресов

Operations: Получить доступность адресов получения cart2

400 ErrorMethodIsDisabled

ErrorMethodIsDisabled

Body

application/json

Object

error

Object

code

string required

Enumeration:

METHOD_IS_DISABLED

message

string required

Example:

Метод временно недоступен

Operations: Получить доступность адресов получения cart2 Установить признак Я в магазине

400 ErrorServiceIsNotValid

ErrorServiceIsNotValid

Body

application/json

Object

error

Object

code

string

Enumeration:

SERVICE_IS_NOT_VALID

message

string

Example:

"Сервисная услуга недоступна"

Operations: DEP Сохранить выбранную услугу товара cart2 Сохранить выбранные сервисные услуги cart2 Удалить выбранные услуги cart2

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

Body

application/json

Object

error

Object

code

string

Enumeration:

OBTAIN_POINT_ID_IS_NOT_FOUND

message

string

Example:

"Выбранный заказ не найден среди заказов корзины."

Operations: DEP Сохранить выбранную услугу товара cart2 DEP Установить дату и время у потенциального заказа на возврат Расформировать потенциальные заказы cart2 Редактировать адрес доставки потенциальных заказов cart2 Сохранить выбранные сервисные услуги cart2 Способы оплаты потенциального заказа корзины услуг Установить дату и время у потенциального заказа cart2 Установить дату и время у потенциального заказа корзины услуг Установить дату и время у потенциального заказа на возврат v2 Установить способ оплаты у заказа корзины услуг Установить уровень сервиса у потенциального заказа

400 ErrorDateTimeReceiptAreOutdated

ErrorDateTimeReceiptAreOutdated

Body

application/json

Object

error

Object

code

string

Enumeration:

DATE_TIME_RECEIPT_ARE_OUTDATED

message

string

Example:

"Дата и время доставки заказа уже устарели"

Operations: DEP Установить дату и время у потенциального заказа на возврат Установить дату и время у потенциального заказа cart2 Установить дату и время у потенциального заказа на возврат v2

400 ErrorObtainPointDelivery

ErrorObtainPointDelivery

Body

application/json

Object

error

Object

code

string

Если на фронт вернулась ошибка с таком кодом, необходимо показать всплывающее окошко с кнопкой “Создать еще один заказ”.

Enumeration:

SET_OBTAINPOINT_ERROR_CREATE_OBTAINPOINT

message

string

Example:

"Невозможно добавить выбранный товар в один из существующих заказов на доставку."

Operations: Установить способ доставки у товаров курьерская доставка cart2

400 ErrorCreditMinSum

ErrorCreditMinSum

Body

application/json

Object

error

Object

code

string

Enumeration:

CREDIT_SUM_LESS_MINIMUM_VALUE

message

string

Example:

"Сумма данного заказа меньше минимальной суммы, на которую можно оформить кредит."

Operations: Установить способ оплаты у заказа cart2

400 ErrorPaymentMethodIsNotValid

ErrorPaymentMethodIsNotValid

Body

application/json

Object

error

Object

code

string

Enumeration:

PAYMENT_METHOD_IS_NOT_VALID

message

string

Example:

"Для выбранного потенциального заказа неправильный способ оплаты"

Operations: Установить способ оплаты у заказа cart2 Установить способ оплаты у заказа корзины услуг

400 ErrorPotentialOrderIsNotFound

ErrorPotentialOrderIsNotFound

Body

application/json

Object

error

Object

code

string

Enumeration:

POTENTIAL_ORDER_ID_IS_NOT_FOUND

message

string

Example:

"Выбранный потенциальный заказ не найден среди заказов корзины."

Operations: DEP Установить способ возврата денежных средств Способы оплаты потенциального заказа cart2 Установить способ возврата денежных средств v2 Установить способ оплаты у заказа cart2

400 PaymentMethodsResponse2

PaymentMethodsResponse2

Body

application/json

Object

data

Object

list

Array of PaymentObjectModel

Operations: Способы оплаты потенциального заказа cart2 Способы оплаты потенциального заказа корзины услуг

400 ErrorInvalidProccessParameters

ErrorInvalidProccessParameters

Body

application/json

Object

error

Object

code

string required

Enumeration:

INVALID_PROCESS_PARAMETERS

message

string required

Example:

"Не удалось выполнить запрос, т.к. переданы некорректные данные."

Operations: DEP Сохранить выбранную услугу товара cart2 Получить конфигурации модулей Сохранить выбранные сервисные услуги cart2 Установить дату и время у потенциального заказа cart2 Установить способ доставки у товаров курьерская доставка cart2 Установить способ доставки у товаров ПВЗ cart2

400 ErrorLocationIsNotMatch

Ошибка, возвращаемая если координаты в x-location не совпадают с координатами в receivingAddress.

Body

application/json

Object

error

Object

code

string required

Enumeration:

LOCATION_IS_NOT_MATCH

message

string required

Example:

"Местоположение на устройстве не совпадает с местоположением указанного адреса."

Operations: DEP Установить способ возврата курьером Редактировать адрес доставки потенциальных заказов cart2 Установить способ возврата курьером v2 Установить способ доставки у товаров курьерская доставка cart2

400 ErrorUserLocationHasChanged

Ошибка, возвращаемая при расформировании МСП после смены местоположения на корзине (OrderGate, после вызова CALCULATE-BASKET).

Body

application/json

Object

error

Object

code

string required

Enumeration:

LOCATION_HAS_CHANGED

message

string required

Example:

"Адрес доставки изменен. Стоимость и наличие товаров могли измениться"

Operations: Редактировать адрес доставки потенциальных заказов cart2

400 ErrorHouseIsNull

Ошибка, возвращаемая, когда при установке МСП курьерской доставки / редактирования адреса курьерской доставки в структуре адреса отсутствует дом (геозоны).

Body

application/json

Object

error

Object

code

string required

Enumeration:

HOUSE_IS_NULL

message

string required

Example:

"Для установки адреса доставки необходимо указать дом."

400 ErrorPinCodeIncorrect

Неправильный пин-код

Body

application/json

Object

error

Object

code

string

Example:

EGC_INVALID_PINCODE

message

string

Example:

Неверный код. Попробуйте еще раз

Operations: Применить подарочную карту Провести валидацию подарочной карты

400 ErrorEgcExpired

Срок действия подарочной карты истек

Body

application/json

Object

error

Object

code

string

Example:

EGC_EXPIRED

message

string

Example:

Истек срок действия

Operations: Восстановить пинкод подарочной карты Применить подарочную карту Провести валидацию подарочной карты

400 PaymentUrlResponse

Ответ на получение ссылки на оплату банковской картой

Body

application/json

Object

data

Object required

paymentUrl

string required

Operations: Получить ссылку на оплату банковской картой SberPay Получить ссылку на оплату Яндекс Pay

400 BnplUrlResponse

Ответ на получение ссылки на оплату частями

Body

application/json

Object

data

Object required

bnplUrl

string required

Operations: DEP Получить ссылку на оплату частями Плайт Получить ссылку на оплату Тинькофф долями Получить ссылку на оплату частями Плайт v2 Получить ссылку на оплату частями Яндекс Сплит

400 MerchantSettingsResponse

MerchantSettingsResponse

Body

application/json

Object

data

Object required

payMerchant

string required

Operations: Получить настроенные мерчанты

400 MakeMobilePaymentResponse

MakeMobilePaymentResponse

Body

application/json

Object

data

Object required

url3DS

string

URL для прохождения проверки 3DS

Operations: Провести оплату через Pay

400 ErrorInvalidSubmitPaymentParameters

ErrorInvalidSubmitPaymentParameters

Body

application/json

Object

error

Object

code

string

Enumeration:

INVALID_SUBMIT_PAYMENT_PARAMETERS

message

string

Example:

"Для подтверждения платежа не указаны обязательные параметры."

Operations: Подтвердить успешную оплату

400 ErrorOrderNumberIsEmpty

ErrorOrderNumberIsEmpty

Body

application/json

Object

error

Object

code

string

Example:

ORDER_NUMBER_IS_EMPTY

message

string

Example:

"Для выполнения запроса необходимо передавать номер заказа."

Operations: Получить данные для оплаты через СБП Получить настроенные данные для GPay Получить настроенные данные для SPay Получить настроенные мерчанты Проверить статус платежа по намерению Провести оплату через Pay

400 ErrorOrderNumberIsBad

Гейт ответил 400й ошибкой при orderNumber != null

Body

application/json

Object

error

Object

code

string

Example:

ORDER_NUMBER_IS_BAD

message

string

Текст ошибки проксируется с гейта

Operations: Получить данные для оплаты через СБП

400 ErrorPaymentToolIsEmpty

ErrorPaymentToolIsEmpty

Body

application/json

Object

error

Object

code

string

Example:

PAYMENTTOOL_IS_EMPTY

message

string

Example:

"Для выполнения запроса необходимо передать платежную систему"

Operations: Получить настроенные мерчанты Провести оплату через Pay

400 ErrorRedirectURLIsEmpty

ErrorRedirectURLIsEmpty

Body

application/json

Object

error

Object

code

string

Example:

REDIRECT_URL_IS_EMPTY

message

string

Example:

"Для выполнения запроса необходимо передать URL перенаправления"

Operations: Провести оплату через Pay

400 ErrorPaymentUrlIsEmpty

ErrorPaymentUrlIsEmpty

Body

application/json

Object

error

Object

code

string

Enumeration:

PAYMENT_URL_IS_EMPTY

message

string

Example:

"Не удалось получить ссылку на оплату банковской картой."

Operations: DEP Получить ссылку на оплату частями Плайт Получить ссылку на оплату банковской картой SberPay Получить ссылку на оплату Тинькофф долями Получить ссылку на оплату частями Плайт v2 Получить ссылку на оплату частями Яндекс Сплит Получить ссылку на оплату Яндекс Pay

400 ErrorPaymentUrlInvalidParameters

ErrorPaymentUrlInvalidParameters

Body

application/json

Object

error

Object

code

string

Enumeration:

INVALID_PARAMETERS

message

string

Example:

"Невозможно выполнить запрос, отсутствует один из обязательных параметров."

400 ErrorMerchantNotFound

ErrorMerchantNotFound

Body

application/json

Object

error

Object

code

string

Example:

MERCHANT_NOT_FOUND

message

string

Example:

"Для успешного выполнения запроса не был получен необходимый настроенный мерчант"

Operations: Получить настроенные данные для GPay Получить настроенные данные для SPay Получить настроенные мерчанты

400 CreditUrlResponse

Ответ на получение ссылки на оформление кредита

Body

application/json

Object

data

Object required

creditUrl

string required

Operations: Получить ссылку на оформление кредита и рассрочки

400 ErrorPaymentMethodIsNotCredit

ErrorPaymentMethodIsNotCredit

Body

application/json

Object

error

Object

code

string

Example:

PAYMENT_METHOD_IS_NOT_CREDIT

message

string

Example:

"Некорректный тип оплаты заказа"

Operations: Получить ссылку на оформление кредита и рассрочки

400 ErrorNotAllProductsFound

ErrorNotAllProductsFound

Body

application/json

Object

error

Object

code

string

Enumeration:

NOT_ALL_PRODUCTS_FOUND

message

string

Example:

"Невозможно сформировать ссылку на кредит, так как в составе заказа зафиксирован удаленный товар"

Operations: Получить ссылку на оформление кредита и рассрочки

400 ErrorProductIsNotCreditOrInstallment

ErrorProductIsNotCreditOrInstallment

Body

application/json

Object

error

Object

code

string

Example:

PRODUCT_IS_NOT_CREDIT_OR_INSTALLMENT

message

string

Example:

"Невозможно получить ссылку на оформление кредита или рассрочки для этих товаров."

Operations: Получить ссылку на оформление кредита и рассрочки

400 ErrorMerchantNotCorrect

ErrorMerchantNotCorrect

Body

application/json

Object

Error

Object

code

string

Example:

MERCHANT_NOT_CORRECT

message

string

Example:

"Получен некорректный настроенный мерчант"

Operations: Получить настроенные данные для SPay

400 SamsungPayMerchantResponse

SamsungPayMerchantResponse

Body

application/json

Object

data

Object

merchantId

string

Айди мерчанта. Берется из запроса гейта

Example:

sportmaster8

serviceId

string

Айди сервиса оплаты. Зашивается на сервере для каждого merchantId, который может прийти с гейта

Example:

693909957010406cbd08b6

merchantName

string

Название мерчанта. Зашивается на сервере

Example:

Sportmaster

Operations: Получить настроенные данные для SPay

400 GooglePayMerchantResponse

GooglePayMerchantResponse

Body

application/json

Object

data

Object

Объект с настроенным содержимым

gateway

string

Зашивается на сервере

Example:

sberbank

gatewayMerchantId

string

Получается из гейта, см. ТЗ

Example:

sportmaster8

Operations: Получить настроенные данные для GPay

400 QrcResponse

Ответ на формирование ссылки на оплату через СБП

Body

application/json

Object

data

Object required

paymentIntentionId

string required

Идентификатор намерения платежа

url

string required

Payload зарегистрированного QR кода в СБП

memberBanks

Array of MemberBank

Список банков-участников СБП

Operations: Получить данные для оплаты через СБП

400 CheckPaymentIntentionResponse

Статус платежа

Body

application/json

Object

data

Object required

status

PaymentIntentionStatus required

Operations: Проверить статус платежа по намерению

400 ErrorPaymentIntentionIdIsEmpty

ErrorPaymentIntentionIdIsEmpty

Body

application/json

Object

error

Object

code

string

Example:

PAYMENT_INTENTION_ID_IS_EMPTY

message

string

Example:

"Для выполнения запроса необходимо передавать номер намерения оплатить."

Operations: Проверить статус платежа по намерению

400 ErrorPaymentIntentionIdIsBad

Гейт ответил 400й ошибкой при paymentIntentionId != null

Body

application/json

Object

error

Object

code

string

Example:

PAYMENT_INTENTION_ID_IS_BAD

message

string

Текст ошибки проксируется с гейта

Operations: Проверить статус платежа по намерению

400 ErrorPaymentStatusUnknown

ErrorPaymentStatusUnknown

Body

application/json

Object

error

Object

code

string

Example:

PAYMENT_STATUS_UNKNOWN

message

string

Example:

"Неизвестный статус платежа"

Operations: Проверить статус платежа по намерению

400 ValidateGiftCardResponse

Ответ на успешную валидацию подарочной карты

Body

application/json

Object

data

Object

giftCardNominal

Price required

comparisonResultText

string

Текст результата сравнения номинала подарочной карты и суммы заказа

Operations: Провести валидацию подарочной карты

400 ErrorEgcAlreadyUsed

Карта уже использована

Body

application/json

Object

error

Object

code

string

Example:

EGC_ALREADY_USED

message

string

Example:

Карта уже использована

400 ErrorEgcTemporarlyBlocked

Карта заблокирована на 30 минут

Body

application/json

Object

error

Object

code

string

Example:

EGC_TEMPORARILY_BLOCKED

message

string

Example:

Карта заблокирована на 30 минут

400 ErrorEgcNotFound

Неправильный номер карты

Body

application/json

Object

error

Object

code

string

Example:

EGC_NOT_FOUND

message

string

Example:

Неверный номер карты

400 ErrorIncorrectGiftCardType

Неправильный тип подарочной карты

Body

application/json

Object

error

Object

code

string

Example:

GC_INCORRECT_TYPE

message

string

Example:

Неправильный тип карты

Operations: Восстановить пинкод подарочной карты Провести валидацию подарочной карты

400 SendPinResponse

Ответ об отправке СМС

Body

application/json

Object

data

Object

resendIn

integer required

Количество секунд, по истечению которых станет доступен повторный запрос пин-кода

Operations: Восстановить пинкод подарочной карты

400 SberPayResponse

SberPayResponse

Body

application/json

Object

data

Object

bankInvoiceId

string required

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

Example:

b19e126d61de4e209db86131778022c1

payload

string required

Закодированный объект из двух атрибутов apiKey и merchantLogin. Перед передачей на фронт объект переводится в строку, убираются пробелы и переносы строк в неконтентной части, строка перегоняется в Base64. К сформированной строке в начало добавляется соль.

Operations: Получить данные для оплаты через SberPay

400 FpsSubscriptionResponse

FpsSubscriptionResponse

Body

application/json

Object

data

Object required

paymentIntentionId

string required

Идентификатор намерения платежа

Example:

8a69e5968949bab101894eda11793579

Operations: Проведение оплаты по подписке СБП

400 EgcResponse

EgcResponse

Body

application/json

Object

data

Object

invoiceNumber

string required

Номер заказа

Operations: Оформить заказ ЭПК

400 EgcInfoResponse

EgcInfoResponse

Body

application/json

Object

data

Object

egcValues

EgcValue required

egcImages

Array of EgcImage

Дизайны ЭПК

Operations: Получить данные для покупки ЭПК

400 OrderHistoryResponse

OrderHistoryResponse

Body

application/json

Object

data

Object required

orders

Array of OrderItem required

filters

Array of OrderFilter

Какие варианты фильтрации бывают. Вшиты на нашем БЭ

Operations: v3 История заказов

400 OrderResponse

OrderResponse

Body

application/json

Object

data

Object required

order

Order required

Operations: v4 Получить заказ Получить товарный чек

400 OrdersByNumbersResponse

OrdersByNumbersResponse

Body

application/json

Object

data

Object required

list

Array of Order

Operations: v2 Поиск заказов по номеру заказа

400 PickUpAutoResponse

PickUpAutoResponse

Body

application/json

Object

data

Object required

queueNumber

integer required

Example:

Operations: Получить заказ на парковке

400 ThanksForOrderResponse

ThanksForOrderResponse

Body

application/json

Object

data

Object required

thanksForOrderBanner

MainBanner

isUserInStore

boolean required

Находится ли пользователь в магазине

screenMode

string required

Состояние, в котором нужно отрисовать экран. На данный момент настроен только SERVICE_ORDER для заказа услуг. Для всех остальных пока отправляется DEFAULT_ORDER, чтобы не делать атрибут nullable

Enumeration:

DEFAULT_ORDER

EGC_ORDER

IN_STORE

RETAIL_SELF_DELIVERY

SERVICE_ORDER

crossborderShortInfo

string

Информация о таможенном брокере

Operations: Получить Спасибо за заказ

400 ErrorOrderIllegalAction

ErrorOrderIllegalAction

Body

application/json

Object

error

Object

code

string

Enumeration:

ORDER_ILLEGAL_ACTION

message

string

Example:

"Действие не доступно для данного заказа"

Operations: DEP Отменить заказ DEP Отменить редактируемый заказ Открыть спор по возврату Отменить возврат Отменить заказ Отправить причину редактирования заказа Продлить хранение заказа

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

Body

application/json

Object

error

Object

code

string

Enumeration:

ORDER_ILLEGAL_ACCESS

name

string

Example:

"Невозможно получить доступ к данным по указанному заказу."

Operations: DEP Отменить заказ DEP Отменить редактируемый заказ DEP Получить корзину возврата DEP Редактировать информацию о возвращаемых товарах DEP Установить получателя корзины возврата DEP Установить способ возврата в магазин DEP Установить способ возврата денежных средств v2 Поиск заказов по номеру заказа v4 Получить заказ Отменить заказ Отправить причину редактирования заказа Оформить корзину возврата Получить возврат Получить заказ на парковке Получить корзину возврата v2 Получить ссылку на оплату частями Яндекс Сплит Получить товарный чек Продлить хранение заказа Редактировать информацию о возвращаемых товарах v2 Установить получателя корзины возврата v2 Установить способ возврата в магазин v2 Установить способ возврата денежных средств v2

400 PickUpAutoDuplicationError

PickUpAutoDuplicationError

Body

application/json

Object

error

Object

code

string

Enumeration:

DUPLICATION_ERROR

name

string

Example:

"Задание по заказу 222222-222222 уже создано. Номер очереди 1."

Operations: Получить заказ на парковке

400 PickUpAutoNotEnabledError

Ошибка, когда FeatureToggles.isPickUpAutoEnabled == false.

Body

application/json

Object

error

Object

code

string required

Код ошибки

Enumeration:

PICKUP_AUTO_NOT_ENABLED

message

string required

Example:

"Услуга PickUp Auto выключена."

Operations: Получить заказ на парковке

400 ErrorProductIdMustNotBeNull

ErrorProductIdMustNotBeNull

Body

application/json

Object

error

Object

code

string required

Код ошибки.

Enumeration:

PRODUCTID_MUST_NOT_BE_NULL

message

string required

Сообщение ошибки.

Example:

"Не удалось получить данные о товарах. Попробуйте позже."

Operations: v2 Поиск заказов по номеру заказа v4 Получить заказ Получить товарный чек

400 ErrorWareIdMustNotBeNull

ErrorWareIdMustNotBeNull

Body

application/json

Object

error

Object

code

string required

Код ошибки.

Enumeration:

WAREID_MUST_NOT_BE_NULL

message

string required

Сообщение ошибки.

Example:

"Не удалось получить данные о товарах. Попробуйте позже."

Operations: v2 Поиск заказов по номеру заказа v4 Получить заказ Получить товарный чек

400 FaqResponse

FaqResponse

Body

application/json

Object

data

Object

questionList

Array of FrequentlyAskedQuestion required

Список вопросов

buttonName

string required

Название кнопки

Example:

Начать чат

buttonDeeplink

string required

Диплинк кнопки

Example:

sportmaster://chat

Operations: Получить данные для FAQ по заказу

400 EgcOrderResponse

EgcOrderResponse

Body

application/json

Object

data

Object required

order

EgcOrder required

Operations: Получить заказ ЭПК

400 [DEP] CommonCartResponse

[DEP] CommonCartResponse

Body

application/json

Object

data

Object

cartFull

CartFull

Operations: DEP Получить корзину возврата DEP Редактировать информацию о возвращаемых товарах DEP Установить дату и время у потенциального заказа на возврат DEP Установить получателя корзины возврата DEP Установить способ возврата в магазин DEP Установить способ возврата денежных средств DEP Установить способ возврата курьером DEP Установить способ возврата ПВЗ

400 ReturnCartResponse

Возвращает модель корзины возврата

Body

application/json

Object

data

Object required

returnCart

ReturnCart

Operations: Получить корзину возврата v2 Редактировать информацию о возвращаемых товарах v2 Установить дату и время у потенциального заказа на возврат v2 Установить получателя корзины возврата v2 Установить способ возврата в магазин v2 Установить способ возврата денежных средств v2 Установить способ возврата курьером v2 Установить способ возврата ПВЗ v2

400 ErrorRefundMethodIsNotValid

ErrorRefundMethodIsNotValid

Body

application/json

Object

code

string

Код ошибки

Enumeration:

REFUND_METHOD_IS_NOT_VALID

message

string

Текст ошибки

Example:

Неправильный способ возврата денежных средств

Operations: DEP Установить способ возврата денежных средств Установить способ возврата денежных средств v2

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

Body

application/json

Object

error

string

Enumeration:

REFUND_IS_NOT_AVAILABLE

message

string

Example:

Возврат товаров по этому заказу недоступен

Operations: DEP Получить корзину возврата DEP Редактировать информацию о возвращаемых товарах DEP Установить получателя корзины возврата DEP Установить способ возврата в магазин DEP Установить способ возврата денежных средств Оформить корзину возврата Получить корзину возврата v2 Редактировать информацию о возвращаемых товарах v2 Установить получателя корзины возврата v2 Установить способ возврата в магазин v2 Установить способ возврата денежных средств v2

400 ErrorRefundMethodIsRequired

ErrorRefundMethodIsRequired

Body

application/json

Object

code

string

Код ошибки

Enumeration:

REFUND_METHOD_IS_REQUIRED

message

string

Текст ошибки

Example:

Не выбран способ возврата денежных средств

Operations: Оформить корзину возврата

400 ErrorReturnReasonIsRequired

ErrorReturnReasonIsRequired

Body

application/json

Object

code

string

Код ошибки

Enumeration:

RETURN_REASON_IS_REQUIRED

message

string

Текст ошибки

Example:

Не выбрана причина возврата товара

Operations: Оформить корзину возврата

400 ErrorPotentialOrderIsRequired

ErrorPotentialOrderIsRequired

Body

application/json

Object

code

string

Код ошибки

Enumeration:

POTENTIAL_ORDER_IS_REQUIRED

message

string

Текст ошибки

Example:

Не найден потенциальный заказ

Operations: Оформить корзину возврата Оформить корзину редактирования Оформить корзину услуг

400 DropOffDeliveryPointAvailabilityResponse

DropOffDeliveryPointAvailabilityResponse

Body

application/json

Object

data

Object required

pickpoints

Array of Pickpoint required

Доступные ПВз для возврата товара

Operations: Список ПВЗ с доступностью товара для возврата

400 ReturnHistoryResponse

ReturnHistoryResponse

Body

application/json

Object

data

Object

returns

Array of ReturnItem required

Заказы на возврат

filters

Array of OrderFilter

Фильтрация статусов заказа на возврат

Operations: История возвратов

400 ReturnResponse

ReturnResponse

Body

application/json

Object

data

Object required

returnDetails

ReturnDetails required

Operations: Получить возврат

400 ServiceCartResponse

Возвращает модель корзины услуг

Body

application/json

Object

data

Object required

serviceCart

ServiceCart required

Operations: Изменить флаг использования бонусов корзины услуг Получить корзину услуг Применить промокод в корзине услуг Удалить промокод в корзине услуг Установить дату и время у потенциального заказа корзины услуг Установить получателя корзины услуг Установить способ оказания услуг в сервисном центре Установить способ оплаты у заказа корзины услуг

400 ErrorServiceIsNotFound

ErrorServiceIsNotFound

Body

application/json

Object

error

Object required

code

string required

Enumeration:

SERVICE_ID_IS_NOT_FOUND

string

string required

Example:

"Интересующая вас услуга не найдена"

Operations: Создать корзину услуг Установить способ оказания услуг в сервисном центре

400 ErrorServicesCategoryMismatch

ErrorServicesCategoryMismatch

Body

application/json

Object

error

Object required

code

string required

Enumeration:

SERVICES_CATEGORY_MISMATCH

message

string required

Example:

"Переданные услуги относятся к разным категориям"

Operations: Создать корзину услуг

400 ServiceCenterAvailabilityResponse

ServiceCenterAvailabilityResponse

Body

application/json

Object

data

Object required

list

Array of ServiceCenter required

Operations: Список сервисных центров с доступностью услуг

400 ErrorServiceCenterIsNotAvailable

ErrorServiceCenterIsNotAvailable

Body

application/json

Object

error

Object required

code

string required

Enumeration:

SERVICE_CENTER_IS_NOT_AVAILABLE

message

string required

Example:

Сервисный центр недоступен

Operations: Установить способ оказания услуг в сервисном центре

400 ErrorSomeServicesAreUnavailable

Ошибка, которая возникает, когда одна или несколько услуг не доступны

Body

application/json

Object

error

Object required

code

string required

Enumeration:

SOME_SERVICES_ARE_UNAVAILABLE

message

string required

Example:

Одна или несколько услуг недоступны

Operations: Установить дату и время у потенциального заказа корзины услуг

400 ErrorServicesExceedMaxDuration

Ошибка, которая возникает, когда общая продолжительность выбранных услуг превышает максимально допустимый временной диапазон

Body

application/json

Object

error

Object required

code

string required

Enumeration:

SERVICES_EXCEED_MAX_DURATION

message

string required

Example:

Выбранные услуги превышают максимально допустимый временной интервал

Operations: Оформить корзину услуг Установить дату и время у потенциального заказа корзины услуг

400 ErrorSelectedDateIsUnavailable

Ошибка, которая возникает, когда выбранная пользователем дата стала недоступна

Body

application/json

Object

error

Object required

code

string required

Enumeration:

SELECTED_DATE_IS_UNAVAILABLE

message

string required

Example:

Выбранный день не доступен

Operations: Установить дату и время у потенциального заказа корзины услуг

400 ErrorSelectedTimeIsUnavailable

Ошибка, которая возникает, когда выбранное пользователем время стало недоступно

Body

application/json

Object

error

Object required

code

string required

Enumeration:

SELECTED_TIME_IS_UNAVAILABLE

message

string required

Example:

Выбранное время не доступно

Operations: Установить дату и время у потенциального заказа корзины услуг

400 ErrorTotalCostBelowThreshold

Когда был выбран способ оплаты, у которого минимальная сумма заказа превышает фактическую сумму

Body

application/json

Object

error

Object required

code

string required

Enumeration:

TOTAL_COST_BELOW_THRESHOLD

message

string required

Example:

Сумма заказа меньше минимальной суммы, для которой допустим выбранный способ оплаты

Operations: Установить способ оплаты у заказа корзины услуг

400 ErrorSelectedDateTimeIsUnavailable

Ошибка, которая возникает, когда выбранные пользователем дата и время стали недоступны

Body

application/json

Object

error

Object required

code

string required

Enumeration:

SELECTED_DATETIME_IS_UNAVAILABLE

message

string required

Example:

Дату и время уже заняли — выберите ещё раз

Operations: Оформить корзину услуг

400 ErrorTooManyServicesInBasket

ErrorTooManyServicesInBasket

Body

application/json

Object

error

Object required

code

string required

Код ошибки

Enumeration:

TOO_MANY_SERVICES_IN_BASKET

message

string required

Текст ошибки

Example:

Достигнут лимит. Можно выбрать не более 10 услуг.

Operations: Создать корзину услуг

400 EditCartResponse

Возвращает модель корзины редактирования

Body

application/json

Object

data

Object required

editCart

EditCart required

Operations: Восстановить удаленный товар в корзине редактирования Получить корзину редактирования Скрыть удаленный товар в корзине редактирования Удалить товары из корзины редактирования Установить количество товара в корзине редактирования

400 ErrorEditingIsNotAvailable

ErrorEditingIsNotAvailable

Body

application/json

Object

error

string

EDITING_IS_NOT_AVAILABLE

message

string

Редактирование по заказу недоступно

Operations: Получить корзину редактирования

400 SubmitEditCartResponse

SubmitEditCartResponse

Body

application/json

Object

data

Object required

order

string required

Operations: Оформить корзину редактирования

400 ErrorFieldValidation

ErrorFieldValidation

Body

application/json

Object

error

Object

code

string

Enumeration:

VALIDATION_ERROR

message

string

Значение берется из POST /validation/rules. Response body. validationRules[i]. frontError того правила, которые было нарушено.

Operations: DEP Установить получателя корзины возврата Изменить номер телефона Изменить профиль Удалить профиль Установить получателя корзины cart2 Установить получателя корзины возврата v2

400 ErrorAnonymUser

ErrorAnonymUser

Body

application/json

Object

error

Object

code

string

Enumeration:

USER_IS_ANONYM

message

string

Example:

"Для выполнения этого действия необходимо войти в учетную запись или создать новую."

Operations: DEP Получить адреса доставки НП ID персональных скидок v3 История заказов Активировать вознаграждение Добавить адрес доставки Изменить имя участника семейного счёта Изменить флаг использования бонусов cart2 Изменить флаг использования бонусов корзины услуг История возвратов Конвертировать бонусы Ответить на приглашение в семью Отправить приглашение в семью Оформить заказ ЭПК Подписаться на стрим Получение созданной скидки Получить адреса получения геозоны Получить выбранный ЛВС Получить данные о вознаграждениях Получить доступность адресов получения cart2 Получить информацию о семье Получить признак Я в магазине Получить часто задаваемые вопросы для семейного счёта Список персональных скидок Удалить признак Я в магазине Удалить семейный счёт Удалить участника семейного счёта Установить признак Я в магазине

400 CheckClubProResponse

CheckClubProResponse

Body

application/json

Object

data

Object

profileId

string

Актуальный/измененный идентификатор профиля

usergateUid

string

Актуальный/измененный идентификатор клубной программы

isClubproIdCorrect

boolean required

Признак смены clubproId

Operations: Проверка и обновление clubpro_id

400 CallcenterPhoneResponse

CallcenterPhoneResponse

Body

application/json

Object

data

Object required

phone

string required

Номер телефона КЦ

Example:

8 800 777-777-1

Operations: Получить телефон КЦ

400 SubscriptionResponse

SubscriptionResponse

Body

application/json

Object

data

Object required

infoForClient

string

Строка с сообщением для блока неподтвержденной почты для экрана подписок

Operations: Изменить статус подписки

400 ProfileResponse

ProfileResponse

Body

application/json

Object

data

Object required

profile

Profile required

Operations: Изменить номер телефона Изменить профиль Получить профиль Удалить аватар Установить аватар

400 WelcomeBonusResponse

WelcomeBonusResponse

Body

application/json

Object

data

Object required

bonusAmount

integer required

Сколько бонусов начисляют за запролнение анкеты после регистрации

400 ProfileIdResponse

ProfileIdResponse

Body

application/json

Object

data

Object required

profile

ProfileId required

Operations: Получить id профиля

400 UserGateTokenResponse

UserGateTokenResponse

Body

application/json

Object

data

Object

userGateToken

string

Токен пользователя в UserGate

Operations: Получить usergate token

400 ErrorGateException

Неспецифическая ошибка, возвращаемая из BFF, когда гейт вернул неспецифическую ошибку, которая не требует специальной обработки. Поскольку ошибка может вернуться в любом запросе, привязанный к этой ошибке список методов скорее всего неполный. Где-то сделали привязку, а где-то не стали делать из-за избыточности.

Body

application/json

Object

error

Object

code

string

Enumeration:

GATE_EXCEPTION

message

string

Operations: DEP v1 Восстановить удаленный товар cart2 DEP v1 Изменить чекбоксы товаров в корзине cart2 DEP Получить тип обращения по коду DEP Удалить выбранную услугу товара cart2 v2 Восстановить удаленный товар cart2 v2 Изменить чекбоксы товаров в корзине cart2 v2 Поиск магазинов по номерам v2 Создать обращение v2 Список магазинов v3 Список магазинов Активация скидки Добавить товар в корзину cart2 Избранные магазины Изменить имя участника семейного счёта Изменить номер телефона с разлогином Изменить профиль Копировать пользовательский список избранных товаров Отправить приглашение в семью Отправить спортсменам приглашение Получить баннер по слоту Получить баннеры по слоту Получить данные о товарах стрима Получить информацию о заполненности профиля Получить секции экрана акций Получить список промокодов и бонусов Получить статусы подписок Получить темы и тематики обращения Получить товарный чек Применить промокод cart2 Список магазинов с доступностью товаров cart2 Удалить выбранные услуги cart2

400 ProfileBannersResponse

ProfileBannersResponse

Body

application/json

Object

data

Object required

list

Array of Banner

Operations: DEP v1 Получить баннеры для профиля v2 Получить баннеры для профиля

400 SubscriptionsResponse

SubscriptionsResponse

Body

application/json

Object

data

Object required

groups

Array of Group required

Массив групп подписок

isChangesAvailable

boolean required

Флаг, показывающий доступно ли изменение статуса подписок

subscriptionReceiptAvailable

boolean required

Флаг доступности подписки на эл. чеки

advertisingAgreement

boolean

Признак согласия на рекламную рассылку

Operations: Получить статусы подписок

400 SocialsResponse

SocialsResponse

Body

application/json

Object

data

Object required

list

Array of Social

Operations: Получить список социальных сетей

400 DeliveryAddressesResponse

DeliveryAddressesResponse

Body

application/json

Object

data

Object required

list

Array of DeliveryAdress

Operations: DEP Получить адреса доставки НП Получить адреса получения геозоны

400 ProfileFilledInfoResponse

ProfileFilledInfoResponse

Body

application/json

Object

data

Object

profileFilled

boolean required

Флаг заполненности профиля

descriptionForButton

string

Описание для кнопки заполнения профиля (получаем из статической страницы cmsGate, id=89168901)

Operations: Получить информацию о заполненности профиля

400 ClientLabelsResponse

ClientLabelsResponse

Body

application/json

Object

Data

Object

clientLabels

Array of string

Метки клиента

Operations: Получить метки клиента

400 ErrorAddressAlreadyExists

Ошибка, если в профиле уже есть такой адрес доставки. Независимо есть или нет геозоны

Body

application/json

Object

error

Object required

code

string required

Example:

ADDRESS_ALREADY_EXISTS

message

string required

Example:

Этот адрес уже сохранён

Operations: Добавить адрес доставки

400 ErrorPhoneAlreadyUsed

Ошибка, возвращаемая из BFF, когда при смене номера телефона уже существует профиль с таким номером

Body

application/json

Object

error

Object

code

string

Enumeration:

PHONE_ALREADY_USED

message

string

Operations: Изменить номер телефона Изменить номер телефона с разлогином

400 CheckUserGateUidAndClubProIdResponse

CheckUserGateUidAndClubProIdResponse

Body

application/json

Object

data

Object

userGateUid

string

Старое или новое значение userGateUid

isUserGateUidCorrect

boolean

Признак корректности userGateUid

clubProId

string

Старое или новое значение clubpro_Id

isClubProIdCorrect

boolean

Признак корректности clubproId

Operations: Проверка и обновление userGateUidclubpro_id

400 NoContent

Ответ, когда у бэкэнда в БД не нашлись записи по профайлу

400 ErrorEmailValidation

Бизнес-ошибка валидации email со стороны гейта

Body

application/json

Object

error

Object

code

string required

Enumeration:

INVALID_EMAIL_FORMAT

message

string required

При получении ошибки в методах UserGate с типом BUSINESS_VALIDATION_ERROR или VALIDATION_ERROR, проверять наличие detail == “Invalid data provided”, в этом случае возвращать фронту ошибку “EMAIL_VALIDATION_ERROR” и текст брать из error.violations[0].userMessage

Operations: v2 Создать обращение Изменить профиль Отправить письмо подтверждения на почту Регистрация по смс Установить получателя корзины cart2

400 MetroListResponse

MetroListResponse

Body

application/json

Object

data

Object required

list

Array of CartMetro required

Operations: Получить станции метро

400 GeoSuggestResponse

GeoSuggestResponse

Body

application/json

Object

data

Object

addressSuggestList

Array of addressSuggest

Список подсказок адресов

Operations: Получить подсказки адресов

400 GeoFencesResponse

Массив геозон

Body

application/json

Object

data

Object

geoFences

Array of GeoFence

Массив геозон

locationUpdate

OffsetDateTime

Operations: Актуализировать геозоны

400 CitiesResponse

CitiesResponse

Body

application/json

Object

data

Object required

list

Array of City required

Operations: Поиск городов по названию Популярные города

400 CityResponse

CityResponse

Body

application/json

Object

data

Object required

city

City

location

Location

locationUpdate

OffsetDateTime

locationAvailability

LocationAvailability

Operations: Поиск города по ID Поиск города по IP Поиск города по координатам

400 StreetsResponse

StreetsResponse

Body

application/json

Object

data

Object required

list

Array of Street required

Operations: Поиск улицы

400 HousesResponse

HousesResponse

Body

application/json

Object

data

Object required

list

Array of House required

Operations: Поиск дома

400 AddressResponse

AddressResponse

Body

application/json

Object

data

Object required

location

Location required

locationUpdate

OffsetDateTime required

locationAvailability

LocationAvailability required

address

Address required

Operations: Поиск адреса по координатам Поиск адреса по названию или uri

400 AddressDecodeResponse

AddressDecodeResponse

Body

application/json

Object

data

Object required

address

Address required

Operations: Получить адрес по местоположению

400 ErrorNotSupportedArea

Данное местоположение не поддерживается в приложении

Body

application/json

Object

error

Object

code

string

Enumeration:

NOT_SUPPORTED_AREA

message

string

Enumeration:

Данное местоположение не поддерживается в приложении

400 LocationResponse

LocationResponse

Body

application/json

Object

data

Object required

location

Location required

400 ErrorProccess

ErrorProccess

Body

application/json

Object

error

Object

code

string required

Enumeration:

PROCCESS_ERROR

message

string required

Example:

"Ошибка в результате работы подпроцесса."

Operations: Авторизация по смс Авторизация через соцсети Логаут Обновить токен Полный логаут Регистрация по смс Регистрация через соцсети

400 AuthResponse

AuthResponse

Body

application/json

Object

data

Object required

token

Token

profile

Profile

authEvent

AuthEvent

Operations: Авторизация по смс Авторизация через соцсети Изменить номер телефона с разлогином Логаут Полный логаут Регистрация по смс Регистрация через соцсети Создать анонимного пользователя Удалить профиль

400 IsPhoneExistsResponse

IsPhoneExistsResponse

Body

application/json

Object

data

Object required

isPhoneExists

boolean

Если вдруг в гейте нашелся аккаунт и у него hasPersonalAcсount == fase, то мы считаем что в этом поле придет тоже false. Такой аккаунт потом можно зарегистрировать

Operations: Найти аккаунт по телефону

400 RefreshTokenResponse

RefreshTokenResponse

Body

application/json

Object

data

Object required

token

Token required

Operations: Обновить токен

400 ErrorRefreshToken

Передали невалидный/отозванный рефреш токен

Body

application/json

Object

error

Object

message

string

Enumeration:

Неправильный токен, необходимо повторно авторизоваться

code

string

Enumeration:

WRONG_TOKEN

Operations: Обновить токен

400 IsSocialNetworkExistsResponse

IsSocialNetworkExistsResponse

Body

application/json

Object

data

Object required

isExists

boolean required

true, если по соцсети удается найти профиль и у данного профиля есть логин в виде телефона. Иначе false

phone

Phone

firstName

string

Имя пользователя, полученное из api сбера (актуально только для сценария регистрации через сбер, т.к. для вк имя возвращает sdk)

Operations: Найти аккаунт по социальной сети

400 ErrorAuthByNetworkResponse

Если при попытке авторизации не удается найти аккаунт по заданной соцсети или у аккаунта такого нет номера, то кидается эта ошибка. Текст ошибки придумать самостоятельно

Body

application/json

Object

error

Object required

code

string required

Enumeration:

AUTH_BY_NETWORK_NOT_FOUND

Operations: Авторизация через соцсети

400 GenerateParametersResponse

GenerateParametersResponse

Body

application/json

Object

data

Object required

state

string required

Сгенерированное значение для предотвращения подделки межсайтовых запросов

nonce

string required

Сгенерированное значение для предотвращения атак повторения

Operations: Сгенерировать параметры для интеграции со СберID

400 ExchangeSilentTokenResponse

ExchangeSilentTokenResponse

Body

application/json

Object

data

Object required

accessToken

string required

Access token пользователя VK ID

userId

integer required

тип данных Long, user_id пользователя VK

Operations: DEP Обменять silent token vk

400 SberTokenResponse

SberTokenResponse

Body

application/json

Object

data

Object required

accessToken

string required

Access_token, полученный из Сбера

Example:

f213a511-58d7-4e7c-88b3-a6de380c81da

Operations: Получить token Сбер

400 ErrorExchangeSilentToken

Ошибка обмена silent token на access token при регистрации через VK ID

Body

application/json

Object

error

Object

message

string

Enumeration:

Ошибка токена, необходимо повторно авторизоваться

code

string

Enumeration:

SILENT_TOKEN_EXCHANGE_ERROR

Operations: DEP Обменять silent token vk

400 ErrorSberToken

Ошибка получения кода доступа в Сбер API

Body

application/json

Object

error

Object

code

string required

Enumeration:

SBER_TOKEN_ERROR

message

string required

Enumeration:

Ошибка получения токена, необходимо повторно авторизоваться

Operations: Получить token Сбер

400 ErrorAuth

ErrorAuth

Body

application/json

Object

error

Object

code

string required

Enumeration:

AUTH_ERROR

message

string required

Example:

"Что-то пошло не так. Попробуйте позже."

Operations: Авторизация по смс Авторизация через соцсети Регистрация по смс Регистрация через соцсети

400 ErrorIncorrectUserType

Ошибка, которая возвращается, если авторизоваться пытается уже авторизованный пользователь.

Body

application/json

Object

error

Object

code

string required

Enumeration:

INCORRECT_USER_TYPE

message

string required

Example:

"Не удалось выполнить авторизацию, так как данный пользователь уже авторизован."

Operations: Авторизация по смс Авторизация через соцсети Найти аккаунт по социальной сети Найти аккаунт по телефону Регистрация по смс Регистрация через соцсети

400 ErrorLogout

ErrorLogout

Body

application/json

Object

error

Object

code

string required

Example:

LOGOUT_ERROR

message

string required

Example:

"Что-то пошло не так. Повторите действие позже"

Operations: Логаут Полный логаут

400 PromoCodesResponse

PromoCodesResponse

Body

application/json

Object

data

Object required

list

Array of Promocode required

Operations: DEP Список всех промокодов пользователя

400 PromoResponse

PromoResponse

Body

application/json

Object

data

Object required

list

Array of Promo

Operations: Получить список промокодов и бонусов

400 AppealTypeListResponse

AppealTypeListResponse

Body

application/json

Object

data

Object required

list

AppealTypeItem required

Operations: DEP Получить типы обращений

400 AppealTypeResponse

AppealTypeResponse

Body

application/json

Object

data

Object required

appealType

AppealType required

Operations: DEP Получить тип обращения по коду

400 AppealThematicListResponse

AppealThematicListResponse

Body

application/json

Object

data

Object

appeals

Array of Appeals required

Массив списка типов обращений

requiredFields

RequiredFields required

Operations: Получить темы и тематики обращения

400 AppealOrderHistoryResponse

AppealOrderHistoryResponse

Body

application/json

Object

data

Object

orders

Array of AppealOrdersHistory

Массив заказов

Operations: Получить историю покупок

400 ErrorFieldValidationPhoneGate

Не прошла валидация телефона на гейте

Body

application/json

Object

error

Object

code

string

Enumeration:

VALIDATION_ERROR

message

string

Значение берется из POST /validation/rules. Response body. validationRules[i]. frontError того правила, которые было нарушено.

Operations: DEP Создать обращение Отправить заявку ГЛЦ

400 ErrorAppealTypeNotFound

ErrorAppealTypeNotFound

Body

application/json

Object

error

Object

code

string required

Enumeration:

TYPE_NOT_FOUND

message

string required

Operations: DEP Получить тип обращения по коду

400 AppealResponse

AppealResponse

Body

application/json

Object

data

Object

appealId

string required

Идентификатор созданного обращения

Operations: v2 Создать обращение

400 BonusHistoryResponse

BonusHistoryResponse

Body

application/json

Object

data

Object required

list

Array of BonusHistoryItem

familyMemberStatus

familyStatus required

Operations: История бонусных операций

400 BonusShortInfoResponse

BonusShortInfoResponse

Body

application/json

Object

data

Object required

info

BonusBalance required

Operations: Краткая информация о бонусной программе

400 BonusProgressResponse

BonusProgressResponse

Body

application/json

Object

data

Object required

progress

BonusProgramProgress required

Operations: Данные о прогрессе в бонусной программе

400 BonusDetailsByTypeResponse

BonusDetailsByTypeResponse

Body

application/json

Object

data

Object required

list

Array of BonusInfoItem required

Operations: Детализация бонусов по типу

400 BonusDetailsResponse

BonusDetailsResponse

Body

application/json

Object

data

Object required

list

Array of BonusDetails required

Operations: Условия бонусных акций

400 BonusQRInfoResponse

BonusQRInfoResponse

Body

application/json

Object

data

Object required

bonusLevel

BonusLevel

clubCard

ClubCardNumber

Operations: Данные об уровне программы и QRкоде

400 [DEP] BonusDetailsResponse

[DEP] BonusDetailsResponse

Body

application/json

Object

data

Object

list

BonusBalanceItem

Operations: DEP Детализация бонусов по дням

400 [DEP] BonusCouponsResponse

Массив бонусных акций

Body

application/json

Object

data

Object required

list

Array of BonusCoupon required

Operations: DEP Получить доступные к активации бонусы

400 ErrorMetroIdIsNotValid

ErrorMetroIdIsNotValid

Body

application/json

Object

error

Object

code

string

Enumeration:

METRO_ID_IS_NOT_VALID

message

string

Example:

"Выбранная станция метро не относится к выбранному городу."

Operations: Добавить адрес доставки Изменить адрес доставки Редактировать адрес доставки потенциальных заказов cart2

400 GetMessagesResponse

GetMessagesResponse

Body

application/json

Object

data

Object required

list

Array of Message required

hasMore

boolean

Operations: Получить уведомления

400 HasUnreadMessagesResponse

HasUnreadMessagesResponse

Body

application/json

Object

data

Object required

hasUnread

boolean required

Флаг наличия непрочитанных сообщений во всех разделах, кроме онлайн-чата

unreadMessagesAmount

integer required

Количество непрочитанных сообщений во всех разделах, кроме онлайн-чата

Example:

chatBotUnreadMessagesAmount

integer

Количество непрочитанных сообщений в онлайн-чате

Example:

Operations: Проверка наличия непрочитанных сообщений

400 [DEP] NotificationTabsResponse

DEPRECATED, можно удалить, когда будет выпилен ФТ newMessageCenterEnabled

Body

application/json

Object

data

Object required

list

Array of NotificationTab required

Массив вкладок со слотами для запроса уведомлений

Operations: DEP Получить вкладки уведомлений

400 NotificationsSectionsResponse

NotificationsSectionsResponse

Body

application/json

Object

data

Object

slots

Array of Slot required

Список разделов

Operations: Получить разделы с уведомлениями

400 TrainerInfoResponse

TrainerInfoResponse

Body

application/json

Object

data

Object

trainerId

string required

Идентификатор тренера

firstName

string required

Имя

lastName

string required

Фамилия

middleName

string

Отчество

status

TrainerStatus required

documentUrl

string required

URL документа статической страницы для отображения контента в блоке “Преимущества”

Example:

cardpro/advantages/trainer

Operations: Получить информацию о статусе тренера

400 SportsmanListResponse

SportsmanListResponse

Body

application/json

Object

sportsmanList

Array of Sportsman

Данные спортсменов

sportsmanMaxAmount

integer required

Максимальное количество спортсменов тренера

Operations: Получить список спортсменов тренера

400 SportsmanInvitationResponse

SportsmanInvitationResponse

Body

application/json

Object

data

Object

sportsmanLink

string required

Ссылка для приглашения спортсмена

Example:

https://sportmaster.onelink.me/imJi/refpro?token=1123111221

errorText

string

Текст ошибки, если спортсмена не удалось добавить

Operations: Отправить спортсменам приглашение

400 FullLinkResponse

FullLinkResponse

Body

application/json

Object

data

Object

fullLink

string required

Полная ссылка для редиректа

Example:

https://www.sportmaster.ru/pro-invitation/?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnZpdGF0aW9uQ29kZSI6IjEwMDAwMDAwNDc3NDY3MzgwNiIsIm1vYmlsZVBob25lIjoiNzkxNTI1ODk4MTUiLCJ0eXBlIjoxfQ.buoRuVT42NBISBSwSlZY6PexzMyM3TUTHfzNiWZljRY

Operations: Расшифровать короткую ссылку

400 UploadMirResponse

UploadMirResponse

Body

application/json

Object

data

Object

docUrl

string required

Единая ссылка на документы тренера из МИР

Example:

https://mir-cd-uat.web.local/ea/faces/index?t oken=1EFB1C984511C286B2452598E097EA4DA2EF80B916A24909F39BA91E8F CEF5536D0E2CF7790C8A4A1A34C148971A8060FF8B45BC43347A960DB456366C76C99B

filesUrl

Array of FileUrl required

Массив документов

vrowid

string required

Идентификатор загруженных документов

Example:

1484681

Operations: Отправить документы тренера в МИР

400 ValidateResponse

ValidateResponse

Body

application/json

Object

data

Object

isValid

boolean required

Признак валидности кода приглашения Спортсмена

Operations: Валидация кода приглашения

400 TrainerSportKindResponse

TrainerSportKindResponse

Body

application/json

Object

data

Object

trainerSportKindName

string

Наименование вида спорта Тренера

Example:

Футбол

trainerSportKindId

string

Идентификатор вида спорта тренера

Example:

14920299

Operations: Получить вид спорта тренера

400 ErrorInvitationNotExist

Код приглашения некорректный

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

INVITATION_NOT_EXIST

message

string

Текст ошибки

Example:

"Приглашения не существует"

Operations: Изменить профиль Регистрация по смс

400 ErrorLinkIsInvalid

Ссылка невалидна

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

LINK_IS_INVALID

message

string

Текст ошибки

Example:

"Ссылка недействительна"

Operations: Расшифровать короткую ссылку

400 SportKindsResponse

SportKindsResponse

Body

application/json

Object

data

Object

sportKinds

Array of SportKinds

Массив видов спорта

Operations: Получить виды спорта Получить индивидуальные виды спорта

400 SportsmanInfoResponse

SportsmanInfoResponse

Body

application/json

Object

data

Object

firstName

string

Имя спортсмена

lastName

string

Фамилия спортсмена

middleName

string

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

sportKindName

string

Наименование вида спорта

Example:

Футбол

sportKindProductsUrl

string

Ссылка на товары

Example:

/catalog/vidy_sporta_/futbol/

documentUrl

string required

Ссылка на преимущества

Example:

cardpro/advantages/sportsman

Operations: Получить информацию о спортсмене

400 ErrorNotAvailableForEmployee

Возвращается, когда пользователь является сотрудником и пытается зарегистрироваться в КП как индивидуальный спортсмен

Body

application/json

Object

error

Object

code

string

Enumeration:

NOT_AVAILABLE_FOR_EMPLOYEE

message

string

Example:

"Вы уже участвуете в программе как сотрудник"

Operations: Зарегистрировать индивидуального спортсмена

400 ErrorNotAvailableForFamilyMember

Возвращается, когда пользователь входит в семью и пытается зарегистрироваться в КП как индивидуальный спортсмен

Body

application/json

Object

error

Object

code

string

Enumeration:

NOT_AVAILABLE_FOR_FAMILY_MEMBER

message

string

Example:

"Ошибка. Вы участник семейного счёта"

Operations: Зарегистрировать индивидуального спортсмена

400 ErrorNotAvailableForIndividualSportsman

Возвращается, когда пользователь является индивидуальным спортсменом и пытается зарегистрироваться в КП как индивидуальный спортсмен

Body

application/json

Object

error

Object

code

string

Enumeration:

NOT_AVAILABLE_FOR_INDIVIDUAL_SPORTSMAN

message

string

Example:

"Вы уже участвуете в программе как спортсмен"

Operations: Зарегистрировать индивидуального спортсмена

400 ErrorNotAvailableForSportsman

Возвращается, когда пользователь является тренерским спортсменом и пытается зарегистрироваться в КП как индивидуальный спортсмен

Body

application/json

Object

error

Object

code

string

Enumeration:

NOT_AVAILABLE_FOR_SPORTSMAN

message

string

Example:

Вы уже участвуете в программе как спортсмен

Operations: Зарегистрировать индивидуального спортсмена

400 ErrorNotAvailableForTrainer

Возвращается, когда пользователь является тренером и пытается зарегистрироваться в КП как индивидуальный спортсмен

Body

application/json

Object

error

Object

code

string

Enumeration:

NOT_AVAILABLE_FOR_TRAINER

message

string

Example:

"Вы уже участвуете в программе как тренер"

Operations: Зарегистрировать индивидуального спортсмена

400 ErrorLimitForSportsmanExceeded

Возвращается, когда для спортсмена исчерпан лимит смены вида спорта

Body

application/json

Object

error

Object

code

string

Enumeration:

LIMIT_FOR_SPORTSMAN_EXCEEDED

message

string

Example:

"Ошибка регистрации. Вид спорта можно менять только 1 раз в год"

Operations: Изменить профиль Регистрация по смс Регистрация через соцсети

400 NewChatMessagesResponse

NewChatMessagesResponse

Body

application/json

Object

data

Object required

count

integer required

Количество новых сообщений чата

Operations: Получить количество непрочитанных сообщений чата

400 ChatWidgetPropsResponse

ChatWidgetPropsResponse

Body

application/json

Object

data

Object required

config

string

Параметры конфига. jSON объект в строковом формате

Operations: DEP v1 Получить данные для старта чата v2 Получить данные для старта чата

400 LastChatMessageResponse

LastChatMessageResponse

Body

application/json

Object

data

Object

unreadMessagesCount

integer required

Количество новых сообщений чата

Example:

lastMessage

string

Текст последнего сообщения

Example:

"Текст сообщения"

lastMessageDate

string

Дата/время последнего сообщения

Example:

"2023-07-18T09:22:37.087Z"

Operations: Получить последнее сообщение чата

400 SportKindResponse

SportKindResponse

Body

application/json

Object

data

Object

favouriteSportKind

FavoriteSportKinds

Operations: Получить выбранный ЛВС

400 ErrorSportKindNotFound

Ошибка, если Пользователь не выбирал ЛВС

Body

application/json

Object

error

Object

code

string

Enumeration:

SPORT_KIND_NOT_FOUND

message

string

Example:

"Вид спорта не был выбран"

400 ErrorSelectSportIsNotAvailable

Ошибка, если сегодня последний месяц и Пользователь еще не выбирал вид спорта (выбрать уже нельзя)

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

SELECT_SPORT_IS_NOT_AVAILABLE

message

string

Текст ошибки

Example:

"Нельзя выбрать вид спорта"

Operations: Получить выбранный ЛВС

400 SportKindListResponse

SportKindListResponse

Body

application/json

Object

data

Object

favouriteSportKinds

Array of FavoriteSportKinds required

Список видов спорта

documentConditionsUrl

string required

url для контента с условиями акции

Enumeration:

/conditions_fav_sport

successFavSportContent

string

Текст для экрана успеха выбора ЛВС

Operations: Получить список ЛВС

400 PublicationSportKindResponse

PublicationSportKindResponse

Body

application/json

Object

data

Object

contentSportKind

publicationSportKind required

Operations: Получить контент по ЛВС

400 RewardsResponse

RewardsResponse

Body

application/json

Object

data

Object required

bonusLevel

BonusLevel required

bonusDetails

Array of BonusAmountDetail

Детализация по имеющимся бонусам

currencyBalance

ProfileCurrencies required

list

Array of Reward required

Список вознаграждений

aboutRewards

string required

url информации о вознаграждениях

promotionRules

string required

url правил акции

rewardBanner

RewardBanner

Operations: Получить данные о вознаграждениях

400 ErrorRewardActivation

ErrorRewardActivation

Body

application/json

Object

error

Object required

code

string required

Enumeration:

REWARD_ACTIVATION_ERROR

message

string required

Ошибка активации. Уже работаем над исправлением

Operations: Активировать вознаграждение

400 ErrorUserType

ErrorUserType

Body

application/json

Object

error

Object required

code

string required

Enumeration:

USER_TYPE_ACCESS_ERROR

message

string required

Example:

"Недоступно для вашей клубной программы"

Operations: Получить данные о вознаграждениях

400 ErrorRewardAlreadyActivated

ErrorRewardAlreadyActivated

Body

application/json

Object

error

Object required

code

string required

Enumeration:

REWARD_ALREADY_ACTIVATED

message

string required

Предложение уже было открыто

Operations: Активировать вознаграждение

400 ErrorRewardNotEnoughPoints

ErrorRewardNotEnoughPoints

Body

application/json

Object

error

Object required

code

string required

Enumeration:

REWARD_NOT_ENOUGH_POINTS

message

string required

Недостаточно баллов для открытия предложения

Operations: Активировать вознаграждение

400 ClientInterestsResponse

ClientInterestsResponse

Body

application/json

Object

data

Object required

clientInterests

client-interests required

clientSurvey

ClientSurvey required

Operations: Получить интересы

400 ReferralProgramResponse

ReferralProgramResponse

Body

application/json

Object

data

Object

contentReferralProgram

ContentRefProg

Operations: Получить контент для Пригласи друга

400 PersonalDiscountsResponse

PersonalDiscountsResponse

Body

application/json

Object

data

Object required

list

Array of PersonalDiscount required

personalDiscountsInfo

string

Ссылка на информацию об акции “Мои скидки”

Operations: Получение созданной скидки Список персональных скидок

400 PersonalDiscountsBaseResponse

PersonalDiscountsBaseResponse

Body

application/json

Object

data

Object required

list

Array of PersonalDiscountBase required

Operations: ID персональных скидок

400 PersonalDiscountActivationResponse

PersonalDiscountActivationResponse

Body

application/json

Object

badges

Array of BadgeParameters

Массив бейджей

buttonType

string

Тип кнопки

Enumeration:

CARD

Operations: Активация скидки

400 PersonalDiscountStatusResponse

PersonalDiscountStatusResponse

Body

application/json

Object

interestsRequired

boolean required

Требуется заполнение интересов

interestsFilled

boolean required

Интересы заполнены

shopNumber

string

Номер магазина

Operations: Проверка возможности создания скидки

400 PersonalDiscountTaskResponse

PersonalDiscountTaskResponse

Body

application/json

Object

discountCreationTaskId

string required

ID заявки

waitingTime

Duration required

message

string required

Сообщение

Operations: Запрос на создание скидки

400 ErrorCheckingDiscount

ErrorCheckingDiscount

Body

application/json

Object

error

Object

title

string required

Заголовок

message

string

Текст ошибки

buttonText

string required

Текст кнопки

buttonUrl

string required

Диплинк для кнопки

code

string required

Код ошибки

Enumeration:

PERSONAL_DISCOUNT_NOT_AVAILABLE_FOR_CREATION

PERSONAL_DISCOUNT_SCRIPT_NOT_FOUND

PERSONAL_DISCOUNT_IS_CREATING

PERSONAL_DISCOUNT_ALREADY_CREATED

PERSONAL_DISCOUNT_NOT_AVAILABLE_IN_THIS_PERIOD

PERSONAL_DISCOUNT_NOT_AVAILABLE

Operations: Проверка возможности создания скидки

400 CheckingCreationDiscountResponse

CheckingCreationDiscountResponse

Body

application/json

Object

data

Object required

discountCreationTaskId

string

ID заявки

400 FamilyResponse

FamilyResponse

Body

application/json

Object

data

Object

family

Family

bonusInfo

Информация о клубной программе и бонусах пользователя required

advertising

boolean required

Согласие подписки на рекламную рассылку

subscriptionReceiptAvailable

boolean required

Флаг доступности подписки на эл. чеки

Operations: Изменить имя участника семейного счёта Ответить на приглашение в семью Получить информацию о семье Удалить семейный счёт Удалить участника семейного счёта

400 FamilyQuestionsResponse

FamilyQuestionsResponse

Body

application/json

Object

data

Object

familyQuestions

Array of FamilyQuestion required

Информация о частозадаваемых вопросах семейного счёта

Operations: Получить часто задаваемые вопросы для семейного счёта

400 InviteFamilyMemberResponse

InviteFamilyMemberResponse

Body

application/json

Object

data

Object

isRegisteredMember

boolean required

Признак зарегистрированности участника в Sportmaster

Example:

true

shareLink

string required

Значение ссылки onelink

Example:

https://sportmaster.onelink.me/imJi

Operations: Отправить приглашение в семью

400 ErrorAnotherBonusProgram

ErrorAnotherBonusProgram

Body

application/json

Object

error

Object required

code

string required

Enumeration:

ERROR_ANOTHER_BONUS_PROGRAM

message

string required

Example:

Участник состоит в другой бонусной программе — его нельзя пригласить

Operations: Отправить приглашение в семью

400 ErrorFamilyIsExists

ErrorFamilyIsExists

Body

application/json

Object

error

Object required

code

string required

Enumeration:

FAMILY_IS_EXISTS

message

string required

Example:

Участник уже добавлен в другой семейный счёт

Operations: Отправить приглашение в семью

400 ErrorLimitFamilyInvitationsExceeded

Ошибка при превышении лимита на отправку приглашений в семейный аккаунт

Body

application/json

Object

error

Object

code

string required

Enumeration:

LIMIT_FAMILY_INVITATIONS_EXCEEDED

message

string required

Example:

Превышен лимит на отправку приглашений

Operations: Отправить приглашение в семью

400 ErrorLimitFamilyJoinsExceeded

Ошибка при превышении лимита на вступления в семейный счёт у пользователя

Body

application/json

Object

error

Object required

code

string required

Enumeration:

LIMIT_FAMILY_JOINS_EXCEEDED

message

string required

Example:

Вы израсходовали лимит на вступления: 2 за 90 дней

Operations: Ответить на приглашение в семью

400 BenefitsResponse

BenefitsResponse

Body

application/json

Object

data

Object required

list

Array of BenefitSection required

Operations: Получить секции экрана акций

400 ShopsResponse

ShopsResponse

Body

application/json

Object

data

Object required

list

Array of BaseShop

city

GeoCity

Operations: v2 Список магазинов

400 ShopsResponse2

ShopsResponse2

Body

application/json

Object

data

Object required

list

Array of BaseShop

Operations: v2 Поиск магазинов по номерам v3 Список магазинов

400 ShopResponse

ShopResponse

Body

application/json

Object

data

Object required

shop

Shop required

Operations: Детальная информация о магазине

400 FavouriteShopsResponse

FavouriteShopsResponse

Body

application/json

Object

data

Object required

list

Array of BaseShop required

Operations: Избранные магазины

400 FavouriteShopNumbersResponse

FavouriteShopNumbersResponse

Body

application/json

Object

data

Object required

list

Array of FavouriteShop required

Operations: Номера избранных магазинов

400 ErrorShopNotFound

ErrorShopNotFound

Body

application/json

Object

error

Object

code

string

Enumeration:

SHOP_NOT_FOUND

message

string

Example:

"Не найден магазин с соответствующим номером"

Operations: v2 Поиск магазинов по номерам Распределить товары на самовывоз из текущего магазина

400 InStoreMenuResponse

InStoreMenuResponse

Body

application/json

Object

data

Object required

list

Array of InStoreMenuItem required

Список разделов меню

Operations: Получить меню Я в магазине

400 InStoreShopInfoResponse

InStoreShopInfoResponse

Body

application/json

Object

data

Object required

shopInfo

InStoreShopInfo

Operations: Определить магазин пользователя Получить признак Я в магазине

400 CatalogMenuResponse

CatalogMenuResponse

Body

application/json

Object

data

Object required

sections

Array of CatalogMenuItem required

catalog

Array of CatalogMenuItem required

Operations: Получить меню каталога

400 SubcategoriesResponse

SubcategoriesResponse

Body

application/json

Object

data

Object required

list

Array of Category required

список дочерних категорий

current

Category required

Operations: Виды спорта Дочерние категории

400 PopularSportsResponse

PopularSportsResponse

Body

application/json

Object

data

Object required

list

Array of PopularSport required

Operations: Популярные виды спорта

400 BrandsResponse

BrandsResponse

Body

application/json

Object

data

Object required

list

Array of Brand required

Operations: Бренды Популярные бренды

400 CatalogBannersResponse

Баннеры в модуле каталог

Body

application/json

Object

data

Object required

list

Array of Banner required

Список баннеров

Operations: Получить баннеры каталога

400 AdBannerResponse

AdBannerResponse

Body

application/json

Object

data

Object required

adBanner

AdBannerCatalog

Operations: Получить рекламный баннер

400 ContentPageResponse

ContentPageResponse

Body

application/json

Object

data

Object

caption

string

Заголовок контентной страницы

list

Array

Список сущностей для CLP

Object

subtype

string required

Тип сущности

Enumeration:

recommendations

registries

banners

html

lookzones

productSelection

content

One of required

Контент для сущности

RecommendationProductsGroup

Registries

Banners

Html

Lookzones

Operations: Получить контентную страницу

400 UserPhotosResponse

UserPhotosResponse

Body

application/json

Object

data

Object required

list

Array of ImageUri required

Массив может быть пустым, если у товара отсутствуют фотографии из отзывов покупателей.

Operations: Получить фотографии покупателей

400 ProductsResponse

ProductsResponse

Body

application/json

Object

data

Object required

list

Array of ProductColorModel required

hasMore

boolean required

Body

application/json

Object

data

Object required

lite

Array of ProductColorModel

full

Array of ProductColorFullModel

Operations: Поиск товаров по id

400 ProductsBySkuIdResponse

ProductsBySkuIdResponse

Body

application/json

Object

data

Object

list

Array of ColorModelSizes

Массив ЦМ (супер light)

Operations: Получить товары по skuId

400 SearchAutocompleteResponse

SearchAutocompleteResponse

Body

application/json

Object

data

Object required

query

string required

Текущий поисковый запрос

correction

string

Исправленный поисковый запрос

hints

Array of string required

Список подсказок

taps

Array required

Object

tap

string required

relatedSearch

string required

products

Array of ProductColorModel required

Body

application/json

Object

data

Object required

list

Array of RecentProductColorModel required

Operations: История просмотров товаров

400 RecommendationResponse

RecommendationResponse

Body

application/json

Object

data

Object required

list

Array of RecommendationGroup required

Список групп рекомендаций

Operations: Индивидуальные рекомендации по товарам

400 RecommendationProductsResponse

RecommendationProductsResponse

Body

application/json

Object

data

Object required

list

Array of RecommendationProductsGroup required

Список рекомендаций

Operations: Рекомендации товара

400 InfiniteRecommendationProductsResponse

InfiniteRecommendationProductsResponse

Body

application/json

Object

data

Object required

item

RecommendationProductsGroup required

hasMore

boolean required

Есть ли еще страницы

Operations: DEP v1 Бесконечная подборка рекомендаций v2 Бесконечная подборка рекомендаций

400 ProductColorModelResponse

ProductColorModelResponse

Body

application/json

Object

data

Object required

product

ProductColorModel required

details

FullProductColorModel required

Operations: Детали товара

400 ProductSetResponse

Комплект

Body

application/json

Object

data

Object required

list

Array of ProductColorModel required

Товары комплекта

Operations: Получить комплект

400 PersonalPriceResponse

PersonalPriceResponse

Body

application/json

Object

data

Object

personalPrice

PersonalPrice

Operations: Персональная цена

400 ProductSizeTableResponse

ProductSizeTableResponse

Body

application/json

Object

data

Object required

size

ProductSizeTable required

sizeTable

NewProductSizeTable

classifyingAttributes

Array of ProductClassifyingAttrs

Характеристики товара (Классифицирующие атрибуты)

Operations: Таблица размеров товара

400 ProductSizeTableError

Ошибка, которую необходимо возвращать, если у запрашиваемой цветомодели отсутствует размерная сетка в формте HTML таблицы.

Body

application/json

Object

error

Object

code

string

Enumeration:

SIZE_TABLE_IS_NOT_EXISTS

message

string

Example:

Таблица размеров данного товара недоступна в данный момент.

Operations: Таблица размеров товара

400 ProductColorModelIsNotApproved

Ошибка, которую необходимо вернуть в случае, если гейт не нашел товар и вернул пустой ответ

Body

application/json

Object

error

Object

code

string

Enumeration:

COLORMODEL_IS_NOT_APPROVED

message

string

Данный товар недоступен для просмотра.

Operations: Детали товара

400 InvalidSlotsError

InvalidSlotsError

Body

application/json

Object

error

Object

code

string required

Код ошибки

Enumeration:

INVALID_SLOTS

message

string required

Сообщение ошибки

Example:

"Массив слотов рекомендаций невалидный или пустой."

Operations: Индивидуальные рекомендации по товарам Рекомендации товара

400 ProductSetsResponse

ProductSetsResponse

Body

application/json

Object

data

Object required

list

Array of ProductSet required

Комплекты

Operations: Получить комплекты товара

400 CompareListTabResponse

CompareListTabResponse

Body

application/json

Object

data

Object

list

Array of CompareProduct

tabList

Array of compareTab

Массив табов

Operations: Получить товары добавленные в список сравнения

400 ProductMarkersResponse

ProductMarkersResponse

Body

application/json

Object

data

Object required

markers

Array of ProductColorModelBadge

Плашки товара

richMarker

ProductColorModelBadge

Operations: DRAFT Получить плашки товара

400 ProductAccessoriesResponse

Аксессуары

Body

application/json

Object

data

Object required

list

Array of ProductColorModel

Список аксессуаров

Operations: Получить аксессуары

400 ProductAccessoriesCategoriesResponse

Категории аксессуаров

Body

application/json

Object

data

Object required

list

Array of AccessoriesCategory

Список категорий

Operations: Получить категории аксессуаров

400 DeliveryOptionError

Ошибка выбранного способа получения

Body

application/json

Object

error

Object

code

string

Enumeration:

WRONG_DELIVERY_OPTION

message

string

Enumeration:

Некорректный способ получения

Operations: Получить аксессуары Получить категории аксессуаров Проверка доступности SKU

400 PersonalPriceListResponse

PersonalPriceListResponse

Body

application/json

Object

data

Object

list

Array of ProductPersonalPrice required

Список персональных цен

Operations: DEP Персональная цена для списка

400 BnplDetailsResponse

BnplDetailsResponse

Body

application/json

Object

data

Object required

paymentInfo

PaymentInfo

Operations: Получить данные о BNPL

400 ReviewSummaryResponse

Общие данные по отзывам о товаре

Body

application/json

Object

data

Object required

summary

ReviewSummary required

isReviewAllowed

boolean required

Статус возможности пользователя оставить отзыв на товар

Operations: DEP Общие данные об отзывах по товару

400 ReviewsResponse

Виды сортировок берутся из параметра http://product-gate.productgateusrtst.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=../productGateApi.json#/Отзывы/getReviews

Body

application/json

Object

data

Object required

list

Array of Review required

hasMore

boolean required

sorting

Array of Sort required

Какие есть сортировки у этого списка. С признаком, по какой сейчас сортируется

Operations: DEP Отзывы по товару

400 ReviewsListResponse

ReviewsListResponse

Body

application/json

Object

Body

application/json

Object

data

Object required

summary

ReviewSummary required

promotedReview

Review

sizeMatch

SizeMatch

reviewHighlights

ImportantQuestion

[DEP] isReviewAllowed

boolean required

[DEP 4.75] Статус возможности пользователя оставить отзыв

Operations: Популярный отзыв товара

400 PhotoUploadResponse

PhotoUploadResponse

Body

application/json

Object

data

Object required

photoId

string required

Operations: DEP Загрузить фото вопроса Загрузить фото отзыва

400 ReviewSchemaResponse

ReviewSchemaResponse

Body

application/json

Object

data

Object

ratingDetails

Array of ProductRaitingDetailParam required

authorDetails

Array of AuthorRatingDetailParam required

isBodyRequired

boolean required

isProsRequired

boolean required

isConsRequired

boolean required

dimensions

Dimensions

Operations: Получить схему отзыва

400 ErrorUserContentIdIsEmpty

ErrorUserContentIdIsEmpty

Body

application/json

Object

error

Object

code

string

Enumeration:

USER_CONTENT_ID_IS_EMPTY

message

string

Example:

"Для выполнения запроса необходимо передать идентификатор отзыва или вопроса."

Operations: Пожаловаться на вопрос Пожаловаться на отзыв

400 QuestionsResponse

QuestionsResponse

Body

application/json

Object

data

Object required

list

Array of Question required

Массив может быть пустым.

hasMore

boolean required

sorting

Array of Sort required

Какие есть сортировки у этого списка. С признаком, по какой сейчас сортируется

total

integer required

Сколько всего вопросов

Operations: Список вопросов к товару

400 ErrorUserContentIsNotFound

ErrorUserContentIsNotFound

Body

application/json

Object

error

Object

code

string

Example:

USER_CONTENT_ID_IS_NOT_FOUND

message

string

Example:

"Для выполнения запроса необходимо передать корректный идентификатор отзыва или вопроса "

Operations: Пожаловаться на вопрос Пожаловаться на отзыв

400 ErrorAplaut

ErrorAplaut

Body

application/json

Object

error

Object

code

string

Enumeration:

APLAUT_ERROR

message

string

Example:

Невозможно отправить вопрос о товаре, попробуйте позже или проверьте вводимые данные.

400 LightProductAvailabilityResponse

LightProductAvailabilityResponse

Body

application/json

Object

data

Object required

productAvailability

Array of SkuAvailabilityLight required

Operations: v4 Доступность товара

400 ProductsDeliveryResponse

ProductsDeliveryResponse

Body

application/json

Object

data

Object required

productsDelivery

Array of SkuAvailabilityDelivery required

Operations: Доступность доставки товара

400 ProductAvailabilitiesResponse

ProductAvailabilitiesResponse

Body

application/json

Object

data

Object required

productAvailability

ProductAvailability required

Operations: DEP v2 Доступность товара v3 Доступность товара

400 SkuAvailabilityInShopResponse

SkuAvailabilityInShopResponse

Body

application/json

Object

data

Object required

list

Array of SkuAvailabilityInShop required

Operations: Доступность SKU в магазинах

400 SkuAvailabilityCheckResponse

SkuAvailabilityCheckResponse

Body

application/json

Object

data

Object required

list

Array of SkuAvailabilityCheck required

Operations: Проверка доступности SKU

400 FavouriteListCreateResponse

FavouriteListCreateResponse

Body

application/json

Object

data

Object

favouriteListId

string required

Идентификатор списка

Example:

150318

Operations: Копировать пользовательский список избранных товаров Создание списка избранных товаров

400 ErrorFavouriteListAlreadyExist

ErrorFavouriteListAlreadyExist

Body

application/json

Object

error

Object

code

string

Enumeration:

LIST_ALREADY_EXIST

message

string

Example:

Список с таким названием уже существует

Operations: Копировать пользовательский список избранных товаров Создание списка избранных товаров

400 FavouriteListsResponse

FavouriteListsResponse

Body

application/json

Object

data

Object required

list

Array of FavouriteList required

Массив пользовательских списков избранных товаров. Может быть пустым

Operations: Получить пользовательские списки избранных товаров

400 ErrorFavouriteListName

ErrorFavouriteListName

Body

application/json

Object

error

Object required

code

string

Enumeration:

LIST_NAME_VALIDATION_ERROR

message

string

Example:

В названии списка должно быть не менее 1 и не более 40 символов

Operations: Копировать пользовательский список избранных товаров Создание списка избранных товаров

400 ErrorEmptyList

ErrorEmptyList

Body

application/json

Object

error

Object

code

string required

Enumeration:

EMPTY_LIST_ERROR

message

string required

Example:

Список избранного пуст

Operations: Копировать пользовательский список избранных товаров

400 ErrorProductSubscription

ErrorProductSubscription

Body

application/json

Object

error

Object

code

string required

Enumeration:

PRODUCT_SUBSCRIPTION_ERROR

message

string required

Example:

Нельзя перенести в список товары, на которые вы подписаны

Operations: Копировать пользовательский список избранных товаров

400 FavoriteProductsResponse

FavoriteProductsResponse

Body

application/json

Object

data

Object required

list

Array of FavoriteProduct required

productsTotalCount

integer

Общее количество товаров в списке. Отдается для списков с пагинацией

hasMore

boolean required

Есть ли еще элементы

Operations: Получить избранные товары

400 FavouriteAddProductsResponse

FavouriteAddProductsResponse

Body

application/json

Object

data

Object required

list

Array of FavoriteProduct required

Список добавленных товаров

Operations: Добавить товары в избранное

400 FavoriteListException

FavoriteListException

Body

application/json

Object

data

Object required

code

string

FAVORITELIST_EXCEPTION

message

string

“Должно быть заполнено хотя бы одно поле”

Operations: DEP Добавить товар в избранное DEP Удалить товар из избранного Добавить товары в избранное Получить избранные товары

400 ErrorFavouriteAdding

ErrorFavouriteAdding

Body

application/json

Object

data

Object

code

string required

Enumeration:

FAVOURITE_ADDING_ERROR

message

string required

Example:

"Ошибка добавления в избранное"

Operations: Добавить товары в избранное

400 CompareListResponse

CompareListResponse

Body

application/json

Object

data

Object required

list

Array of CompareProduct required

tabList

Array of compareTab

Массив табов

Operations: DEP Получить товары добавленные в список сравнения

400 GuidesResponse

GuidesResponse

Body

application/json

Object

data

Object

list

Array of GuideShortInfo required

hasMore

boolean required

Operations: Получить список гидов

400 GuideResponse

GuideResponse

Body

application/json

Object

data

Object

guide

Guide required

Operations: Получить гид по подбору

400 GuideProgressResponse

GuideProgressResponse

Body

application/json

Object

data

Object required

productCount

integer required

Количество товаров

subquery

string required

URL для основной подборки

altSubquery

string

URL для альтернативной подборки

Operations: Получить данные по прогрессу гида

400 GuideAltProductsResponse

GuideAltProductsResponse

Body

application/json

Object

data

Object required

altProductList

Array of AltProductList

Альтернативная подборка

Operations: v2 Получить альтернативную подборку гида

400 ProductKitsCategoriesResponse

Категории комплектов

На текущий момент возвращается только один тип категорий - “Жизненные ситуации”

Body

application/json

Object

data

Object

lifeSituations

Array of KitsCategory required

тип категории “Жизненные ситуации”

Operations: Получить категории комплектов товаров

400 ProductKitListResponse

ProductKitListResponse

Body

application/json

Object

data

Object required

list

Array of ProductKit required

Список комплектов

allProductKitsUrl

string required

Ссылка на раздел “Все образы”

hasMore

boolean required

Флаг есть ли еще данные для загрузки

Body

application/json

Object

error

Object

code

string

Enumeration:

INVALID_REQUEST_PARAMETERS

message

string

Example:

"Некорретные параметры запроса"

Operations: Список комплектов товаров

400 ProductKitsResponse

ProductKitsResponse

Body

application/json

Object

data

Object required

list

Array of ProductKit required

Список комплектов для товара

Operations: Получить комплекты для товара

400 ProductKitByIdResponse

ProductKitByIdResponse

Body

application/json

Object

data

Object

kit

ProductKit required

shareLink

string required

Ссылка для шаринга

relatedKits

Array of ProductKit

Связанные комплекты

Operations: Получить комплект по id

400 ErrorKitNotFound

ErrorKitNotFound

Body

application/json

Object

error

Object required

code

string required

Enumeration:

KIT_NOT_FOUND_ERROR

message

string required

Example:

"Комплект не найден"

Operations: Получить комплект по id

400 ServiceCategoriesResponse

ServiceCategoriesResponse

Body

application/json

Object

data

Object

list

Array of ServiceCategory required

banners

Array of Banner required

serviceCentersCount

integer required

Количество доступных сервисных центров

Operations: Список категорий услуг сервисного центра

400 ServiceCategoryDetailResponse

ServiceCategoryDetailResponse

Body

application/json

Object

data

Object

serviceCategory

ServiceCategory required

children

Array of ServiceCategory required

Список подкатегорий

Operations: Информация по категории услуг сервисного центра

400 ServiceProductDetailResponse

ServiceProductDetailResponse

Body

application/json

Object

data

Object

serviceProduct

ServiceProduct required

Operations: Информация по услуге сервисного центра

400 ServiceCentersResponse

ServiceCentersResponse

Body

application/json

Object

data

Object

list

Array of ServiceCenter required

Список сервисных центров

Operations: Список сервисных центров

400 BannerResponse

BannerResponse

Body

application/json

Object

data

Object required

banner

Banner required

Operations: Получить баннер по слоту

400 MainResponse

MainResponse

Body

application/json

Object

data

Object required

list

Array of MainSection required

hasMore

boolean required

Есть ли еще страницы

Operations: DEP v1 Получить шапку главного экрана v2 Получить шапку главного экрана Получить секцию главной страницы

400 ServicesSectionsResponse

ServicesSectionsResponse

Body

application/json

Object

data

Object required

list

Array of ServiceSection required

hasMore

boolean

Есть ли еще страницы

Operations: Получить секции экрана сервисов

400 ServicesDashboardResponseOld

ServicesDashboardResponseOld

Body

application/json

Object

data

Object required

promosImage

ImageUri required

afishaImage

ImageUri required

streamsImage

ImageUri required

travelImage

ImageUri required

trainingsImage

ImageUri required

Operations: DEPRECATED Дашборд экрана сервисов

400 ServicesGroupsResponse

Список групп сервисов

Body

application/json

Object

data

Object

Объект верхнего уровня

groups

Array of ServicesGroup required

Список групп сервисов

Operations: Получить доступные группы сервисов

400 FavoriteServicesListResponse

Список избранных пользователем сервисов

Body

application/json

Object

data

Object required

Объект верхнего уровян

favoriteServices

Array of ServicesEnum required

Список выбранных пользователем сервисов (существующих и включённых для конкретной версии МП и ОС устройства пользователя)

Operations: Изменить список избранных сервисов

400 ServicesSectionsListResponse

ServicesSectionsListResponse

Body

application/json

Object

data

Object required

Объект верхнего уровня

sections

Array of ServiceSection required

Списко секций

Operations: Получить список секций по идентификаторам

400 BannersResponse

BannersResponse

Body

application/json

Object

data

Object required

list

Array of Banner

Operations: Получить баннеры по слоту

400 TickerResponse

TickerResponse

Body

application/json

Object

data

Object

list

Array of TickerBanner required

Operations: Получить баннеры Бегущая строка

400 PersGateTagsResponse

Метки персонализации Pers Gate.

Body

application/json

Object

data

Object required

tags

Array of PersGateTag required

Operations: v1 Получить метки PersGate v2 Получить метки PersGate

400 DocumentResponse

DocumentResponse

Body

application/json

Object

data

Object required

document

Document required

Operations: v2 Получить документ по ID v2 Получить документ по URL Получить документ по слоту

400 PublicationResponse

PublicationResponse

Body

application/json

Object

data

Object required

publication

Publication required

Operations: v2 Получить публикацию по URL ID

400 PublicationsResponse

PublicationsResponse

Body

application/json

Object

data

Object required

list

Publication required

hasMore

boolean required

Флаг непоказанных публикаций

Example:

true

400 ServiceFromUrlResponse

Если URL привёл на какой-то сервис – в ответе есть свойства сервиса. Иначе свойства NULL

Body

application/json

Object

data

Object required

serviceNameForAnalytics

string

Наименование сервиса для отправки события в PersGate, если:

URL принадлежит к сервису
Значение задано для сервиса

Example:

Checkup

serviceId

ServicesEnum

Operations: DEP v1 Найти связанный сервис по URL v2 Найти связанный сервис по URL

400 ErrorDocumentIsNotActive

Статическая страница неактивна в CMS Gate и её нельзя отображать пользователю.

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

DOCUMENT_IS_NOT_ACTIVE

message

string

Сообщение

Example:

"В данный момент страница недоступна для просмотра."

Operations: v2 Получить документ по ID v2 Получить документ по URL Получить данные для FAQ по заказу

400 ErrorDocumentIdIsNull

Отсутствует идентификатор статической страницы.

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

DOCUMENTID_IS_NULL

message

string

Сообщение

Example:

"Невозможно выполнить запрос без идентификатора страницы."

400 ErrorDocumentNotFound

Статическая страница не найдена.

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

DOCUMENT_NOT_FOUND

message

string

Сообщение

Example:

"Невозможно выполнить запрос, указанную страницу не удалось найти."

Operations: v2 Получить документ по URL Получить документ по слоту

400 ErrorPublicationNotFound

Публикация не найдена.

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

PUBLICATION_NOT_FOUND

message

string

Сообщение

Example:

"Не удалось найти публикацию."

Operations: v2 Получить публикацию по URL ID

400 ErrorPublicationIdentifier

Ошибка, генерируемая при отсутствии обоих параметров запроса на получение публикации по идентификатору или URL.

Body

application/json

Object

error

Object

code

string

Код ошибки

Enumeration:

PUBLICATION_IDENTIFIER_INVALID

message

string

Сообщение

Example:

"Невозможно выполнить запрос, отсутствует идентификатор публикации или указанный идентификатор не является корректным."

Operations: v2 Получить публикацию по URL ID

400 SendSmsResponse

SendSmsResponse

Body

application/json

Object

data

Object required

requestId

string required

requestId

resendIn

integer required

Длительность в секундах, через сколько можно отправить новую смс.

codeLength

integer required

Сколько символов в отправленном смс коде

Operations: Отправить смсдозвон если номер неизвестен

400 CheckResponse

Ответ на запрос проверки кода введенного пользователем.

Body

application/json

Object

data

Object required

token

string required

Строка подтверждающая прохождение проверки.

Operations: Проверка введенного кода если номер не был известен

400 ErrorDeviceBlocked

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

Body

application/json

Object

error

Object required

code

string required

Enumeration:

DEVICE_BLOCKED

message

string required

Example:

Ваш девайс заблокирован на 5 минут

Operations: WIP Отправка сообщения для подтверждения действия по SMS на номер телефона из профиля WIP Проверка введенного кода для номера из профиля Отправить смсдозвон если номер неизвестен Проверка введенного кода если номер не был известен

400 ErrorSmsCodeIncorrect

Смс код непраивльный

Body

application/json

Object

error

Object required

code

string required

Enumeration:

SMS_CODE_INCORRECT

message

string required

Example:

Неверный смс код

Operations: WIP Проверка введенного кода для номера из профиля Проверка введенного кода если номер не был известен

400 ErrorVerifyCodeExpiry

Время проверки данного кода истекло.

Body

application/json

Object

error

Object required

code

string required

Enumeration:

VERIFY_CODE_EXPIRY

message

string required

Example:

Время действия вашего кода истекло

Operations: WIP Проверка введенного кода для номера из профиля Проверка введенного кода если номер не был известен

400 SendVerificationSmsResponse

SendVerificationSmsResponse

Body

application/json

Object

data

Object required

resendIn

integer required

Длительность в секундах, через сколько можно отправить новую смс.

requestId

string required

Идентификатор проверки кода вводимого пользователем

lastPhoneDigits

string required

Куда была отправлена смс. Последние 4 цифры номера

Operations: WIP Отправка сообщения для подтверждения действия по SMS на номер телефона из профиля

400 CheckSmsVerificationResponse

Ответ на запрос проверки кода введенного пользователем.

Body

application/json

Object

data

Object required

token

string required

Строка подтверждающая прохождение проверки.

Operations: WIP Проверка введенного кода для номера из профиля

400 ErrorTooManyDifferentPhonesToRequestCode

ErrorTooManyDifferentPhonesToRequestCode

Body

application/json

Object

error

Object

code

string

Enumeration:

TOO_MANY_DIFFERENT_PHONES_TO_REQUEST_CODE

message

string

Example:

Слишком много попыток запроса кода на разные номера телефонов. Повторите попытку позже.

Operations: Отправить смсдозвон если номер неизвестен

400 ErrorTooManyIncorrectCodeInputs

ErrorTooManyIncorrectCodeInputs

Body

application/json

Object

error

Object

code

string

Enumeration:

TOO_MANY_INCORRECT_CODE_INPUTS

message

string

Example:

"Превышено количество неверно введенных смс-кодов"

Operations: Отправить смсдозвон если номер неизвестен Проверка введенного кода если номер не был известен

400 ErrorFieldValidationPhoneOwn

Не прошла собственная валидация телефона на бэкенде

Body

application/json

Object

error

Object

code

string

Enumeration:

ERROR_FIELD_VALIDATION

message

string

Enumeration:

Такой код страны не поддерживается

Номер телефона после кода страны не должен превышать 10 символов

Operations: Отправить смсдозвон если номер неизвестен

400 PopupResponse

PopupResponse

Body

application/json

Object

data

Object required

popup

PopupInfo required

contents

Array of PopupContent required

Информация об экранах в поп-апе, может быть один или несколько

Operations: Детальная информация по всплывающему окну

400 ErrorPopupNotFound

Информация по всплывающему окну не была найдена

Body

application/json

Object

error

Object required

code

string

Код ошибки

Enumeration:

POPUP_NOT_FOUND

message

string required

Сообщение

Example:

"Невозможно выполнить запрос, информацию по всплывающему окну не удалось найти."

Operations: Детальная информация по всплывающему окну

400 PopupSettingsResponse

Информация по правилам показа всплывающих окон для фронта.

Body

application/json

Object

data

Object required

list

Array of PopupSettings

popupDowntime

integer

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

sessionDisplayCount

integer

Сколько раз мы можем за сессию показывать любые окна

Operations: Получить правила показа всплывающих окон

400 ActiveStreamResponse

ActiveStreamResponse

Body

application/json

Object

data

Object required

stream

Stream

liveButton

Operations: Получить активный стрим

400 StreamsResponse

StreamsResponse

Body

application/json

Object

data

Object required

list

Array of Stream required

Список стримов

tags

Array of StreamTag required

Список возможных тэгов стримов

Operations: Список всех стримов

400 StreamResponse

StreamResponse

Body

application/json

Object

data

Object required

stream

StreamFull

Operations: Получить стрим по айди

400 StreamProductsResponse

StreamProductsResponse

Body

application/json

Object

data

Object required

Объект верхнего уровня

products

Array required

Массив товаров

Object

productId

string required

Идентификатор цветомодели товара

Example:

25939160299

sizeRatio

number required

Кол-во sku, доступных онлайн / Кол-во sku всего

Example:

0.25

availability

Object required

Доступность товара

isDelivery

boolean required

Доступность товара для доставки

isPickUp

boolean required

Доступность товара для самовывоза из магазина

isPickPoint

boolean required

Доступность товара для самовывоза из пункта самовывоза

isNow

boolean required

Доступность товара для получения сейчас

Operations: Получить данные о товарах стрима

400 ErrorPhoneTypeLoginNotFound

ErrorPhoneTypeLoginNotFound

Body

application/json

Object

error

Object

error

string

Enumeration:

PHONE_NOT_FOUND

message

string

Operations: Подписаться на стрим

400 ErrorStreamNotFound

ErrorStreamNotFound

Body

application/json

Object

error

Object

code

string

Enumeration:

ERROR_STREAM_NOT_FOUND

message

string

Operations: DEPRECATED Прислать колбэк о создании сегмента пользователей Подписаться на стрим Получить стрим по айди Сообщить об изменении статуса стрима

400 ErrorUserdAlreadySubscribed

Ошибка возращается в случае, если пользователь пытается подписаться на стрим, на которые он уже подписан

Body

application/json

Object

error

Object required

Объект верхнего уровня

code

string required

Enumeration:

ERROR_USER_ALREADY_SUBSCRIBED

message

string required

Мы пришлём уведомление когда трансляция начнется. Проверьте, пожалуйста, чтобы уведомления от приложения Спортмастер были включены

Operations: Подписаться на стрим

DEP Конфигурация модуля Profile

GET /configuration/profile

v1 Конфигурация модуля Profile

POST /v1/profile/configuration

v1 Конфигурация модуля Ordering

POST /v1/ordering/configuration

DEP v4 Конфигурация модуля App

POST /v4/configuration/app

DEP Конфигурация модуля App

POST /v3/configuration/app

Конфигурация модуля Catalog

POST /v1/catalog/configuration/

DEP Конфигурация модуля Catalog

POST /configuration/catalog

Конфигурация модуля Stores

POST /v1/stores/configuration

DEP Конфигурация модуля Streams

POST /configuration/streams

DEP Конфигурация модуля Afisha

POST /v1/configuration/afisha

DEP Конфигурация модуля Chat

GET /v1/configuration/chat

Получить конфигурации модулей

POST /v1/configurations

v1 Конфигурация модуля Popups

POST /v1/popups/configuration

Получить корзину cart2

POST /v1/cart2

Добавить товар в корзину cart2

POST /v1/cart2/add

DEP v1 Установить количество товара в корзине cart2

POST /v1/cart2/set

v2 Установить количество товара в корзине cart2

POST /v2/cart2/set

DEP v1 Изменить чекбоксы товаров в корзине cart2

POST /v1/cart2/select

v2 Изменить чекбоксы товаров в корзине cart2

POST /v2/cart2/select

Удалить товары из корзины cart2

POST /v1/cart2/remove

DEP v1 Восстановить удаленный товар cart2

POST /v1/cart2/restoreDeletedItems

v2 Восстановить удаленный товар cart2

POST /v2/cart2/restoreDeletedItems

DEP v1 Скрыть удаленный товар cart2

POST /v1/cart2/hideDeletedLines

v2 Скрыть удаленный товар cart2

POST /v2/cart2/hideDeletedLines

Создать слепок корзины

POST /v1/cart/createSnapshot

Применить слепок корзины cart2

POST /v1/cart2/applySnapshot

Применить промокод cart2

POST /v1/cart2/promoCode

DEP v1 Удалить промокод в корзине cart2

DELETE /v1/cart2/promoCode

v2 Удалить промокод в корзине cart2

DELETE /v2/cart2/promoCode

Изменить флаг использования бонусов cart2

POST /v1/cart2/applyBonuses

Получить варианты доставки для товаров cart2

POST /v1/cart2/deliveryTypes

Установить получателя корзины cart2

POST /v1/cart2/receiver

Список магазинов с доступностью товаров cart2

POST /v1/cart2/internalPickupAvailability

Установить способ доставки у товаров самовывоз cart2

POST /v1/cart2/obtainPoint/internalPickup

Распределить товары на самовывоз из текущего магазина

POST /v1/cart2/obtainPoint/_set-in-store

Установить уровень сервиса у потенциального заказа

POST /v1/cart2/obtainPoint/{obtainPointId}/_service-level-code

Список ПВЗ с доступностью товаров cart2

POST /v1/cart2/externalPickupAvailability/

Детальные данные о наличии товаров в ПВЗ cart2

POST /v1/cart2/externalPickupAvailability/detail

Установить способ доставки у товаров ПВЗ cart2

POST /cart2/obtainPoint/externalPickup

Получить доступность адресов получения cart2

POST /v1/cart2/obtainPoint/receivingAddressAvailability

Установить способ доставки у товаров курьерская доставка cart2

POST /v1/cart2/obtainPoint/delivery

Редактировать адрес доставки потенциальных заказов cart2

POST /v1/cart2/obtainPoint/setAddress

Установить дату и время у потенциального заказа cart2

POST /v1/cart2/obtainPoint/{obtainPointId}/setDateTime

Сохранить выбранные сервисные услуги cart2

POST /v2/cart2/obtainPoint/{obtainPointId}/deliveryService

Удалить выбранные услуги cart2

DELETE /v2/cart2/obtainPoint/{obtainPointId}/deliveryService

DEP Сохранить выбранную услугу товара cart2

POST /v1/cart2/obtainPoint/{obtainPointId}/deliveryService

DEP Удалить выбранную услугу товара cart2

DELETE /v1/cart2/obtainPoint/{obtainPointId}/deliveryService

Способы оплаты потенциального заказа cart2

GET /cart2/order/{potentialOrderId}/paymentMethods

Установить способ оплаты у заказа cart2

POST /v1/cart2/order/{potentialOrderId}/paymentMethods

Расформировать потенциальные заказы cart2

POST /v1/cart2/obtainPoint/delete

Оформить корзину

POST /v1/cart/submit

Получить ссылку на оплату банковской картой SberPay

POST /payment/url

Подтвердить успешную оплату

POST /payment/confirm

Получить настроенные мерчанты

POST /payment/merchantSettings

Получить настроенные данные для GPay

GET /payment/merchantSettings/gpay

Получить настроенные данные для SPay

GET /payment/merchantSettings/spay

Провести оплату через Pay

POST /payment/mobile

Получить ссылку на оформление кредита и рассрочки

POST /payment/credit

Получить данные для оплаты через СБП

POST /payment/qrc

Получить ссылку на оплату частями Яндекс Сплит

POST /payment/bnpl/yandex

Получить ссылку на оплату частями Плайт v2

POST /v2/payment/bnpl/sovcombank

DEP Получить ссылку на оплату частями Плайт

POST /payment/bnpl

Получить ссылку на оплату Тинькофф долями

POST /payment/bnpl/tinkoff

Восстановить пинкод подарочной карты

POST /v1/giftCard/sendPin

Применить подарочную карту

POST /v1/giftCard/payment

Проверить статус платежа по намерению

POST /payment/checkIntention

Провести валидацию подарочной карты

POST /v1/giftCard/validate

Получить данные для оплаты через SberPay

POST /payment/sberpay

Получить ссылку на оплату Яндекс Pay

POST /payment/yandexPay

Проведение оплаты по подписке СБП

POST /payment/_fps-subscription

Получить данные для покупки ЭПК

GET /v1/egc/info

Оформить заказ ЭПК

POST /v1/egc/invoice

v3 История заказов

GET /v3/orderHistory

v2 Поиск заказов по номеру заказа

POST /v2/orderHistory/numbers

v4 Получить заказ

POST /v4/order/{orderNumber}

Получить товарный чек

GET /order/receipt/{receiptCode}

Получить Спасибо за заказ

POST /orderHistory/thanksForOrder

Получить данные для FAQ по заказу

GET /order/faq

Получить заказ на парковке

POST /order/{orderNumber}/pickUpAutoRequest

DEP Отменить заказ

POST /order/{orderNumber}

Отменить заказ

POST /order/{orderNumber}/_cancel

Отправить причину редактирования заказа

POST /order/{orderNumber}/edit-reason

Получить заказ ЭПК

GET /egcorder/{orderNumber}

Продлить хранение заказа

POST /order/{orderNumber}/prolongate

DEP Получить корзину возврата

GET /v1/return-cart

DEP Установить получателя корзины возврата

POST /v1/return-cart/receiver

DEP Установить способ возврата денежных средств

POST /v1/return-cart/order/{potentialOrderId}/refundMethods

DEP Редактировать информацию о возвращаемых товарах

POST /v1/return-cart/lines/_set-info

Получить корзину возврата v2

GET /v2/return-cart

Установить получателя корзины возврата v2

POST /v2/return-cart/receiver

Установить способ возврата денежных средств v2

POST /v2/return-cart/potential-order/refund-methods

Редактировать информацию о возвращаемых товарах v2

POST /v2/return-cart/lines/_set-info

Оформить корзину возврата

POST /v1/return-cart/submit

DEP Установить способ возврата в магазин

POST /v1/return-cart/obtain-point/to-shop

Установить способ возврата в магазин v2

POST /v2/return-cart/obtain-point/to-shop

Список ПВЗ с доступностью товара для возврата

POST /v1/return-cart/_get-drop-off-delivery-points

DEP Установить способ возврата ПВЗ

POST /v1/return-cart/obtain-point/to-delivery-point

Установить способ возврата ПВЗ v2

POST /v2/return-cart/obtain-point/to-delivery-point

DEP Установить способ возврата курьером

POST /v1/return-cart/obtain-point/to-courier

DEP Установить дату и время у потенциального заказа на возврат

POST /v1/return-cart/obtain-point/_set-date-time

Установить способ возврата курьером v2

POST /v2/return-cart/obtain-point/to-courier

Установить дату и время у потенциального заказа на возврат v2

POST /v2/return-cart/obtain-point/_set-date-time

История возвратов

GET /v1/return-orders

Получить возврат

GET /v1/return-orders/{returnCode}

Отменить возврат

POST /v1/return-orders/{returnCode}/_cancel

Открыть спор по возврату

POST /v1/return-orders/{returnCode}/_start-quarrel

Получить корзину услуг

GET /v1/service-cart

Создать корзину услуг

POST /v1/service-cart

Применить промокод в корзине услуг

POST /v1/service-cart/promo

Удалить промокод в корзине услуг

DELETE /v1/service-cart/promo

Изменить флаг использования бонусов корзины услуг

POST /v1/service-cart/_apply-bonuses

Установить получателя корзины услуг

POST /v1/service-cart/receiver

Список сервисных центров с доступностью услуг

GET /v1/service-cart/_service-center-availability

Установить способ оказания услуг в сервисном центре

POST /v1/service-cart/obtain-point/to-service-center

Установить дату и время у потенциального заказа корзины услуг

POST /v1/service-cart/obtain-point/_set-date-time

Способы оплаты потенциального заказа корзины услуг

GET /v1/service-cart/order/payment-methods

Установить способ оплаты у заказа корзины услуг

POST /v1/service-cart/order/payment-methods

Оформить корзину услуг

POST /v1/service-cart/submit

Получить корзину редактирования

GET /v1/edit-cart

Установить количество товара в корзине редактирования

POST /v1/edit-cart/lines/_set-quantity

Удалить товары из корзины редактирования

POST /v1/edit-cart/lines/_delete

Скрыть удаленный товар в корзине редактирования

POST /v1/edit-cart/lines/_hide-deleted

Восстановить удаленный товар в корзине редактирования

POST /v1/edit-cart/lines/_restore-deleted

Оформить корзину редактирования

POST /v1/edit-cart/_submit

DEP Отменить редактируемый заказ

POST /v1/edit-order/_cancel

Получить профиль

GET /profile

Изменить профиль

PATCH /profile

Получить метки клиента

GET /v1/profile/client-labels

Удалить профиль

POST /profile/deleteAccount

Изменить номер телефона

POST /profile/changePhone

Изменить номер телефона с разлогином

POST /profile/_change-phone-with-logout

Отправить письмо подтверждения на почту

POST /profile/sendEmailForConfirmation

Установить аватар

POST /profile/avatar

Удалить аватар

DELETE /profile/avatar

Отправить push token

POST /profile/pushToken

Получить id профиля

GET /profile/id

Получить usergate token

GET /profile/userGateToken

v2 Получить баннеры для профиля

POST /v2/profile/banners

DEP v1 Получить баннеры для профиля

GET /profile/banners

Получить телефон КЦ

GET /v1/info/callCenterPhone

Получить список социальных сетей

GET /v1/info/socials

Проверка и обновление clubpro_id

POST /v1/profile/checkClubProId

Получить информацию о заполненности профиля

GET /profile/filledInfo

Проверка и обновление userGateUidclubpro_id

POST /v1/profile/_check-user-gate-uid-and-club-pro-id

Responses

400 ProfileConfigurationResponse

Конфигурация для модуля Профиля пользователя

POST /v1/profile/configuration

Документация: https://confluence.app.local/pages/viewpage.action?pageId=804637395

Недоступен из-вне, только через POST /v1/configurations

Responses

400 ProfileConfigurationResponse

Конфигурация для модуля Профиля пользователя

POST /v1/ordering/configuration

Конфигурация фича тоглов, параметров для модуля оформления заказа

Многие параметры в админке зависят от версии мобильного приложения. Бекенд должен брать версию из заголовка и нормализовать её до вида х.у.z , т.к. там могут быть разные дебаг суффиксы.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489470354

Недоступен из-вне, только через POST /v1/configurations

Request body

application/json

Object

osVersion

string required

Номер версии

Example:

5.1.1

Responses

400 OrderingConfigResponse

Конфигурация для модуля оформления и корзины.

POST /v4/configuration/app

Документация: https://confluence.app.local/pages/viewpage.action?pageId=695246774

Request body

application/json

Object

osVersion

string required

Номер версии

Example:

5.1.1

Responses

400 AppConfigResponseV4

Конфигурация для общих вещей приложения. Версия (v4).

400 ErrorUnderMaintenance

Проходит сервисное обслуживание серверов.

POST /v3/configuration/app

Конфигурация фича тоглов, параметров из админки и тд.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489470358

Request body

application/json

Object

osVersion

string required

Номер версии

Example:

5.1.1

persGateTags

PersGateTagsParam

location

Location

Responses

400 AppConfigResponse

Конфигурация для общих вещей приложения.

400 ErrorUnderMaintenance

Проходит сервисное обслуживание серверов.

POST /v1/catalog/configuration/

Конфигурация фича тоглов, параметров для модуля каталога

Документация: https://confluence.app.local/pages/viewpage.action?pageId=752063445

Request body

application/json

Object

osVersion

string required

Номер версии

Example:

5.1.1

Responses

400 CatalogConfigResponse

CatalogConfigResponse

POST /configuration/catalog

DEPRECATED в рамках перехода на новый метод получения конфигурации

Конфигурация фича тоглов, параметров для модуля каталога

Документация: https://confluence.app.local/pages/viewpage.action?pageId=526163957

Request body

application/json

Object

osVersion

string required

Номер версии

Example:

5.1.1

Responses

400 CatalogConfigResponse

CatalogConfigResponse

POST /v1/stores/configuration

Конфигурация фича тоглов, параметров для модуля stores

Документация: https://confluence.app.local/pages/viewpage.action?pageId=891604464

Недоступен из-вне, только через POST /v1/configurations

Responses

400 StoresConfigResponse

StoresConfigResponse

POST /configuration/streams

Конфигурация фича тоглов, параметров для модуля стримов

Документация: https://confluence.app.local/pages/viewpage.action?pageId=601088119

Responses

400 StreamsConfigResponse

Конфигурация для модуля Streams

400 ErrorUnderMaintenance

Проходит сервисное обслуживание серверов.

POST /v1/configuration/afisha

Конфигурация фича тоглов, параметров для модуля Афиши

Документация: https://confluence.app.local/pages/viewpage.action?pageId=601090413

Responses

400 AfishaConfigResponse

Конфигурация для модуля Afisha

400 ErrorUnderMaintenance

Проходит сервисное обслуживание серверов.

GET /v1/configuration/chat

Документация: https://confluence.app.local/pages/viewpage.action?pageId=634586730

Responses

400 ChatConfigurationResponse

ChatConfigurationResponse

POST /v1/configurations

Запрос на получение всех конфигураций. Параметры в запросе определяют, конфигурации каких модулей будут возвращены в ответе. Если не подавать в запросе параметр конфигурации определенного модуля, то он не будет запрошен. Сопоставление возможных параметров для модулей и конфигураций, которая будет возвращена на эти параметры, представлено в таблице ниже.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=804632039

Сервис	ModuleConfigurationRequest.version	ModuleConfigurationRequest.request	Ответ
catalog	1	OsVersionConfigurationRequest	CatalogConfiguration
ordering	1	OsVersionConfigurationRequest	OrderingConfiguration
profile	1	null	ProfileConfiguration
stores	1	null	StoresConfiguration
app	4	OsVersionConfigurationRequest	AppConfiguration
streams	1	null	StreamsConfiguration
afisha	1	null	AfishaConfiguration
chat	1	null	ChatConfiguration
tracker	1	null	TrackerConfiguration
popups	1	OsVersionConfigurationRequest	PopupsConfiguration

Request body

application/json

Object

catalog

ModuleConfigurationRequest

ordering

ModuleConfigurationRequest

profile

ModuleConfigurationRequest

stores

ModuleConfigurationRequest

app

ModuleConfigurationRequest

streams

ModuleConfigurationRequest

afisha

ModuleConfigurationRequest

chat

ModuleConfigurationRequest

tracker

ModuleConfigurationRequest

popups

ModuleConfigurationRequest

Responses

400 AllConfigurationsResponse

Ответ на общий запрос конфигурации модулей.

400 ErrorInvalidProccessParameters

ErrorInvalidProccessParameters

POST /v1/popups/configuration

Конфигурация фича тоглов для модуля всплывающих окон

Документация: https://confluence.app.local/pages/viewpage.action?pageId=961969710

Недоступен из-вне, только через POST /v1/configurations

Request body

application/json

Object

osVersion

string

Номер версии

Example:

4.65.0

Responses

400 default

default response

POST /v1/cart2

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673429711

Request body

application/json

Object

clearDeletedLines

boolean

Если этот параметр передан в true, то бекенд не должен никогда нам возвращать те айтемы, что были в массиве deletedItems на момент вызова. При этом новые удаления там вполне могут копиться до тех пор, пока мы не вызовем опять метод получения корзины с этим флагом.

ДЛЯ БЭ: у корзины есть айди, получается на беке нужно хрнаить айди линий и айди корзины, чтобы не выдавать их нам.

cartResponse

CartFormatResponse2

Responses

400 CartResponse2

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v1/cart2/add

версия понижена до v1
ендпоинт сменен на cart2
параметр cartFormat сменен на CartFormatResponse2
ответ CartResponse сменен на CartResponse2

Добавленный товар попадает в нераспределенные.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673430818

Request body

application/json

Object

productList

Array of ProductShortInfo required

Товары

cartFormat

CartFormatResponse2

promoCode

string

Промокод на товар

Responses

400 CartResponse2

400 ErrorProductIsNotFound

ErrorProductIsNotFound

400 ErrorProductIsNotActive

ErrorProductIsNotActive

400 ErrorProductIsNotAvailable

ErrorProductIsNotAvailable

400 ErrorBasketState

ErrorBasketState

400 ErrorTooManyLinesInBasket

ErrorTooManyLinesInBasket

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorPromocodeIsNotValid

ErrorPromocodeIsNotValid

400 ErrorGateException

POST /v1/cart2/set

DEP с версии 4.65

ендпоинт стал cart2
параметр cartFormat стал CartFormatResponse2
ответ стал CartResponse2
ошибки не трогал, мб будут изменения

Количество товара можно установить от 1 до 50.

Если количество товара прибавляется, то товар попадет в нераспределенные. Если уменьшается, то сначала удаляется необходимое количество из нераспределенных, затем из МСП (при выборе МСП нет условий для фильтрации, берутся первые подходящие).

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673429877

Request body

application/json

Object

CartItemId required

quantity

integer required

Количество товара, которое должно стать в корзине

cartFormat

CartFormatResponse2

Responses

400 CartResponse2

400 ErrorInvalidQuantity

Ошибка, возвращаемая при некорректном значение количества товара.

400 ErrorBasketState

ErrorBasketState

400 ErrorTooManyLinesInBasket

ErrorTooManyLinesInBasket

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v2/cart2/set

изменен объект в теле запроса с CartItemId на CartItemIdWithLines

Количество товара можно установить от 1 до 50.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=957061504

Request body

application/json

Object

CartItemIdWithLines

quantity

integer required

Количество товара, которое должно стать в корзине

cartFormat

CartFormatResponse2

Responses

400 CartResponse2

400 ErrorInvalidQuantity

Ошибка, возвращаемая при некорректном значение количества товара.

400 ErrorBasketState

ErrorBasketState

400 ErrorTooManyLinesInBasket

ErrorTooManyLinesInBasket

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v1/cart2/select

DEP с версии 4.65

Документация: https://confluence.app.local/pages/viewpage.action?pageId=785662492

Request body

application/json

Object

ids

Array of CartItemId required

Список товаров, для которых нужно изменить значение чекбоксов

selected

boolean required

Значение, в которые нужно установить чекбоксы

Example:

true

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

400 ErrorGateException

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v2/cart2/select

Документация: https://confluence.app.local/pages/viewpage.action?pageId=957062878

Request body

application/json

Object

ids

Array of CartItemIdWithLines required

Список товаров, для которых нужно изменить значение чекбоксов

selected

boolean required

Значение, в которые нужно установить чекбоксы

Example:

true

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

400 ErrorGateException

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v1/cart2/remove

ендпоинт сменился на cart2
параметр cartFormat стал CartFormatResponse2
ответ стал CartResponse2
параметр ids стал CartItemIdWithLines, теперь умогут удаляться только переданные лайны

Товары удаляются по лайнам из нераспределенных и распределенных по МСП групп. Если для удаления передан распроданный товар, то он ищется в корзине по паре productId / sku.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673429788

Request body

application/json

Object

ids

Array of CartItemIdWithLines required

cartFormat

CartFormatResponse2

Responses

400 CartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v1/cart2/restoreDeletedItems

DEP c версии 4.67

http://ordergate-ru-by-kz.ordergateuat.web.local/swagger-ui/index.html?url=../openapi.yaml#/baskets/restoreDeletedLines

ендпоинт сменен на cart2
ответ сменен на FullCartResponse2

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673430056

Request body

application/json

Object

CartItemId

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorRestoredItemIfNotFound

ErrorRestoredItemIfNotFound

400 ErrorGateException

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v2/cart2/restoreDeletedItems

http://ordergate-ru-by-kz.ordergateuat.web.local/swagger-ui/index.html?url=../openapi.yaml#/baskets/restoreDeletedLines

Документация: https://confluence.app.local/pages/viewpage.action?pageId=965976555

Request body

application/json

Object

CartItemIdWithLines

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorRestoredItemIfNotFound

ErrorRestoredItemIfNotFound

400 ErrorGateException

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v1/cart2/hideDeletedLines

DEP с версии 4.67

Метод исключает из выдачи корзины из списка удаленных товаров переданные в этом методе товары. Для подробностей смотри поле clearDeletedLines у метода получения корзины.

ендпоинт сменен на cart2
ответ сменен на FullCartReponse2

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673429949

Request body

application/json

Object

CartItemId

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorDeletedLinesAreNotFound

ErrorDeletedLinesAreNotFound

POST /v2/cart2/hideDeletedLines

Документация: https://confluence.app.local/pages/viewpage.action?pageId=965976656

Request body

application/json

Object

CartItemIdWithLines

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorDeletedLinesAreNotFound

ErrorDeletedLinesAreNotFound

POST /v1/cart/createSnapshot

Документация: https://confluence.app.local/pages/viewpage.action?pageId=526166026

Responses

400 SnapshotResponse

SnapshotResponse

400 ErrorBasketState

ErrorBasketState

POST /v1/cart2/applySnapshot

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673425605

Request body

application/json

Object

snapshotUrl

string required

Ссылка на слепок корзины

Example:

https://www.sportmaster.ru/basket/checkout.do?specificationId=1f9dea2e-68d7-4b14-ad8f-88a8a619e46c

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorTooManyLinesInBasket

ErrorTooManyLinesInBasket

400 ErrorApplicationSnapshot

ErrorApplicationSnapshot

POST /v1/cart2/promoCode

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673430258

Request body

application/json

Object

promoCode

string required

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorPromocodeIsNotValid

ErrorPromocodeIsNotValid

400 ErrorPromocodForInstallment

ErrorPromocodForInstallment

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorGateException

400 ErrorEmptyPromocode

ErrorEmptyPromocode

DELETE /v1/cart2/promoCode

DEP в рамках MPSM-11743

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673430308

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

DELETE /v2/cart2/promoCode

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1039382221

Request body

application/json

Object

promoCode

string required

Промокод

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

POST /v1/cart2/applyBonuses

изменен ответ на FullCartResponse2
изменен ендпоинт на cart2

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673425501&moved=true

Request body

application/json

Object

applyBonuses

boolean required

Списывать или нет бонусы при оформлении корзины

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorBasketState

ErrorBasketState

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v1/cart2/deliveryTypes

Документация: https://confluence.app.local/pages/viewpage.action?pageId=689112067

Request body

application/json

Object

cartItemsIds

Array of CartItemIdWithLines

Айди товаров, для которых рассчитать доступные варианты доставки

Responses

400 CartItemsDeliveryTypes

CartItemsDeliveryTypes

POST /v1/cart2/receiver

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673443812

Request body

application/json

Object

fio

string required

ФИО получателя

string required

Email получателя

Max length: 255

Pattern: ^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+\.)+[a-zA-Z0-9-]+$

phone

Phone

verificationToken

string

Код, полученный при проверке номера смс. Передавать не обязательно. Если не передан, то у овнера остается прошлое значение номера. Если номера не было, то возвращается специальная ошибка.

Передается только для анонима.

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorFieldValidation

ErrorFieldValidation

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorPhoneInBasket

400 ErrorEmailValidation

Бизнес-ошибка валидации email со стороны гейта

POST /v1/cart2/internalPickupAvailability

Возвращает по данной позиции в корзине распределение по магазинам - когда можно будет забрать товар и на каких условиях.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=683242894

Request body

application/json

Object

cartItemIds

Array of CartItemIdWithLines required

Responses

400 InternalPickupAvailabilityResponse2

InternalPickupAvailabilityResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorInternalPickupAvailability

ErrorInternalPickupAvailability

400 ErrorSomeBasketLinesIsSoldout

ErrorSomeBasketLinesIsSoldout

400 ErrorGateException

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v1/cart2/obtainPoint/internalPickup

в пути cart сменнился на cart2
как будто теперь не надо искать обтейн поинты с таким магазином, просто устанавливаем все переданые данные
в параметрах теперь сразу желаемое распределение по заказам
в ответе теперь FullCartResponse2
ошибки ответов я не трогал, оставляю это на тебя

Метод устаналивает для товаров МСП - самовывоз из магазина, при этом сразу отдает желаемое разбитие по заказам

Документация: https://confluence.app.local/pages/viewpage.action?pageId=683214916

Request body

application/json

Object

shopNumber

string required

Номер магазина

Example:

898

cartItemsByOrders

Array of SetInternalPickupParams required

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 InternalPickupErrorResponse

InternalPickupErrorResponse

400 ErrorSomeBasketLinesIsSoldout

ErrorSomeBasketLinesIsSoldout

POST /v1/cart2/obtainPoint/_set-in-store

По переданному id магазина распределяет товары корзины в МСДП на самовывоз из этого магазина

Документация: https://confluence.app.local/pages/viewpage.action?pageId=926830696

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorShopNotFound

ErrorShopNotFound

400 InternalPickupErrorResponse

InternalPickupErrorResponse

POST /v1/cart2/obtainPoint/{obtainPointId}/_service-level-code

Пересоздает МСДП с заданным в запросе уровнем сервиса

Документация: https://confluence.app.local/pages/viewpage.action?pageId=936089018

Path variables

obtainPointId

string required

Идентикиатор потенциального заказа

Request body

application/json

Object

serviceLevelCode

string

Уровень сервиса, который нужно установить. null означает, что уровень сервиса нужно сбросить

Enumeration:

RETAIL_SELF_DELIVERY

SELF_DELIVERY

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorObtainPointIsNotSelfDelivery

ErrorObtainPointIsNotSelfDelivery

400 InternalPickupErrorResponse

InternalPickupErrorResponse

400 ErrorServiceLevelCodeIsNotValid

ErrorServiceLevelCodeIsNotValid

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

POST /v1/cart2/externalPickupAvailability/

Возвращет по данной позиции в корзине распределение по ПВЗ - когда можно будет забрать товар и на каких условиях.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=689123453

Request body

application/json

Object

cartItemIds

Array of CartItemIdWithLines required

Responses

400 ExternalPickupAvailabilityResponse2

ExternalPickupAvailabilityResponse2

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorBasketState

ErrorBasketState

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorSomeBasketLinesIsSoldout

ErrorSomeBasketLinesIsSoldout

400 ErrorExternalPickupAvailability

ErrorExternalPickupAvailability

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

POST /v1/cart2/externalPickupAvailability/detail

Выдает, какие лайны доступны и недоступны в ПВЗ

Документация: https://confluence.app.local/pages/viewpage.action?pageId=695243543

Request body

application/json

Object

pickPointId

string

cartItemIds

Array of CartItemIdWithLines

Responses

400 ExternalPickupAvailabilityDetailResponse

ExternalPickupAvailabilityDetailResponse

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorBasketState

ErrorBasketState

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorSomeBasketLinesIsSoldout

ErrorSomeBasketLinesIsSoldout

400 ErrorExternalPickupAvailability

ErrorExternalPickupAvailability

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

POST /cart2/obtainPoint/externalPickup

У данных товаров устанавливается способ получения - пвз.

изменились входные параметры, теперь это массив лайн йдишниками

Ошибки не трогал, их актуальность на тебе

Документация: https://confluence.app.local/pages/viewpage.action?pageId=680737702

Request body

application/json

Object

pickpointId

string required

cartItemIds

Array of CartItemIdWithLines required

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorBasketState

ErrorBasketState

400 ErrorSomeBasketLinesIsSoldout

ErrorSomeBasketLinesIsSoldout

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorInvalidProccessParameters

ErrorInvalidProccessParameters

POST /v1/cart2/obtainPoint/receivingAddressAvailability

Работает только на геозонах. Метод для каждого адреса получения возвращает доступность товаров на доставку по этому адресу

Документация: https://confluence.app.local/pages/viewpage.action?pageId=839369276

Request body

application/json

Object

addressIds

Array of string required

Список ID адресов, для которых нужно рассчитать доступность

Example:

3514692b-a3f5-403b-b215-1d1045dff486

cartItemIds

Array of CartItemIdWithLines required

Список товаров, для которых нужно рассчитать доступность

Responses

400 ReceivingAddressAvailabilityResponse

ReceivingAddressAvailabilityResponse

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorBasketState

ErrorBasketState

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorSomeBasketLinesIsSoldout

ErrorSomeBasketLinesIsSoldout

400 ErrorAddressesListIncorrect

ErrorAddressesListIncorrect

400 ErrorMethodIsDisabled

ErrorMethodIsDisabled

POST /v1/cart2/obtainPoint/delivery

Создает потенциальный заказ на доставку с заданными товарами

Документация: https://confluence.app.local/pages/viewpage.action?pageId=683222938

Request body

application/json

Object

cartItemIds

Array of CartItemIdWithLines required

deliveryAddressInfo

DeliveryAddressInfo

receivingAddressInfo

ReceivingAddressInfo

isExpress

boolean required

null/отуствие параметра - бекенд сам определяет, какую доставку ставить товарам. Ставится тот вариант, которым можно привести наибольшее количество товаров. Если экспрессом и обычной доставкой кол-во товров равно, что ставится обычная доставка
true - ставится экспресс доставка, при этом товары, которые нельзя привести экспресом упадут в нераспределенные товары
false - ставится обычная доставка

Все вараианты допускают, что часть товаров уйдет в нераспределенные.

Все варианты подразумевают, что может быть создано n заказов

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorSomeBasketLinesIsSoldout

ErrorSomeBasketLinesIsSoldout

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorBasketState

ErrorBasketState

400 ErrorObtainPointDelivery

ErrorObtainPointDelivery

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorInvalidProccessParameters

ErrorInvalidProccessParameters

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorLocationIsNotMatch

Ошибка, возвращаемая если координаты в x-location не совпадают с координатами в receivingAddress.

400 ErrorHouseIsNull

POST /v1/cart2/obtainPoint/setAddress

Документация: https://confluence.app.local/pages/viewpage.action?pageId=683244560

Request body

application/json

Object

obtainPointIds

Array of string required

Массив айдишников обейтн поинтов, которым нужно поменять адрес.

deliveryAddressInfo

DeliveryAddressInfo

receivingAddressInfo

ReceivingAddressInfo

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorBasketState

ErrorBasketState

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorMetroIdIsNotValid

ErrorMetroIdIsNotValid

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorLocationIsNotMatch

Ошибка, возвращаемая если координаты в x-location не совпадают с координатами в receivingAddress.

400 ErrorUserLocationHasChanged

400 ErrorHouseIsNull

POST /v1/cart2/obtainPoint/{obtainPointId}/setDateTime

Метод применяется для установки даты и времени курьерской доставки у потенциального заказа.

ендпоинт сменился на cart2
ответ сменился на FullCartResponse2

Документация: https://confluence.app.local/pages/viewpage.action?pageId=683232170

Path variables

obtainPointId

string required

Request body

application/json

Object

receivingDateFrom

DateOnly required

receivingDateTo

DateOnly

receivingTimeSlot

string

Временной интервал доставки

receivingTimeSlotId

integer

ID временного слота доставки

deliveryServiceLevelId

integer required

ID MDM уровня сервиса доставки (справочник gt_service_level)

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorBasketState

ErrorBasketState

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorDateTimeReceiptAreOutdated

ErrorDateTimeReceiptAreOutdated

400 ErrorInvalidProccessParameters

ErrorInvalidProccessParameters

POST /v2/cart2/obtainPoint/{obtainPointId}/deliveryService

Привязывает к МСП услуги на уровне товара

Документация: https://confluence.app.local/pages/viewpage.action?pageId=804627486

Path variables

obtainPointId

string required

Request body

application/json

Object

serviceList

Array of ServiceData required

Данные по выбранным сервисным услугам

cleanServices

boolean required

Признак, что надо удалить не выбранные услуги

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorBasketState

ErrorBasketState

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

400 ErrorServiceIsNotValid

ErrorServiceIsNotValid

400 ErrorInvalidProccessParameters

ErrorInvalidProccessParameters

DELETE /v2/cart2/obtainPoint/{obtainPointId}/deliveryService

Метод удаления выбранных услуг на уровне заказа и на уровне товара в корзине

эндпоинт cart2
ответ FullCartResponse2

Документация: https://confluence.app.local/pages/viewpage.action?pageId=797614476

Path variables

obtainPointId

string required

Request body

application/json

Object

serviceLineIds

Array of string

ИД лайнов услуг

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorGateException

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorServiceIsNotValid

ErrorServiceIsNotValid

POST /v1/cart2/obtainPoint/{obtainPointId}/deliveryService

DEPRECATED: версия 4.48.0 - 05.02 - 22.02

Метод добавления к товару в корзине сервисной услуги

ендроинт cart2
ответ FullCartResponse2

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673433713

Path variables

obtainPointId

string required

Request body

application/json

Object

lineId

string required

ИД штуки корзины, к которой требуется привязать услугу

mdmServiceId

string required

ИД МДМ сервисной услуги

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 ErrorBasketState

ErrorBasketState

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

400 ErrorServiceIsNotValid

ErrorServiceIsNotValid

400 ErrorInvalidProccessParameters

ErrorInvalidProccessParameters

DELETE /v1/cart2/obtainPoint/{obtainPointId}/deliveryService

DEPRECATED: версия 4.48.0 - 05.02 - 22.02

Метод удаления выбранной сервисной услуги у товара в корзине

эндпоинт cart2
ответ FullCartResponse2

Документация: https://confluence.app.local/pages/viewpage.action?pageId=673433670

Path variables

obtainPointId

string required

Request body

application/json

Object

serviceLineId

string required

ИД лайна услуги

Example:

fa537932-e755-42a0-bda3-aaa48cec724e

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorGateException

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

GET /cart2/order/{potentialOrderId}/paymentMethods

Документация: https://confluence.app.local/pages/viewpage.action?pageId=763381920

Path variables

potentialOrderId

string required

Responses

400 PaymentMethodsResponse2

PaymentMethodsResponse2

400 ErrorBasketState

ErrorBasketState

400 ErrorPotentialOrderIsNotFound

ErrorPotentialOrderIsNotFound

POST /v1/cart2/order/{potentialOrderId}/paymentMethods

Документация: https://confluence.app.local/pages/viewpage.action?pageId=683219342

Path variables

potentialOrderId

string required

Request body

application/json

Object

paymentMethodId

string required

Берется из модели метода оплаты. Фактически это значение энама

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorPotentialOrderIsNotFound

ErrorPotentialOrderIsNotFound

400 ErrorBasketState

ErrorBasketState

400 ErrorPaymentMethodIsNotValid

ErrorPaymentMethodIsNotValid

400 ErrorCreditMinSum

ErrorCreditMinSum

POST /v1/cart2/obtainPoint/delete

Расформировать потенциальные заказы - отвязать существующие распределенные заказы от МСДП.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677961826

Request body

application/json

Object

obtainPointIds

Array of string

Массив айдишников обтейн поинтов. Если нулл, не передан или пустой - то расформировать все

Responses

400 FullCartResponse2

FullCartResponse2

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorBasketState

ErrorBasketState

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /v1/cart/submit

Документация: https://confluence.app.local/pages/viewpage.action?pageId=546732798

Request body

application/json

Object

cartVersion

integer required

Параметр нужен, чтобы пользователь оформил ту версию корзины, что видел.

Responses

400 SubmitCartResponse

SubmitCartResponse

400 ErrorBasketVersionIsNotValid

ErrorBasketVersionIsNotValid

400 ErrorBasketState

ErrorBasketState

400 ErrorOwnerDataIsRequired

ErrorOwnerDataIsRequired

400 ErrorEmailIsRequired

ErrorEmailIsRequired

400 ErrorProfileIdIsEmpty

ErrorProfileIdIsEmpty

400 ErrorPaymentMethodIsRequired

ErrorPaymentMethodIsRequired

400 ErrorDeliveryDateIsRequired

ErrorDeliveryDateIsRequired

400 ErrorAdressIsRequired

ErrorAdressIsRequired

400 ErrorDeliveryDateIsExpired

ErrorDeliveryDateIsExpired

400 ErrorReceiverDataIsRequired

ErrorReceiverDataIsRequired

400 ErrorOrderWeightExceeded

ErrorOrderWeightExceeded

400 ErrorOrderCostIsExceeded

ErrorOrderCostIsExceeded

400 ErrorExceedLimitOnActiveOrders

ErrorExceedLimitOnActiveOrders

POST /payment/url

Метод используется для оплаты банковской картой и через SberPay в приложении Сбера (для SberPay SDK используется отдельный метод)

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494231986

Request body

application/json

Object

orderNumber

string required

Номер заказа

Для БЭ: это инвойс намбер

urlFail

string required

URL для возврата пользователя из эквайринга без успешной оплаты

urlSuccess

string required

URL для возврата пользователя из эквайринга после успешной оплаты

isSberPay

boolean

Если true, то идет оплата через СберПей

Responses

400 PaymentUrlResponse

Ответ на получение ссылки на оплату банковской картой

400 ErrorPaymentUrlIsEmpty

ErrorPaymentUrlIsEmpty

400 ErrorPaymentUrlInvalidParameters

ErrorPaymentUrlInvalidParameters

POST /payment/confirm

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494231992

Request body

application/json

Object

orderNumber

string required

acquiringParams

string required

Параметры, переданные эквайрингом на страницу успешной оплаты

Example:

orderId=f369bf51-3f16-7e09-864b-6dd20015bca7&lang=ru

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorInvalidSubmitPaymentParameters

ErrorInvalidSubmitPaymentParameters

POST /payment/merchantSettings

Служебный метод, чтобы фронт мог интегрировать *Pay оплаты

Для БЭ: запрос строится на http://pgate-sm.pgateuat.web.local/pgate/rest/v2/swagger-ui/index.html?url=../openapi.yaml#/p-gate-rest/getMerchantSettings

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232016

Request body

application/json

Object

orderNumber

string required

Номер заказа

paymentTool

string required

Платежная система

Enumeration:

SAMSUNG_PAY

GOOGLE_PAY

APPLE_PAY

Responses

400 MerchantSettingsResponse

MerchantSettingsResponse

400 ErrorOrderNumberIsEmpty

ErrorOrderNumberIsEmpty

400 ErrorPaymentToolIsEmpty

ErrorPaymentToolIsEmpty

400 ErrorMerchantNotFound

ErrorMerchantNotFound

GET /payment/merchantSettings/gpay

Возвращает модель необходимых параметров для оплаты через GooglePay

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232026

Request parameters

orderNumber

string required

Номер заказа

Responses

400 GooglePayMerchantResponse

GooglePayMerchantResponse

400 ErrorOrderNumberIsEmpty

ErrorOrderNumberIsEmpty

400 ErrorMerchantNotFound

ErrorMerchantNotFound

GET /payment/merchantSettings/spay

Возвращает модель необходимых параметров для оплаты через SamsungPay

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232074

Request parameters

orderNumber

string required

Номер заказа

Responses

400 SamsungPayMerchantResponse

SamsungPayMerchantResponse

400 ErrorOrderNumberIsEmpty

ErrorOrderNumberIsEmpty

400 ErrorMerchantNotFound

ErrorMerchantNotFound

400 ErrorMerchantNotCorrect

ErrorMerchantNotCorrect

POST /payment/mobile

Для бэ: работает на http://pgate-sm.pgateuat.web.local/pgate/rest/v2/swagger-ui/index.html?url=../openapi.yaml#/p-gate-rest/makeMobilePayment

сумма получается методом http://pgate-sm.pgateuat.web.local/pgate/rest/v2/swagger-ui/index.html?url=../openapi.yaml#/p-gate-rest/getAmountToPay

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232009

Request body

application/json

Object

orderNumber

string required

Номер заказа

payToken

string required

Токен платежа (ApplePay, GooglePay, SamsungPay), обязательное поле

paymentTool

string required

Инструмент оплаты, обязательное поле

Enumeration:

GOOGLE_PAY

SAMSUNG_PAY

APPLE_PAY

successUrl

string required

Полный адрес, на который требуется перенаправить пользователя в случае успешной оплаты, включая используемый протокол

failUrl

string required

Полный адрес, на который требуется перенаправить пользователя в случае неуспешной оплаты, включая используемый протокол

Responses

400 MakeMobilePaymentResponse

MakeMobilePaymentResponse

400 ErrorOrderNumberIsEmpty

ErrorOrderNumberIsEmpty

400 ErrorPaymentToolIsEmpty

ErrorPaymentToolIsEmpty

400 ErrorRedirectURLIsEmpty

ErrorRedirectURLIsEmpty

POST /payment/credit

БЭ: метод работает на http://pgate-sm.gksm.local/pgate/rest/v2/swagger-ui/index.html?url=../openapi.yaml#/p-gate-rest/getCreditUrl

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232080

Request body

application/json

Object

orderNumber

string required

Номер заказа

Для БЭ: это инвойс намбер

urlFail

string required

URL для возврата пользователя из эквайринга без успешного кредита

urlSuccess

string required

URL для возврата пользователя из эквайринга после успешного кредита

Responses

400 CreditUrlResponse

Ответ на получение ссылки на оформление кредита

400 ErrorPaymentMethodIsNotCredit

ErrorPaymentMethodIsNotCredit

400 ErrorNotAllProductsFound

ErrorNotAllProductsFound

400 ErrorProductIsNotCreditOrInstallment

ErrorProductIsNotCreditOrInstallment

POST /payment/qrc

Для БЭ: метод проксирует http://pgate-sm.gksm.local/pgate/rest/v2/swagger-ui/index.html?url=../openapi.yaml#/p-gate-rest/getQrcData

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232091

Request body

application/json

Object

orderNumber

string required

Номер заказа

Responses

400 QrcResponse

Ответ на формирование ссылки на оплату через СБП

400 ErrorOrderNumberIsEmpty

ErrorOrderNumberIsEmpty

400 ErrorOrderNumberIsBad

Гейт ответил 400й ошибкой при orderNumber != null

POST /payment/bnpl/yandex

Документация: https://confluence.app.local/pages/viewpage.action?pageId=831755656

Request body

application/json

Object

orderNumber

string required

Номер заказа (инвойса)

urlFail

string required

URL для возврата пользователя из эквайринга без успешной оплаты

urlSuccess

string required

URL для возврата пользователя из эквайринга после успешной оплаты

Responses

400 BnplUrlResponse

Ответ на получение ссылки на оплату частями

400 ErrorPaymentUrlIsEmpty

ErrorPaymentUrlIsEmpty

400 ErrorPaymentUrlInvalidParameters

ErrorPaymentUrlInvalidParameters

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

POST /v2/payment/bnpl/sovcombank

Документация: https://confluence.app.local/pages/viewpage.action?pageId=552909003

Request body

application/json

Object

orderNumber

string required

Номер заказа (инвойса)

urlFail

string required

URL для возврата пользователя из эквайринга без успешной оплаты

urlSuccess

string required

URL для возврата пользователя из эквайринга после успешной оплаты

Responses

400 BnplUrlResponse

Ответ на получение ссылки на оплату частями

400 ErrorPaymentUrlIsEmpty

ErrorPaymentUrlIsEmpty

400 ErrorPaymentUrlInvalidParameters

ErrorPaymentUrlInvalidParameters

POST /payment/bnpl

Документация: https://confluence.app.local/pages/viewpage.action?pageId=552909003

Request body

application/json

Object

orderNumber

string required

Номер заказа (инвойса)

urlFail

string required

URL для возврата пользователя из эквайринга без успешной оплаты

urlSuccess

string required

URL для возврата пользователя из эквайринга после успешной оплаты

Responses

400 BnplUrlResponse

Ответ на получение ссылки на оплату частями

400 ErrorPaymentUrlIsEmpty

ErrorPaymentUrlIsEmpty

400 ErrorPaymentUrlInvalidParameters

ErrorPaymentUrlInvalidParameters

POST /payment/bnpl/tinkoff

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721059277

Request body

application/json

Object

orderNumber

string required

Номер заказа (инвойса)

urlFail

string required

URL для возврата пользователя из эквайринга без успешной оплаты

urlSuccess

string required

URL для возврата пользователя из эквайринга после успешной оплаты

Responses

400 BnplUrlResponse

Ответ на получение ссылки на оплату частями

400 ErrorPaymentUrlIsEmpty

ErrorPaymentUrlIsEmpty

400 ErrorPaymentUrlInvalidParameters

ErrorPaymentUrlInvalidParameters

POST /v1/giftCard/sendPin

Документация: https://confluence.app.local/pages/viewpage.action?pageId=576557671

Request body

application/json

Object

orderNumber

string required

Номер заказа

giftCardNumber

string required

Номер подарочной карты

isEgc

boolean required

Выбранный Пользователем тип подарочной карты. Передаетс true, если была выбрана Электронная подарочная карта, и false, если выбрана Подарочная карта

Responses

400 SendPinResponse

Ответ об отправке СМС

400 ErrorEgcExpired

Срок действия подарочной карты истек

400 ErrorEgcAlreadyUsed

Карта уже использована

400 ErrorEgcTemporarlyBlocked

Карта заблокирована на 30 минут

400 ErrorEgcNotFound

Неправильный номер карты

400 ErrorIncorrectGiftCardType

Неправильный тип подарочной карты

POST /v1/giftCard/payment

Документация: https://confluence.app.local/pages/viewpage.action?pageId=576557684

Request body

application/json

Object

orderNumber

string required

Номер заказа

giftCardNumber

string required

Номер подарочной карты

giftCardPin

string required

Пин-код подарочной карты

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorPinCodeIncorrect

Неправильный пин-код

400 ErrorEgcExpired

Срок действия подарочной карты истек

400 ErrorEgcAlreadyUsed

Карта уже использована

400 ErrorEgcTemporarlyBlocked

Карта заблокирована на 30 минут

400 ErrorEgcNotFound

Неправильный номер карты

POST /payment/checkIntention

Метод служит, чтобы понять статус платежа по намерению

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232102

Request body

application/json

Object

orderNumber

string required

Номер заказа

paymentIntentionId

string required

Идентификатор намерения платежа

Responses

400 CheckPaymentIntentionResponse

Статус платежа

400 ErrorOrderNumberIsEmpty

ErrorOrderNumberIsEmpty

400 ErrorPaymentIntentionIdIsEmpty

ErrorPaymentIntentionIdIsEmpty

400 ErrorPaymentIntentionIdIsBad

Гейт ответил 400й ошибкой при paymentIntentionId != null

400 ErrorPaymentStatusUnknown

ErrorPaymentStatusUnknown

POST /v1/giftCard/validate

Документация: https://confluence.app.local/pages/viewpage.action?pageId=576556291

Request body

application/json

Object

orderNumber

string required

Номер заказа

totalCost

Price required

giftCardNumber

string required

Номер подарочной карты

giftCardPin

string required

Пин-код подарочной карты

isEgc

boolean required

Responses

400 ValidateGiftCardResponse

Ответ на успешную валидацию подарочной карты

400 ErrorPinCodeIncorrect

Неправильный пин-код

400 ErrorEgcExpired

Срок действия подарочной карты истек

400 ErrorEgcAlreadyUsed

Карта уже использована

400 ErrorEgcTemporarlyBlocked

Карта заблокирована на 30 минут

400 ErrorEgcNotFound

Неправильный номер карты

400 ErrorIncorrectGiftCardType

Неправильный тип подарочной карты

POST /payment/sberpay

Метод используется для SberPay SDK

Документация: https://confluence.app.local/pages/viewpage.action?pageId=804694928

Request body

application/json

Object

orderNumber

string required

Номер заказа

Example:

2700924-901450

Responses

400 SberPayResponse

SberPayResponse

POST /payment/yandexPay

Метод используется для инструмента оплаты Яндекс Pay

Документация: https://confluence.app.local/pages/viewpage.action?pageId=889128678

Request body

application/json

Object

orderNumber

string required

Номер заказа

Для БЭ: это инвойс намбер

urlFail

string required

URL для возврата пользователя из эквайринга без успешной оплаты

urlSuccess

string required

URL для возврата пользователя из эквайринга после успешной оплаты

Responses

400 PaymentUrlResponse

Ответ на получение ссылки на оплату банковской картой

400 ErrorPaymentUrlIsEmpty

ErrorPaymentUrlIsEmpty

400 ErrorPaymentUrlInvalidParameters

ErrorPaymentUrlInvalidParameters

POST /payment/_fps-subscription

Документация: https://confluence.app.local/pages/viewpage.action?pageId=938397241

Request body

application/json

Object

orderNumber

string required

Номер заказа

bankId

string required

ID банка на стороне СБП

Responses

400 FpsSubscriptionResponse

FpsSubscriptionResponse

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

GET /v1/egc/info

https://confluence.app.local/pages/viewpage.action?pageId=607985825

Responses

400 EgcInfoResponse

EgcInfoResponse

POST /v1/egc/invoice

Документация: https://confluence.app.local/pages/viewpage.action?pageId=563343504

Request body

application/json

Object

summ

Price required

senderEmail

string required

E-mail отправителя

receiver

EgcReceiver required

delayedSend

EgcDelayedSend

message

EgcMessage

imageType

integer

Код дизайна ЭПК

Responses

400 EgcResponse

EgcResponse

400 ErrorAnonymUser

ErrorAnonymUser

GET /v3/orderHistory

Документация: https://confluence.app.local/pages/viewpage.action?pageId=592801303

Request parameters

filterId

string optional

Айди фильтра. Если не передан, то возвращаюстя все заказы

Responses

400 OrderHistoryResponse

OrderHistoryResponse

400 ErrorAnonymUser

ErrorAnonymUser

POST /v2/orderHistory/numbers

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489487521

Request body

application/json

Object

numbers

Array of string required

Номера заказов

Responses

400 OrdersByNumbersResponse

OrdersByNumbersResponse

400 ErrorProductIdMustNotBeNull

ErrorProductIdMustNotBeNull

400 ErrorWareIdMustNotBeNull

ErrorWareIdMustNotBeNull

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

POST /v4/order/{orderNumber}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721044462

Path variables

orderNumber

string required

Responses

400 OrderResponse

OrderResponse

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorProductIdMustNotBeNull

ErrorProductIdMustNotBeNull

400 ErrorWareIdMustNotBeNull

ErrorWareIdMustNotBeNull

GET /order/receipt/{receiptCode}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=592801502

Path variables

receiptCode

string required

Responses

400 OrderResponse

OrderResponse

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorProductIdMustNotBeNull

ErrorProductIdMustNotBeNull

400 ErrorWareIdMustNotBeNull

ErrorWareIdMustNotBeNull

400 ErrorGateException

POST /orderHistory/thanksForOrder

Проверяются условия оформления заказа, отдаются данные для экрана “Спасибо за заказ”

Документация: https://confluence.app.local/pages/viewpage.action?pageId=541904488

Request body

application/json

Object

orderNumbers

Array of string required

Номера заказов

Responses

400 ThanksForOrderResponse

ThanksForOrderResponse

GET /order/faq

Документация: https://confluence.app.local/pages/viewpage.action?pageId=563404786

Request parameters

orderNumber

string required

Номер заказа

Responses

400 FaqResponse

FaqResponse

400 ErrorDocumentIsNotActive

Статическая страница неактивна в CMS Gate и её нельзя отображать пользователю.

POST /order/{orderNumber}/pickUpAutoRequest

Документация: https://confluence.app.local/pages/viewpage.action?pageId=526360128

Path variables

orderNumber

string required

Номер заказа

Request body

application/json

Object

shopNumber

integer required

Номер магазина

carNumber

string required

Номер автомобиля

orderReceiveCode

string required

Смс код для получения заказа

Responses

400 PickUpAutoResponse

PickUpAutoResponse

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 PickUpAutoDuplicationError

PickUpAutoDuplicationError

400 PickUpAutoNotEnabledError

Ошибка, когда FeatureToggles.isPickUpAutoEnabled == false.

POST /order/{orderNumber}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489484800 DEP в рамках MPSM-12464

Path variables

orderNumber

string required

Request body

application/json

Object

cancelReasonId

string required

comment

string

Max length: 2,000

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorOrderIllegalAction

ErrorOrderIllegalAction

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

POST /order/{orderNumber}/_cancel

Документация: https://confluence.app.local/pages/viewpage.action?pageId=965977835

Path variables

orderNumber

string required

Request body

application/json

Object

cancelReasonId

string

Идентификатор причины отмены

Example:

123

comment

string

Текстовое описание от пользователя с причиной отмены

Max length: 2,000

orderStage

string required

Контекст выполнения запроса

Enumeration:

DEFAULT

ON_PRODUCT_DELETE

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorOrderIllegalAction

ErrorOrderIllegalAction

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

POST /order/{orderNumber}/edit-reason

Документация: https://confluence.app.local/pages/viewpage.action?pageId=965968873

Path variables

orderNumber

string required

Request body

application/json

Object

editReasonMnemocode

string required

Мнемокод причины редактирования заказа

Example:

payment_change

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorOrderIllegalAction

ErrorOrderIllegalAction

GET /egcorder/{orderNumber}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=620588824

Path variables

orderNumber

string required

Номер заказа ЭПК

Responses

400 EgcOrderResponse

EgcOrderResponse

POST /order/{orderNumber}/prolongate

Метод продления срока хранения заказа

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489484810

Path variables

orderNumber

string required

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorOrderIllegalAction

ErrorOrderIllegalAction

GET /v1/return-cart

Документация: https://confluence.app.local/pages/viewpage.action?pageId=990505635

Responses

400 [DEP] CommonCartResponse

[DEP] CommonCartResponse

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

POST /v1/return-cart/receiver

Документация: https://confluence.app.local/pages/viewpage.action?pageId=990505946

Request body

application/json

Object

fio

string required

ФИО получателя

Example:

Иванов Иван Иванович

string required

Email получателя

Min length: 255

Pattern: ^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+\.)+[a-zA-Z0-9-]+$

Example:

iiivanov_00@sportaster.ru

phone

Phone required

Responses

400 [DEP] CommonCartResponse

[DEP] CommonCartResponse

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorFieldValidation

ErrorFieldValidation

POST /v1/return-cart/order/{potentialOrderId}/refundMethods

Path variables

potentialOrderId

string required

Номер потенциального заказа

Example:

d2b631aa-63ce-446d-b9dc-ec9f82c48962

Request body

application/json

Object

refundMethods

Array of RefundMethodShort

Способы возврата денежных средств

Responses

400 [DEP] CommonCartResponse

[DEP] CommonCartResponse

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorPotentialOrderIsNotFound

ErrorPotentialOrderIsNotFound

400 ErrorRefundMethodIsNotValid

ErrorRefundMethodIsNotValid

POST /v1/return-cart/lines/_set-info

Метод передает список товаров с информацией о причинах возврата по каждому

Документация: https://confluence.app.local/pages/viewpage.action?pageId=990505663

Request body

application/json

Object

lines

Array of ReturnBasketLine required

Список товаров с информацией о причинах возврата

Responses

400 [DEP] CommonCartResponse

[DEP] CommonCartResponse

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorFileIsBad

ErrorFileIsBad

400 ErrorMaxFilesLimitExceeded

ErrorMaxFilesLimitExceeded

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

GET /v2/return-cart

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1060335825

Responses

400 ReturnCartResponse

Возвращает модель корзины возврата

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

POST /v2/return-cart/receiver

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1060335916

Request body

application/json

Object

fio

string required

ФИО получателя

Example:

Иванов Иван Иванович

string required

Email получателя

Min length: 255

Pattern: ^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+\.)+[a-zA-Z0-9-]+$

Example:

iiivanov_00@sportaster.ru

phone

Phone required

Responses

400 ReturnCartResponse

Возвращает модель корзины возврата

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorFieldValidation

ErrorFieldValidation

POST /v2/return-cart/potential-order/refund-methods

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1060335895

Request body

application/json

Object

refundMethods

Array of RefundMethodShort

Способы возврата денежных средств

Responses

400 ReturnCartResponse

Возвращает модель корзины возврата

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorPotentialOrderIsNotFound

ErrorPotentialOrderIsNotFound

400 ErrorRefundMethodIsNotValid

ErrorRefundMethodIsNotValid

POST /v2/return-cart/lines/_set-info

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1060335852

Request body

application/json

Object

lines

Array of ReturnBasketLine required

Список товаров с информацией о причинах возврата

Responses

400 ReturnCartResponse

Возвращает модель корзины возврата

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorFileIsBad

ErrorFileIsBad

400 ErrorMaxFilesLimitExceeded

ErrorMaxFilesLimitExceeded

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

POST /v1/return-cart/submit

Документация: https://confluence.app.local/pages/viewpage.action?pageId=990505707

Request body

application/json

Object

cartVersion

integer required

Параметр нужен, чтобы пользователь оформил ту версию корзины, что видел.

Responses

400 SubmitCartResponse

SubmitCartResponse

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorBasketVersionIsNotValid

ErrorBasketVersionIsNotValid

400 ErrorRefundMethodIsRequired

ErrorRefundMethodIsRequired

400 ErrorReturnReasonIsRequired

ErrorReturnReasonIsRequired

400 ErrorPotentialOrderIsRequired

ErrorPotentialOrderIsRequired

400 ErrorOwnerDataIsRequired

ErrorOwnerDataIsRequired

POST /v1/return-cart/obtain-point/to-shop

Документация: https://confluence.app.local/pages/viewpage.action?pageId=990505910

Request body

application/json

Object

shopNumber

string required

Номер магазина

Example:

898

Responses

400 [DEP] CommonCartResponse

[DEP] CommonCartResponse

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

POST /v2/return-cart/obtain-point/to-shop

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1060335800

Request body

application/json

Object

shopNumber

string required

Номер магазина

Example:

898

Responses

400 ReturnCartResponse

Возвращает модель корзины возврата

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

400 ErrorRefundIsNotAvailable

ErrorRefundIsNotAvailable

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

POST /v1/return-cart/_get-drop-off-delivery-points

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1031241995

Request body

application/json

Object

cartItemIds

Array of CartItemIdWithLines required

Responses

400 DropOffDeliveryPointAvailabilityResponse

DropOffDeliveryPointAvailabilityResponse

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorExternalPickupAvailability

ErrorExternalPickupAvailability

POST /v1/return-cart/obtain-point/to-delivery-point

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1031262159

Request body

application/json

Object

pickpointId

string required

id выбранного ПВЗ

cartItemIds

Array of CartItemIdWithLines required

Выбранные товары

Responses

400 [DEP] CommonCartResponse

[DEP] CommonCartResponse

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorExternalPickupAvailability

ErrorExternalPickupAvailability

POST /v2/return-cart/obtain-point/to-delivery-point

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1060335884

Request body

application/json

Object

pickpointId

string required

id выбранного ПВЗ

cartItemIds

Array of CartItemIdWithLines required

Выбранные товары

Responses

400 ReturnCartResponse

Возвращает модель корзины возврата

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorExternalPickupAvailability

ErrorExternalPickupAvailability

POST /v1/return-cart/obtain-point/to-courier

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1039882918

Request body

application/json

Object

cartItemIds

Array of CartItemIdWithLines required

Выбранные товары

receivingAddressInfo

ReceivingAddressInfo required

Responses

400 [DEP] CommonCartResponse

[DEP] CommonCartResponse

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorLocationIsNotMatch

Ошибка, возвращаемая если координаты в x-location не совпадают с координатами в receivingAddress.

400 ErrorHouseIsNull

POST /v1/return-cart/obtain-point/_set-date-time

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1047436031

Request body

application/json

Object

receivingDateFrom

DateOnly required

receivingDateTo

DateOnly

receivingTimeSlot

string required

Временной интервал возврата

receivingTimeSlotId

integer required

ID временного слота возврата

Responses

400 [DEP] CommonCartResponse

[DEP] CommonCartResponse

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorDateTimeReceiptAreOutdated

ErrorDateTimeReceiptAreOutdated

400 ErrorExternalPickupAvailability

ErrorExternalPickupAvailability

POST /v2/return-cart/obtain-point/to-courier

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1060335784

Request body

application/json

Object

cartItemIds

Array of CartItemIdWithLines required

Выбранные товары

receivingAddressInfo

ReceivingAddressInfo required

Responses

400 ReturnCartResponse

Возвращает модель корзины возврата

400 ErrorSomeBasketLinesIsNotFound

ErrorSomeBasketLinesIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorLocationIsNotMatch

Ошибка, возвращаемая если координаты в x-location не совпадают с координатами в receivingAddress.

400 ErrorHouseIsNull

POST /v2/return-cart/obtain-point/_set-date-time

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1060335926

Request body

application/json

Object

receivingDateFrom

DateOnly required

receivingDateTo

DateOnly

receivingTimeSlot

string required

Временной интервал возврата

receivingTimeSlotId

integer required

ID временного слота возврата

Responses

400 ReturnCartResponse

Возвращает модель корзины возврата

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorObtainingMethodIsNotValid

ErrorObtainingMethodIsNotValid

400 ErrorDateTimeReceiptAreOutdated

ErrorDateTimeReceiptAreOutdated

400 ErrorExternalPickupAvailability

ErrorExternalPickupAvailability

GET /v1/return-orders

Документация: https://confluence.app.local/pages/viewpage.action?pageId=990500233

Request parameters

filterId

string optional

Айди фильтра. Если не передан, то возвращаюстя все возвраты

Responses

400 ReturnHistoryResponse

ReturnHistoryResponse

400 ErrorAnonymUser

ErrorAnonymUser

GET /v1/return-orders/{returnCode}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=990494522

Path variables

returnCode

string required

Responses

400 ReturnResponse

ReturnResponse

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

POST /v1/return-orders/{returnCode}/_cancel

Документация: https://confluence.app.local/pages/viewpage.action?pageId=990505931

Path variables

returnCode

string required

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorOrderIllegalAction

ErrorOrderIllegalAction

POST /v1/return-orders/{returnCode}/_start-quarrel

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1053348211

Path variables

returnCode

string required

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorOrderIllegalAction

ErrorOrderIllegalAction

GET /v1/service-cart

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1039861866

Responses

400 ServiceCartResponse

Возвращает модель корзины услуг

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

POST /v1/service-cart

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1019159326

Request body

application/json

Object

serviceList

Array of ServiceInCart required

Список услуг, которые нужно добавить в новую корзину

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorServiceIsNotFound

ErrorServiceIsNotFound

400 ErrorServicesCategoryMismatch

ErrorServicesCategoryMismatch

400 ErrorTooManyServicesInBasket

ErrorTooManyServicesInBasket

POST /v1/service-cart/promo

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1025431220

Request body

application/json

Object

promoCode

string required

Промокод, который нужно применить

Responses

400 ServiceCartResponse

Возвращает модель корзины услуг

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorPromocodeIsNotValid

ErrorPromocodeIsNotValid

DELETE /v1/service-cart/promo

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1025431218

Responses

400 ServiceCartResponse

Возвращает модель корзины услуг

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

POST /v1/service-cart/_apply-bonuses

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1039859725

Request body

application/json

Object

applyBonuses

boolean required

Списывать или нет бонусы при оформлении корзины

Example:

true

Responses

400 ServiceCartResponse

Возвращает модель корзины услуг

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorAnonymUser

ErrorAnonymUser

POST /v1/service-cart/receiver

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1039860022

Request body

application/json

Object

fio

string required

ФИО получателя

string required

Email получателя

phone

Phone

verificationToken

string

Передается только для анонима.

Responses

400 ServiceCartResponse

Возвращает модель корзины услуг

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorPhoneInBasket

GET /v1/service-cart/_service-center-availability

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1039860732

Responses

400 ServiceCenterAvailabilityResponse

ServiceCenterAvailabilityResponse

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

POST /v1/service-cart/obtain-point/to-service-center

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1039860821

Request body

application/json

Object

serviceCenterId

string required

Номер сервисного центра

Example:

117

cartItemIds

CartItemIdWithLines required

Responses

400 ServiceCartResponse

Возвращает модель корзины услуг

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorServiceIsNotFound

ErrorServiceIsNotFound

400 ErrorServiceCenterIsNotAvailable

ErrorServiceCenterIsNotAvailable

POST /v1/service-cart/obtain-point/_set-date-time

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1039868309

Request body

application/json

Object

availDate

DateOnly required

timeSlot

string required

Выбранное время начала оказания услуг

Example:

10:00

Responses

400 ServiceCartResponse

Возвращает модель корзины услуг

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorSomeServicesAreUnavailable

Ошибка, которая возникает, когда одна или несколько услуг не доступны

400 ErrorServicesExceedMaxDuration

400 ErrorSelectedDateIsUnavailable

Ошибка, которая возникает, когда выбранная пользователем дата стала недоступна

400 ErrorSelectedTimeIsUnavailable

Ошибка, которая возникает, когда выбранное пользователем время стало недоступно

GET /v1/service-cart/order/payment-methods

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1034096328

Responses

400 PaymentMethodsResponse2

PaymentMethodsResponse2

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

POST /v1/service-cart/order/payment-methods

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1025426658

Request body

application/json

Object

paymentMethodId

string required

Берется из модели метода оплаты. Фактически это значение энама

Responses

400 ServiceCartResponse

Возвращает модель корзины услуг

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorObtainPointIdIsNotFound

ErrorObtainPointIdIsNotFound

400 ErrorPaymentMethodIsNotValid

ErrorPaymentMethodIsNotValid

400 ErrorTotalCostBelowThreshold

Когда был выбран способ оплаты, у которого минимальная сумма заказа превышает фактическую сумму

POST /v1/service-cart/submit

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1025434396

Request body

application/json

Object

cartVersion

integer required

Параметр нужен, чтобы пользователь оформил ту версию корзины, что видел.

agreeToReceiveNews

boolean

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

Responses

400 SubmitCartResponse

SubmitCartResponse

400 ErrorBasketIsEmpty

Ошибка, которая возникает, когда корзина оказалась пустой

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

400 ErrorActionIsNotAvailable

ErrorActionIsNotAvailable

400 ErrorBasketVersionIsNotValid

ErrorBasketVersionIsNotValid

400 ErrorPotentialOrderIsRequired

ErrorPotentialOrderIsRequired

400 ErrorOwnerDataIsRequired

ErrorOwnerDataIsRequired

400 ErrorPaymentMethodIsRequired

ErrorPaymentMethodIsRequired

400 ErrorServicesExceedMaxDuration

400 ErrorSelectedDateTimeIsUnavailable

Ошибка, которая возникает, когда выбранные пользователем дата и время стали недоступны

GET /v1/edit-cart

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1101334582

Responses

400 EditCartResponse

Возвращает модель корзины редактирования

400 ErrorEditingIsNotAvailable

ErrorEditingIsNotAvailable

POST /v1/edit-cart/lines/_set-quantity

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1106347159

Request body

application/json

Object

CartItemIdWithLines

quantity

integer required

Количество товара, которое должно стать в корзине

Responses

400 EditCartResponse

Возвращает модель корзины редактирования

400 ErrorBasketState

ErrorBasketState

400 ErrorTooManyLinesInBasket

ErrorTooManyLinesInBasket

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

POST /v1/edit-cart/lines/_delete

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1106347222

Request body

application/json

Object

ids

Array of CartItemIdWithLines required

Responses

400 EditCartResponse

Возвращает модель корзины редактирования

400 ErrorBasketState

ErrorBasketState

400 ErrorLinesAreNotFound

ErrorLinesAreNotFound

POST /v1/edit-cart/lines/_hide-deleted

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1106347363

Request body

application/json

Object

CartItemIdWithLines

Responses

400 EditCartResponse

Возвращает модель корзины редактирования

400 ErrorBasketState

ErrorBasketState

400 ErrorDeletedLinesAreNotFound

ErrorDeletedLinesAreNotFound

POST /v1/edit-cart/lines/_restore-deleted

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1106347406

Request body

application/json

Object

CartItemIdWithLines

Responses

400 EditCartResponse

Возвращает модель корзины редактирования

400 ErrorBasketState

ErrorBasketState

400 ErrorRestoredItemIfNotFound

ErrorRestoredItemIfNotFound

POST /v1/edit-cart/_submit

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1106347521

Request body

application/json

Object

cartVersion

integer required

Параметр нужен, чтобы пользователь оформил ту версию корзины, что видел.

Responses

400 SubmitEditCartResponse

SubmitEditCartResponse

400 ErrorBasketVersionIsNotValid

ErrorBasketVersionIsNotValid

400 ErrorBasketState

ErrorBasketState

400 ErrorPotentialOrderIsRequired

ErrorPotentialOrderIsRequired

400 ErrorOwnerDataIsRequired

ErrorOwnerDataIsRequired

400 ErrorPaymentMethodIsRequired

ErrorPaymentMethodIsRequired

POST /v1/edit-order/_cancel

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1106369277

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorOrderIllegalAction

ErrorOrderIllegalAction

400 ErrorOrderIllegalAccess

ErrorOrderIllegalAccess

GET /profile

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489465075

Responses

400 ProfileResponse

ProfileResponse

PATCH /profile

Меняются только те поля, что были переданы

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489465099

Request body

application/json

Object

anketa

Anketa

string

addSportsman

AddSportsman

agreeToSubscriptions

boolean

Подписка пользователя на email-расссылку. Параметр может приходить только с экрана изменения почты!

agreeGetReceipts

boolean

Подписка пользователя на получение эл. чеков. Параметр может приходить только с экрана изменения почты!

Example:

true

agreements

Agreements

Responses

400 ProfileResponse

ProfileResponse

400 ErrorFieldValidation

ErrorFieldValidation

400 ErrorGateException

400 ErrorInvitationNotExist

Код приглашения некорректный

400 ErrorEmailValidation

Бизнес-ошибка валидации email со стороны гейта

400 ErrorLimitForSportsmanExceeded

Возвращается, когда для спортсмена исчерпан лимит смены вида спорта

GET /v1/profile/client-labels

Документация - https://confluence.app.local/pages/viewpage.action?pageId=734873971

Responses

400 ClientLabelsResponse

ClientLabelsResponse

POST /profile/deleteAccount

Документация https://confluence.app.local/pages/viewpage.action?pageId=526180270

Request body

application/json

Object

name

string required

Имя пользователя

lastName

string

Фамилия Пользователя

phone

string required

Телефон пользователя

string required

Электронная почта

Responses

400 AuthResponse

AuthResponse

400 ErrorFieldValidation

ErrorFieldValidation

POST /profile/changePhone

Номер берется из токена, который выдали механизм подтверждения номера телефона.

Для БЭ: Изменение номера происходит через http://rest-app.usergatetst.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=/v3/api/openapi.yml#/Anketa/changeLogins

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489465101

Request body

application/json

Object

token

string required

Номер, выданный при подверждении действия смской

Responses

400 ProfileResponse

ProfileResponse

400 ErrorFieldValidation

ErrorFieldValidation

400 ErrorPhoneAlreadyUsed

Ошибка, возвращаемая из BFF, когда при смене номера телефона уже существует профиль с таким номером

POST /profile/_change-phone-with-logout

Производится смена номера телефона с разлогином со всех устройств (номер берется из токена, который был получен при подтверждении номера)

Документация - https://confluence.app.local/pages/viewpage.action?pageId=889128598

Request body

application/json

Object

token

string required

Токен, полученный в результате подтверждения номера телефона (по токену определяем номер телефона и используем для смены логина)

Responses

400 AuthResponse

AuthResponse

400 ErrorGateException

400 ErrorPhoneAlreadyUsed

Ошибка, возвращаемая из BFF, когда при смене номера телефона уже существует профиль с таким номером

POST /profile/sendEmailForConfirmation

Документация: https://confluence.app.local/pages/viewpage.action?pageId=626603703

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorEmailValidation

Бизнес-ошибка валидации email со стороны гейта

POST /profile/avatar

Multipart запрос.

В User Gate нет работы с аватарами, этим должен заниматься наш бекенд

Документация: -

Request body

multipart/form-data

Object

avatar

string

Обрати внимание, что это не String, а File. В спеке нету такого

Responses

400 ProfileResponse

ProfileResponse

DELETE /profile/avatar

Multipart запрос

Документация: -

Responses

400 ProfileResponse

ProfileResponse

POST /profile/pushToken

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489465105

Request body

application/json

Object

pushToken

string required

pushService

string required

Enumeration:

apns

fcm

hms

Responses

400 EmptyResponse

Пустой ответ сервера

GET /profile/id

Получить айди и тип профиля (гость / авторизованный)

Документация: -

Responses

400 ProfileIdResponse

ProfileIdResponse

GET /profile/userGateToken

Authentication

Access token

Документация (до анонимов): https://confluence.app.local/pages/viewpage.action?pageId=478283543

Документация (после анонимов): https://confluence.app.local/pages/viewpage.action?pageId=570006207

Responses

400 UserGateTokenResponse

UserGateTokenResponse

POST /v2/profile/banners

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721044639

Responses

400 ProfileBannersResponse

ProfileBannersResponse

GET /profile/banners

DEPRECATED: версия 4.40.0 - 25.09 - 06.10

Документация: https://confluence.app.local/pages/viewpage.action?pageId=558308608

Responses

400 ProfileBannersResponse

ProfileBannersResponse

GET /v1/info/callCenterPhone

Документация: https://confluence.app.local/pages/viewpage.action?pageId=581543918

Responses

400 CallcenterPhoneResponse

CallcenterPhoneResponse

GET /v1/info/socials

Документация: https://confluence.app.local/pages/viewpage.action?pageId=581548688

Responses

400 SocialsResponse

SocialsResponse

POST /v1/profile/checkClubProId

Документация https://confluence.app.local/pages/viewpage.action?pageId=785654027

Request body

application/json

Object

clubProId

string

Значение clubpro_id из постоянной памяти МП

userGateUid

string

Значение profileId в памяти МП

Responses

400 CheckClubProResponse

CheckClubProResponse

GET /profile/filledInfo

Возвращается информация о заполненности профиля для экрана QR-кода

Документация - https://confluence.app.local/pages/viewpage.action?pageId=884240714

Responses

400 ProfileFilledInfoResponse

ProfileFilledInfoResponse

400 ErrorGateException

POST /v1/profile/_check-user-gate-uid-and-club-pro-id

Документация https://confluence.app.local/pages/viewpage.action?pageId=899439555

Request body

application/json

Object

clubProId

string

Значение clubpro_id из постоянной памяти МП

userGateUid

string

Значение profileId в памяти МП

Responses

400 CheckUserGateUidAndClubProIdResponse

CheckUserGateUidAndClubProIdResponse

GET /city/popular

Данные берутся из CmsGate

Метод https://confluence.app.local/display/CMSGATE/(API)+SEARCH-REGISTRY#tab-Сигнатура

slots = frontoffice_top_cities (если не выйдет, то попробовать popular_locality) скрин http://joxi.ru/zANGkg7i8o0BJr

consumer = любое значение, легаси

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062317

Responses

400 CitiesResponse

CitiesResponse

GET /city

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062320

Работает через Geogate POST /territories/search Поиск НП, улиц, домов

Читать это https://confluence.app.local/display/GEOGATE/(API)+SEARCH-TERRITORIES#tab-Логика

template - наш query
searchType - PREFIX_WORDS (?) см https://confluence.app.local/pages/viewpage.action?pageId=304773953
receivingMethods - все доступные см https://confluence.app.local/pages/viewpage.action?pageId=307992676
searchLevel - SETTLEMENT см https://confluence.app.local/pages/viewpage.action?pageId=300298652

Request parameters

query

string required

Строка поиска города

Responses

400 CitiesResponse

CitiesResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

GET /city/coord

Документация: https://confluence.app.local/pages/viewpage.action?pageId=541899378

Request parameters

lat

number required

lng

number required

Responses

400 CityResponse

CityResponse

GET /city/{cityId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=541159078

Path variables

cityId

string required

Responses

400 CityResponse

CityResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

GET /city/ip

В настоящий момент метод нигде не используется МП. Предположительно создавался для тестирования.

Документация: -

Responses

400 CityResponse

CityResponse

GET /geo/street

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062326

Request parameters

query

string required

cityId

string required

Responses

400 StreetsResponse

StreetsResponse

GET /geo/house

Документация: https://confluence.app.local/pages/viewpage.action?pageId=581052152

Request parameters

query

string required

streetId

string required

Responses

400 HousesResponse

HousesResponse

GET /city/{cityId}/metro

Для БЭ: http://rest-app.geogate-uat.k8s-dev.gksm.local/swagger-ui/index.html?url=../openapi.json#/territory/GetTerritoryMetros Возвращает пустой массив, если в городе нет метро

Документация: https://confluence.app.local/pages/viewpage.action?pageId=621833488

Path variables

cityId

string required

ID населенного пункта

Responses

400 MetroListResponse

MetroListResponse

GET /geo/address

Документация: https://confluence.app.local/pages/viewpage.action?pageId=661910838

Request parameters

query

string required

Строка поиска адреса

mode

AddressMode optional

Определение условия для поиска адреса.

Responses

400 AddressResponse

AddressResponse

GET /geo/geopoint

Документация: https://confluence.app.local/pages/viewpage.action?pageId=695267138

Request parameters

lat

number required

Широта

Example:

55.755864

lng

number required

Долгота

Example:

37.617698

Responses

400 AddressResponse

AddressResponse

GET /geo/suggest

Получить подсказки адресов из сервиса Яндекс Геосаджест

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677944629

Request parameters

query

string required

Строка поиска адреса

lat

number optional

Широта

Example:

59.988343

lng

number optional

Долгота

Example:

30.322345

Responses

400 GeoSuggestResponse

GeoSuggestResponse

POST /v1/geo/geo-fences

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721053717

Request body

application/json

Object

locationUpdate

OffsetDateTime

location

Location required

Responses

400 GeoFencesResponse

Массив геозон

POST /v1/geo/location

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721059559

Request body

application/json

Object

location

Location required

Responses

400 EmptyResponse

Пустой ответ сервера

GET /v1/geo/getAddressByLocation

Преобразует сохраненное местоположение пользователя из шапки (location) в адрес по структуре Яндекса для геозон. Для преобразования использует координаты location.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=793221628

Responses

400 AddressDecodeResponse

AddressDecodeResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /auth/anonym

Подумать: можно ли как-то проверять по девайс айди созданные аккаунты и позвращать уже готовые? Чтобы не плодить новые

Город пытаться определить по айпи, если не получается, то ставить Москву.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062663

Request body

application/json

Object

deviсe

Device required

aid

string

Идентификатор анонимного пользователя / идентификатор установки в UserGate

Передается, если ранее локально был сохранен. Если передан, бэк не должен создавать нового анонима

Example:

2be20f48-46ed-46c8-9232-2ceae1bd693e

Responses

400 AuthResponse

AuthResponse

POST /auth/isPhoneExists

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062665

Request body

application/json

Object

token

string required

Токен, полученный при подтверждении номера телефона

Responses

400 IsPhoneExistsResponse

IsPhoneExistsResponse

400 ErrorIncorrectUserType

Ошибка, которая возвращается, если авторизоваться пытается уже авторизованный пользователь.

POST /auth/isSocialNetworkExists

Бекенд по переданному токену должен получить нужные ему данные и методом

UserGate POST /profiles/_find-by-login Поиск профиля по логину

найти профиль, передав туда loginValue и loginType соотвествующей соцсети.

Если удается найти аккаунт по данной соцсети, нужно проверить, есть ли у данного аккаунта номер телефона методом UserGate GET /profiles/{profileId}/logins

и если номер есть, то вернуть true.

В остальных случаях вернуть false.

Итого: true возвращается, если по данной соцсети удается найти профиль и у данного профиля есть логин в виде телефона.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062667

Request body

application/json

Object

network

SocialNetworkType

token

string required

Токен, полученный при авторизации в социальной сети

Responses

400 IsSocialNetworkExistsResponse

IsSocialNetworkExistsResponse

400 ErrorIncorrectUserType

Ошибка, которая возвращается, если авторизоваться пытается уже авторизованный пользователь.

POST /auth/signInBySms

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

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062670

Request body

application/json

Object

token

string required

Токен, полученный при подверждении номера телефона

referrerCode

string

Код реферера

Example:

100000000000000000

Responses

400 AuthResponse

AuthResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorProccess

ErrorProccess

400 ErrorAuth

ErrorAuth

400 ErrorIncorrectUserType

Ошибка, которая возвращается, если авторизоваться пытается уже авторизованный пользователь.

POST /auth/signUpBySms

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

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062673

Request body

application/json

Object

token

string required

Токен, полученный при подверждении номера телефона

name

string required

Имя пользователя

unconfirmedEmail

string

Email пользователя

agreeToSubscriptions

boolean required

Согласие пользователя на рассылку

addSportsman

AddSportsman

referrerCode

string

Код реферера

Example:

100000000000000000

Responses

400 AuthResponse

AuthResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorInvitationNotExist

Код приглашения некорректный

400 ErrorProccess

ErrorProccess

400 ErrorAuth

ErrorAuth

400 ErrorIncorrectUserType

Ошибка, которая возвращается, если авторизоваться пытается уже авторизованный пользователь.

400 ErrorEmailValidation

Бизнес-ошибка валидации email со стороны гейта

400 ErrorLimitForSportsmanExceeded

Возвращается, когда для спортсмена исчерпан лимит смены вида спорта

POST /auth/signInBySocialNetwork

После авторизации мержить данные из временного пользователя. В т.ч. корзину

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062675

Request body

application/json

Object

token

string required

Токен, полученный при авторизации через соцсеть

network

SocialNetworkType required

referrerCode

string

Код реферера

Example:

100000000000000000

Responses

400 AuthResponse

AuthResponse

400 ErrorAuthByNetworkResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorProccess

ErrorProccess

400 ErrorAuth

ErrorAuth

400 ErrorIncorrectUserType

Ошибка, которая возвращается, если авторизоваться пытается уже авторизованный пользователь.

POST /v2/auth/signUpBySocialNetwork

После регистрации мержить данные из временного пользователя. В т.ч. корзину.

Может быть ситуация, когда аккаунт не зарегистрирован по социальной сети, но зарегистрирован по номеру телефона. В таком случае нужно привязать к существующему аккаунту по номеру телефона аккаунт социальной сети (метод POST /profiles/{profileId}/logins Изменение Login'ов профиля (CHANGE-LOGINS))

Может быть ситуация, когда аккаунт был зарегистрирован через социальную сеть, но у него не было номера телефона. В этом случае уже нужно подвязать номер телефона к аккаунту.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062677

Request body

application/json

Object

networkToken

string required

Токен, полученный от соцсети при авторизации в ней

networkType

SocialNetworkType required

smsToken

string

Токен, полученный при подверждении номера телефона

name

string required

Имя пользователя

agreeToSubscriptions

boolean required

Согласие пользователя на рассылку

referrerCode

string

Код реферера

Example:

100000000000000000

Responses

400 AuthResponse

AuthResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorProccess

ErrorProccess

400 ErrorAuth

ErrorAuth

400 ErrorIncorrectUserType

Ошибка, которая возвращается, если авторизоваться пытается уже авторизованный пользователь.

400 ErrorLimitForSportsmanExceeded

Возвращается, когда для спортсмена исчерпан лимит смены вида спорта

POST /auth/refresh

Токены можно перевыпустить только для того девайса, с которого выдавались прошлые

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494228050

Request body

application/json

Object

refreshToken

string required

deviceId

string required

Айди девайса, который передавали при создании анонимного пользователя

Responses

400 RefreshTokenResponse

RefreshTokenResponse

400 ErrorRefreshToken

Передали невалидный/отозванный рефреш токен

400 ErrorProccess

ErrorProccess

POST /auth/logout

Делается разлогин пользователя.

При этом на беке создается анонимный пользователь.

Беку не забыть отвязывать пуш токены

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062679

Responses

400 AuthResponse

AuthResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorProccess

ErrorProccess

400 ErrorLogout

ErrorLogout

POST /auth/logout/all/

Делается разлогин пользователя.

При этом на беке создается анонимный пользователь.

Беку не забыть отвязывать пуш токены

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1025419496

Responses

400 AuthResponse

AuthResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorProccess

ErrorProccess

400 ErrorLogout

ErrorLogout

POST /auth/exchangeSilentAuthTokenVK

DEPRECATED: версия 4.53 в рамках MPSM-8413

Документация: https://confluence.app.local/pages/viewpage.action?pageId=552899602

Request body

application/json

Object

silentToken

string required

Токен, полученный при авторизации через VK ID

uuid

string required

uuid, полученный при авторизациии через VK ID

Responses

400 ExchangeSilentTokenResponse

ExchangeSilentTokenResponse

400 ErrorExchangeSilentToken

Ошибка обмена silent token на access token при регистрации через VK ID

POST /auth/attachSocialNetwork

Документация: https://confluence.app.local/pages/viewpage.action?pageId=797611593

Request body

application/json

Object

token

string required

Токен, полученный при авторизации через соцсеть

socialNetwork

SocialNetworkType required

Responses

400 EmptyResponse

Пустой ответ сервера

400 400

Ошибка, когда профиль ВК уже привязан к другому аккаунту СМ

Body

application/json

Object

data

Object

message

string required

Enumeration:

Данный профиль ВК уже привязан к другому аккаунту

code

string required

Enumeration:

TEXT_ERROR

GET /auth/sber/_generate-parameters

Документация - https://confluence.app.local/pages/viewpage.action?pageId=922337026

Responses

400 GenerateParametersResponse

GenerateParametersResponse

POST /auth/sber/token

Документация: https://confluence.app.local/pages/viewpage.action?pageId=922337042

Request body

application/json

Object

state

string required

Сгенерированное значение для предотвращения подделки межсайтовых запросов

authCode

string required

Код авторизации

codeVerifier

string required

Параметр безопасности

Responses

400 SberTokenResponse

SberTokenResponse

400 ErrorSberToken

Ошибка получения кода доступа в Сбер API

GET /v2/promocode

DEPRECATED с версии 4.63

Документация: https://confluence.app.local/pages/viewpage.action?pageId=519704792

Responses

400 PromoCodesResponse

PromoCodesResponse

GET /v1/promo

Метод для получения единого списка промокодов и бонусов пользователя

Документация - https://confluence.app.local/pages/viewpage.action?pageId=903302808

Responses

400 PromoResponse

PromoResponse

400 ErrorGateException

GET /appeal/types

Authentication

Access token

http://rest-app.usergateuat.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=/v3/api/openapi.yml#/Appeal/getAppealSubjects

Берутся уникальные значения по appealTypeCode

Документация: https://confluence.app.local/pages/viewpage.action?pageId=435922271 DEP в рамках MPSM-11965

Responses

400 AppealTypeListResponse

AppealTypeListResponse

GET /appeal/types/{code}

Authentication

Access token

http://rest-app.usergateuat.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=/v3/api/openapi.yml#/Appeal/getAppealSubjects

Фильтрация по code

Документация: https://confluence.app.local/pages/viewpage.action?pageId=435922289 DEP в рамках MPSM-11965

Path variables

code

string required

Код типа обращения

Responses

400 AppealTypeResponse

AppealTypeResponse

400 ErrorAppealTypeNotFound

ErrorAppealTypeNotFound

400 ErrorGateException

POST /appeal/create

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494214381 DEP в рамках MPSM-11965

Request body

application/json

Object

appealCode

string required

Код типа обращения

subjectId

string required

Идентификатор темы обращения

name

string required

Имя

phone

string required

Номер телефона

string required

Электронная почта

orderNumber

string

Номер заказа

message

string required

Сообщение

sendToManager

boolean

Отправить руководителю клиентской службы (да или нет). Отправляется только с типом “Жалоба”

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorFieldValidationPhoneGate

Не прошла валидация телефона на гейте

POST /v2/appeal

Документация - https://confluence.app.local/pages/viewpage.action?pageId=915232726

Request body

application/json

Object

firstName

string required

Имя пользователя

lastName

string required

Фамилия пользователя

phone

string required

Номер телефона пользователя

string required

Email пользователя

appealThematicsId

string required

Идентификатор тематики обращения

Example:

1720920299

appealTypeId

string required

Идентификатор типа обращения

Example:

1720920299

needFeedback

boolean required

Признак, что нужна обратная связь

message

string required

Текст сообщения

orderNumber

string

Номер заказа

Example:

57007-218389

shopNumber

string

Номер магазина

Example:

5231

toCCDirector

boolean required

Признак, что необходимо отправить руководителю КЦ

Responses

400 AppealResponse

AppealResponse

400 ErrorGateException

400 ErrorEmailValidation

Бизнес-ошибка валидации email со стороны гейта

POST /v3/appeal

Responses

400 default

default response

GET /appeal/thematics

Документация - https://confluence.app.local/pages/viewpage.action?pageId=915232724

Responses

400 AppealThematicListResponse

AppealThematicListResponse

400 ErrorGateException

GET /appeal/order-history

Документация - https://confluence.app.local/pages/viewpage.action?pageId=922331243

Responses

400 AppealOrderHistoryResponse

AppealOrderHistoryResponse

GET /bonus/history

Построено на запросе http://rest-app.usergatetst.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=/v3/api/openapi.yml#/ClubPro/getBonusHistory

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494231901

Request parameters

dateBegin

DateOnly required

Дата начала периода. Она должна быть раньше даты конца

dateEnd

DateOnly required

Дата окончания периода. Она должна быть позже (ближе к текущему дню) даты конца

filterId

string optional

Фильтр по семейным и личным бонусам. Если не передан, то возвращаются все транзации

Enumeration:

PERSONAL

FAMILY_WITHOUT_PERSONAL

Responses

400 BonusHistoryResponse

BonusHistoryResponse

GET /v2/bonus/shortInfo

Информация о текущем статусе в клубной программе и текуший баланс бонусов с детализацией по типам и датой сгорания.

Объект в основном формируется из http://rest-app.usergatetst.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=/v3/api/openapi.yml#/ClubPro/checkBalance

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494231924

Responses

400 BonusShortInfoResponse

BonusShortInfoResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

GET /bonus/progress

Данные о текущем уровне, сколько до следующего уровня, сумма общих покупок и т.п. Запрос строится на http://rest-app.usergatetst.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=/v3/api/openapi.yml#/ClubPro/getCP

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494231942

Responses

400 BonusProgressResponse

BonusProgressResponse

POST /bonus/activateBonuses

Документация: https://confluence.app.local/pages/viewpage.action?pageId=621830394

Request parameters

accrualCode

string required

Код активации

Responses

400 EmptyResponse

Пустой ответ сервера

GET /bonus/detailsByType

Информация о сроках начисления и сгорания бонусов, распределённая по типам «Кешбэк» и «Промо»

Объект формируется из http://rest-app.usergate-uat-ru.k8s-dev.gksm.local/swagger-ui/index.html?url=/v3/api/openapi.yml#/ClubPro/getBonusDetailsForPeriod

Документация: https://confluence.app.local/pages/viewpage.action?pageId=816375704

Request parameters

dateBegin

DateOnly required

Дата начала периода

dateEnd

DateOnly required

Дата окончания периода

Responses

400 BonusDetailsByTypeResponse

BonusDetailsByTypeResponse

GET /bonus/details

Детальная информация про условия бонусов: на что можно потратить, кол-во бонусов, дата сгорания, где можно списать

Объект формируется из http://rest-app.usergate-uat-ru.k8s-dev.gksm.local/swagger-ui/index.html?url=/v3/api/openapi.yml#/ClubPro/getBonusDetailsForPeriod

Документация: https://confluence.app.local/pages/viewpage.action?pageId=936085430

Request parameters

dateBegin

DateOnly required

Дата начала периода

dateEnd

DateOnly required

Дата окончания периода

Responses

400 BonusDetailsResponse

BonusDetailsResponse

GET /bonus/detailsByDay

DEPRECATED: версия 4.51

Сколько бонусов будет в какой день.

Построено на http://rest-app.usergatetst.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=/v3/api/openapi.yml#/ClubPro/getBonusDetailsForPeriod.

БЭ должен самостоятельно сделать разбивку по дням. Для всех рассчетов нам нужны поля:

summa - сколько бонусов осталось по этому начислению. Если тут 0, то считается, что данная ячейка бонусов полностью израсходована.
dateBegin - дата, скоторой эти бонусы есть, начислены
dateEnd - дата, когда эти бонусы сгорят.

Алгоритм примерно такой - берем период и считаем, что в каждом дне этого периода есть summa бонусов. И таким образом складываем по всем айтемам из ответа суммы по дням и получаем ответ, который нужен мобильному приложению.

Задавал такой вопрос:

если запрошу бонусы за 25-27 мая, то в ответе мне придет сущность, которая была начислена 1 мая, а сгорит 30 мая? Ответ: придет

Для истории:

amount - количество начисленных бонусов
summa - количество бонусов, которые еще не потратили

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494231917

Request parameters

dateBegin

Date required

Дата начала периода

dateEnd

Date required

Дата окончания периода

Responses

400 [DEP] BonusDetailsResponse

[DEP] BonusDetailsResponse

GET /bonus/getAvailableBonusForActivation

DEPRECATED с версии 4.63

Документация: https://confluence.app.local/pages/viewpage.action?pageId=621825173

Responses

400 [DEP] BonusCouponsResponse

Массив бонусных акций

GET /v1/bonus/qr-info

Документация: https://confluence.app.local/pages/viewpage.action?pageId=943257374

Responses

400 BonusQRInfoResponse

BonusQRInfoResponse

GET /v1/profile/receivingAddresses

Документация: https://confluence.app.local/pages/viewpage.action?pageId=736400274

Метод получения списка сохраненных адресов доставки пользователя В зависимости от фича тоггла геозон возвращает адреса доставки по 2 структурам: для города (deviveryAddress) и геозон (receivingAddress)

Responses

400 DeliveryAddressesResponse

DeliveryAddressesResponse

400 ErrorAnonymUser

ErrorAnonymUser

PUT /profile/deliveryAddresses/{deliveryAddressId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=621821089

Метод изменения адреса в списке сохраненных адресов доставки пользователя

В Request body передается один из двух объектов (deliveryAddressInfo или receivingAddressInfo) в зависимости от фича тоггла геозон

Path variables

deliveryAddressId

string required

Идентификатор адреса

Request body

application/json

Object

deliveryAddressInfo

DeliveryAddressInfo

receivingAddressInfo

ReceivingAddressInfo

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorMetroIdIsNotValid

ErrorMetroIdIsNotValid

DELETE /profile/deliveryAddresses/{deliveryAddressId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=621821070

Метод удаления адреса из списка сохраненных адресов доставки пользователя

Path variables

deliveryAddressId

string required

Идентификатор адреса

Responses

400 EmptyResponse

Пустой ответ сервера

POST /profile/deliveryAddresses

Документация: https://confluence.app.local/pages/viewpage.action?pageId=621821084

Метод добавление адреса в список сохраненных адресов доставки пользователя

В Request body передается один из двух объектов (deliveryAddressInfo или receivingAddressInfo) в зависимости от фича тоггла геозон

Request body

application/json

Object

deliveryAddressInfo

DeliveryAddressInfo

receivingAddressInfo

ReceivingAddressInfo

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorMetroIdIsNotValid

ErrorMetroIdIsNotValid

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorAddressAlreadyExists

Ошибка, если в профиле уже есть такой адрес доставки. Независимо есть или нет геозоны

GET /v1/profile/deliveryAddresses

Документация: https://confluence.app.local/pages/viewpage.action?pageId=621820860

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

Request parameters

territoryId

string optional

id населенного пункта для фильтрации (используется для корзины)

Responses

400 DeliveryAddressesResponse

DeliveryAddressesResponse

400 ErrorAnonymUser

ErrorAnonymUser

POST /notifications/markMessages

Документация https://confluence.app.local/pages/viewpage.action?pageId=519706807

Request body

application/json

Object

communicationCode

string

Код коммуникации. Если параметр не передавать, то все сообщения в профиле будут помечены как прочитанные. Поскольку коммуникации помечаются как прочитанные только при клике (нет массового выбора), то отправляем параметр по одному (не массив)

Responses

400 EmptyResponse

Пустой ответ сервера

GET /notifications/tabs

DEPRECATED, можно удалить, когда будет выпилен ФТ newMessageCenterEnabled

Метод для получения вкладок в шапке Центра уведомлений. В данный момент получаем список из нашего БД, в дальнейшем будем получать от гейта

Документация https://confluence.app.local/pages/viewpage.action?pageId=552914211

Responses

400 [DEP] NotificationTabsResponse

DEPRECATED, можно удалить, когда будет выпилен ФТ newMessageCenterEnabled

GET /v2/notifications/getMessages

Докуменатция https://confluence.app.local/pages/viewpage.action?pageId=519706819

Request parameters

offset

integer optional

limit

integer optional

slot

string optional

Раздел, по которому запрашиваются уведомления

Example:

"message_center_order_status"

Responses

400 GetMessagesResponse

GetMessagesResponse

GET /notifications/hasUnreadMessages

Документация https://confluence.app.local/pages/viewpage.action?pageId=519706840

Responses

400 HasUnreadMessagesResponse

HasUnreadMessagesResponse

GET /v1/notifications/sections

Метод возвращает список разделов для Центра уведомлений.

Документация https://confluence.app.local/pages/viewpage.action?pageId=1031245085

Responses

400 NotificationsSectionsResponse

NotificationsSectionsResponse

GET /cardPro/trainerInfo

Документация: https://confluence.app.local/pages/viewpage.action?pageId=851970763

Responses

400 TrainerInfoResponse

TrainerInfoResponse

GET /cardPro/sportsmanList

Документация: https://confluence.app.local/pages/viewpage.action?pageId=541154079

Responses

400 SportsmanListResponse

SportsmanListResponse

POST /cardPro/inviteSportsman

Документация: https://confluence.app.local/pages/viewpage.action?pageId=541154173

Request body

application/json

Object

sportsmanInvitationList

Array of SportsmanInvitation required

Данные спортсменов для отправки приглашения

Responses

400 SportsmanInvitationResponse

SportsmanInvitationResponse

400 ErrorGateException

DELETE /cardPro/deleteSportsman

Документация: https://confluence.app.local/pages/viewpage.action?pageId=541154285

Request body

application/json

Object

phone

string required

Телефон спортсмена

Example:

79000000000

invitationCode

string required

Код приглашения

Example:

100000000216263150

Responses

400 EmptyResponse

Пустой ответ сервера

POST /v1/cardPro/sportsman-invitation/validate

Документация - https://confluence.app.local/pages/viewpage.action?pageId=831763983

Request body

application/json

Object

invitationCode

string

Код приглашения Спортсмена

Responses

400 ValidateResponse

ValidateResponse

POST /v1/cardPro/trainer/docs/verify

Документация - https://confluence.app.local/pages/viewpage.action?pageId=881133329

По методу отправляется docUrl + vrowid или registryLink, не может быть оба варианта

Request body

application/json

Object

docUrl

string

Единая ссылка на документы тренера из МИР

Example:

https://mir-cd-uat.web.local/ea/faces/index?t oken=1EFB1C984511C286B2452598E097EA4DA2EF80B916A24909F39BA91E8F CEF5536D0E2CF7790C8A4A1A34C148971A8060FF8B45BC43347A960DB456366C76C99B

vrowid

string

Идентификатор загруженных документов

Example:

1484681

registryLink

string

Ссылка на реестр тренеров

Example:

https://www.mos.ru/coachregister/Home/Search?specializationIds=3

Responses

400 EmptyResponse

Пустой ответ сервера

POST /v1/cardPro/trainer/docs/upload

Документация - https://confluence.app.local/pages/viewpage.action?pageId=874804808

Request body

application/json

Object

trainerFiles

Array of TrainerFile required

Массив загружаемых документов тренера

Responses

400 UploadMirResponse

UploadMirResponse

GET /cardPro/trainer/sportKind

Документация - https://confluence.app.local/pages/viewpage.action?pageId=885885426

Responses

400 TrainerSportKindResponse

TrainerSportKindResponse

POST /v1/cardPro/individual-sportsman

Документация https://confluence.app.local/pages/viewpage.action?pageId=1068492936

Request body

application/json

Object

form

IndividualSportsmanForm required

sportKind

string required

Идентификатор вида спорта

advertisingAgreement

boolean

Согласие пользователя на рекламу

address

Address required

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorNotAvailableForEmployee

400 ErrorNotAvailableForFamilyMember

400 ErrorNotAvailableForIndividualSportsman

400 ErrorNotAvailableForSportsman

400 ErrorNotAvailableForTrainer

POST /v1/cardPro/trainer

Документация https://confluence.app.local/pages/viewpage.action?pageId=908644773

Request body

application/json

Object

form

TrainerForm required

document

TrainerDocuments required

sportKind

string required

Идентификатор вида спорта

agreeToSubscriptions

boolean

Согласие пользователя на рассылку

Responses

400 EmptyResponse

Пустой ответ сервера

GET /v1/cardPro/individual-sport-kinds

Документация - https://confluence.app.local/pages/viewpage.action?pageId=1068495722

Responses

400 SportKindsResponse

SportKindsResponse

GET /v1/cardPro/sport-kinds

Документация - https://confluence.app.local/pages/viewpage.action?pageId=908651731

Responses

400 SportKindsResponse

SportKindsResponse

GET /v1/cardPro/sportsman-info

Документация - https://confluence.app.local/pages/viewpage.action?pageId=929129858

Responses

400 SportsmanInfoResponse

SportsmanInfoResponse

GET /profile/subscriptions

Документация: https://confluence.app.local/pages/viewpage.action?pageId=558331355

Responses

400 SubscriptionsResponse

SubscriptionsResponse

400 ErrorGateException

POST /profile/subscriptions

Документация: https://confluence.app.local/pages/viewpage.action?pageId=558331448

Request body

application/json

Object

subscriptions

Array of Subscription required

Responses

400 SubscriptionResponse

SubscriptionResponse

POST /v1/workingWithLinks/openShortLink

Документация: https://confluence.app.local/pages/viewpage.action?pageId=621815822

Request body

application/json

Object

shortLinkParameter

string required

Параметры короткой ссылки

Example:

/-TRC4

Responses

400 FullLinkResponse

FullLinkResponse

400 ErrorLinkIsInvalid

Ссылка невалидна

POST /v2/chat/widgetProps

Документация: https://confluence.app.local/pages/viewpage.action?pageId=838588487

Request body

application/json

Object

page

Object required

Информация о странице

type

string required

Тип страницы МП

Example:

Orders

location

string

URL страницы (диплинк)

Example:

sportmaster://order/2908123-990212

Responses

400 ChatWidgetPropsResponse

ChatWidgetPropsResponse

GET /v1/chat/widgetProps

Документация: https://confluence.app.local/pages/viewpage.action?pageId=626614791

Responses

400 ChatWidgetPropsResponse

ChatWidgetPropsResponse

GET /v1/chat/newMessages

https://confluence.app.local/pages/viewpage.action?pageId=626596895

Responses

400 NewChatMessagesResponse

NewChatMessagesResponse

POST /v1/chat/device-events

https://confluence.app.local/pages/viewpage.action?pageId=731340218

Request body

application/json

Object

deviceEvent

string required

Мнемокод события неактивности чата

Enumeration:

BACK_BUTTON

HIDE_APP

Responses

400 EmptyResponse

Пустой ответ сервера

GET /v1/chat/lastMessage

Документация https://confluence.app.local/pages/viewpage.action?pageId=1039380410

Responses

400 LastChatMessageResponse

LastChatMessageResponse

GET /v1/favourite-sport-kind

Документация: https://confluence.app.local/pages/viewpage.action?pageId=651503259

Responses

400 SportKindResponse

SportKindResponse

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorSelectSportIsNotAvailable

Ошибка, если сегодня последний месяц и Пользователь еще не выбирал вид спорта (выбрать уже нельзя)

PUT /v1/favourite-sport-kinds/{sportKindId}/_select

Документация: https://confluence.app.local/pages/viewpage.action?pageId=651503175

Path variables

sportKindId

string required

id выбранного вида спорта

Responses

400 EmptyResponse

Пустой ответ сервера

GET /v1/favourite-sport-kinds

Документация: https://confluence.app.local/pages/viewpage.action?pageId=651501525

Responses

400 SportKindListResponse

SportKindListResponse

GET /v1/favourite-sport-kind/publication

Документация: https://confluence.app.local/pages/viewpage.action?pageId=661901546

Responses

400 PublicationSportKindResponse

PublicationSportKindResponse

POST /v1/rewards/_convert-bonuses

Метод конвертации бонусов на баллы

Документация: https://confluence.app.local/pages/viewpage.action?pageId=651520373

Request body

application/json

Object

bonusAmount

number required

Бонусы

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorAnonymUser

ErrorAnonymUser

POST /v1/rewards/{rewardCode}

Метод активации вознаграждения за баллы

Документация: https://confluence.app.local/pages/viewpage.action?pageId=651520374

Path variables

rewardCode

string required

Код вознаграждения

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorRewardActivation

ErrorRewardActivation

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorRewardAlreadyActivated

ErrorRewardAlreadyActivated

400 ErrorRewardNotEnoughPoints

ErrorRewardNotEnoughPoints

POST /v1/rewards

Метод получения данных о вознаграждениях для экрана “Нематериальные вознаграждения”

Документация: https://confluence.app.local/pages/viewpage.action?pageId=651516818

Responses

400 RewardsResponse

RewardsResponse

400 ErrorUserType

ErrorUserType

400 ErrorAnonymUser

ErrorAnonymUser

GET /profile/client-interests

Документация: https://confluence.app.local/pages/viewpage.action?pageId=741001397

Responses

400 ClientInterestsResponse

ClientInterestsResponse

POST /profile/client-interests

Документация: https://confluence.app.local/pages/viewpage.action?pageId=741010128

Request body

application/json

Object

styles

Array of interest-style

Выбранные пользователем стили

forWhomShopping

Array of string

Для кого покупают

Example:

10190299

sportInterests

Array of string

Выбранные виды спорта

Example:

10040299

gender

string

Выбранный пол

Example:

MALE

Responses

400 EmptyResponse

Пустой ответ сервера

GET /v1/referral-program/document

Документация: https://confluence.app.local/pages/viewpage.action?pageId=816358136

Responses

400 ReferralProgramResponse

ReferralProgramResponse

POST /v1/personal-discount

Документация: https://confluence.app.local/pages/viewpage.action?pageId=731331303

Responses

400 PersonalDiscountsResponse

PersonalDiscountsResponse

400 ErrorAnonymUser

ErrorAnonymUser

GET /v1/personal-discount/base

Возвращает ID групп персональных скидок для локального сохранения на фронте

Документация: https://confluence.app.local/pages/viewpage.action?pageId=734868490

Responses

400 PersonalDiscountsBaseResponse

PersonalDiscountsBaseResponse

400 ErrorAnonymUser

ErrorAnonymUser

POST /v1/personal-discount/_activation

https://confluence.app.local/pages/viewpage.action?pageId=932505598

Request body

application/json

Object

discountCode

string required

Код скидки

Responses

400 ErrorGateException

400 PersonalDiscountActivationResponse

PersonalDiscountActivationResponse

GET /v1/personal-discount/{scriptCode}/status

Документация: https://confluence.app.local/pages/viewpage.action?pageId=979524236

Path variables

scriptCode

string required

Responses

400 PersonalDiscountStatusResponse

PersonalDiscountStatusResponse

400 ErrorCheckingDiscount

ErrorCheckingDiscount

POST /v1/personal-discount/task

Документация: https://confluence.app.local/pages/viewpage.action?pageId=979524391

Request body

application/json

Object

scriptCode

string required

Код сценария

Responses

400 PersonalDiscountTaskResponse

PersonalDiscountTaskResponse

GET /v1/personal-discount/{discountCreationTaskId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=990483840

Path variables

discountCreationTaskId

string required

Responses

400 ErrorAnonymUser

ErrorAnonymUser

400 PersonalDiscountsResponse

PersonalDiscountsResponse

GET /v1/profile/family

Документация: https://confluence.app.local/pages/viewpage.action?pageId=831770258

Responses

400 FamilyResponse

FamilyResponse

400 ErrorAnonymUser

ErrorAnonymUser

GET /v1/profile/family/questions

Документация: https://confluence.app.local/pages/viewpage.action?pageId=838578254

Responses

400 FamilyQuestionsResponse

FamilyQuestionsResponse

400 ErrorAnonymUser

ErrorAnonymUser

POST /v1/profile/family/_invite

Документация: https://confluence.app.local/pages/viewpage.action?pageId=831770260 Если не указано значение “familyId”, то будет попытка создания новой семьи. И добавления участника в неё.

Request body

application/json

Object

familyId

string

Идентификатор семьи

memberPhone

string required

Телефон приглашённого участника

Example:

79999999999

memberName

string

Имя приглашённого участника

Example:

Матушка

Responses

400 InviteFamilyMemberResponse

InviteFamilyMemberResponse

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorAnotherBonusProgram

ErrorAnotherBonusProgram

400 ErrorFamilyIsExists

ErrorFamilyIsExists

400 ErrorLimitFamilyInvitationsExceeded

Ошибка при превышении лимита на отправку приглашений в семейный аккаунт

400 ErrorGateException

POST /v1/profile/family/{familyId}/_answer

Документация: https://confluence.app.local/pages/viewpage.action?pageId=831770262

Path variables

familyId

string required

Идентификатор семьи

Request body

application/json

Object

answer

boolean required

Ответ на приглашение

Example:

false

Responses

400 FamilyResponse

FamilyResponse

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorLimitFamilyJoinsExceeded

Ошибка при превышении лимита на вступления в семейный счёт у пользователя

PUT /v1/profile/family/{familyId}/members/{memberId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1101336101 Метод может вызывать только владелец сем. счёта, чтобы изменить имя для приглашённых и уже действующих участников семьи.

Path variables

familyId

string required

Идентификатор семьи

memberId

string required

Идентификатор участника семьи

Request body

application/json

Object

name

string required

Новое имя участника семейного счёта

Responses

400 FamilyResponse

FamilyResponse

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorGateException

DELETE /v1/profile/family/{familyId}/members/{memberId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=831770264 Методом можно удалить либо участника, либо приглашённого пользователя. На текущий момент удалить владельца сем. счёта этим методом нельзя.

Path variables

familyId

string required

Идентификатор семьи

memberId

string required

Идентификатор участника семьи

Responses

400 FamilyResponse

FamilyResponse

400 ErrorAnonymUser

ErrorAnonymUser

DELETE /v1/profile/family/{familyId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=831770267 Методом может воспользоваться только владелец семейного счёта

Path variables

familyId

string required

Идентификатор семьи

Responses

400 FamilyResponse

FamilyResponse

400 ErrorAnonymUser

ErrorAnonymUser

GET /v1/profile/benefits

Документация - https://confluence.app.local/pages/viewpage.action?pageId=1052912754

Responses

400 BenefitsResponse

BenefitsResponse

400 ErrorGateException

GET /v2/shop

Вернуть все магазины города. Документация: https://confluence.app.local/pages/viewpage.action?pageId=427391093

Responses

400 ShopsResponse

ShopsResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorGateException

POST /v3/shop

Вернуть все магазины города.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721566306

Request body

application/json

Object

filterId

string

Идентификатор фильтра. Если не передан, то возвращаюстся все магазины

Example:

"INSTORE"

Responses

400 ShopsResponse2

ShopsResponse2

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorGateException

POST /v2/shop/search

Документация: https://confluence.app.local/pages/viewpage.action?pageId=427391100

Request body

application/json

Object

shopNumbers

Array of string required

Идентификаторы запрашиваемых магазинов

Responses

400 ShopsResponse2

ShopsResponse2

400 ErrorShopNotFound

ErrorShopNotFound

400 ErrorGateException

GET /v2/shop/{shopNumber}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=427391105

Path variables

shopNumber

string required

Responses

400 ShopResponse

ShopResponse

GET /v2/shop/favourite

избранное - юзергейт GET-FAVORITE-SHOPS-LIST сами магазины - см запрос “Список магазинов” в спеке

У анонима нет избранных магазинов

Документация: https://confluence.app.local/pages/viewpage.action?pageId=427391108

Responses

400 FavouriteShopsResponse

FavouriteShopsResponse

400 ErrorGateException

GET /shop/favouriteNumbers

Только номера избранных магазинов. юзергейт GET-FAVORITE-SHOPS-LIST

Документация: https://confluence.app.local/pages/viewpage.action?pageId=427391111

Responses

400 FavouriteShopNumbersResponse

FavouriteShopNumbersResponse

POST /shop/favourite/{shopNumber}

Делается через UserGate.

Если запрос дергается анонимом, то должна быть ошибка с примерным текстом - “Авторизуйтесь, чтобы добавить магазин в избранное”

Документация: https://confluence.app.local/pages/viewpage.action?pageId=427391150

Path variables

shopNumber

string required

Responses

400 EmptyResponse

Пустой ответ сервера

DELETE /shop/favourite/{shopNumber}

Делается через UserGate

Документация: https://confluence.app.local/pages/viewpage.action?pageId=427391153

Path variables

shopNumber

string required

Responses

400 EmptyResponse

Пустой ответ сервера

GET /v1/in-store/profile-tag

Метод получения признака “Я в магазине” с профиля

Документация: https://confluence.app.local/pages/viewpage.action?pageId=891605675

Responses

400 InStoreShopInfoResponse

InStoreShopInfoResponse

400 ErrorAnonymUser

ErrorAnonymUser

POST /v1/in-store/profile-tag

Метод установки признака “Я в магазине” на профиль

Документация: https://confluence.app.local/pages/viewpage.action?pageId=891604456

Request body

application/json

Object

shopNumber

string required

Номер магазина

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorMethodIsDisabled

ErrorMethodIsDisabled

DELETE /v1/in-store/profile-tag

Метод удаления признака “Я в магазине” с профиля

Документация: https://confluence.app.local/pages/viewpage.action?pageId=891604458

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorAnonymUser

ErrorAnonymUser

GET /v1/in-store/user-shop

Метод определение магазина, в котором находится пользователь. Используется определение ближайшего магазина по координатам пользователя и минимального расстояния, которое считается что пользователь находится в магазине

Документация: https://confluence.app.local/pages/viewpage.action?pageId=891614938

Request parameters

lat

number required

lon

number required

Responses

400 InStoreShopInfoResponse

InStoreShopInfoResponse

GET /v1/in-store/menu

Метод получения меню раздела “Я в магазине”

Документация: https://confluence.app.local/pages/viewpage.action?pageId=891604560

Responses

400 InStoreMenuResponse

InStoreMenuResponse

GET /catalog/menu

Authentication

Access token

Наши слоты в CMSGate:

Старое меню

frontoffice_menu_sections
frontoffice_menu_catalog

Новое меню

mobile_app_catalog_main_menu
mobile_app_catalog_header_menu

Бэк забирает данные либо по первой паре, либо по второй

Документация: https://confluence.app.local/pages/viewpage.action?pageId=427390791

Responses

400 CatalogMenuResponse

CatalogMenuResponse

POST /v2/catalog/categories/subcategories

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677960615

Request body

application/json

Object

categoryUri

string required

Путь на родительский ресурс

Example:

brand/nike

Responses

400 SubcategoriesResponse

SubcategoriesResponse

POST /v3/catalog/categories/sports

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677960495

Responses

400 SubcategoriesResponse

SubcategoriesResponse

POST /v2/catalog/brands

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721569925

Responses

400 BrandsResponse

BrandsResponse

POST /v1/banners/adBanners

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=1003347875

Request body

application/json

Object

contextId

string

Экран, для которого вызываем рекламу

categoryId

string

ID категории (только для листинга, при наличии)

Responses

400 AdBannerResponse

AdBannerResponse

GET /catalog/brands/top

Бекенд разработчикам

curl -X 'GET' \
  'http://www.cmsgateuat.marathon.mesos.sportmaster.ru/api/v1/registry/mobile_app_brandspage_registry?site=sm&front=mobile_app&consumer=sm_mobileapp_ecom_ios_ru&locale=ru-RU&absRefs=false&stag=false' \
  -H 'accept: application/json'

Нам нужно изображение с “imageLabel” = “mobile_app_brandspage”

Документация: https://confluence.app.local/pages/viewpage.action?pageId=427390914

Responses

400 BrandsResponse

BrandsResponse

GET /catalog/categories/sports/top

Документация: https://confluence.app.local/pages/viewpage.action?pageId=427390834

Responses

400 PopularSportsResponse

PopularSportsResponse

GET /v1/catalog/banners

Метод для получения баннеров в модуле каталог

Документация: https://confluence.app.local/pages/viewpage.action?pageId=809487515

Request parameters

slot

string required

Слот баннеров

url

string optional

ссылка на экран или ссылка баннера

Responses

400 CatalogBannersResponse

Баннеры в модуле каталог

400 ErrorBannerNotFound

Баннер не найден.

POST /v1/products/clp

Ссылка на ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=1025430080

Request body

application/json

Object

url

string required

Ссылка для CLP

Responses

400 ContentPageResponse

ContentPageResponse

GET /products/{productId}/reviews/photos

Получить фотографии из отзывов покупателей по товару с указанным id

Документация: https://confluence.app.local/pages/viewpage.action?pageId=434108699

Path variables

productId

string required

Responses

400 UserPhotosResponse

UserPhotosResponse

POST /v2/products/recent

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677967145

Request body

application/json

Object

persGateTags

PersGateTagsParam

Responses

400 RecentProductsResponse

RecentProductsResponse

POST /v2/products/search

Документация: https://confluence.app.local/pages/viewpage.action?pageId=430745093

Request parameters

limit

integer optional

offset

integer optional

Request body

application/json

Object

subquery

string

Параметры фильтрации

queryText

string

Текстовый поиск

persGateTags

PersGateTagsParam

woQueryTextCorrection

boolean

Флаг исправления полнотекстового запроса (поиск)

userInteraction

boolean

Флаг взаимодествия пользователя с листингом

facetAvailabilityApply

boolean

Флаг применения в запросе фильтров по способу получения

obtainment

ObtainmentStructure

pageType

string

Тип страницы каталога

Responses

400 ProductsResponse

ProductsResponse

POST /v2/products/search/autocomplete

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677967262

Request body

application/json

Object

queryString

string required

Текст по которому будем искать подсказки

persGateTags

PersGateTagsParam

Responses

400 SearchAutocompleteResponse

SearchAutocompleteResponse

POST /products/search/photo

Бекенд разработчикам

Поиск по фото делаем через староний сервис

curl https://visearch.visenze.com/uploadsearch \
       -F image=@example.png \
       -u 6d5864c1c91003b163cae1bdbd70d001:0f21f743e1e154386833126b0f2ef5de

Обрати внимание: запрос пагинируемый!

В ответе возвращаются results, содержащий массив id товаров. Для полученных id ищем данные о товарах в продукт гейте, запросом http://product-gate.productgatesmuat.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=../productGateApi.json#/Товары/getProductsFlexible

Обрати внимание: нужно фильтровать товары по доступности в городе, т.к. visenze не привязан к городу

Ответ фронту: не должен содержать мету, hasMore - всегда false (запрос с фронта не пагинируемый)

Документация: https://confluence.app.local/pages/viewpage.action?pageId=430745221

Request body

multipart/form-data

string binary

Responses

400 ProductsResponse

ProductsResponse

POST /v3/products/recs

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

Запрос возвращает айдишники товаров, модели товаров ищем запросом [Product гейт] POST /products/_search-by-ids-flex

Документация: https://confluence.app.local/pages/viewpage.action?pageId=434079231

Request body

application/json

Object

slots

Array of RecommendationSlot required

productIds

Array of string

Массив идентификаторов товаров, для которых ищем рекомендации

Max items: 120

queryText

string

Текст поискового запроса. Для рекомендаций поиска

pageType

string

Тип страницы. Справочник http://mdm.app.local/MDM.aspx?entities=gt_frontend_pages

contextId

string

Идентификатор допустимого контекста для слотов рекомендации

Example:

ID ветки каталога, раздела меню, страницы ContentGate, товара

persGateTags

PersGateTagsParam

Responses

400 RecommendationProductsResponse

RecommendationProductsResponse

400 InvalidSlotsError

InvalidSlotsError

POST /v1/products/individualRecs

Запрос в гейте - http://rest-api.productgate-sm-uat-ru1.k8s-dev.gksm.local/swagger-ui/index.html?url=../productGateApi.json#/Рекомендации/searchRecsByIds

Запрос возвращает айдишники товаров

Документация: https://confluence.app.local/pages/viewpage.action?pageId=615216531

Request body

application/json

Object

slot

RecommendationSlot

productIds

Array of string

Массив идентификаторов товаров, для которых ищем рекомендации

Max items: 120

pageType

string

Тип страницы. Справочник http://mdm.app.local/MDM.aspx?entities=gt_frontend_pages

persGateTags

PersGateTagsParam

Responses

400 RecommendationResponse

RecommendationResponse

400 InvalidSlotsError

InvalidSlotsError

POST /v2/products/infiniteRecs

Документация: https://confluence.app.local/pages/viewpage.action?pageId=871622481

Request parameters

limit

integer optional

Количество товаров, загружаемых запросом

offset

integer optional

Количество загруженных(отображенных) элементов на клиенте

Request body

application/json

Object

slot

RecommendationSlot required

productIds

Array of string

Массив идентификаторов товаров, для которых ищем рекомендации

Max items: 120

queryText

string

Текст поискового запроса. Для рекомендаций поиска

pageType

string

Тип страницы. Справочник http://mdm.app.local/MDM.aspx?entities=gt_frontend_pages

contextId

string

Идентификатор допустимого контекста для слотов рекомендации

Example:

ID ветки каталога, раздела меню, страницы ContentGate, товара

Responses

400 InfiniteRecommendationProductsResponse

InfiniteRecommendationProductsResponse

POST /v1/products/infiniteRecs

DEPRECATED с версии 4.56

Документация: https://confluence.app.local/pages/viewpage.action?pageId=531660851

Request parameters

limit

integer optional

Количество товаров, загружаемых запросом

offset

integer optional

Количество загруженных(отображенных) элементов на клиенте

Request body

application/json

Object

slot

RecommendationSlot required

productId

string

Идентификатор товара, для которого ищем рекомендации

Example:

21555930299

pageType

string

Тип страницы. Справочник http://mdm.app.local/MDM.aspx?entities=gt_frontend_pages

contextId

string

Идентификатор допустимого контекста для слотов рекомендации

Example:

ID ветки каталога, раздела меню, страницы ContentGate, товара

persGateTags

PersGateTagsParam

Responses

400 InfiniteRecommendationProductsResponse

InfiniteRecommendationProductsResponse

POST /v2/products/{productId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677964846

Path variables

productId

string required

Request body

application/json

Object

persGateTags

PersGateTagsParam

Responses

400 ProductColorModelResponse

ProductColorModelResponse

400 ProductColorModelIsNotApproved

Ошибка, которую необходимо вернуть в случае, если гейт не нашел товар и вернул пустой ответ

POST /v2/products/{productId}/personalPrice

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677964867

Path variables

productId

string required

Responses

400 PersonalPriceResponse

PersonalPriceResponse

POST /v1/products/_personal-price-list

Документация: https://confluence.app.local/pages/viewpage.action?pageId=885886628

Метод получения персональной цены для списка товаров. Корзина пользователя в расчете не учитывается

Request body

application/json

Object

productIds

Array of string required

id товаров

Responses

400 PersonalPriceListResponse

PersonalPriceListResponse

POST /products/search-ids

Документация: https://confluence.app.local/pages/viewpage.action?pageId=434096643

Request body

application/json

Object

ids

Array of string required

format

ProductsResponseFormat

persGateTags

PersGateTagsParam

onlyOnlineAvailable

boolean

Исключить ли товары, все sku которых имеют isOnlineAvailable == FALSE

calculatePersonalPrice

boolean

Рассчитать ли для товаров персональную цену

Responses

400 ProductsByIdResponse

ProductsByIdResponse

POST /v2/products/{productId}/sizeTable

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677968309

Path variables

productId

string required

Responses

400 ProductSizeTableResponse

ProductSizeTableResponse

400 ProductSizeTableError

POST /v2/products/{productId}/productSet

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677964860

Path variables

productId

string required

ИД товара

Responses

400 ProductSetsResponse

ProductSetsResponse

POST /v1/products/productSet

Документация: https://confluence.app.local/pages/viewpage.action?pageId=588294933

Request body

application/json

Object

productList

Array required

Товары в комплекте

Object

productId

string required

ИД товара

Responses

400 ProductSetResponse

Комплект

POST /v1/products/{productId}/productMarkers

DRAFT

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721553544

Path variables

productId

string required

Responses

400 ProductMarkersResponse

ProductMarkersResponse

POST /v1/products/{productId}/accessories

Метод получения списка товаров - аксессуаров

Документация: https://confluence.app.local/pages/viewpage.action?pageId=734886888

Path variables

productId

string required

id основного товара

Request body

application/json

Object

categoryBranchId

string

ID товарной категории для фильтрации

deliveryOption

AccessoriesDeliveryOption

limit

integer

Максимальное количество товаров

Responses

400 ProductAccessoriesResponse

Аксессуары

400 DeliveryOptionError

Ошибка выбранного способа получения

POST /v1/products/{productId}/accessories/categories

Метод получения веток каталога аксессуаров

Документация: https://confluence.app.local/pages/viewpage.action?pageId=745234875

Path variables

productId

string required

id основоного товара

Request body

application/json

Object

deliveryOption

AccessoriesDeliveryOption required

Responses

400 ProductAccessoriesCategoriesResponse

Категории аксессуаров

400 DeliveryOptionError

Ошибка выбранного способа получения

POST /v1/bnpl/payment-details

Документация: https://confluence.app.local/pages/viewpage.action?pageId=974013837

Request body

application/json

Object

price

integer required

Стоимость товара. Передается одно значение, которое актуально для пользователя

bnplType

string required

Тип сервиса BNPL

Example:

BNPL_SOVCOMBANK

Responses

400 BnplDetailsResponse

BnplDetailsResponse

POST /v1/products/search-skuId

Request body

application/json

Object

skuIds

Array of string required

Массив skuIds

Responses

400 ProductsBySkuIdResponse

ProductsBySkuIdResponse

POST /appeal/createBestPrice

http://rest-app.usergate-uat-ru.k8s-dev.gksm.local/swagger-ui/index.html?url=/v3/api/openapi.yml#/Appeal/createAppealBestPrice

Документация: https://confluence.app.local/pages/viewpage.action?pageId=515444705

Request body

application/json

Object

companyProductId

string required

Идентификатор товара

Example:

23684280299

companyPrice

integer required

Цена товара в СМ в копейках

Example:

799000

competitorProductUrl

string required

Ссылка на товар конкурента

Example:

https://www.wildberries.ru/catalog/58957382/detail.aspx?targetUrl=XS

competitorPrice

integer required

Цена на товар у конкурента в копейках

Example:

699000

clientPhone

string required

Номер телефона

Example:

79000000000

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorFieldValidationPhoneGate

Не прошла валидация телефона на гейте

GET /reviews/summary

DEPRECATED с версии 4.75

Для BE:

Соотвествует http://product-gate.productgateusrtst.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=../productGateApi.json#/Отзывы/getReviews модели colorModel . Соотвествие не прямое, некооторые поля нужно пересчитать.

на 25 мая 2021 года не все нужные поля есть в гейте. Обещали за 2 недели доработать

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217550

Request parameters

productId

string required

Responses

400 ReviewSummaryResponse

Общие данные по отзывам о товаре

GET /review/promotedReview

Для карточки товара нужен отзыв, который считается самым популряным.

Для БЭ: Гейт должен доработать и сделть такой запрос. Для справки, в шопилоте это поле - acets.most_helpful_review. Если доработок не будет, то давайте просто брать первый отзыв с сортировкой RATING_DESC.

Данные актуальны на 25 мая 2021 года

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217560

Request parameters

productId

string required

Request headers

X-Pers-Tags

array of string optional

Метки персонализации

Example:

"no_stories,no_stream,cmsgate_banners"

Responses

400 PromotedReviewResponse

PromotedReviewResponse

GET /reviews

DEPRECATED с версии 4.75

Для БЭ: Сортировки такие: http://joxi.ru/DmBqxOKHglJpDr

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217569

Aplaut на одну страницу может вернуть максимум 20, поэтому сейчас максимальный limit в запросе это 20

Request parameters

productId

string required

sortId

string optional

Берется из ответа

offset

integer optional

limit

integer optional

Max: 20

Responses

400 ReviewsResponse

POST /reviews/{id}/report

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217574

Path variables

string required

Request body

application/json

Object

reason

string

Причина жалобы просто строкой

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorUserContentIdIsEmpty

ErrorUserContentIdIsEmpty

400 ErrorUserContentIsNotFound

ErrorUserContentIsNotFound

GET /reviews/schema

Импользуется для получения схемы, с помощью которой создается отзыв.

От этой схемы нам нужно присылать только (в виде, уже готом для клиента. Т.е. этот запрос сразу формирует ответ под клиента)

rating_details
author_details

Все остальные параметры вшиты на клиенте.

Основано на http://product-gate.productgatesmuat.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=../productGateApi.json#/Отзывы/getReviewsSchema

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217582

Request parameters

productId

string required

Responses

400 ReviewSchemaResponse

ReviewSchemaResponse

POST /reviews/create

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217584

Request body

application/json

Object

productId

string required

rating

integer required

ratingDetails

Array of RatingDetailParam

body

string required

Текст отзыва

proc

string

Преимущества

cons

string

Недостатки

isRecommend

boolean required

Рекомендую ли я этот товар

photoIds

Array of string

Айди загруженных фотографий

authorDetails

Array of AuthorDetailParam

name

string required

Имя пользователя

location

string required

Локация пользователя

hideMyData

boolean

Скрыть мои данные при публикации отзыва.

dimensions

DimensionDetails

consumerToken

string

JWT Токен

Responses

400 EmptyResponse

Пустой ответ сервера

POST /reviews/uploadPhoto

Мультипарт запрос

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217587 Данным методом загружаем фото из отзывов и фото из вопросов

Request body

multipart/form-data

Object

photo

Object required

Тип File. В спекет просто нет такого типа

Responses

400 PhotoUploadResponse

PhotoUploadResponse

POST /questions/uploadPhoto

DEPRECATED с версии 4.75

Мультипарт запрос

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217589

Request body

multipart/form-data

Object

photo

Object required

Тип File. В спекет просто нет такого типа

Responses

400 PhotoUploadResponse

PhotoUploadResponse

GET /questions

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217591

Request parameters

productId

string required

offset

integer optional

limit

integer optional

sortingId

QuestionsSort optional

В дальнейшем берутся из ответа

Responses

400 QuestionsResponse

QuestionsResponse

POST /questions

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217593

Request body

application/json

Object

productId

string required

photoIds

Array of string

text

string required

Текст вопроса

string required

Имейл пользователя

name

string required

Имя пользователя

hideMyData

boolean

Скрыть мои данные

Responses

400 EmptyResponse

Пустой ответ сервера

400 400

Если не найдены имя пользователя или email, то отправляется данная ошибка с указанием отсутствующих данных

Body

application/json

Object

error

Object

message

string

code

string

POST /questions/{id}/report

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494217595

Path variables

string required

Request body

application/json

Object

reason

string

Причина жалобы просто строкой

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorUserContentIdIsEmpty

ErrorUserContentIdIsEmpty

400 ErrorUserContentIsNotFound

ErrorUserContentIsNotFound

POST /v1/reviews/list

Ссылка на документацию: https://confluence.app.local/pages/viewpage.action?pageId=1016039559

Получение информации для экрана всех отзывов

Request parameters

productId

string required

Идентификатор товара

limit

integer optional

offset

integer optional

Request body

application/json

Object

sortId

string

Идентификатор сортировки

filter

string

Параметр фильтрации

Responses

400 ReviewsListResponse

ReviewsListResponse

POST /v3/products/{productId}/availability

Документация: https://confluence.app.local/pages/viewpage.action?pageId=839354134

Path variables

productId

string required

Responses

400 ProductAvailabilitiesResponse

ProductAvailabilitiesResponse

POST /v2/products/{productId}/availability

[DEP] версия 4.52

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677962866

Path variables

productId

string required

Responses

400 ProductAvailabilitiesResponse

ProductAvailabilitiesResponse

POST /v4/products/{productId}/availability

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1094456976

Path variables

productId

string required

Responses

400 LightProductAvailabilityResponse

LightProductAvailabilityResponse

POST /v1/products/{productId}/delivery-availability

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1094457591

Path variables

productId

string required

Request body

application/json

Object

price

number

Цена товара. Передаем целое число, как отображаем на карточке товара, без копеек

Responses

400 ProductsDeliveryResponse

ProductsDeliveryResponse

POST /v3/skus/{skuId}/shop-availability

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677965290

Path variables

skuId

string required

Request body

application/json

Object

price

number

Цена товара. Передаем целое число, как отображаем на карточке товара, без копеек

colorModelId

string

ID ЦМ

Responses

400 SkuAvailabilityInShopResponse

SkuAvailabilityInShopResponse

POST /v1/skus/_availability

Метод проверки доступности sku в определенном МСП. У МАРСа нет возможности отдавать доступность по списку размеров, поэтому бэк будет запрашивать гейт 1 размер - 1 запрос

Документация: https://confluence.app.local/pages/viewpage.action?pageId=752067262

Request body

application/json

Object

skus

Array of string required

Список размеров

deliveryType

DeliveryOptionType required

Responses

400 SkuAvailabilityCheckResponse

SkuAvailabilityCheckResponse

400 DeliveryOptionError

Ошибка выбранного способа получения

POST /v1/favourite-lists/_create

Метод создания пользовательского списка избранных товаров

Документация: https://confluence.app.local/pages/viewpage.action?pageId=704905261

Request body

application/json

Object

favouriteListName

string required

Название списка

Min length: 1

Max length: 40

Responses

400 FavouriteListCreateResponse

FavouriteListCreateResponse

400 ErrorFavouriteListAlreadyExist

ErrorFavouriteListAlreadyExist

400 ErrorFavouriteListName

ErrorFavouriteListName

DELETE /v1/favourite-lists/{favouriteListId}

Метод удаления пользовательского списка избранных товаров

Документация: https://confluence.app.local/pages/viewpage.action?pageId=704905281

Path variables

favouriteListId

string required

Идентификатор списка

Request parameters

deleteProducts

boolean required

Удалить ли товары списка из избранного

Responses

400 EmptyResponse

Пустой ответ сервера

POST /v1/favourite-lists

Метод получения пользовательских (созданных пользователем) списков избранных товаров

Документация: https://confluence.app.local/pages/viewpage.action?pageId=704905499

Request body

application/json

Object

limit

integer

Количество запрашиваемых списков. Если не передано то все

Min: 1

fullInfo

boolean

Полная информация

Responses

400 FavouriteListsResponse

FavouriteListsResponse

POST /v1/favourite-lists/_copy

Метод копирования пользовательского списка вместе с товарами

Документация: https://confluence.app.local/pages/viewpage.action?pageId=704916341

Request body

application/json

Object

favouriteListName

string required

Название создаваемого списка

Min length: 1

Max length: 40

favouriteListId

string required

Идентификатор копируемого списка

Responses

400 FavouriteListCreateResponse

FavouriteListCreateResponse

400 ErrorGateException

400 ErrorFavouriteListAlreadyExist

ErrorFavouriteListAlreadyExist

400 ErrorFavouriteListName

ErrorFavouriteListName

400 ErrorEmptyList

ErrorEmptyList

400 ErrorProductSubscription

ErrorProductSubscription

POST /v2/products/favorite

Документация: https://confluence.app.local/pages/viewpage.action?pageId=432502413

В методе передается ИЛИ favouriteListIds ИЛИ favouriteListTypes

Request parameters

limit

integer optional

Min: 1

offset

integer optional

Request body

application/json

Object

favouriteListIds

Array of string

ID списка избранного

favouriteListTypes

Array of FavouriteListType

Тип списка избранного

Responses

400 FavoriteProductsResponse

FavoriteProductsResponse

400 FavoriteListException

FavoriteListException

PUT /v2/products/favorite

DEP 4.37 07.08 - 25.08 в рамках MPSM-915

Документация: https://confluence.app.local/pages/viewpage.action?pageId=432502418

В методе передается ИЛИ favouriteListId ИЛИ favouriteListType

Request body

application/json

Object

colorModelId

string required

Идентификатор товара

Example:

1234567890

skuId

string required

Идентификатор размера

Example:

1234567890

favouriteListId

string

ID списка избранного

favouriteListType

FavouriteListType

Responses

400 EmptyResponse

Пустой ответ сервера

400 FavoriteListException

FavoriteListException

DELETE /v2/products/favorite

DEPRECATED 4.37 04.08 - 25.08 а рамках MPSM-915

Удаляем все позиции переданной ЦМ

Документация: https://confluence.app.local/pages/viewpage.action?pageId=432502467

Request parameters

colorModelId

string required

Идентификатор цветомодели

favouriteListId

string optional

ID списка избранного

favouriteListType

FavouriteListType optional

Тип списка избранного

Responses

400 EmptyResponse

Пустой ответ сервера

400 FavoriteListException

FavoriteListException

PUT /v3/products/favorite

Документация: https://confluence.app.local/pages/viewpage.action?pageId=704911651

В методе передается ИЛИ favouriteListId (для пользовательского списка) ИЛИ favouriteListType (для списка избранного, листа ожидания, скоро в продаже)

Request body

application/json

Object

favouriteProductList

Array of FavouriteProductId required

Список товаров

favouriteListId

string

ID списка избранного

favouriteListType

FavouriteListType

Responses

400 FavouriteAddProductsResponse

FavouriteAddProductsResponse

400 FavoriteListException

FavoriteListException

400 ErrorFavouriteAdding

ErrorFavouriteAdding

POST /v1/products/favorite/_delete

Если передан id списка, то удаляем из него, если не передан, то из всех списков

Документация: https://confluence.app.local/pages/viewpage.action?pageId=704912679

Request body

application/json

Object

favouriteProductList

Array of FavouriteProductId required

Список товаров

favouriteListId

string

ID списка избранного

Responses

400 EmptyResponse

Пустой ответ сервера

GET /v1/compareList

Работает даже для неавторизованного пользователя

Документация: https://confluence.app.local/pages/viewpage.action?pageId=434082773

Responses

400 CompareListResponse

CompareListResponse

POST /compareList/add

Документация: https://confluence.app.local/pages/viewpage.action?pageId=434079883

Request body

application/json

Object

colorModelId

string required

Айди цветомодели

Responses

400 EmptyResponse

Пустой ответ сервера

POST /compareList/remove

Документация: https://confluence.app.local/pages/viewpage.action?pageId=434079896

Request body

application/json

Object

colorModelIds

Array of string required

Responses

400 EmptyResponse

Пустой ответ сервера

POST /v2/compareList

Работает даже для неавторизованного пользователя

Документация: https://confluence.app.local/pages/viewpage.action?pageId=716254782

Request body

application/json

Object

getCompareTabs

boolean required

Вернуть табы сравнения или нет

Responses

400 CompareListTabResponse

CompareListTabResponse

POST /v2/guide

Документация: https://confluence.app.local/pages/viewpage.action?pageId=677965141

Request parameters

limit

integer required

offset

integer required

Responses

400 GuidesResponse

GuidesResponse

GET /guide/{guideId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=536296847

Path variables

guideId

string required

ID гида

Responses

400 GuideResponse

GuideResponse

POST /v1/guide/progress

Документация: https://confluence.app.local/pages/viewpage.action?pageId=570011815

Request body

application/json

Object

categoryBranchId

string required

ID товарной категории

Example:

12977090299

sort

string

Сортировка

Example:

BY_POPULARITY

appliedFacets

Array of Facet

Фасеты выбранных ответов

altAppliedFacets

Array of Facet

Фасеты выбранных ответов для альтернативной подборки

Responses

400 GuideProgressResponse

GuideProgressResponse

POST /v2/guide/{guideId}/altproducts

Документация: https://confluence.app.local/pages/viewpage.action?pageId=626600222

Path variables

guideId

string required

ID гида

Request body

application/json

Object

altSubquery

string required

URL для альтернативной подборки

subquery

string required

URL для основной подборки

Responses

400 GuideAltProductsResponse

GuideAltProductsResponse

GET /v1/kits/categories

Документация: https://confluence.app.local/pages/viewpage.action?pageId=804638681

Метод получения категорий комплектов товаров (категорий луков, lookzone) для главной страницы раздела комплектов товаров

Responses

400 ProductKitsCategoriesResponse

Категории комплектов

На текущий момент возвращается только один тип категорий - “Жизненные ситуации”

POST /v1/kits/_search

Метод получения списка комплектов товаров с пагинацией и фильтрацией.

Заполняется или subquery, или labelDisplay, обязательно должен быть заполнен один из них

Документация: https://confluence.app.local/pages/viewpage.action?pageId=809469037

Request parameters

limit

integer optional

offset

integer optional

Request body

application/json

Object

subquery

string

Ссылка на подвыборку с заданной фильтрацией

Example:

/lookzone/catalog/life_47

labelDisplay

string

Метка раздела отображения

Example:

mobile_app_main - главный экран

Responses

400 ProductKitListResponse

ProductKitListResponse

400 ErrorInvalidRequestParameters

ErrorInvalidRequestParameters

GET /v1/products/{productId}/productKits

Метод, который возвращает доступные комплекты для заданного товара

Документация: https://confluence.app.local/pages/viewpage.action?pageId=809480095

Path variables

productId

string required

Идентификатор товара

Responses

400 ProductKitsResponse

ProductKitsResponse

GET /v1/kits/{kitId}

Метод получения комплекта по идентификатору

Документация: https://confluence.app.local/pages/viewpage.action?pageId=809480101

Path variables

kitId

string required

Идентификатор комплекта

Responses

400 ProductKitByIdResponse

ProductKitByIdResponse

400 ErrorKitNotFound

ErrorKitNotFound

GET /v1/service-center/categories

Метод возвращает список категорий сервисного центра: “Велосипеды”, “Лыжи и сноуборды” и т.д.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=866250862

Responses

400 ServiceCategoriesResponse

ServiceCategoriesResponse

POST /v1/service-center/categories/one

Метод возвращает информацию по категории услуг: описание и список подкатегорий (если есть)

Документация: https://confluence.app.local/pages/viewpage.action?pageId=866250892

Request body

application/json

Object

categoryUri

string

Ссылка на категорию

Example:

/services/velosipedy

Responses

400 ServiceCategoryDetailResponse

ServiceCategoryDetailResponse

GET /v1/service-center/products/{productId}

Метод возвращает информацию услуге

Документация: https://confluence.app.local/pages/viewpage.action?pageId=866250935

Path variables

productId

string required

Идентификатор услуги

Example:

6275530299

Responses

400 ServiceProductDetailResponse

ServiceProductDetailResponse

POST /v1/service-center/centers

Метод возвращает список сервисных центров. Либо для конкретной услуги, либо для все центры в данной локации

Документация: https://confluence.app.local/pages/viewpage.action?pageId=866250941

Request body

application/json

Object

productId

string

Идентификатор сервисной услуги

Example:

6275530299

Responses

400 ServiceCentersResponse

ServiceCentersResponse

POST /v2/main/header

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721044156

Responses

400 MainResponse

MainResponse

GET /v1/main/header

DEPRECATED: версия 4.40.0 - 25.09 - 06.10

Документация: https://confluence.app.local/pages/viewpage.action?pageId=449506961

Responses

400 MainResponse

MainResponse

POST /v2/main/sections

Документация: https://confluence.app.local/pages/viewpage.action?pageId=449506964

Request body

application/json

Object

lastSection

MainSectionIdentifier

limit

integer

Количество загружаемых секций за один запрос

persGateTags

PersGateTagsParam

Responses

400 MainResponse

MainResponse

POST /banner

Документация: https://confluence.app.local/pages/viewpage.action?pageId=695244860

Request body

application/json

Object

slot

string required

Слот баннера

Example:

"sm_hh_mobileapp_bannerBonuses"

Responses

400 BannerResponse

BannerResponse

400 ErrorGateException

400 ErrorBannerNotFound

Баннер не найден.

GET /services/sections

Документация: https://confluence.app.local/pages/viewpage.action?pageId=822563954

Request parameters

ids

array of string optional

Список идентификаторов секций

Responses

400 ServicesSectionsListResponse

ServicesSectionsListResponse

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

POST /services/sections

Документация: https://confluence.app.local/pages/viewpage.action?pageId=828380934

Request body

application/json

Object

lastSectionId

string

Идентификатор последней секции, которая отображена на клиенте.

limit

integer

Сколько секций возвращать

servicesEnabled

Array of ServicesEnum

Список сервисов, которые лежат в локальном конфиге. Передаются, чтобы БФФ в секциях групп сервисов не вернул какой-нибудь сервис, для которого фронт не включил переходы по диплинкам и прочие такие вещи.

Если не указан, БФФ вернёт все сервисы подряд.

Min items: 1

Unique items: YES

Example:

[
    "BDAY",
    "TRACKER",
    "BETS"
]

Responses

400 ServicesSectionsResponse

ServicesSectionsResponse

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

PUT /services/favorites

Документация: https://confluence.app.local/pages/viewpage.action?pageId=731340371

Request body

application/json

Object

serviceIds

Array of ServicesEnum required

ID сервиса из бэкенда МП

Responses

400 FavoriteServicesListResponse

Список избранных пользователем сервисов

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

POST /services/groups

Получение списка групп сервисов на экране управления избранными сервисами.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=734856370

Request body

application/json

Object

servicesEnabled

Array of ServicesEnum

Если не указан, БФФ вернёт все сервисы подряд.

Min items: 1

Unique items: YES

Example:

[
    "BDAY",
    "TRACKER",
    "BETS"
]

Responses

400 ServicesGroupsResponse

Список групп сервисов

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

GET /services/dashboard

[DEPRECATED]

Документация: https://confluence.app.local/pages/viewpage.action?pageId=489470392

Responses

400 ServicesDashboardResponseOld

ServicesDashboardResponseOld

POST /v1/banner/list

Документация - https://confluence.app.local/pages/viewpage.action?pageId=1024905338

Request body

application/json

Object

slot

string required

Слот баннера

Example:

mobile_app_bonuses_banner

Responses

400 BannersResponse

BannersResponse

400 ErrorGateException

POST /v1/banner/ticker/list

Документация: https://confluence.app.local/pages/viewpage.action?pageId=1025434209

Request body

application/json

Object

slots

Object required

Список слотов для Бегещей строки

Example:

{"mobile_app_running_line_banner", "mobile_app_running_line_banner_catalog"}

Responses

400 TickerResponse

TickerResponse

POST /internal-analytics/bff/event

Отправить событие в BFF

Документация: https://confluence.app.local/pages/viewpage.action?pageId=745228226

Request body

application/json

Object

events

Array of BffEvent

Список событий для отправки в аналитику BFF

Responses

400 EmptyResponse

Пустой ответ сервера

POST /analytics/event

Отправить событие в перс гейт

Работет на http://rest-api.persgate.marathon.mesos.sportmaster.ru/swagger-ui/index.html?configUrl=%2Fv3%2Fapi-docs%2Fswagger-config&urls.primaryName=v2#/Events API/createEvent (вторая версия)

Описание параметров тут https://confluence.app.local/display/PERSGATE/(API)+PUT-EVENT#tab-PUT-EVENT+v101+(TOBE) именно новая версия.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490051379

Request parameters

eventType

string required

Название события (название схемы из свагера)

Example:

pg_notification_get

Request body

application/json

Object

model

string

Тип используемой модели событий.

Enumeration:

sm-primary

sm-game

sm-tracker

version

string required

версия спецификации модели событий. Пример: 0.1.0, 1.0.0 и т.д.

type

string required

Название события (название схемы из свагера)

data

Object required

JSON события

Responses

400 EmptyResponse

Пустой ответ сервера

GET /analytics/tags

Работает на http://rest-api.persgate-cm-prd-ru1.k8s-prod.gksm.local/swagger-ui/index.html?configUrl=%2Fv3%2Fapi-docs%2Fswagger-config&urls.primaryName=v2#/Tags API/getTags

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490051382

DEPRECATED в рамках задачи https://jira.app.local/browse/MPSM-4365

Responses

400 PersGateTagsResponse

Метки персонализации Pers Gate.

POST /v2/analytics/tags

Документация: https://confluence.app.local/pages/viewpage.action?pageId=710854781

Request body

application/json

Object

geoFenceIdList

Array of string

(DEPRECATED с 4.71) Массив ID геозон местоположения пользователя

Responses

400 PersGateTagsResponse

Метки персонализации Pers Gate.

GET /v2/documents/{documentId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=434080157

Справочник мнемокодов Documents: https://confluence.app.local/pages/viewpage.action?pageId=434080166

Path variables

documentId

string required

Мнемокод документа

Enumeration:

PRIVACY

USER_CONTENT_RULES

ABOUT_CLUB_PROGRAM

SUBSCRIPTIONS

LEGAL_ADDRESS

OFFER

PAYMENT_AND_DELIVERY

BEST_PRICE_GUARANTEE

PRIVACY_POLICY

ABOUT_CARD_PRO

ABOUT_REFERRAL_PROGRAM

REFERRAL_PROGRAM_NOT_AVAILABLE

REFERRAL_REGISTERED

SHARE_REFERRAL_LINK

EGC

PERS_PRICE

CONFIRM_EMAIL

STORE_INFO

SERVICE

RECOMMENDATION_TECHNOLOGY

SUBSCRIBE_RECEIPT

DELIVERY_PICKUP

PERSONAL_DATA_PROCESSING

PERSONAL_AGREEMENT

Responses

400 DocumentResponse

DocumentResponse

400 ErrorDocumentIsNotActive

Статическая страница неактивна в CMS Gate и её нельзя отображать пользователю.

GET /v2/documents/url

Документация: https://confluence.app.local/pages/viewpage.action?pageId=434080164

Request parameters

chpu

string required

Ссылка на запрашиваемый ресурс

Example:

/catalog/brendy/kinexib

Responses

400 DocumentResponse

DocumentResponse

400 ErrorDocumentIsNotActive

Статическая страница неактивна в CMS Gate и её нельзя отображать пользователю.

400 ErrorDocumentNotFound

Статическая страница не найдена.

400 ErrorBasketIsNotExist

Ошибка, которая возникает, когда корзина не найдена

GET /v1/documents/slot

Документация: https://confluence.app.local/pages/viewpage.action?pageId=899427774

По указанному слоту запрашивается фрагмент статической страницы из гейта и возвращается фронту

Request parameters

slot

string required

Слот, по которому требуется вернуть текст

Example:

mobile_app_fragment_services_velosipedy

Responses

400 DocumentResponse

DocumentResponse

400 ErrorDocumentNotFound

Статическая страница не найдена.

GET /v2/publications

Документация: https://confluence.app.local/pages/viewpage.action?pageId=434096594

Request parameters

url

string optional

URL публикации, используется для получения публикации в CMS Gate

Example:

/share-referral-link

string optional

ID публикации, используется для получения публикации в CMS Gate

Example:

11611026

Responses

400 PublicationResponse

PublicationResponse

400 ErrorPublicationNotFound

Публикация не найдена.

400 ErrorPublicationIdentifier

POST /v2/documents/findService

Документация: https://confluence.app.local/pages/viewpage.action?pageId=721044762

Request parameters

url

string required

URL публикации или ресурса вебвью, по которому требуется найти связанный сервис

Example:

/share-referral-link

Responses

400 ServiceFromUrlResponse

Если URL привёл на какой-то сервис – в ответе есть свойства сервиса. Иначе свойства NULL

400 EmptyRequestParamError

Ошибка, которая возникает, если фронт не передаёт обязательный параметр запроса.

GET /v1/documents/findService

DEPRECATED: версия 4.40.0 - 25.09 - 06.10

Документация: https://confluence.app.local/pages/viewpage.action?pageId=667902455

Request parameters

url

string required

URL публикации или ресурса вебвью, по которому требуется найти связанный сервис

Example:

/share-referral-link

Responses

400 ServiceFromUrlResponse

Если URL привёл на какой-то сервис – в ответе есть свойства сервиса. Иначе свойства NULL

400 EmptyRequestParamError

Ошибка, которая возникает, если фронт не передаёт обязательный параметр запроса.

POST /verify/sendSms

Отправка сообщения для подтверждения по SMS на указанный номер телефона. Если вызвать этот запрос с того же девайса для такой же операции до того, как истечет время жизни прошлой смс, то смс на самом деле не отправляется, а в ответе указывается актуальное время, когда реально можно будет отправить новую смс.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=490062455

Request body

application/json

Object

phone

Phone required

operation

string required

Операция для которой производится подтверждение.

Enumeration:

search_account

change_phone

social_network_registration

communicationChannel

string

Канал коммуникации. Если параметр не передан, то считается “SMS”

Enumeration:

SMS

CALL

Responses

400 SendSmsResponse

SendSmsResponse

400 ErrorDeviceBlocked

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

400 ErrorTooManyDifferentPhonesToRequestCode

ErrorTooManyDifferentPhonesToRequestCode

400 ErrorTooManyIncorrectCodeInputs

ErrorTooManyIncorrectCodeInputs

400 ErrorFieldValidationPhoneOwn

Не прошла собственная валидация телефона на бэкенде

POST /verify/check

Документация: https://confluence.app.local/pages/viewpage.action?pageId=563332490

Request body

application/json

Object

requestId

string required

Идентификатор проверки. Получается из метода SendSms

code

string required

Код введенный пользователем.

Responses

400 CheckResponse

Ответ на запрос проверки кода введенного пользователем.

400 ErrorDeviceBlocked

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

400 ErrorSmsCodeIncorrect

Смс код непраивльный

400 ErrorVerifyCodeExpiry

Время проверки данного кода истекло.

400 ErrorTooManyIncorrectCodeInputs

ErrorTooManyIncorrectCodeInputs

POST /verify/sendVerificationSms

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

Документация: -

Request body

application/json

Object

operation

string required

Операция для которой производится подтверждение.

Enumeration:

BONUS_USE

Responses

400 ErrorDeviceBlocked

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

400 SendVerificationSmsResponse

SendVerificationSmsResponse

POST /verify/checkSmsVerification

Документация: -

Request body

application/json

Object

requestId

string required

Идентификатор проверки. Получается из метода SendVerificationSms

code

string required

Код введенный пользователем.

Responses

400 ErrorDeviceBlocked

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

400 ErrorSmsCodeIncorrect

Смс код непраивльный

400 ErrorVerifyCodeExpiry

Время проверки данного кода истекло.

400 CheckSmsVerificationResponse

Ответ на запрос проверки кода введенного пользователем.

GET /v2/service/verification/increaseCount

Метод скорее всего увеличивает количество отправленных СМС, чтобы при достижении какого-то порога блокировать отправку СМС. Во избежание спама, перебора или чего-то еще

Можно почитать про упоминание метода здесь: https://jira.app.local/browse/MPSM-2137

В спеку метод добавлен постфактум, просто чтобы вы знали, что такой эндпойнт уже занят

Responses

400 default

default response

GET /v1/popups/{popupId}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=938409081

Path variables

popupId

string required

id всплывающего окна

Responses

400 PopupResponse

PopupResponse

400 ErrorPopupNotFound

Информация по всплывающему окну не была найдена

POST /v1/popups/settings

Документация: https://confluence.app.local/pages/viewpage.action?pageId=938409079

Request body

application/json

Object

oldPopupSettings

Array of PopupSettings

Сохранённая в МП информация по правилам показа всплывающих окон для фронта.

Responses

400 PopupSettingsResponse

Информация по правилам показа всплывающих окон для фронта.

GET /streams

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232120

Responses

400 StreamsResponse

StreamsResponse

GET /streams/live

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232126

Метод возвращает активный стрим, если такой есть. Если активного стрима нет, метод возвращает ближайший пока_неактивный стрим. Если стримов в будущем нет вообще, метод возвращает stream == null

Responses

400 ActiveStreamResponse

ActiveStreamResponse

GET /streams/{id}

Документация: https://confluence.app.local/pages/viewpage.action?pageId=494232132

Path variables

integer required

Responses

400 StreamResponse

StreamResponse

400 ErrorStreamNotFound

ErrorStreamNotFound

POST /streams/{id}/subscribe

Документация: https://confluence.app.local/pages/viewpage.action?pageId=563410336

Не имеет ничего общего с подписками из User Gate

Path variables

integer required

Идентификатор стрима

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorAnonymUser

ErrorAnonymUser

400 ErrorPhoneTypeLoginNotFound

ErrorPhoneTypeLoginNotFound

400 ErrorStreamNotFound

ErrorStreamNotFound

400 ErrorUserdAlreadySubscribed

Ошибка возращается в случае, если пользователь пытается подписаться на стрим, на которые он уже подписан

POST /streams/products

Метод для получения данных о товарах стрима для событий аналитики.

Данные получаются из Product Gate. Намеренно не дублируют данных, доступных в полной модели стрима.

Документация: https://confluence.app.local/pages/viewpage.action?pageId=683213981

Request body

application/json

Object

productIds

Array required

Массив идентификаторов цветомоделей из полной модели стрима

Min items: 1

string

Example:

"25939160299"

Responses

400 StreamProductsResponse

StreamProductsResponse

400 UnauthorizedError

Ошибка, возвращаемая в случае невалидности (истечения срока жизни токена) Access Token.

400 EmptyRequestParamError

Ошибка, которая возникает, если фронт не передаёт обязательный параметр запроса.

400 ErrorGateException

400 ErrorInvalidParameters

Общая ошибка, возвращаемая из BFF, если входные параметры запроса не прошли валидацию.

ТЗ: https://confluence.app.local/pages/viewpage.action?pageId=704914824

GET /api/support/streams/insider/get-csv-for-user-segment/{filename}

Документация метода: https://confluence.app.local/pages/viewpage.action?pageId=570016275

Path variables

filename

string required

Responses

200 200

Вернуть найденный файл

404 404

Not Found

POST /api/support/streams/insider/send-callback-for-user-segment

Документация метода: https://confluence.app.local/pages/viewpage.action?pageId=570016276

Request body

application/json

Object

status

string required

Статус создания сегмента

Example:

200

segment_name

string required

Название сегмента

Example:

Stream Reminder user segment, streamId: 22605

matched_user_count

string

Количество совпадений по пользователям между файлом и БД Insider

Example:

sent_user_count

string

Example:

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorStreamNotFound

ErrorStreamNotFound

GET /api/support/streams/insider/get-csv-for-user-segment/{streamId}

Authentication

Access token

Документация метода: https://confluence.app.local/pages/viewpage.action?pageId=656848045

Path variables

streamId

integer required

ID стрима

Responses

200 200

Вернуть найденный файл

404 404

Not Found

POST /api/support/streams/streamerce/stream-notification

Метод API для Streamerce, сообщающий об изменении статуса стрима. Отправлять в следующих случаях:

До запланированного старта стрима осталось 15 минут
Стрим фактически стартовал
Предыдущий стрим закончился – теперь ближайший стрим другой, сообщение об этом другом стриме

Документация метода: https://confluence.app.local/pages/viewpage.action?pageId=656848539

Выкачен ли метод – смотри в задачах

Request body

application/json

Object

streamId

integer required

ID стрима, о котором сообщение

Example:

623342

startDate

string required

Время начала стрима – назначенное, если стрим должен начаться в будущем; фактическое, если стрим только что стартовал

Example:

2023-04-18T15:00:02.000Z

Responses

400 EmptyResponse

Пустой ответ сервера

400 ErrorStreamNotFound

ErrorStreamNotFound

Полезная нагрузка JWT токена.

Object

profileId

string

Идентификатор пользователя в UserGate.

expiresAt

integer

Время в формате UnixTime, определяющее момент, когда токен станет невалидным (expiration).

deviceId

string

Идентификатор устройства пользователя.

isAnonym

boolean

Признак анонимности пользователя

userGateToken

string

access_token из UserGate

anonymAid

string

Идентификатор анонимного пользователя в UserGate. Необходим для связи анонима и неанонима после логаута.

anonymUserGateTokenEndDate

Date

Types: Access Token Refresh Token

Структура Refresh Token (JWT) до шифрования.

Object

header

Object

Заголовок JWT токена.

alg

string

Используемый алгоритм подписи.

typ

string

Тип токена.

enc

string

Используемый алгоритм шифрования.

payload

Payload

Структура Access Token (JWT) до шифрования.

Object

header

Object

Заголовок JWT токена.

alg

string

Используемый алгоритм подписи.

typ

string

Тип токена.

enc

string

Используемый алгоритм шифрования.

payload

Payload

Номер телефона

Object

countryCode

integer required

Телефонный код страны

Example:

nationalNumber

integer required

Часть номера без кода страны

Example:

9123456789

isoCode

string required

Код страны ISO 3166-1 alpha-2

Methods: DEP Установить получателя корзины возврата Отправить смсдозвон если номер неизвестен Установить получателя корзины cart2 Установить получателя корзины возврата v2 Установить получателя корзины услуг

Types: BaseShop CartOwner EgcReceiver OrderReciever PickupOrderInfo Profile ReceiverOrderInfo TrainerForm

Responses: IsSocialNetworkExistsResponse

Модель цены

Object

value

integer required

Значение цены в копейках

currency

string required

Валюта в ISO 4217

Example:

RUB

Methods: Оформить заказ ЭПК Провести валидацию подарочной карты

Types: AltCourierDelivery AppealOrdersHistory BonusLevelConfirmation BonusProgramProgress CartDiscount CartItemExternalAvailability2 CartItemFull2 CartItemInObtainPoint CartItemMiddle CartLiteItem CartService CartTotals coupon DeliveryInfoVariant DiscountList EgcOrder EgcValue InternalAvailabilityPotentialOrder OrderItem OrderProductItem OrderService OrderTotals PaymentInfo PaymentObjectModel PaymentScheduleItem PersonalPrice PickupDeliveryOptions PotentialOrderTotals ProductKitPrice ProductPersonalDiscount ProductPrice RefundMethod RefundMethodShort ReturnCartItem ReturnCartTotals ReturnDetails ReturnItem ReturnPaymentInfo ReturnPotentialOrderTotals ReturnrProductItem ServiceCartItem ServiceCartTotals ServicePotentialOrderTotals ServiceProduct SkuAvailabilityDeliveryOption

Responses: ValidateGiftCardResponse

Дата в формате yyyy-MM-dd'T'HH:mm:ss'Z'. Пример: 2019-12-21T12:00:00Z. Что соответствует 12 часам дня в UTC.

string

Example:

2019-12-21T12:00:00Z

Methods: DEP Детализация бонусов по дням

Types: AppealOrdersHistory CartItemFull2 CompareProduct EgcDelayedSend FavoriteProduct LastMessage Order OrderingShopInventory OrderItem OrderStatus Payload ShopInventory SkuAvailabilityPickup Stream StreamFull

Дата в формате yyyy-MM-dd'T'HH:mm:ssZZZZZ. Пример: 2022-10-21T12:00:00+04:00

string

Example:

2022-10-21T12:00:00+04:00

Methods: Актуализировать геозоны

Types: CurrentFamilyMember InternalAvailabilityPotentialOrder ObtainPointIntPickupInfo OrderDeliveryInfo OrderingShopInventory PopupSettings Profile ShopInventory SkuAvailabilityDeliveryInfo SkuAvailabilityTransport

Responses: AddressResponse CityResponse GeoFencesResponse

Дата без времени в формате yyyy-MM-dd

string

Example:

2019-12-21

Methods: DEP Установить дату и время у потенциального заказа на возврат Детализация бонусов по типу История бонусных операций Условия бонусных акций Установить дату и время у потенциального заказа cart2 Установить дату и время у потенциального заказа корзины услуг Установить дату и время у потенциального заказа на возврат v2

Types: AltCourierDelivery Anketa Answer BonusAmountDetail BonusBalanceItem BonusCoupon BonusDetails BonusesInfo BonusHistoryItem BonusInfoItem BonusLevelConfirmation CartItemExternalAvailability2 child CurrentFamilyMember DeliveryInfoVariant IndividualSportsmanForm InternalAvailabilityPotentialOrder IntServiceInfoVariant MediaArticle Message ObtainPointCourierInfo ObtainPointDeliveryInfo ObtainPointExtPickupInfo ObtainPointIntServiceInfo OrderDeliveryInfo PaymentScheduleItem PersonalDiscount PickupCourierInfo PickupDeliveryOptions Promo Promocode Publication Question RecentProductColorModel ReturnDeliveryInfo ReturnDeliveryInfoVariant ReturnDetails ReturnItem ReturnMethodInfo Review Reward ServiceDeliveryInfo SkuAvailabilityDeliveryInfo SkuAvailabilityDeliveryOption SkuAvailabilityTransport TrainerForm

HEX значение

string

Example:

#4BA221

Types: AchievementListItem BadgeParameters BonusCoupon Button ButtonParameters CartItemBadge ColorFacetItem Lookzones MetroLine OrderStatus PopupButton PopupButtons PopupContent ProductColorModelBadge ProductCompositeColor Promo Promocode RecommendationProductsGroup ReturnStatus ServiceItem TrainingNative

Ссылка на изображение

string

Example:

https://cdn.sptmr.ru/upload/resize_cache/iblock/d04/370_416_1/41571720299.jpg

Types: AccessoriesCategory AchievementListItem AfishaEvent artMedia Banner BannerBonuses BannerShort BenefitBanner Brand CartBanner CartItemFull2 CartItemMiddle CatalogMenuItem Category ColorFacetItem ColorModelSizes compareTab DeliveryAdress EgcImage FavouriteList GenderImages GuideShortInfo InStoreMenuItem Interest KitsCategory LinkedColorModel Look Lookzones MainBanner MainBannerWithButton MainBannerWithTimer MainCategory MainGuide MainPopularCategoryGroup MainPopularServicesSection MainSliderBanner MainStreamsTrendsClip MediaArticle Message OrderProductItem PaymentMethod PaymentToolInfo PersonalDiscount PopularSport PopupContent ProductBreadCrumb ProductColorModel ProductColorModelBadge ProductKit ProductKitMedias ProductMedia ProductSeller ProductSticker ProductTechnology Profile Promo Promocode Publication Question RecommendationProductsGroup Register ReturnCartItem ReturnrProductItem Review RewardBanner RewardContent ServiceCartItem ServiceCategory ServiceItem ServiceRegularBanner ServiceWidget ShopFormat SkuAvailabilityInShop Slot SpecificDeliveryService Stream StreamFull SurveyAnswer Training TrainingNative

Responses: ServicesDashboardResponseOld UserPhotosResponse

Операционная система

string

Enumeration:

ios

android

Types: Device

Модель сортировки

Object

QuestionsSort required

name

string required

Название сортировки, отображается пользователю

isSelected

boolean required

Признак, что сейчас список сортируется по этой сортировке

Responses: QuestionsResponse ReviewsListResponse ReviewsResponse

Object

lat

number double

lng

number double

Types: BaseShop DropoffDeliveryPointReturnInfo DropoffShopReturnInfo GeoCity IntServiceOrderInfo MetroStation Pickpoint PickPointOrderInfo PickupOrderInfo

См также: V.1.2. Таблица наполнения экрана сервисов. Таблица соответствия значений. ServiceItem. id

string

Enumeration:

PROMOS

AFISHA

TRAVELING

MEDIA

STREAMS

TRACKER

BDAY

STORES

BONUSES

GAME

TRAININGS

TRAININGS_NATIVE

SERVICES

[произвольное строковое значение]

[DEPRICATED]SERVICE_WIDGET

ACHIEVEMENTS

CHAT

BETS

GAME_CENTER

Methods: Изменить список избранных сервисов Получить доступные группы сервисов Получить секции экрана сервисов

Types: MainPopularServicesSection ServiceItem ServiceItemsLight ServiceWidget

Responses: FavoriteServicesListResponse ServiceFromUrlResponse

Ссылка на видео

string

Example:

https://cdn.sportmaster.ru/upload/content/contentgate/uat/ru_sm/banners/1_1.mp4

Types: MainBanner MainBannerWithSize MainSliderBanner

Файл, закодированный в base64

P.S. В перспективе, если в будущем помимо base64 будут использоваться еще какие-то стандарты кодирования, то можно расширить эту модель и добавить атрибут, в каком формате передается данный файл

Object

name

string required

Наименование файла с расширением

body

string required

Файл, закодированный в base64

Types: ReturnBasketLine

Время в формате [hh]:[mm]:[ss]. Пример: 12:10:10

string

Example:

12:10:10

Продолжительность в формате ISO 8601, формат P(n)Y(n)M(n)DT(n)H(n)M(n)S.Пример: P2Y10M15DT10H30M20S (duration of 2 years, 10 months, 15 days, 10 hours, 30 minutes and 20 seconds)

string

Example:

P2Y10M15DT10H30M20S

Types: BadgeParameters

Responses: PersonalDiscountTaskResponse

Конфигурация модуля Profile

Используется в методе Получить конфигурации модулей

Object

amountBonus

integer required

[DEPRECATED] c версии 4.60 Количество бонусов

referralProgramEnabled

boolean required

Фича тоггл для Реферальной программы

chatEnabled

boolean required

[DEPRECATED] c версии 4.52 Фича тоггл Чата с поддержкой

profilePrivacyTextEnabled

boolean required

[DEPRECATED] c версии 4.77. Фича тоггл на показ текста условий пользования при регистрации и на форме обратной связи [Дубль OrderingConfiguration.orderPrivacyTextEnabled, удалить, когда поднимется версия и переместить в AppConfiguration]

favSportEnabled

boolean required

Фича тоггл для Любимого вида спорта

rewardsEnabled

boolean required

Фича тоггл раздела “Нематериальные вознаграждения”

clientInterestsEnabled

boolean required

Фича тоггл раздела “Мои интересы”

personalDiscountsEnabled

boolean required

Фича тоггл раздела “Персональные скидки”

familyEnabled

boolean required

Фича тоггл показа элементов семейного аккаунта

cardProTrainerEnabled

boolean required

[DEPRECATED] c версии 4.79 Фича тоггл для функциональности Карты PRO (ЛК тренера)

cardProEnabled

boolean

[DEPRECATED] c версии 4.79 Фича тоггл общей функциональности Карты PRO

sportsmanParentEnabled

boolean required

Фича тоггл для функциональности КартыПро. Регистрация родителя спортсменом, если ребёнку нет 14 лет

authSberIdEnabled

boolean required

Фича тоггл авторизации по Сбер ID

cardProTrainerInvitationEnabled

boolean

[DEPRECATED] c версии 4.79 Фича тоггл для доступа к разделу Регистрация тренера

createNewAppealEnabled

boolean

Фича тоггл новой обратной связи

Example:

false

cardProSportsmanEnabled

boolean

[DEPRECATED] c версии 4.79 Фича тоггл ЛК спортсмена

Example:

false

personalDiscountsActiveEnabled

boolean

Фича тоггл активации скидки в разделе “Персональные скидки”

Example:

false

orderRefundEnabled

boolean required

Фича тоггл доступности функционала возврата товаров у заказа

tickerEnabled

boolean required

Фича тоггл баннера “Бегущая строка”

benefitsEnabled

boolean required

Фича тоггл раздела “Все акции”

Types: AllConfigurationsData

Responses: ProfileConfigurationResponse

Конфигурация для почты России.

Получается из статичной страницы http://www.cms-gate.web.local/api/v1/staticpage?site=sm&front=mobile_app&consumer=frontoffice_prod_mpsm&locale=ru-RU&staticContentId=1306401

Текст, который нам приходит не должен содержать спец символы в виде символа новой строки и переноса каретки

Object

fioWarning

string required

Берется из warning

Example:

ФИО должны быть указаны точно, как в паспорте получателя

howToGet

string required

Берется из how_to_get

Example:

Для получения заказа необходимо предъявить паспорт или установить и зарегистрироваться в приложении Почты России

Types: OrderingConfigurationModel

Настройка для рассрочки

Object

isEnabled

boolean required

Включен ли механизм рассрочки

Types: OrderingConfigurationModel

Object

isEnabled

boolean required

Включен ли шаринг корзины

Types: OrderingConfigurationModel

Конфигурация модуля ordering

Используется в методе Получить конфигурации модулей

Object

russianPost

RussianPostConfiguration

needPrepayDescription

string required

Текстовое описание причины предоплаты для потенциального заказа

Example:

Мы начнем сборку заказа сразу после поступления 100% оплаты онлайн

installment

InstallmentConfiguration

cartSnapshot

CartSnapshotConfiguration

[DEP] orderPrivacyTextEnabled

boolean required

DEP в рамках MPSM-16409. Фича тоггл для показа текста вместо чекбокса условий пользования при оформлении заказа [Дубль ProfileConfiguration.profilePrivacyTextEnabled, удалить, когда поднимется версия и переместить в AppConfiguration]

cart2Enabled

boolean required

Включена ли вторая версия корзины

pickupAvailabilityTimeEnabled

boolean required

Фича тоггл времени довоза заказа в РМ

yandexSplitSdkEnabled

boolean required

Фича тоггл использования SDK для оплаты Яндекс Сплит

yandexDiscountEnabled

boolean required

Фича тоггл отображения плашки со скидкой Яндекс Сплит

retailSelfDeliveryEnabled

boolean required

Фича тоггл доступности функционала “Товар у меня в руках”

pickupQuickFilterEnabled

boolean required

Фича тоглл работы и отображения быстрого фильтра на карте со списком пунктов самовывоза

serviceCenterMode

string required

Enumeration:

HTML

CATALOG

CART

Types: AllConfigurationsData

Responses: OrderingConfigResponse

Конфигурация для обновления приложения

Object

forceUpdate

boolean required

Блокирующее это обновление или нет

title

string required

Текст заголовка

message

string required

Текст сообщения

buttonText

string required

Текст кнопки

Types: AppConfigurationModel

Responses: AppConfigResponse

Конфигурация показа диалога оценки приложения

Object

appOpenCount

integer required

Минимальное количество открытий приложения до того, чтобы начать пытаться показывать диалог с оценкой

interval

integer required

Интервал показа в днях. Например, если пришло 2, то показываем раз в 2 дня.

viewAmount

integer required

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

Types: AppConfigurationModel

Responses: AppConfigResponse

[DEPRECATED] Модель для конфигурации сервисов

Object

isAfishaEnabled

boolean required

Значение берется из админки. Это фича тогл

isStreamsEnabled

boolean required

Значение берется из админки

isTrainingsEnabled

boolean required

isTravelEnabled

boolean required

travelPublicationUrl

string

Url публикации путеществий из цмс гейта.

trainingsPublicationUrl

string

Url публикации тренировок из цмс гейта.

promosPublicationUrl

string

Url публикации акций из цмс гейта.

Responses: AppConfigResponse

Элемент на экране сервисов. Наполняется из CMS гейта механизмом баннеров.

Object

bannerId

string required

ID баннера из CMS Gate

ServicesEnum required

type

ServiceItemType required

image

ImageUri required

imageAssetId

string

ID ассета, если баннер был загружен через Laika

title

string required

Название раздела

Example:

Клуб путешественников

textColor

Color

url

string

Диплинк для перехода

Example:

/catalog/aksessuary/

slot

string required

Мнемокод баннера

Example:

"sm_hh_service_tracker"

Types: ServiceSectionEntity ServicesGroupItem

Responses: AppConfigResponse

string

Enumeration:

DEFAULT

PUBLICATION

WEBVIEW

Types: MainPopularServicesSection ServiceItem ServiceItemsLight ServiceWidget

Конфигурация показа диалога получения бонусов за заполнение анкеты

Object

bannerOpenCount

integer required

Количество показа баннера до того, чтобы изменить интервал показа на другой

intervalOne

integer required

Интервал показа в днях. Например, если пришло 30, то показываем раз в 30 дней

intervalTwo

integer required

Интервал показа в днях. Например, если пришло 180, то показываем раз в 180 дней

Example:

180

viewAmount

integer required

Количество раз, которое мы будем пытаться показать диалог. Т.е. если интервал 30, то каждые 30 дней вот столько раз мы будем пытаться показать диалог

slot

string required

Мнемокод баннера

Example:

"sm_hh_mobileapp_bannerBonuses"

bannerId

string required

ID баннера из CMS Gate

image

ImageUri required

imageAssetId

string

ID ассета, если баннер был загружен через Laika

title

string

Заголовок

text

string

Текст для изображения

tag

string required

Название метки жизненной ситуации

Example:

AVT_SITE

Responses: AppConfigResponse

Object

ServicesEnum

type

ServiceItemType

smallSlot

string

Слот для получения баннера в CmsGate для нового экрана сервисов

mainPageSlot

string

Слот для получения баннера в CmsGate для блока популярных сервисов на главной странице

Types: AppConfigurationModel

Не используется с версии 4.68

Object

bannerOpenCount

integer required

Количество показа баннера до того, чтобы изменить интервал показа на другой

intervalOne

integer required

Интервал показа в днях. Например, если пришло 30, то показываем раз в 30 дней

intervalTwo

integer required

Интервал показа в днях. Например, если пришло 180, то показываем раз в 180 дней

Example:

180

viewAmount

integer required

tag

string required

Название метки жизненной ситуации

Example:

AVT_SITE

slot

string required

Мнемокод баннера

actionType

BannerActionType required

actionText

BannerActionText required

Types: AppConfigurationModel

Конфигурация модуля app

Используется в методе Получить конфигурации модулей

Object

appReview

ReviewsConfiguration

appUpdate

AppUpdateConfiguration

serviceItems

Array of ServiceItemsLight

Элементы на экране сервисов. Отправляются только включенные сервисы

bannerSliderTimer

integer

Время (в секундах) переключения баннеров в слайдере на Главной (не в шапке)

amountBonus

integer required

Количество бонусов. DEP с версии 4.60

geoFencesEnabled

boolean required

Фича тоггл геозон

locationTrackingEnabled

boolean required

Фича тоггл фактической геопозиции клиента

banners

Array of BannerLight

[DEPRECATED] c версии 4.68. Параметры показа баннеров в шторках

promosPageUrl

string

Диплинк для перехода

Если serviceItems содержит PROMOS сервис, то /promo,

Иначе null

newYear

boolean required

Фича тоггл новогодней анимации

newMessageCenterEnabled

boolean

Фича тоггл нового ЦУ

mainDynamicPageEnabled

boolean

Фича тоггл конструктора главного экрана

Types: AllConfigurationsData

Responses: AppConfigResponseV4

Конфигурация модуля catalog

Используется в методе Получить конфигурации модулей

Object

bestPriceEnabled

boolean required

Доступна ли функция лучшей цены

searchHint

string required

Подсказка поиска

persPriceEnabled

boolean required

Отображение персональной цены

replenishmentEnabled

boolean required

Фича тогл для листа ожидания

cart2Enabled

boolean required

Включена ли вторая версия корзины [Дубль OrderingConfiguration, удалить, когда поднимется версия]

pickupAvailabilityTimeEnabled

boolean required

Фича тоггл времени довоза товаза в РМ

[DEP] correctedQueryTextEnabled

boolean required

Фича тоггл отображения поискового запроса (поиск) DEP 4.8x

associatedAttributesPreSelectEnabled

boolean required

Фича тогл предвыбора размеров товаров с ассоциирущими атрибутами

productCardAsyncEnabled

boolean required

Фича тогл асинхронной загрузки КТ

newCatalogMenuEnabled

boolean required

Фича тогл нового меню каталога

accessoriesEnabled

boolean required

Фича тогл конструктора аксессуаров

productKitsEnabled

boolean required

Фича тогл комплектов товаров

photoReviewEnabled

boolean required

Фича тогл на блок “Фото покупателей”

[DEP] serviceCenterNativeEnabled

boolean required

Фича тогл перехода в нативный или сверстанный раздел сервисных услуг. DEP 4.73.0

newPaginationEnabled

boolean required

Фича тогл новой пагинации товарного листинга

redirectFromLookzoneEnabled

boolean required

Фича тогл перехода из лукзон в карточку товара

redirectFromAccessoriesEnabled

boolean required

Фича тогл перехода из конструктора аксессуаров в карточку товара

catalogPersPriceEnabled

boolean required

Фича тогл персцены в листинге

reviewHightlightsEnabled

boolean required

Фича тогл умных отзывов в КТ

newFiltersEnabled

boolean required

Фича тогл для нового экрана фильтров

newPickupFilterEnabled

boolean required

Фича тогл для нового экрана фильтра самовывоза

catalogContentPageEnabled

boolean required

Фича тогл для CLP в каталоге

snackbarWithCounterEnabled

boolean required

Фича тогл снекбара с каунтером в КТ

obligatoryServicesEnabled

boolean required

Фича тогл сервисного сбора в КТ

Types: AllConfigurationsData

Responses: CatalogConfigResponse

Конфигурация модуля stores

Используется в методе Получить конфигурации модулей

Object

inStoreEnabled

boolean required

Я в магазине

Types: AllConfigurationsData

Responses: StoresConfigResponse

Конфигурация модуля streams [DEP] -> https://sportmaster-streams.speca.handh.ru/#StreamsConfiguration

Object

streamsPipPlaybackEnabled

boolean required

Признак использования миниплеера для отображения вместо кнопки “Live”, и отображения миниплеера при закрытии стрима.

trendsEnabled

string required

Признак возможности отображения ленты коротких роликов

Responses: StreamsConfigResponse

Конфигурация модуля afisha

Используется в методе Получить конфигурации модулей

Object

useOldAfishaUrl

boolean required

Использовать ли старый или новый урл для Афиши

Types: AllConfigurationsData

Responses: AfishaConfigResponse

Конфигурация модуля chat

Используется в методе Получить конфигурации модулей

Object

chatABtestEnabled

boolean required

[DEPRECATED] c версии 4.52 Фича тоггл АБ-теста чата “Спортивный помощник”

chatSherlockEnabled

boolean required

[DEPRECATED] c версии 4.52 Фича тоггл для переключения чата “Шерлок” и “Спортивный помощник” (включенный тоггл = чат “Шерлок”)

chatEnabled

boolean required

[DEPRECATED] можно удалить, когда будет выпилен ФТ newMessageCenterEnabled. Фича тоггл Чата “Спортивного помощника”

Types: AllConfigurationsData

Responses: ChatConfigurationResponse

Параметр запроса конфигурации, содержащий только версию ОС.

Object

osVersion

string required

Номер версии

Example:

5.1.1

Параметры запроса конфигурации модуля

Object

version

integer required

Версия конфигурации

Example:

request

unknown

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

Methods: Получить конфигурации модулей

Конфигурации по всем модулям. Каждое поле - конфигурация определенного модуля. Объект, который будет лежать в поле, указан в таблице метода Получить конфигурации модулей

Object

catalog

CatalogConfigurationModel

ordering

OrderingConfigurationModel

profile

ProfileConfigurationModel

stores

StoresConfiguration

app

AppConfigurationModel

streams

unknown

Конфигурация модуля streams. Конфиг находится в отдельной спеке (https://sportmaster-streams.speca.handh.ru/#StreamsConfiguration)

afisha

AfishaConfigurationModel

chat

ChatConfigurationModel

tracker

unknown

Конфигурация модуля tracker. Конфиг находится в отдельной спеке (https://sportmaster-tracker.speca.handh.ru/#TrackerConfigurationModel)

popups

PopupsConfigurationModel

Responses: AllConfigurationsResponse

Конфигурация модуля popups

Используется в методе Получить конфигурации модулей

Object

contentGatePopupEnabled

boolean required

Фичатоглл для отображения всплывающих окон

Types: AllConfigurationsData

Responses: PopupsConfigResponse

Детализация потенциальных бонусов (бонусы, которые могут быть начислены клиенту, если он выкупит корзину)

Object

mdmId

integer required

ID акции

name

string required

Наименование акции

Example:

Дополнительный кэшбэк

amount

number required

Размер скидки

Example:

100

Types: CartTotals PotentialOrderTotals ServiceCartTotals ServicePotentialOrderTotals

Доступные услуги для заданного варианта доставки

Object

integer required

ID MDM услуги

name

string required

Наименование услуги

availability

boolean required

Признак доступности услуги

availableIcon

ImageUri

unavailableIcon

ImageUri

Types: ObtainPointCourierInfo

Итоги по потенциальному заказу

Object

productAmount

integer required

Сколько товаров в заказе. 2 одинаковых кроссовка и 1 шапка = три товара.

totalCost

Price required

totalCatalogCost

Price required

totalServicesCost

Price required

totalDeliveryCost

Price required

totalServiceChargeCost

Price

serviceChargeDescription

string

Текст для отображения в шторке с информацией о сервисном сборе

discounts

CartDiscountList

pendingPotentialBonuses

number

Общая сумма потенциальных бонусов за оформление текущего заказа

pendingPotentialBonusesPromo

Array of PendingPotentialBonusesPromo

Акции по потенциальным бонусам за оформление текущего заказа

[DEP] promo

Price required

[DEP] totalBonusesUsed

Price required

[DEP] catalogDiscount

Price required

Types: PotentialOrder2

Данные о получателе корзины

Object

fio

string

ФИО пользователя

phone

Phone

string

Email пользователя

Types: CartFull CartFull2 ReturnCart ServiceCart

Модель оплаты для списка доступных методов оплаты потенциального заказа

Object

paymentMethod

PaymentMethod required

period

integer

Срок кредитования (рассрочки). Удаляется из контракта в рамках MPSM-8777, т.к. не используется на фронте

costThreshold

Price

isEnabled

boolean required

Доступен ли элемент к выбору. Гейт возвращает только доступные к оплате. Нам сюда нужно приделывать кредит и делать его недоступным. Данные по кредиту и откуда брать тест смотри модель CartBankProducts поле про кредит.

Types: PotentialOrder2

Responses: PaymentMethodsResponse2

Тип лифта

Object

string required

Айди. Вшивать энам на клиенте не нужно. Перечисление дано для БЭ, чтобы ребята поняли, как мапить

Enumeration:

NOTSPECIFIED

ABSENT

PASSENGER

CARGO

name

string required

Название присуствия лифта. Вшивать энам на клиенте не нужно. Перечисление дано для БЭ, чтобы ребята поняли, как мапить

Enumeration:

Неизвестно

Отсутствует

Пассажирский

Грузовой

Types: DeliveryAddressInfo ObtainPointCourierInfo ReceivingAddressInfo

Информация МСДП по самовывозу из ПВЗ

Object

pickPointAddress

string required

Адрес точки самовывоза

Example:

г. Саранск, ТЦ "РИО", ул. советская, д.55а

pickPointTypeName

string required

Название типа ПВЗ

Example:

Отделение почты

pickPointTypeIcon

string

Иконка типа ПВЗ

pickPointId

number required

Айди ПВЗ

receivingDateFrom

DateOnly

receivingDateTo

DateOnly

storeTerm

integer

Срок хранения в днях.

isRussianPost

boolean

Является ли данная доставка из пвз - доставкой почты россии.

Types: ObtainPointDeliveryInfo

string

Enumeration:

PICKUP

DELIVERY

PICKPOINT

DELIVERY_EGC

DROPOFF_SHOP

DROPOFF_DELIVERY_POINT

PICKUP_COURIER

Types: CartDeliveryInfo2 CartFull DeliveryType ObtainPointsDeliveryTypes

Responses: CartItemsDeliveryTypes

Тип доставки

Object

title

string

Заголовок

Example:

Самовывоз

value

DeliveryTypeEnum

Types: CartItemDeliveryInfo2 ObtainPointDeliveryInfo OrderDeliveryInfo OrderItem

Инвентаризация в магазине

Object

begin

Date

end

Date

beginDateTime

OffsetDateTime

endDateTime

OffsetDateTime

cause

string

Причина инвентаризации

Enumeration:

COMPLETE_INVENTORY

PARTIAL_INVENTORY

SCHEDULED_INVENTORY

Types: ObtainPointIntPickupInfo PickupOrderInfo

Информация МСДП по самовывозу из магазина

Object

shopAddress

string required

Адрес магазина

Example:

г. Саранск, ТЦ "РИО", ул. советская, д.55а

shopTypeName

string

Название типа магазина

Example:

Супермаркет

shopTypeIcon

string

Иконка типа магазина

shopId

number required

Айди магазина

receivingDateTimeFrom

OffsetDateTime

inventory

OrderingShopInventory

storeDays

integer

Срок хранения в магазине

Types: ObtainPointDeliveryInfo

Данные по времени и дате доставке

Для БЭ: http://ordergate-ru-by-kz.ordergateuat.web.local/swagger-ui/index.html?url=../openapi.yaml#/baskets/getAltDelivery

Object

dateFrom

DateOnly

dateTo

DateOnly

timeSlot

string

Временной интервал доставки

timeSlotId

integer

ID временного слота доставки

deliveryCost

Price

isExpress

boolean required

Является ли данный слот слотом для экспресс доставки

deliveryServiceLevelId

integer required

ID MDM уровня сервиса доставки (справочник gt_service_level)

deliveryHours

integer

Количество часов для доставки

isSelectedServicesAvailable

boolean required

Флаг доступности выбранных сервисов доставки для данного интервала

isDeliveryClick

boolean

Признак Доставки по клику

deliveryClick

DeliveryClick

Types: ObtainPointCourierInfo

Информация МСДП по курьерской доставке

Object

receivingDateFrom

DateOnly required

receivingDateTo

DateOnly

receivingTimeSlot

string

Временной интервал доставки

Example:

09:00 - 14:00

receivingTimeSlotId

integer

ID временного слота доставки

receivingDeliveryHours

integer

Количество часов для доставки

territoryId

string

[Удалено в рамках 13943] ID MDM населенного пункта (НП)

territoryName

string

[Удалено в рамках 13943] Название населенного пункта (НП)

streetId

string

[Удалено в рамках 13943] ID улицы в GeoGate (НП)

Max length: 100

street

string

[Удалено в рамках 13943] Улица (НП)

Max length: 512

house

string

[Удалено в рамках 13943] Дом (НП)

Max length: 64

entrance

string

[Удалено в рамках 13943] Подъезд (НП)

Max length: 32

doorphoneCode

string

[Удалено в рамках 13943] Код домофона (НП)

Max length: 64

elevator

Elevator required

floor

integer

[Удалено в рамках 13943] Этаж (НП)

apartment

string

[Удалено в рамках 13943] Квартира (НП)

Max length: 32

Pattern: ^$|^[\pL\d ]+$

addressConfirmed

boolean

[Удалено в рамках 13943] Признак верификации адреса (НП)

isExpress

boolean required

Является ли выбраная доставка - экспресс.

specificDeliveryServices

Array of SpecificDeliveryService

Доступные услуги доставки

availableDeliveryVariants

Array of DeliveryInfoVariant required

Данные по времени и дате доставке

receivingAddressInfo

ReceivingAddressInfo

Types: ObtainPointDeliveryInfo

Информация о доставке для данного МСП.

Одно из полей (intPickup, extPickup, delivery) должно быть не null.

Object

selectedDeliveryType

DeliveryType required

intPickup

ObtainPointIntPickupInfo

extPickup

ObtainPointExtPickupInfo

delivery

ObtainPointCourierInfo

territoryDate

DateOnly

shippingMethod

string

Ключ способа получения товара

Example:

10060299

shippingMethodLevel

string

Ключ уровня сервиса получения товара

Example:

10060299

shippingMethodLevelCode

string

Мнемокод ключа уровня сервиса получения товара

Example:

RETAIL_SELF_DELIVERY

Types: ObtainPoint2

Способ оплаты заказа Список возможных способов оплаты в OrderGate: https://confluence.app.local/pages/viewpage.action?pageId=386449608 и в МДМ: https://confluence.app.local/pages/viewpage.action?pageId=314147975

Object

string required

Значение, которое потом подставляется в другие методы. По сути это энам из гейта

name

string required

Название варианта оплаты. Отображается пользователю

Example:

При получении

shortDescription

string

Краткое пояснение к полю.

Example:

Наличными или картой

extraDescription

string

Некий экстра пояснительный текст. Поддерживает простые html тэги.

Example:

Как оформить кредит онлайн? И тут длинное описание как. Это для кредитов и рассрочки от сбера, например. Этот текст берется из цмс гейта, смотри модель CartBankProducts и там про кредит

icon

ImageUri required

paymentSchedule

Array of PaymentScheduleItem

График платежей

paymentTools

Array of PaymentToolInfo

Инструменты оплаты

yandexPayBanner

CartBanner

discount

number

Размер скидки, если воспользоваться этим способом оплаты

Example:

isEnabled

boolean required

Доступен ли способ оплаты к выбору. OrderGate возвращает только доступные к оплате. Бэкенд на своей стороне может добавлять недоступные способы оплаты. Атрибут перенесен из модели PaymentObjectModel, которая в свою очередь кажется избыточной и в целевой картине все корзины должны отвязаться от нее.

Example:

true

selected

boolean required

Признак, были ли этот способ оплаты выбран или нет. Новый атрибут. В целевой картине все корзины должны использовать массив для отображения доступных способов оплаты, а по атрибуту selected определять выбранный способ оплаты. Сейчас в обычной корзине для выбранного способа оплаты используется отдельный атрибут, что является избыточным.

Example:

false

Types: PaymentObjectModel PotentialOrder2 ServicePotentialOrder

Упрощенный формат оформленного заказа

Object

orderNumber

string required

Номер заказа

Responses: SubmitCartResponse

Облегченная версия полной модели товара в корзине

Object

cartItemId

CartItemIdWithLines

name

string required

Название товара в корзине

image

ImageUri required

params

Array of CartItemParams required

Параметры товара (цвет, размер и тд.)

quantity

integer required

Сколько в корзине данного товара, штук

itemPrice

Price required

itemPriceWoDiscount

Price required

totalPrice

Price required

totalPriceWoDiscount

Price required

catalogPrice

Price required

catalogDiscount

Price required

Types: CartFull2 EditCart

Сервисные услуги при доставке

Object

mdmServiceId

string required

ИД сервисной услуги в МДМ

Example:

59048860299

name

string required

Название услуги

Example:

Сборка тренажеров и инвентаря

description

string

Описание услуги

shortDescription

string

Краткое описание услуги

noteShort

string

Текст условия зависимой услуги на уровне заказа

riseDescription

string

Текст для подъема. Для услуг на уровне товаров всегда NULL

servicePrice

Price required

servicePriceWoDiscount

Price required

discount

Price required

isSelected

boolean required

Выбрана ли услуга

serviceLineId

string

Ид лайна услуги в корзине. Заполнен если isSelected = true

Example:

fa537932-e755-42a0-bda3-aaa48cec724e

parentLineId

string

Ид лайна товара в корзине, к которому относится услуга. Для услуг на уровне заказа всегда NULL

Example:

183e2eae-676f-4062-947c-e8788181009b

parentServicesIds

Array of string

ID услуг(и), для которой эта зависимая услуга

Types: CartItemInObtainPoint ObtainPoint2

Итоговая информация по банковским продуктам в корзине

Object

yandexSplitBanner

CartBanner

bnplSovcombankBanner

CartBanner

installmentBanner

CartBanner

creditBanner

CartBanner

isCreditAvailable

boolean required

Если итоговая сумма корзины >= 4000 рублей, то доступно.

isInstallmentAvailable

boolean required

Доступна ли рассрочка.

Для БЭ: Определяется для каждого товара через ордер гейт по creditProducts.

isBnplSovcombankAvailable

boolean required

Доступна ли оплата частями Плайт

isYandexSplitAvailable

boolean required

Доступна ли оплата Яндекс Сплитом

Types: CartFull2

Итоги по всей корзине

Object

productsAmount

integer required

Количество товаров.

Для бэ: количество лайнсов, за исключением распроданных и удаленных.

total

Price required

priceWoDiscount

Price required

totalWoDelivery

Price required

totalDeliveryCost

Price

discounts

CartDiscountList

pendingPotentialBonuses

number

Общая сумма потенциальных бонусов за заказ

pendingPotentialBonusesPromo

Array of PendingPotentialBonusesPromo

Акции по потенциальным бонусам за оформление текущего заказа

[DEP] catalogDiscount

Price required

[DEP] bonuses

Price

[DEP] promo

Price required

Types: CartFull CartFull2 EditCart

Группа скидок или акций в корзине. Например “Персональная скидка”, “Промокод”

Object

price

Price required

name

string

Название скидки

Example:

Персональная скидка

Types: CartDiscountList

Объект, который объединяет в себе все скидки и примененные бонусы к корзине

Object

bonuses

CartDiscount

totalActions

CartDiscount

actions

Array of CartDiscount

Список примененных скидок

Types: CartTotals PotentialOrderTotals ServiceCartTotals ServicePotentialOrderTotals

Баннер в корзине

Object

string required

ИД баннера

bannerHeader

string required

Заголовок баннера

Example:

Дарим 300 бонусов

bannerText

string

Текст баннера

Example:

при самовывозе из магазина

image

ImageUri required

url

string required

Урл, которую нужно скормить в метод получения статического контента по урл.

slot

string required

Слот баннера

Example:

"sm_hh_mobileapp_get_300_bonus"

Types: CartBankProducts CartFull2 PaymentMethod

Покупатель (владелец) корзины.

Для БЭ: от нас не требуют поддерживать эти данные в актуальном состоянии, т.е. из профиля синхронизировать постоянно не нужно.

Object

profileId

string required

ID пользователя

fio

string

ФИО пользователя

phone

Phone

string

Email пользователя

[DEP] anketaComplete

boolean

Признак заполненности профиля. DEP в рамках чистки A/B-теста (MPSM-11743)

Types: CartFull2

Пара productId (ЦМ) + SKU для мэтчинга в lineId

Object

productId

string required

Идентификатор цветомодели

sku

number long required

Идентификатор SKU, описывает конкретный размер

Methods: DEP v1 Восстановить удаленный товар cart2 DEP v1 Изменить чекбоксы товаров в корзине cart2 DEP v1 Скрыть удаленный товар cart2 DEP v1 Установить количество товара в корзине cart2

Types: ProductShortInfo

Параметры товара в корзине. Например, цвет, размер

Object

name

string required

Название параметра

Example:

Цвет

value

string required

Значение параметра

Example:

Красный

Types: CartItemFull2 CartItemMiddle ReturnCartItem

Object

title

string required

Заголовок в плашке

Example:

Только самовывоз

bgColor

Color required

textColor

Color required

type

string

Тип взаимодействия

Enumeration:

static

link

hint

hints

popup

description

string

Текст для шторки

Example:

Скидка 20% на куртки Columbia"

url

string

Example:

/catalog/url/

string

id плашки (необходимо для отправки событий)

Types: CartItemFull2

Object

CartItemId required

quantity

integer

Сколько добавлять

nominal

integer

Цена БНПК

Example:

501

Methods: Добавить товар в корзину cart2

Краткая корзина, в ней есть только информация о наличии товаров в корзине. Используется для списков товаров, чтобы отображать актуальные данные

Object

items

Array of CartLiteItem required

version

integer required

Версия корзины

Responses: CartResponse2

Облегченная позиция товара в корзине

Object

[DEP] productId

string required

[DEP 4.74] Айди цветомодели

[DEP] sku

number long

[DEP 4.74] SKU товара

cartItemId

CartItemIdWithLines required

quantity

integer required

Количество lines в корзине с данными productId и sku

name

string

Название товара в корзине

totalPrice

Price

totalPriceWoDiscount

Price

catalogPrice

Price required

catalogDiscount

Price required

Types: CartLite

Object

deliveryClickShortInfo

string

Краткое описание услуги “Доставка по клику”

deliveryClickLongInfo

string

Полное описание услуги “Доставка по клику”

Types: DeliveryInfoVariant

Указывает, какую корзину возвращать в ответе.

Если не передается, то возвращается облегченная корзина

string

Enumeration:

LITE

FULL2

Methods: DEP v1 Установить количество товара в корзине cart2 v2 Установить количество товара в корзине cart2 Добавить товар в корзину cart2 Получить корзину cart2 Удалить товары из корзины cart2

Полная модель корзины версии 2

поля bonusApplied и isBonusAvailable переехали в поле bonusesInfo Лебедева Мария Сергеевна там внутри есть вопрос про стат. страницу
unallocatedItems теперь содержит объекты CartItemIdWithLines, а не CartItemFull
Все товары корзины теперь в массиве availableItems, там будут старые unallocatedItems + товары из обтейн поинтов - CartItemFull2
deliveryInfo теперь тип CartDeliveryInfo2
добавляется массив altPotentialOrders [AltPotentialOrder] , который сейчас содержит данные только для самовывоза из магазинов
в obtainPoints становится тип ObtainPoint2
добавилось поле receiver

Object

version

integer required

Версия корзины

availableItems

Array of CartItemFull2

Все нераспределенные товары (кроме товаров с отключенным чекбоксом) + товары из обтейн поинтов. При этом одинаковые товыры (ску+продакт айди) объеденены тут в 1 элемент массива.

Т.е. если есть 5 кроссовок адидас 38 размера в корзине, при этом 3 лайна в нераспределенных, а 2 лайна в одном обтейн поинте, то эти пять лайнов тут как 1 элемент массива с количеством 5

unselectedItems

Array of CartItemFull2

Доступные товары с отключенным чекбоксом. Имеет три состояния:

Массив не пустой (значит в корзине есть товары с отключенным чекбоксом)
Массив пустой (значит товаров с отключенным чекбоксом нет, но сам функционал чекбоксов доступен пользователю)
null (значит функционал чекбоксов пользователю не доступен)

unallocatedItems

Array of CartItemIdWithLines required

Лайны, у которых не проставлен МСП

deletedItems

Array of CartItemMiddle required

Удаленные товары, которые можно восстановить.

soldOutLines

Array of CartItemMiddle required

Распроданные товары, которые уже нельзя купить

[DEP] promoCodes

Array of string required

[DEP в рамках MPSM-11743] Список примененных промокодов

promoCodeList

Array of cartpromocode

Список примененных промокодов

obtainPoints

Array of ObtainPoint2 required

Потенциальные заказы. Все товары, которым проставили МСП, распределяются по потенциальным заказам

owner

CartOwner required

banners

Array of CartBanner required

Баннеры в корзине

bankProducts

CartBankProducts required

totals

CartTotals required

dailyOfferExpiresIn

integer

Количество секунд до конца дня (до конца завершения акции Товар дня)

Example:

11655

deliveryInfo

CartDeliveryInfo2 required

bonusesInfo

CartBonusesInfo required

altPotentialOrders

AltPotentialOrder

receiver

OrderReciever

crossborderShortInfo

string

Информация о таможенном брокере

Responses: CartResponse2 FullCartResponse2

Товар в корзине v2

cartItemId с новой моделью, там есть лайн айдишники
в deliveryInfo сменился тип на https://sportmaster.speca.handh.ru/#CartItemDeliveryInfo2

Object

cartItemId

CartItemIdWithLines

name

string

Название товара в корзине

image

ImageUri

params

Array of CartItemParams

Параметры товара (цвет, размер и тд.)

quantity

integer

Сколько в корзине данного товара, штук

availableAmount

integer

Сколько можно купить такого товара.

Значение данного поля не будет использоваться в пикере количества товара при изменении количества. Данное поле будет использоваться для валидации после изменения количества. После изменения количества товара все штуки этого товара будут строго непривязанынми к МСП.

Затем все штуки товара прогоняются через GET-ALT-… (получение доступного количества товара для каждого способа получения). Из полученных значений выбирается максимальное.

По этому максимальному значению запрашивается GET-ALT-CHANNELS, чтобы получить конечный список способов получения, в котором можно получить максимальное из возможного количество товара.

Таким образом, если штуки товара были привязаны к МСП, то при изменении количества этого товара все штуки станут нераспределенными (и для них будет расчитан avaliableAmount в соответствии с алгоритмом). А если изменение товара привязанного к МСП не планируется, то и avaliableAmount считать нет необходимости.

itemPrice

Price

itemPriceWoDiscount

Price

totalPrice

Price

totalPriceWoDiscount

Price

badges

Array of CartItemBadge

Бейджик с информацией.

hasInstallment

boolean

Доступен ли этот товар в рассрочку

deliveryInfo

CartItemDeliveryInfo2

wareAdditionDate

Date

catalogPrice

Price

catalogDiscount

Price

returnInfo

ReturnInfo

selected

boolean

(Корзина возврата) Выбран (отмечен чекбоксом) ли товар или нет

Types: CartFull2

Место Способ Дата Получения, фактически это потенциальный заказ.

По МСДП распределеются товары в потенциальные заказы

cartItems теперь другой массив - там просто айдишники товаров c лайнами и данные по услугам доставки CartItemInObtainPoint
potentialOrder тепрь PotentialOrder2

Object

obtainPointId

string

deliveryServices

Array of CartService

Сервисные услуги на уровне заказа

cartItems

Array of CartItemInObtainPoint required

Товары, которые распределены в данный МСП

needPrepay

boolean

Нужна ли предоплата

deliveryInfo

ObtainPointDeliveryInfo required

potentialOrder

PotentialOrder2 required

crossborderShortInfo

string

Информация о таможенном брокере

Types: CartFull CartFull2

Товар, который распределен по МСП

Object

cartItemId

CartItemIdWithLines required

deliveryServices

Array of CartService

Сервисные услуги на уровне товара

totalPrice

Price

totalPriceWoDiscount

Price

Types: ObtainPoint2

Object

deliveryTypes

Array of DeliveryType required

onlyIntPickup

boolean required

Товар можно забрать только самовывозом из магазина.

Для бэ: вычисляется по deliveryTypes.

isExpressDeliveryEnabled

boolean required

Доступна ли экспресс доставка.

Для бэ: определяется через запрос http://ordergate-ru-by-kz.ordergateuat.web.local/swagger-ui/index.html?url=../openapi.yaml#/baskets/getAltDelivery по полю deliveryServiceLevelId или deliveryServiceLevelCode (надо проверить, что подходит) справочник тут https://confluence.app.local/pages/viewpage.action?pageId=307992258 мнемокод по идее express_delivery

isDeliveryClick

boolean

Доступна ли доставка по клику Флаг требуется для отправки аналитики. Отпределяется по deliveryServiceLevelCode == delivery_click. Для товаров availableItems передается true или false, а у unselectedItems null, так как модель переиспользуется общая, а данных для unselectedItems нет. Атрибут требуется для аналитики.

isDeliveryServicesEnabled

boolean required

Доступны ли услуги доставки

needPrepay

boolean required

Нужна ли предоплата

Types: CartItemFull2

Потенциальный заказ при оформлении корзины

добавлется paymentMethods Array of PaymentObjectModel required https://sportmaster.speca.handh.ru/#PaymentObjectModel
удален receiver

Object

string required

Идентификатор потенциального заказа

paymentMethodsTools

Array of PaymentMethod required

Способы и инструменты оплаты

paymentMethod

PaymentMethod

paymentMethods

Array of PaymentObjectModel

[DEP в рамках MPSM-17365] Доступные методы оплаты заказа

refundInfo

RefundInfo

totals

PotentialOrderTotals required

Types: ObtainPoint2

Информация по вариантам доставки корзины

все поля удалились,
добавился массив вариантов доставки нераспределенных товаров
добавился массив вариантов доставки распределенных товаров

Object

unallocatedItemsDeliveryTypes

Array required

Варианты доставки для всех нераспределенных лайнов

Array of DeliveryTypeEnum

allocatedItemsDeliveryTypes

Array of ObtainPointsDeliveryTypes required

Варианты доставки для товаров, распределенных по обтейн поинтам

Types: CartFull2

Пара productId (ЦМ) + SKU

И все лайн айди

добавился массис айдишников лайнов

Object

productId

string required

Идентификатор цветомодели

sku

number long

Идентификатор SKU, описывает конкретный размер

linesIds

Array of string required

Айдишники лайнов

Types: AltCourierDelivery CartFull2 CartItemAddressAvailability CartItemExternalAvailabilityDetail CartItemFull2 CartItemInObtainPoint CartItemInternalAvailability2 CartItemMiddle CartLiteItem InternalAvailabilityPotentialOrder ReturnCartItem ReturnPotentialOrder ServiceCartItem ServiceCenter ServicePotentialOrder SetInternalPickupParams

Данные по бонусам в корзине

Object

bonusApplied

boolean required

Метка использования бонусов

isBonusAvailable

boolean required

Можно ли применять бонусы к корзине

[DEP] isBonusBlocked

boolean

Применение бонусов в корзине заблокировано. DEP в рамках чистки A/B-теста (MPSM-11743)

bonusInfoDocumentId

string required

Айди статической страницы, где описание про списание бонусов

potentialBonuses

integer

Количество потенциальных бонусов

Example:

250

Types: CartFull CartFull2

Данные по альтернативному заказу из конкретного магазина

Object

storeId

string required

Айди магазина

altPotentialOrders

Array of InternalAvailabilityPotentialOrder required

Все возможные варианты разбиения по заказм товров, которые установлены в данный магазин

Types: AltPotentialOrder

Альтернативные варианты по курьерской доставке для товаров

Формируется по http://ordergate-ru-by-kz.ordergateuat.web.local/swagger-ui/index.html?url=../openapi.yaml#/baskets%2Fobtain-points/getAltDelivery

Object

obtainPointIds

Array of string required

Заказы группируются в массив. Фронт бегает по заказам, получает оттуда товары и ставит им альтернативные вариант доставки.

Именно по товарам из этих заказов можно сделать альтеранативный вариант курьерской доставки

isExpress

boolean required

Альтернативный заказы будет экспресс или нет

minDeliveryPrice

Price required

numberOfAltOrders

integer required

Сколько будет сформировано альтернативных заказов

nearestDate

DateOnly required

territoryDate

DateOnly required

items

Array of CartItemIdWithLines required

Товары, которые будут зазканы этим альтернативным вариантом

Types: AltPotentialOrder

Альтернативные потенциальные заказы.

Object

intPickup

Array of AltIntPickup

Альтернативные данные для самовывоза из магазина. Возвращается только, если они есть.

courierDelivery

Array of AltCourierDelivery

Альтернативные варианты доставки для курьерской доставки

Types: CartFull2

Варианты доставки для групп МСП, которые доставляются в 1 магазин/пвз/адрес

Object

obtainPointIds

Array of string required

Массив айдишников обтейн поинтов

deliveryTypes

Array of DeliveryTypeEnum required

Варианты достаки для товаров, которые были распределены в МСП из массива выше + нераспределенных товаров корзины

Types: CartDeliveryInfo2

Модель, которая описывает промокод в корзине

Object

promoCode

string required

Промокод

isValid

boolean required

Признак валидности

invalidReason

string

Причина невалидности

Types: CartFull2 EditCart

Доступность позиций в корзине по магазинам.

Изенения относительно 1ой модели (https://speca.io/HeadsAndHands/sportmaster/_edit/schemas/CartItemInternalAvailability):

удаляется trafficLightsLevelCaption,
удаляется trafficLightsLevelImage
всё остальное перрезжает в InternalAvailabilityPotentialOrder

Т.к. у магазина теперь могут быть варианты доставки, то мы объединяем их под одним элементом и выделяем “потенциальные” заказы.

Принцип разбиения такой.

Есть 5 товаров. Через данный магазин можно забрать максимум 3 товара. Сегодня 18 мая.
1 товар в наличии
1 товар привезут 19 мая
1 товар привезут 22 мая

Тогда разбиение по заказм будет такое:

Вместе 22 мая
1 заказ сегодня
1 заказ 19 мая
1 заказ 22 мая

т.е. в массиве будет 4 элемента

Object

shop

BaseShop required

potentialOrders

Array of InternalAvailabilityPotentialOrder required

Варианты, как товары могут быть разбиты по заказам при заборе из заданного магазина

unavailableItems

Array of CartItemIdWithLines

Товары, которые нельзя получить в данном магазине

Responses: InternalPickupAvailabilityResponse2

Характеризует потенциальный заказ, которым могут быть забраны товары из магазина.

Object

totalAvailabilityDateTime

OffsetDateTime required

territoryDate

DateOnly required

totalPrepay

boolean required

Итоговая метка предоплаты

availability

string

Тип доступности товара.

Для бэ: определяется по массиву goods. Если там хоть у кого то есть довоз, то довоз. Иначе, в наличии.

Enumeration:

IN_STOCK

SUPPLY

availableItems

Array of CartItemIdWithLines required

Доступные к заказу товары в этом мсп (тут прям ограниченное количество лайнАйди внутри приходит)

storeDays

integer

Количество дней, сколько храним заказ

deliveryPrice

Price required

totalServiceChargeCost

Price

serviceChargeDescription

string

Текст для отображения в шторке с информацией о сервисном сборе

Types: AltIntPickup CartItemInternalAvailability2

Данный объект соотвествует 1 потецниальному заказу (мсп), который должен быть создан

Object

cartItemIds

Array of CartItemIdWithLines

Methods: Установить способ доставки у товаров самовывоз cart2

Доступность товара в ПВЗ

Object

pickpoint

Pickpoint required

[DEP] availabilityDate

DateOnly required

availabilityDateFrom

DateOnly required

availabilityDateTo

DateOnly

territoryDate

DateOnly

needPrepay

boolean

Признак предоплаты

deliveryCost

Price

availableItemsCount

integer required

Сколько товаров доступно доступно

totalItemsCount

integer required

Сколько товаров запрашивали

Responses: ExternalPickupAvailabilityResponse2

Детальные данные о доступности товаров в ПВЗ

Object

pickpointId

string required

Идентификатор ПВЗ

availableItems

Array of CartItemIdWithLines required

Доступные товары для ПВЗ

unavailableItems

Array of CartItemIdWithLines

Недоступные товары для ПВЗ

Responses: ExternalPickupAvailabilityDetailResponse

Object

string required

ID услуги

Example:

1237666

availableIcon

string required

Ссылка на иконку доступной услуги

Example:

https://cdn.sportmaster.ru/upload/content/cmsgate/ru_sm/smprod/dip_content/2023/static/mp/delivery/fit-accepted.png

unavailableIcon

string required

Ссылка на иконку недоступной услуги

Example:

https://cdn.sportmaster.ru/upload/content/cmsgate/ru_sm/smprod/dip_content/2023/static/mp/delivery/fit-cancelled.png

Responses: ExternalPickupAvailabilityResponse2

Object

addressId

string required

ID адреса получения

Example:

3514692b-a3f5-403b-b215-1d1045dff486

availableItems

Array of CartItemIdWithLines required

Список товаров, которые доступны по этому адресу получения

Responses: ReceivingAddressAvailabilityResponse

Object

lineId

string

id штуки корзины, к которой требуется привязать услугу

mdmServiceId

string required

id МДМ сервисной услуги

linkedServiceIds

Array of string

ids МДМ зависимых сервисных услуг

Methods: Сохранить выбранные сервисные услуги cart2

Элемент графика платежей

Object

sum

Price required

date

DateOnly

Types: PaymentMethod

Информация о инструменте оплаты

Object

string required

Enum из OrderGate

Example:

CARD_ONLINE

name

string required

Название инструмента оплаты. Отображается пользователю

Example:

Картой

icon

ImageUri required

selected

boolean required

Признак, были ли этот инструмент оплаты выбран или нет

fpsQuantity

string

Количество привязанных счетов к СБП

Example:

Types: PaymentMethod

Статус оплаты

string

Enumeration:

IN_PROGRESS

SUCCESS

FAIL

INACTIVE_SUBSCRIPTION

Responses: CheckPaymentIntentionResponse

Банков-партнер СБП, для которых у клиента созданы подписки

Object

bankId

string required

ID банка на стороне СБП

Example:

100000000273

bankName

string required

Наименование банка

Example:

Озон Банк (Ozon)

Types: OrderPaymentInfo

Список банков-участников СБП

Object

name

string required

Наименование банка

logo

string required

Логотип

url

string required

Ссылка на оплату

Responses: QrcResponse

Возможные номиналы ЭПК

Object

egcValueList

Array of Price required

Значения номиналов ЭПК для плашек

Example:

minEgcValue

Price

maxEgcValue

Price

Responses: EgcInfoResponse

Object

destinationType

string

Способ получения ЭПК

Enumeration:

PHONE

string

Email получателя ЭПК

phone

Phone required

Methods: Оформить заказ ЭПК

Object

dateTime

Date required

city

City required

Methods: Оформить заказ ЭПК

Object

greeting

string

Приветствие для ЭПК

text

string

Текст поздравления для ЭПК

signature

string

Подпись отправителя для ЭПК

Methods: Оформить заказ ЭПК

Дизайны ЭПК

Object

imageType

integer required

Код дизайна ЭПК

Example:

mainImage

ImageUri required

name

string

Название для доп. изображения ЭПК

Example:

Синяя

previewImage

ImageUri required

Responses: EgcInfoResponse

Object

question

string required

Вопрос

Example:

Отменить заказ

url

string required

URL документа с ответом из CMS

Example:

/cancel-order-chat

Responses: FaqResponse

Объект, которые агрегирует все данные по МСДП

Object

type

DeliveryType required

delivery

DeliveryOrderInfo

extPickup

PickPointOrderInfo

intPickup

PickupOrderInfo

intService

IntServiceOrderInfo

receivingDateFrom

DateOnly

planReceivingDateTimeFrom

OffsetDateTime

receivingDateTo

DateOnly

receivingTimeSlot

string

Временной интервал доставки

territoryDate

DateOnly

storagePeriod

string

Срок хранения заказа

prolongateDateTo

DateOnly

receiver

ReceiverOrderInfo

shippingMethod

string required

Ключ способа получения товара

Example:

10060299

shippingMethodLevel

string required

Ключ уровня сервиса получения товара

Example:

10060299

shippingMethodLevelCode

string

Мнемокод ключа уровня сервиса получения товара

Example:

RETAIL_SELF_DELIVERY

deliveryServiceCancellingMessage

string

Текстовое уведомление о передачи информацию в курьерскую службу

deliveryClickInfo

string

Текстовое уведомление о доставке по клику

withDelivery

boolean

Признак довоза товара по заказу

Types: EgcOrder Order

Полная модель заказа

Описание атрибутов в OrderGate: https://confluence.app.local/pages/viewpage.action?pageId=334092849

Object

number

string required

Номер заказа

orderType

string required

Тип заказа

Enumeration:

PRODUCTS

EGC

RECEIPT

SERVICES

createdDate

Date required

status

OrderStatus required

needPrepay

boolean required

Признак предоплаты

deliveryInfo

OrderDeliveryInfo required

payment

OrderPaymentInfo required

totals

OrderTotals required

items

Array of OrderProductItem

Список товаров

services

Array of OrderService

Сервисный услуги

possibleActions

Array of OrderPossibleAction required

Доступные действия над заказом

cancelReasons

Array of OrderCancelReason

Допустимые причины отмены заказа. Возврщаются только если заказ можно отменить

editReasons

Array of OrderEditReason

Список причин редактирования заказа

isCancelled

boolean required

Отмененный ли это заказ

promoCodes

Array of string

Список примененных промокодов.

statusHistory

Array of OrderStatus

История статусов заказа

isCancelling

boolean

Признак попытки отмены заказа

authCode

string

Код авторизации для получения заказа при самовывозе

Example:

3485

showQrCode

boolean required

Отображения блока с QR-кодом для заказов самовывоза

returnAvailability

ReturnAvailability required

crossborderShortInfo

string

Информация о таможенном брокере

repeatOrder

boolean required

Доступность повтора заказа (только для статуса “Отменён”)

editOrder

boolean required

Доступность редактирования заказа (только для текущих заказов)

Responses: OrderResponse OrdersByNumbersResponse

Заказ в списке заказов

Object

number

string required

Номер заказа

receiptCode

string

Код чека

date

Date required

status

OrderStatus required

totalSum

Price required

deliveryType

DeliveryType required

showQrCode

boolean required

Признак показа кнопки QR-кода

needPayment

boolean

Признак для показа плашки с призывом оплатить заказ

prepayLimitTime

integer

Время для автоотмены заказа (в секундах) для счетчика

Example:

5400

additionalProductCount

integer required

Количество товаров в заказе

imageUrls

Array of string

URL фото товаров

Types: MainSectionEntity

Responses: OrderHistoryResponse

Object

status

string required

Мнемокод статуса

statusText

string required

Текстовка клиентского статуса, отображается пользователю

statusDate

Date

textColor

Color

backgroundColor

Color

Types: Order OrderItem

Object

string required

Айди, по которому фильруется выдача заказов

name

string required

Название фильтра

Example:

Текущие

isSelected

boolean

Флаг примененности фильтра.

Responses: OrderHistoryResponse ReturnHistoryResponse

Данные о самовывозе из магазина оформленного заказа.

Для БЭ: данные о магазине берутся из гео гейта по айди (номеру магазина) http://rest-app.geogate-uat.k8s-dev.gksm.local/swagger-ui/index.html?url=../openapi.json#/shop/getShop

Object

shopId

string required

shopAddress

string required

Адрес магазина

Example:

г. Саранск, ТЦ "РИО", ул. советская, д.55а

shopName

string required

Название магазина

shopPhone

Phone required

geoPoint

GeoPoint required

weekSchedule

Array of IntPickupWeekSchedule required

График работы магазина по дням недели

convenienceShop

boolean required

Круглосуточный магазин

inventory

OrderingShopInventory

isPickUpAutoAvailable

boolean required

Доступность услуги Самовывоз на парковке

Types: OrderDeliveryInfo

Данные об оказании услуг в сервисном центре

Object

shopId

string required

shopAddress

string required

Адрес сервисного центра

Example:

г. Саранск, ТЦ "РИО", ул. советская, д.55а

geoPoint

GeoPoint required

weekSchedule

Array of IntPickupWeekSchedule required

График работы магазина по дням недели

convenienceShop

boolean required

Круглосуточный магазин

Types: OrderDeliveryInfo

Данные о курьерской доставке оформленного заказа.

Для БЭ: формируется полностью из http://ordergate-ru-by-kz.ordergateuat.web.local/swagger-ui/index.html?url=../openapi.yaml#/orders/getOrder из поля address

Object

address

string required

Адрес

trackNumbers

Array of string

Ссылки для отслеживания заказа

controlNumber

string

Контрольный номер

Example:

4932

releaseLoc

integer

Номер интернет магазина

Example:

7712

Types: OrderDeliveryInfo

Информация о доставке в пункт выдачи товаров у оформленного заказа

Для БЭ: формируется из http://rest-app.geogate-uat.k8s-dev.gksm.local/swagger-ui/index.html?url=../openapi.json#/deliveryPoints/searchDeliveryPoint

Object

pickpointId

integer required

name

string

Навзание ПВЗ

address

string

Адрес ПВЗ

geoPoint

GeoPoint

workTime

string

График работы

routeDescription

string

Описание проезда

insideLocate

string

Расположение внутри

trackNumbers

Array of string

Ссылки для отслеживания заказа

howToReceive

string

Инфо о том, как получить заказ.

Types: OrderDeliveryInfo

Object

isPayed

boolean

Оплачен заказ или нет. Null, если статус невозможно получить (для отмененных заказов, например)

Для БЭ: как определять тут https://confluence.app.local/pages/viewpage.action?pageId=423622509 29 вопрос.

needPayment

boolean

Признак для показа плашки с призывом оплатить заказ

prepayLimitTime

integer

Время для автоотмены заказа (в секундах) для счетчика

Example:

5400

paymentMethod

OrderPaymentMethodItem required

paymentTools

Array of PaymentTool

Возвращается только если isPayed == false.

Для БЭ: получается через http://pgate-sm.pgateuat.web.local/pgate/rest/v2/swagger-ui/index.html?url=../openapi.yaml#/p-gate-rest/getPaymentTools Инвойс - это номер заказа

fpsSubscriptionBanks

Array of FpsSubscriptionBank

Список банков-партнеров СБП, для которых у клиента созданы подписки

showPaymentTools

boolean required

Признак показа шторки с инструментами оплаты

eCheckUrl

string

Ссылка на сайт электронных чеков

Example:

https://lkdr.nalog.ru/

promoList

Array of PromoBlock

Массив промо-блоков для различных инструментов оплаты

payNowMessage

string

Сообщение о предоплате для оплаты при получении

Example:

Заказ оформлен. Можно оплатить его сейчас, чтобы не тратить время потом.

Types: EgcOrder Order

График работы магазина по дням недели

Object

dayNumber

integer required

Номер дня недели

dayName

string required

День недели

workTime

IntPickupWorkTime required

Types: DropoffShopReturnInfo IntServiceOrderInfo PickupOrderInfo

Object

workStartTime

string required

workEndTime

string required

Types: IntPickupWeekSchedule

Даные о получателе заказа.

Для БЭ: берется из contactUser, если объект пустой, то из owner

Object

fio

string

phone

Phone

string

Types: OrderDeliveryInfo

Тоталсы по оформленному заказу.

Для тестеров: суммы с учетом скидок (EgcPaid не учитывается) должны сходиться с totalCost.

Object

totalCatalogCost

Price required

totalDeliveryCost

Price required

totalServiceChargeCost

Price

serviceChargeDescription

string

Текст для отображения в шторке с информацией о сервисном сборе

totalServicesCost

Price required

totalBonusesUsed

Price

totalCost

Price required

[DEP] promocodeDiscount

Price required

[DEP] catalogDiscount

Price

actionsDiscount

Price

egcPaid

Price

egcToPay

Price

Types: Order

Каким методом был оплачен заказ

Для БЭ: все типы есть тут в енаме http://ordergate-ru-by-kz.ordergateuat.web.local/swagger-ui/index.html?url=../openapi.yaml#/orders/getOrder paymentMethod таблица тут https://confluence.app.local/pages/viewpage.action?pageId=386449608 более хорошая таблица тут https://confluence.app.local/pages/viewpage.action?pageId=314147975

Object

string required

По сути это энам из гейта

name

string required

Название варианта оплаты. Отображается пользователю

Example:

При получении

paymentMethod

string required

Ключ способа оплаты

Example:

10060299

Types: OrderPaymentInfo

Модель товара в заказе. Данные о товаре получаются из продакт гейта.

Для БЭ: всё устроено по аналогии с корзиной. В гейте 2 одинаковых кроссовка это 2 разных лайн. Мы должны объединять в 1 со счетчиком на осовании productId и wareId

Некоторые параметры nullable поскольку у сотрудника могут приходить товары Ostin, Funday и других, поскольку чеки приходят по КП сотрудника, после доработок ClubPro вернуться в тип required

Object

productId

string

ID MDM ЦМ

skuId

integer required

ID MDM артикула

amount

integer required

Количество товара.

Для бэ: рассчитывает наш бек путем объединения лайнсов.

name

string required

Название товара

totalPrice

Price required

priceWoDiscount

Price required

catalogDiscount

Price required

sumTotalPrice

Price required

sumPriceWoDiscount

Price required

sumDiscount

Price required

image

ImageUri

params

Array of OrderProductParam

Параметры товара

isReviewAllowed

boolean required

Статус возможности пользователя оставить отзыв

isSellerProduct

boolean required

Признак, что товар продавца / маркетплейса / FBS. Использкется для возврата товара fbs.

isAvailableForCart

boolean required

Признак, что товар доступен для добавления в корзину

isBnpk

boolean required

Признак, что это безноминальная подарочная карта

Types: Order

Параметр товара в заказе

Для БЭ: в коризне есть такое же, как сделать это смотреть в корзине. Сейчас будет только 2 параметра - цвет и размер

Object

name

string required

Название параметра

value

string

Значение параметра

Types: OrderProductItem ReturnrProductItem

Доступное действие над заказом

string

Enumeration:

CANCEL-ORDER

EXTEND-RESERVE

DELETE_PRODUCT

EXTEND_RESERVE

CANCEL_ORDER

START_QUARREL

Types: Order ReturnDetails

Причина отмены заказа

TODO непонятно, во все причины омены можно вставлять комментарий или не во все

Object

reasonId

string required

MDM идентификатор причины отмены

reasonName

string required

Наименование причины отмены (текстовое описание)

allowComment

boolean required

Можно ли оставлять комментарий.

Для БЭ: Можно оставлять только у “Другое”. айди другого описан тут в 74 вопросе https://confluence.app.local/pages/viewpage.action?pageId=423622509

Types: Order

Object

mnemocode

string required

Мнемокод причины редактирования заказа

Example:

order_type_change

text

string required

Текстовое описание причины редактирования заказа

Example:

Изменить способ или адрес доставки

Types: Order

Инструмент оплаты

string

Enumeration:

CASH_IN_STORE

CASH_IN_EXT_STORE

CARD_IN_STORE

CARD_IN_EXT_STORE

EGC_IN_STORE

EGC_ONLINE

CARD_ONLINE

GC_IN_STORE

CASH_TO_COURIER

CARD_TO_COURIER

CASHLESS

GOOGLE_PAY

SAMSUNG_PAY

APPLE_PAY

CREDIT

INSTALLMENT

FASTER_PAYMENT_SYSTEM

SBER_PAY

BNPL_SOVCOMBANK

BNPL_TINKOFF

YANDEX_SPLIT

YANDEX_PAY

Types: OrderPaymentInfo PromoBlock

Object

paymentTool

PaymentTool required

title

string

Заголовок (из баннера ЦМС)

description

string

Описание (из баннера ЦМС)

url

string

URL статической сраницы (из баннера ЦМС)

Types: OrderPaymentInfo

Модель заказа ЭПК

Object

number

string required

Номер заказа ЭПК

orderType

string required

Тип заказа. По факту для этой модели всегда будет один тип заказа, но для совместимости с другими моделями в рамках общего алгоритма здесь тоже нужно поддерживать этот атрибут

Enumeration:

EGC

deliveryInfo

OrderDeliveryInfo required

payment

OrderPaymentInfo required

needPrepay

boolean required

Нужна предоплата

totals

Object required

Итоговая стоимость заказа

totalCost

Price required

Responses: EgcOrderResponse

Информация по сервисным услугам при доставке

Object

mdmServiceId

string required

ИД сервисной услуги в МДМ

name

string required

Наименование услуги

description

string

Описание

sumTotalPrice

Price required

sumPriceWoDiscount

Price required

sumDiscount

Price required

totalPrice

Price required

amount

integer required

Количество

isOrderService

boolean required

Признак услуги на уровне заказа

Types: Order

Данные по возврату в заказе

Object

returnButtonDisplay

boolean required

Отвечает за отображение кнопки “Вернуть товары”

orderRefundAvailability

boolean required

Признак возможности возврата по заказу

Types: Order

Модель корзины возврата

Object

version

integer

Версия корзины

originalOrderNumber

string

Номер исходного заказа, по которому была создана эта корзина (для корзины возврата)

availableItems

Array of CartItemList

Все нераспределенные товары + товары из обтейн поинтов. В зависимости от используемое в настоящий момент корзины (возврата или другой) одинаковые товыры (ску+продакт айди) могут быть объеденены тут в 1 элемент массива, а могут в разные.

inactiveItems

Array of CartItemList

Товары, недоступные по каким-то причинам (распроданы, заблокированы, нельзя оформить для возврата и т.д.)

deliveryTypes

Array of DeliveryTypeEnum

Варианты доставки для всех нераспределенных лайнов

obtainPoints

Array of ObtainPoint2

Потенциальные заказы. Все товары, которым проставили МСП, распределяются по потенциальным заказам

totals

CartTotals

receiver

OrderReciever

bonusesInfo

CartBonusesInfo

promoCodes

Array of string

Список примененных промокодов

Responses: [DEP] CommonCartResponse

Модель корзины возврата

Object

version

integer required

Версия корзины

originalOrderNumber

string required

Номер исходного заказа, по которому была создана эта корзина (для корзины возврата)

availableItems

CartItemList required

unavailableItems

CartItemList

returnTypes

Array of ReturnTypeEnum

Варианты доставки для всех выбранных лайнов

potentialOrder

ReturnPotentialOrder

totals

ReturnCartTotals

receiver

OrderReciever

Responses: ReturnCartResponse

Группа товаров, которая должна с определенным заголовком отображаться на экране корзины

Object

title

string required

Заголовок группы

Example:

Возврат недоступен

description

string

Описание группы товаров

Example:

Это товары продавца. После оформления возврата, нам нужно дождаться его ответа.

items

Array of ReturnCartItem required

Список товаров

Types: CartFull ReturnCart

Товар в корзине возвратов, по смыслу схожа с моделью CartItemFull2 товарной корзины.

Object

cartItemId

CartItemIdWithLines required

name

string required

Название товара в корзине

image

ImageUri

params

Array of CartItemParams

Параметры товара (цвет, размер и тд.)

quantity

integer required

Сколько в корзине данного товара, штук

itemPrice

Price required

returnInfo

ReturnInfo required

selected

boolean required

Выбран (отмечен чекбоксом) ли товар или нет

Types: CartItemList

Итоги по всей корзине

Object

productsAmount

integer required

Количество товаров.

Для бэ: количество лайнсов, за исключением распроданных и удаленных.

total

Price required

Types: ReturnCart

string

Enumeration:

DROPOFF_SHOP

DROPOFF_DELIVERY_POINT

PICKUP_COURIER

Types: ReturnCart ReturnDeliveryInfo ReturnItem ReturnMethodInfo

Информация по товару, который был выбран для возврата

Object

lineId

string required

ID лайна

Example:

4deb23a5-f4a6-477b-9c29-5ac668bed63c

reasonId

string required

ID причины возврата

Example:

10020299

comment

string

Комментарий пользователя

images

Array of File

Список приложенных пользователем фотографий. 1) Если массив заполнен, то фотографии нужно загрузить. 2) Если массив null, то изменения по фотографиям делать не нужно. 3) Если массив пустой, то фотографии нужно отвязать от товара

Methods: DEP Редактировать информацию о возвращаемых товарах Редактировать информацию о возвращаемых товарах v2

Объект с коротким описанием способа возврата денежных средств

Object

string required

Мнемокод способа возврата. Enum из гейта

Example:

CASH

refundAmount

Price

Methods: DEP Установить способ возврата денежных средств Установить способ возврата денежных средств v2

Потенциальный заказ в корзине возврата

Object

cartItems

Array of CartItemIdWithLines required

Товары, которые распределены в данный потенциальный заказ

returnMethod

ReturnMethodInfo required

refundInfo

RefundInfo

totals

ReturnPotentialOrderTotals required

Types: ReturnCart

Общая информация о способах возврата денежных средств и опциях в потенциальном заказе

Object

changeRefundAvailable

boolean required

Признак “Возможен выбор только одного из способов”

refundAmountAvailable

boolean required

Признак “Возможно менять сумму возврата для способов”

refundMethods

Array of RefundMethod required

Список доступных способов возврата

Types: PotentialOrder2 ReturnPotentialOrder

Объект с описанием способа возврата денежных средств

Object

string required

Мнемокод способа возврата. Enum из гейта

Example:

CASH

name

string required

Название способа возврата. Для отображения пользователю

Example:

Наличные

icon

string required

Иконка способа возврата

description

string

Описание для расчетного счета

maxAmount

Price

refundAmount

Price

selected

boolean required

Признак, были ли этот способ возврата выбран или нет

Types: RefundInfo

Общая информация о причине возврата в разрезе отдельно взятого лайна корзины

Object

returnReasons

Array of ReturnReason required

Список доступных причин возврата

selectedReasonId

string

ID выбранной причины возврата. Принимает значения либо null (то есть причина не была выбрана), либо id (причина выбрана)

reasonNote

string

Комментарий клиента

Example:

На труселях, которые я покупал раньше, не было НИ ЕДИНОГО РАЗРЫВА!

photoCode

string

Код фотографии в МИР

Types: CartItemFull2 ReturnCartItem

Объект для описания причины возврата товара

Object

string required

ID причины

name

string required

Наименование причины

Example:

Цвет не нравится

isCommentRequired

boolean required

Признак Необходим комментарий

isPhotoRequired

boolean required

Признак Необходима фотография

hint

string required

Комментарий к причине возврата

Example:

Пожалуйста, опишите выявленный дефект

Types: ReturnInfo

Информация о способе возврата товара(ов). Один из способов должен быть заполнен.

Object

selectedReturnType

ReturnTypeEnum required

dropoffShop

DropoffShopInfo

dropoffDeliveryPoint

DropoffDeliveryPointInfo

pickupCourier

PickupCourierInfo

territoryDate

DateOnly required

Types: ReturnPotentialOrder

Информация о возврате в магазин

Object

shopAddress

string required

Адрес магазина

Example:

г. Саранск, ТЦ "РИО", ул. советская, д.55а

shopId

number required

Айди магазина

Types: ReturnMethodInfo

Данные по доставке в ПВЗ

Object

deliveryPointAddress

string required

Адрес точки самовывоза

Example:

г. Саранск, ТЦ "РИО", ул. советская, д.55а

deliveryPointTypeName

string required

Название типа ПВЗ

Example:

Отделение почты

deliveryPointTypeIcon

string required

Иконка типа ПВЗ

deliveryPointId

number required

ID ПВЗ возврата

Types: ReturnMethodInfo

Данные по возврате курьером

Object

receivingDateFrom

DateOnly required

receivingDateTo

DateOnly

receivingTimeSlot

string required

Временной интервал доставки

Example:

09:00 - 14:00

receivingTimeSlotId

integer required

ID временного слота доставки

pickupCourierOptions

Array of ReturnDeliveryInfoVariant required

Данные по времени и дате доставке

receivingAddressInfo

ReceivingAddressInfo required

Types: ReturnMethodInfo

Данные по времени и дате доставке

Для БЭ: http://ordergate-ru-by-kz.ordergateuat.web.local/swagger-ui/index.html?url=../openapi.yaml#/baskets/getAltDelivery

Object

dateFrom

DateOnly required

dateTo

DateOnly

timeSlot

string required

Временной интервал доставки

timeSlotId

integer required

ID временного слота доставки

Types: PickupCourierInfo

Итоги по всей корзине

Object

productsAmount

integer required

Количество товаров

totalCost

Price required

Types: ReturnPotentialOrder

Полная модель возврата

Object

returnNumber

string required

Номер возврата

Example:

67028524-949472

returnCode

string required

Код возврата (только с ним можно отменить заказ)

Example:

10001906835962

orderNumber

string

Номер заказа

Example:

2708524-953073

createdDate

DateOnly required

status

ReturnStatus required

deliveryInfo

ReturnDeliveryInfo required

returnPaymentMethods

Array of ReturnPaymentInfo

Способы возврата

totalAmount

Price required

quantity

integer required

Количество товаров

Example:

items

Array of ReturnrProductItem required

Список товаров

possibleActions

Array of OrderPossibleAction required

Доступные действия над заказом

showQrCode

boolean required

Признак показа блока с QR-кодом для заказов самовывоза

returnFormLink

string

Ссылка на бланк возврата

Responses: ReturnResponse

Object

status

string required

Мнемокод статуса возврата

statusText

string required

Текст статуса возврата

statusDescription

string

Описание (коммуникация) к статусу возврата товара FBS

textColor

Color

backgroundColor

Color

Types: ReturnDetails ReturnItem

Объект, которые агрегирует все данные по МСДП

Object

type

ReturnTypeEnum

dropoffShop

DropoffShopReturnInfo

dropoffDeliveryPoint

DropoffDeliveryPointReturnInfo

pickupCourier

PickupCourierReturnInfo

retainDate

DateOnly

trackNumber

string

Трек-номер

trackUrl

string

Ссылки на возврат в курьерской компании

Example:

http://dpd.ru/p?HzEZWJKIwD

Types: ReturnDetails

Object

shopAddress

string required

Адрес магазина

Example:

г. Саранск, ТЦ "РИО", ул. советская, д.55а

geoPoint

GeoPoint required

weekSchedule

Array of IntPickupWeekSchedule required

График работы магазина по дням недели

Types: ReturnDeliveryInfo

Object

string required

Способ возврата средств (enum)

Example:

BANK_CARD

name

string required

Наименование способа возврата

Example:

Банковская карта

amount

Price required

Types: ReturnDetails

Object

productId

string required

ID MDM ЦМ

skuId

integer required

ID MDM артикула

amount

integer required

Количество товара

name

string required

Название товара

price

Price required

image

ImageUri

params

Array of OrderProductParam

Параметры товара

returnReasonName

string

Наименование причины возврата

returnReasonNote

string

Комментарий к причине возврата

Types: ReturnDetails

Object

number

string

Номер заказа на возврат

Example:

67028524-949472

returnCode

string required

Код возврата. Нужен для получения экрана возврата.

Example:

10003556651083

date

DateOnly

status

ReturnStatus required

totalSum

Price required

returnMethod

ReturnTypeEnum required

additionalProductCount

integer required

Оставшееся количество товаров в заказе без превью

imageUrls

Array of string

URL фото товаров

Responses: ReturnHistoryResponse

Object

name

string

Навзание ПВЗ

address

string

Адрес ПВЗ

geoPoint

GeoPoint

workTime

string

График работы

routeDescription

string

Описание проезда

insideLocate

string

Расположение внутри

Types: ReturnDeliveryInfo

Данные о курьере оформленного возврата

Object

address

string required

Адрес

Types: ReturnDeliveryInfo

Object

string required

Идентификатор услуги (productId)

Example:

6275530299

quantity

integer required

Количество услуг

Example:

Methods: Создать корзину услуг

Данные по времени и дате оказания услуги в сервисном центре

Object

availDate

DateOnly required

timeSlots

Array of string required

Список доступных часов начала оказания услуг

Types: ObtainPointIntServiceInfo

Информация МСДП по оказанию услуг в сервисном центре

Object

serviceCenterAddress

string required

Адрес сервисного центра

Example:

г. Москва, ТЦ \"Бутово Молл\", пос. Воскресенское, Чечёрский пр., д.51

selectedAvailDate

DateOnly

selectedTimeSlot

string

Выбранное время начала оказания услуг

Example:

12:00

availableDateTimeVariants

Array of IntServiceInfoVariant required

Список доступных слотов оказания услуг

Types: ServiceDeliveryInfo

Услуга в корзине сервисных услуг. По смыслу схожа с моделью CartItemFull2 товарной корзины.

Object

cartItemId

CartItemIdWithLines required

name

string required

Название услуги в корзине

image

ImageUri

quantity

integer required

Сколько в корзине данной услуги, штук

itemPrice

Price required

itemPriceWoDiscount

Price required

Types: ServiceCart

Информация о способе получения потенциального заказа для корзины услуг. Аналогичен модели ObtainPointDeliveryInfo из корзины товаров. В зависимости от способа должен быть заполнен атрибут intService или fieldService (пока не реализовываем)

Object

selectedDeliveryType

string required

Какой тип доставки выбран. В зависимости от этого, один из атрибутов будет не null

Enumeration:

in_service_centre

field_service

intService

ObtainPointIntServiceInfo

territoryDate

DateOnly required

shippingMethod

string required

Ключ способа получения услуги (http://mdm.app.local/MDM.aspx?entities=gt_receiving_method)

Example:

10050299

shippingMethodLevel

string required

Ключ уровня сервиса получения услуги (http://mdm.app.local/MDM.aspx?entities=gt_service_level)

Example:

10200299

Types: ServicePotentialOrder

Потенциальный заказ в корзине сервисных услуг

Object

string required

Идентификатор

Example:

33d1f73b-765c-406e-b257-171abb4e8e6a

cartItems

Array of CartItemIdWithLines required

Товары, которые распределены в данный потенциальный заказ

needPrepay

boolean required

Нужна ли предоплата

deliveryInfo

ServiceDeliveryInfo required

paymentMethods

Array of PaymentMethod required

Список доступных способов оплаты. Выбранный способ также лежит в массиве с атрибутом selected: true

totals

ServicePotentialOrderTotals required

Types: ServiceCart

Модель корзины услуг

Object

version

integer required

Версия корзины

availableItems

Array of ServiceCartItem required

Все нераспределенные услуги + услуги из потенциального заказа

potentialOrder

ServicePotentialOrder

totals

ServiceCartTotals required

receiver

OrderReciever

bonusesInfo

ServiceCartBonusesInfo required

promoCode

string

Примененный промокод

Responses: ServiceCartResponse

Итоги по всей корзине услуг

Object

amount

integer required

Количество услуг с учетом штук. Т.е. количество лайнов

total

Price required

totalWoDiscount

Price required

discounts

CartDiscountList

pendingPotentialBonuses

number

Общая сумма потенциальных бонусов за оформление заказа

pendingPotentialBonusesPromo

Array of PendingPotentialBonusesPromo

Акции по потенциальным бонусам за оформление заказа

Types: ServiceCart

Итоги по потенциальному заказу

Object

amount

integer required

Количество услуг с учетом штук. Т.е. количество лайнов

total

Price required

totalWoDiscount

Price required

discounts

CartDiscountList

pendingPotentialBonuses

number

Общая сумма потенциальных бонусов за оформление заказа

pendingPotentialBonusesPromo

Array of PendingPotentialBonusesPromo

Акции по потенциальным бонусам за оформление заказа

Types: ServicePotentialOrder

Данные по бонусам в корзине услуг

Object

bonusApplied

boolean required

Метка использования бонусов

isBonusAvailable

boolean required

Можно ли применять бонусы к корзине

bonusInfoDocumentId

string required

ID статической страницы, где описание про списание бонусов

potentialBonuses

integer

Количество потенциальных бонусов

Example:

250

Types: ServiceCart

Модель корзины редактирования

Object

version

integer required

Версия корзины

availableItems

Array of CartItemMiddle required

Все доступные товары, которые были в заказе

deletedItems

Array of CartItemMiddle

Удаленные товары, которые можно восстановить

promoCodeList

Array of cartpromocode

Список примененных промокодов

totals

CartTotals required

deleteProductDescription

string

Текст-описание к экрану удаления товаров

Example:

Мы пересчитаем стоимость заказа, когда вы удалите товары

Responses: EditCartResponse

Модель профиля

Object

string required

userGateUid

string

UID профиля из UserGate

Example:

100000000000000000

city

City

type

string required

Тип профиля

Enumeration:

guest

registered

isUserCityConfirmed

boolean

Подтверждал ли юзер выбор города. Становится true, если я вызвал метод изменения профиля с городом

userType

string

Тип зарегистрированного профиля

Enumeration:

STANDARD

EMPLOYEE

TRAINER

SPORTSMAN

INDIVIDUAL_SPORTSMAN

anketa

Anketa

phone

Phone

avatar

ImageUri

referralProgramAvailable

boolean

Признак возможности участия в реферальной программе

location

Location

locationUpdate

OffsetDateTime

agreeToEmailSubscriptions

boolean required

Статус подписки на email-рассылку

agreements

Agreements

Responses: AuthResponse ProfileResponse

Анкета пользователя.

Данные адреса дублируются в 2 структуры:

Новая структура адреса Яндекс, используется при включенном фича тоггле геозон (объект address)
Старая структура адреса, используется при выключенном фича тоггле геозон (параметры territoryId, territoryName, streetId, streetName, houseId, house)

Object

firstName

string

Имя

lastName

string

Фамилия

middleName

string

Отчество

sex

string

Пол

Enumeration:

MALE

FEMALE

birthDate

DateOnly

territoryId

string

ID населенного пункта

territoryName

string

Название населенного пункта

streetId

string

ID улицы

streetName

string

Название улицы

houseId

string

ID дома

house

string

Дом

address

Address

trainerState

TrainerState

requiredFields

Array of RequiredField

Список заполненных полей анкеты

children

Array of child

Данные о ребенке спортсмене

Methods: Изменить профиль

Types: Profile

У пользователя может быть 2 имейла в 1 момент времени. 1 - подвержденный, который является логином, второй неподвержденный. Тут сначала возращается неподвержденный, если такого нет, то подвержденный

Object

string required

isConfirmed

boolean required

Types: Profile

Responses: FamilyResponse

Айди профиля и тип (гость / авторизованный)

Object

string required

Гейтовый айди пользователя

type

string required

Enumeration:

guest

registered

Responses: ProfileIdResponse

Object

communicationIdentType

string required

Тип коммуникационного идентификатора

Enumeration:

PHONE

CONFIRMED_EMAIL

MOBILEAPP_TOKEN

VKONTAKTE

communicationIdentValue

string required

Значение коммуникационного идентификатора

Example:

70000000000

communicationChannel

string required

Канал коммуникации

Enumeration:

sms

viber

call

app_push

receipt

status

string required

Статус подписки

Enumeration:

subscribed

unsubscribed

Methods: Изменить статус подписки

Types: Group

Группа подписок

Object

groupTitle

string required

Название группы

toggleEnabled

boolean

Значение положения тоггла

subscriptions

Array of Subscription required

Массив подписок

Responses: SubscriptionsResponse

Object

url

string required

Ссылка на социальную сеть

Example:

https://vk.com/sportmaster

icon

string required

Иконка социальной сети

Example:

https://cdn.sptmr.ru/upload/content/cmsgate/ru_sm/smprod/mobile_app_hh_4.0/icons/socials/vk.png

Responses: SocialsResponse

Адрес доставки

Object

addressName

string

Название адреса

Max length: 25

territoryId

string required

Идентификатор населеного пункта

territoryName

string required

Название населеного пункта

postCode

string

Почтовый индекс

hasMetro

boolean required

Признак наличия метро в городе

metroId

string

ID станции метро

metroName

string

Название станции метро

streetId

string

Ид улицы

street

string required

Название улицы

Max length: 512

house

string required

Номер дома

Max length: 64

houseBlock

string

Корпус

building

string

Строение

entrance

string

Подъезд

Max length: 32

doorphoneCode

string

Домофон

Max length: 64

elevator

Elevator

floor

string

Этаж

Max length: 3

apartment

string

Квартира

Max length: 32

addressConfirmed

boolean required

Признак верификации адреса

Methods: Добавить адрес доставки Изменить адрес доставки Редактировать адрес доставки потенциальных заказов cart2 Установить способ доставки у товаров курьерская доставка cart2

Types: DeliveryAdress

Object

deliveryAddressId

string required

Идентификатор адреса доставки

deliveryAddressMnemocode

string required

Мнемокод адреса

Enumeration:

HOME

OFFICE

OTHER

image

ImageUri required

deliveryAddressInfo

DeliveryAddressInfo

receivingAddressInfo

ReceivingAddressInfo

Responses: DeliveryAddressesResponse

Адрес получения (Адрес доставки с геозонами)

Object

addressName

string

Название адреса

deliveryAddress

Address required

entrance

string

Подъезд

doorphoneCode

string

Домофон

elevator

Elevator

floor

string

Этаж

apartment

string

Квартира

Methods: DEP Установить способ возврата курьером Добавить адрес доставки Изменить адрес доставки Редактировать адрес доставки потенциальных заказов cart2 Установить способ возврата курьером v2 Установить способ доставки у товаров курьерская доставка cart2

Types: DeliveryAdress ObtainPointCourierInfo PickupCourierInfo

Обязательное поле анкеты

Object

title

string required

Название поля

Example:

Имя

isFilled

boolean required

Значение заполненности

Example:

true

description

string

Описание поля

Types: Anketa

Состояние учетной записи тренера. Произведен DEP в рамках https://jira.app.local/browse/MPSM-8698 т.к. этот атрибут стал не актуален

Object

isVerified

boolean

Признак верификации тренера

Types: Anketa

Не используется с версии 4.68 Тип действия при нажатии на кнопку баннера в шторке anketa - выполнить действия для баннера бонусов deeplink - перейти по диплинку

string

Enumeration:

anketa

deeplink

Types: BannerLight

Не используется с версии 4.68 Текст кнопки баннера в шторке Получить - текст кнопки для баннера бонусов Начать - текст кнопки для баннера заполнения интересов

string

Enumeration:

Получить

Начать

Types: BannerLight

Определение события, которое должно отправляться в случае успешной регистрации

string

Enumeration:

SIGN_UP

LOG_IN

Responses: AuthResponse

Согласие клиента на рекламную рассылку и на обработку персональных данных

Object

personalData

boolean

Согласие на обработку персональных данных

advertising

boolean

Согласие подписки на рекламную рассылку

Methods: Изменить профиль

Types: Profile

Модель станций метро для доставки.

Object

string required

name

string required

Responses: MetroListResponse

Местоположение

Object

Example:

{
    "location": {
        "locationName": "Москва, Красная площадь, 1",
        "locationLevel": "OTHER",
        "geoPoint": {
            "lat": 55.755246,
            "lon": 37.617779
        },
        "geoFences": [
            {
                "geoFenceId": "589990299",
                "territoryId": "17458520011",
                "geoFenceName": "Россия",
                "geoLayer": {
                    "geoLayerId": "10000299",
                    "geoLayerCode": "COUNTRY"
                }
            },
            {
                "geoFenceName": "Москва и МО",
                "geoLayer": {
                    "geoLayerId": "10220299",
                    "geoLayerCode": "MACROCITY"
                },
                "geoFenceId": "1144650299"
            },
            {
                "geoFenceName": "МСК+0 (UTC+3)",
                "geoLayer": {
                    "geoLayerId": "10210299",
                    "geoLayerCode": "TIME_ZONE"
                },
                "geoFenceId": "1141810299"
            },
            {
                "geoFenceId": "1094470299",
                "territoryId": "1720920299",
                "geoFenceName": "Москва (столица)",
                "geoLayer": {
                    "geoLayerId": "10200299",
                    "geoLayerCode": "TERRITORY"
                }
            }
        ],
        "isConfirmed": false, 
        "availabilityCluster": "north",
    }
}

geoPoint

GeoPointLocation required

geoFences

Array of GeoFence required

Геозоны

locationName

string required

Название местоположения

locationLevel

string required

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

Enumeration:

HOUSE

OTHER

isConfirmed

boolean required

Местоположение выбрано пользователем

availabilityCluster

string

Кластер доступности

Example:

north

Methods: DEP Конфигурация модуля App Актуализировать геозоны Сохранить местоположение пользователя

Types: BffCommonParams Profile

Responses: AddressResponse CityResponse LocationResponse

Геозоны

Object

geoFenceId

string required

ID геозоны

geoFenceName

string required

Название геозоны

territoryId

string

ID территории, опционально, релеванто для геозон административного слоя

geoLayer

GeoLayer required

Types: Location

Responses: GeoFencesResponse

Новые координаты для геозон

Object

lat

number double

Широта

lon

number double

Долгота

Types: Address Location

Слой геозон

Object

geoLayerId

string required

ID геослоя

geoLayerCode

string required

Мнемокод геослоя. Список значений не является финальным, при получении мнемокода типа string не из списка его необходимо сохранять.

Enumeration:

COUNTRY

TERRITORY

TIME_ZONE

MACROCITY

DELIVERY_ZONE

PICKUP_POINT_ZONE

REPORT_ZONE

SERVICE_ZONE

SHIPMENT_ZONE

NON_COMMODITY_ZONE

Types: GeoFence

Object

string required

name

string required

Responses: StreetsResponse

Object

string required

name

string required

Кракое название города/села/деревни

Example:

Руза

fullName

string

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

Example:

г. Руза, Московская обл

eutc

string

Часовой пояс города

Example:

UTC+3

macrocityId

string

Идентификатор макрогорода.

Возвращается не во всех методах, см ТЗ методов

hasMetro

boolean

Признак наличия метро в городе.

Возвращается не во всех методах - в модели ShopBase не используется

Types: BaseShop BffCommonParams EgcDelayedSend Profile

Responses: CitiesResponse CityResponse

Object

string required

houseNumber

string

Номер дома

buildingNumber

string

Номер корпуса

structureNumber

string

Номер строения

postalCode

string

Почтовый индекс

Responses: HousesResponse

Адрес по структуре Яндекс для геозон (содержит город, улицу, дом)

Object

coder

string required

Формат геокодирования

Example:

YANDEX

countryCode

string

Код страны

Example:

postalCode

string

Почтовый индекс

unstructuredAddress

string required

Неструктурированный адрес

yandexStructureComponentList

Array of YandexStructure required

Структура адреса Яндекс

geoPoint

GeoPointLocation required

Methods: Зарегистрировать индивидуального спортсмена

Types: Anketa ReceivingAddressInfo

Responses: AddressDecodeResponse AddressResponse

Признаки возможности использования местоположения

Object

availableForHeader

boolean required

Признак, что местоположение можно установить в шапку МП

requiredLayers

boolean required

Признак наличия в ответе геозон обязательных слоев

availableForApp

boolean required

Признак, что МП умеем работать с этой локацией.

Например, у крыма тут будет false, т.к. МП не работает в крыму. Или у Минска тут будет false, т.к. страна - не Россия

Responses: AddressResponse CityResponse

Object

kind

string required

Тип компонента адреса Яндекса

Enumeration:

HOUSE

STREET

METRO

DISTRICT

LOCALITY

AREA

PROVINCE

COUNTRY

HYDRO

RAILWAY

ROUTE

VEGETATION

AIRPORT

OTHER

name

string required

Название

num

integer required

Порядковый номер компонента в структуре адреса

Types: Address

Вторая строка подсказки адреса

Object

text

string required

Название объекта

Example:

Санкт-Петербург

Array of AddressSuggestHighlight

Фрагменты, совпавшие со строкой запроса

Types: addressSuggest

Первая строка подсказки адреса

Object

text

string required

Название объекта

Example:

Варшавская улица, 16

Array of AddressSuggestHighlight

Фрагменты, совпавшие со строкой запроса

Types: addressSuggest

Фрагмент подсказки адреса, совпавшие со строкой запроса

Object

begin

integer required

Начало диапазона индексов символов строки text для подсвечивания

Example:

end

integer required

Окончание диапазона индексов символов строки text для подсвечивания

Example:

Types: AddressSuggestSubtitle AddressSuggestTitle

Подсказка адреса

Object

title

AddressSuggestTitle required

subtitle

AddressSuggestSubtitle

tags

Array

Тип адреса

string

Example:

locality

formattedAddress

string required

Полный адрес

uri

string required

Дополнительная информация об адресе от яндекса.

Example:

ymapsbm1://geo?data=Cgg1MzIwMTUzMhKMAdCg0L7RgdGB0LjRjywg0KDQtdGB0L_Rg9Cx0LvQuNC60LAg0KLQsNGC0LDRgNGB0YLQsNC9ICjQotCw0YLQsNGA0YHRgtCw0L0pLCDQmtCw0LfQsNC90YwsINGB0LDQtNC-0LLQvtC1INGC0L7QstCw0YDQuNGJ0LXRgdGC0LLQviDQpNC-0YLQvtC9

Responses: GeoSuggestResponse

Определение условия для поиска адреса

string

Enumeration:

TEXT

URI

Methods: Поиск адреса по названию или uri

Данные об авторизационных токенах

Object

accessToken

string required

Короткоживущий токен доступа, подставляется в заголовки запросов

refreshToken

string required

Долгоживущий одноразовый токен для получения новой пары токенов

expiresIn

integer required

Через сколько секунд истекает accessToken

Responses: AuthResponse RefreshTokenResponse

Данные о девайсе.

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

Object

string required

Уникальный айди девайса, который генерируется локально

Methods: Создать анонимного пользователя

string

Enumeration:

VKONTAKTE

(DEPRECATED) FACEBOOK

(DEPRECATED) ODNOKLASSNIKI

APPLE_ID

SBER_ID

Methods: Авторизация через соцсети Найти аккаунт по социальной сети Привязать соцсеть Регистрация через соцсети

DEP с версии 4.63

Модель промокода в списке промокодов пользователя

Object

issueDate

DateOnly

startDate

DateOnly

endDate

DateOnly

actionName

string

Название акции

couponId

string

ID купона, выводится пользователю

Example:

GTFEJVGJ

image

ImageUri

textLegal

string

Текст, который отобраажется на детальной информации о купоне

Example:

Промокод одноразовый, на товары с розничной скидкой от 30% до 49%. Кроме Лучших и Финальных цен.

textDetail

string

Текст для ссылки на подробности акции

Example:

Подробнее

refDetail

string

Ссылка на подробности акции

Example:

https://www.sportmaster.ru/news/5685760/

color

Color

Responses: PromoCodesResponse

Object

promoId

string required

Код начисления/ купона

actionName

string required

Название промоакции

actionType

string required

Тип акции: промокод - ACTION, бонус - ACCRUAL

Enumeration:

ACTION

ACCRUAL

dateBegin

DateOnly

dateEnd

DateOnly

description

string

Текст условий промоакции

linkText

string

Текст для ссылки на подробности

url

string

Ссылка на подробности промоакции

color

Color

image

ImageUri

Responses: PromoResponse

Object

code

string required

Код типа обращения

title

string required

Название типа обращения

subjects

Array of AppealSubject required

Список тем обращений для данного типа (может состоять минимум из одного элемента (по построению с гейта))

hasOrderField

boolean required

Нужно ли показывать поле заказа (true - для типов order_info и complaint)

subjectPlaceholder

string

Текст для поля выбора темы обращения (для типов, у которых несколько тем, например proposal и complaint)

Example:

Выберите тип обращения*

subjectListTitle

string

Заголовок для списка выбора темы обращения (для типов, у которых несколько тем, например proposal и complaint)

Example:

Тема обращения

hasSendToManagerOption

boolean

Отображается ли чекбокс “Отправить руководителю клиентской службы”. true только для жалоб

Example:

false

Responses: AppealTypeResponse

Object

string required

Идентификатор темы обращения

title

string required

Название темы обращения

Types: AppealType

Object

code

string required

Код типа обращения

title

string required

Название типа обращения

Responses: AppealTypeListResponse

Object

number

string required

Номер заказа

date

Date required

price

Price required

Responses: AppealOrderHistoryResponse

Object

string required

Идентификатор типа обращения

name

string required

Наименование типа обращения

code

string required

Код типа обращения

themes

Array of AppealTypeThemes required

Массив тем обращения

Responses: AppealThematicListResponse

Object

string required

Идентификатор тематики обращения

name

string required

Название тематики обращения

Types: AppealTypeThemes

Object

string required

Идентификатор темы обращения

name

string required

Наименование темы обращения

thematics

Array of AppealThemeThematics required

Массив тематик

Types: Appeals

Object

shop

requiredIds required

order

requiredIds required

Responses: AppealThematicListResponse

Object

themeIds

Array of string

Список идентификаторов тем

thematicIds

Array of string

Список идентификаторов тематик

Types: RequiredFields

Информация о прогрессе в клубной программе. Какой сейчас уровень, какой следующий, сколько нужно, чтоб перейти дальше.

Присутствует объект documentUrls, использующийся для формирования контента на экране моих бонусов, получаемого из статических страниц CmsGate по url документа

Object

curLevel

BonusLevel required

nextLevel

BonusLevel

curLevelSumma

Price

nextLevelSumma

Price

toNextLevelSumma

Price

buySumma

Price required

cashLevel

number

Уровень кешбека в процентах. Если null - не отображается (у тренеров и сотрудников)

availableBonusAmount

number required

Бонусный баланс

levelConfirmation

BonusLevelConfirmation

descriptionForAction

string

Описание действий пользователя (параметр text из справочника descriptionActionsClubProgram)

documentUrls

BonusDocumentUrls required

privatePersonType

PrivatePersonType required

Responses: BonusProgressResponse

Модель уровня клубной программы.

Object

name

string required

Название уровня

code

string required

Код уровня

Enumeration:

STANDART

SILVER

GOLD

EMPLOYEE

TRAINER

Types: BonusBalance BonusProgramProgress Информация о клубной программе и бонусах пользователя

Responses: BonusQRInfoResponse RewardsResponse

Модель бонусной карты карты.

Карта характеризуется только номером, баланс и уровень участия привязан к пользователю, а не к карте.

Для БЭ: Берется из GET-MOBILE-CLUB-CARD

Object

qrCode

string

QR-код

Example:

qr_loyality_B5EAF28BE54D85678AA1FAFC6E124F0A0429D0AE2C94C87A1D21438F675357787D528B8CC7024706915999A94D54949ADE156F2E048B154C449E158615B6BCF4

Types: BonusBalance

Responses: BonusQRInfoResponse

Объект в основном формируется из http://rest-app.usergatetst.marathon.mesos.sportmaster.ru/swagger-ui/index.html?url=/v3/api/openapi.yml#/ClubPro/checkBalance

Object

totalAmount

number required

Общий баланс бонусов

cashLevel

number

Уровень кешбека в процентах. Если null - не отображается (у сотрудников)

cashAmount

number required

Сумма кешбек бонусов

promoAmount

number required

Сумма промо бонусов

bonusLevel

BonusLevel required

clubCard

ClubCardNumber

details

Array of BonusAmountDetail required

Детализация по имеющимся бонусам

privatePersonType

PrivatePersonType required

familyMemberStatus

familyStatus required

Responses: BonusShortInfoResponse

За что были начислены бонусы, какого типа и когда они сгорят.

Object

bonusType

string required

Тип бонусов

Enumeration:

UNKNOWN

CASHBACK

PROMO

EMPLOYEE

amount

number required

Количество бонусов

dateEnd

DateOnly required

Types: BonusBalance

Responses: RewardsResponse

Элемент в истории операций с бонусами

Object

date

DateOnly required

dateEnd

DateOnly

summa

number required

Кол-во бонусов по транзакции. Приходит со знаком, по нему клиент понимает, списание это или пополнение

actionName

string required

Название акции

Example:

Кешбэк бонусы за покупки

transDesc

string required

Название транзакции

Example:

Начисление бонусов

transType

string required

Код типа бонусной транзакции

Example:

promoTerms

PromoTerms

transDescByFamily

string

Описание транзакций для участников семейцного счёта

Example:

"Личные" / "Семейный счёт"

Responses: BonusHistoryResponse

Элемент информации о бонусе (тип бонуса, количество и дата сгорания/начисления)

Object

bonusType

string required

Тип бонуса

Enumeration:

CASHBACK

PROMO

amount

number required

Количество бонусов (целочисленное значение)

Example:

500

dateBegin

DateOnly

dateEnd

DateOnly required

Responses: BonusDetailsByTypeResponse

Тип учетной записи в клубной программе

Object

title

string required

Название типа аккаунта

Example:

Спортсмен

value

string required

Отражение энама из гейта

Enumeration:

STANDARD

EMPLOYEE

TRAINER

SPORTSMAN

INDIVIDUAL_SPORTSMAN

Types: BonusBalance BonusProgramProgress

Детальная информация о бонусе: название, тип, кол-во, дата сгорания, каналы и условия траты. Используется для блока “На что можно списать” на экране “Мои бонусы”

Object

bonusType

string required

Тип бонуса

Enumeration:

CASHBACK

PROMO

amount

number required

Количество бонусов (целочисленное значение)

Example:

1000

dateEnd

DateOnly required

promoTerms

PromoTerms required

Responses: BonusDetailsResponse

Urls документов статических страниц для формирования контента на экране моих бонусов

Object

cashback

string required

URL документа для шторки кешбэк бонусов

Example:

bonus_cashback

promo

string required

URL документа для шторки промо бонусов

Example:

bonus_promo

silverLevel

string required

[DEPRECATED] с версии 4.70. URL документа для шторки серебряного уровня

Example:

bonus_silver_level

goldLevel

string required

[DEPRECATED] с версии 4.70. URL документа для шторки золотого уровня

Example:

bonus_gold_level

faq

string required

URL документа для блока “Часто задаваемые вопросы”

Example:

bonus_faq

currentLevelInfo

string

URL документа статич. страницы для шторки текущего уровня пользователя

Example:

current_silver_level

nextLevelInfo

string

URL документа статич. страницы для шторки следующего уровня пользователя

Example:

next_gold_level

Types: BonusProgramProgress

Элемент количества бонусов за какой то день

Object

date

DateOnly required

amount

number required

Количество бонусов в этот день

Responses: [DEP] BonusDetailsResponse

Элемент бонусная акция

Object

accrualCode

string required

Код начисления

Example:

12345

actionName

string required

Наименование акции

Example:

Акция

dateBegin

DateOnly required

dateEnd

DateOnly required

textLegal

string

Текст условия акции

Example:

Применяется только 1 раз

textDetail

string

Текст для ссылки подробнее на шторке акции

Example:

Подробнее

color

Color

image

string

Ссылка на изображение промоакции

Example:

https://cdn.sptmr.ru/upload/content/cmsgate/ru_sm/smprod/coupons/cms_auto_upload/image-2021-08-19-15-35-08-547.png

refDetail

string

Ссылка на подробности акции

Example:

https://www.sportmaster.ru/news/31690304/

Responses: [DEP] BonusCouponsResponse

Условия акции: каналы, условия траты и ссылка на условия акции

Object

spendingTerms

string required

Условия траты бонусов

Example:

На все товары онлайн и офлайн

spendingChannel

string

Канал траты бонусов

Example:

Онлайн-покупки и розница

url

string

Ссылка на условия акции

Example:

https://www.sportmaster.ru/promo/38962110/

Types: BonusDetails BonusHistoryItem

Информация для динамического уровня клубной программы:

сумма для подтверждения уровня
дата проверки уровня
дата действия уровня

Объект возвращается, если FT dynamicLevelCpEnabled включен. Если выключен или у клиента базовый текущий уровень, то объект передается null

Object

toConfirmLevelSumma

Price required

confirmLevelDate

DateOnly required

levelValidityDate

DateOnly required

Types: BonusProgramProgress

Object

messageId

string required

Идентификатор сообщения

messageHeader

string

Заголовок сообщения

messageText

string

Тело сообщения

createdDate

DateOnly

linkMobileApp

string

Ссылка МП

image

ImageUri

hasBeenRead

boolean

Прочитано

Responses: GetMessagesResponse

DEPRECATED, можно удалить, когда будет выпилен ФТ newMessageCenterEnabled

Object

tabName

string required

Имя вкладки

Example:

Заказы

slot

string required

Слот для запроса вкладки

Example:

"message_center_order_status"

Responses: [DEP] NotificationTabsResponse

Object

text

string required

Текст последнего сообщения

Example:

"Ваш заказ 12345-6789 уже в пути!"

createdDate

Date

Types: Slot

Object

code

string required

Код раздела

Example:

"message_center_order_status"

title

string required

Заголовок раздела

Example:

"Заказы"

subtitle

string required

Подзаголовок раздела

Example:

"Доставка, самовывоз, возвраты"

imageUrl

ImageUri required

unreadMessagesCount

integer required

Количество непрочитанных сообщений в разделе

Example:

lastMessage

LastMessage required

Responses: NotificationsSectionsResponse

Данные спортсмена для отправки приглашения

Object

phone

string required

Телефон спортсмена

Example:

79000000000

sportsmanName

string required

Имя спортсмена

Example:

Алексей

Methods: Отправить спортсменам приглашение

Данные спортсмена

Object

invitationCode

string required

Код приглашения

Example:

100000004241755471

Methods: Изменить профиль Регистрация по смс

Модель спортсмена

Object

invitationCode

string required

Код приглашения

Example:

100000000216263150

sportsmanName

string

Имя спортсмена

Example:

Алексей

firstName

string

Имя из анкеты

Example:

Алексей

lastName

string

Фамилия из анкеты

Example:

Иванов

phone

string required

Телефон спортсмена

Example:

79000000000

status

boolean required

Статус регистрации

Example:

true

Responses: SportsmanListResponse

Object

mnemocode

string required

Мнемокод статуса из UserGate

name

string required

Название статуса

Example:

Подтвержден

nameColor

string required

Цвет названия статуса

Example:

#4EB529

descShort

string required

Описание статуса в профиле

Example:

Документы проверены. Статус тренера подтвержден

descFull

string

Описание статуса для шторки в разделе ЛК тренера

Example:

Документы проверены. Статус тренера подтвержден еще на один год

icon

string

Иконка для статуса в разделе ЛК тренера

Example:

https://cdn.sportmaster.ru/upload/content/cmsgate/ru_sm/smuat/mobile_app_hh_4.0/icons/trainer_statuses/ok.png

Responses: TrainerInfoResponse

Object

sex

string required

Пол ребенка

Enumeration:

MALE

FEMALE

birthDate

DateOnly required

Types: Anketa

Object

fileName

string required

Наименование файла с расширением

body

string required

Файл закодированный в base64 на фронте

Methods: Отправить документы тренера в МИР

Object

fileUrl

string required

Ссылка на документ

Example:

https://mir-cd-uat.web.local/efs /process?param=vkYWG31BrDxvvvWyQefl15dFBeknXH/dQZx0LBK+HfAOLx8hiUbzhdLvZ66ZaxTLI1vDLNW2wf MWv6elcCwpdsfTZZ/A/88uDgCP9Z3FEfZj4REKKdSLxdG592ohzbGZAQlVJRm ECJCprQg21cVMu2PzuL16g9c2pR8nRWEQwyFvNSkjCFyI1zafTPOfkVElzQBrkp2fK4gqpBXvnMGcfxL6nG9bF+O0xiU8jM0tZ+ABGU5oWeXSCGv2RrRD1M1WF/V3hKY6vdp04uT6U/wMKQ==

isBadFile

boolean required

Булевой атрибут, был ли в файле вирус

Responses: UploadMirResponse

Object

firstName

string required

Имя

lastName

string required

Фамилия

middleName

string

Отчество

sex

string required

Пол

Enumeration:

MALE

FEMALE

birthDate

DateOnly required

phoneNumber

Phone required

string required

registryLink

string

Ссылка на реестр

Example:

https://registry.web.local

Methods: Отправить анкету тренера

Object

string required

Идентификатор вида спорта

name

string required

Название вида спорта

Responses: SportKindsResponse

Object

docUrl

string required

Единая ссылка на документы тренера из МИР

vrowid

string required

Идентификатор загруженных документов

Methods: Отправить анкету тренера

Object

firstName

string required

Имя

lastName

string required

Фамилия

middleName

string

Отчество

birthDate

DateOnly required

string required

Methods: Зарегистрировать индивидуального спортсмена

Object

name

string

url

string required

iconUrl

string

Object

string required

ID вида спорта

name

string required

Наименование вида спорта

Responses: SportKindListResponse SportKindResponse

Object

string required

Идентификатор публикации в CMS Gate

url

string required

URL публикации в CMS

announcement

string

Контент для шапки экрана

body

string

Контент для инструкции экрана

Responses: PublicationSportKindResponse

Вознаграждение

Object

rewardCode

string required

Код вознаграждения

dateBegin

DateOnly required

dateEnd

DateOnly required

price

number required

Стоимость в баллах

isAvailable

boolean required

Доступно для пользователя

isPurchased

boolean required

Куплено пользователем

pointsToBuy

number

[DEPRECATED] c версии 4.68. Нужно еще баллов чтобы приобрести

rewardContent

RewardContent required

freeAwardsLevel

FreeAwardsLevel

Responses: RewardsResponse

Контент вознаграждения

Object

rewardType

string required

Тип вознаграждения

Enumeration:

TEXT

LINK

title

string required

Заголовок

text

string

Текст

image

ImageUri

moreUrl

string

Ссылка на подробности акции

resultButton

RewardButton

resultText

string

Текст результата вознаграждения. Для типа с текстом

Types: Reward

Модель кнопки вознаграждения

Object

buttonText

string required

Текст кнопки

buttonUrl

string required

Ссылка кнопки

Types: RewardContent

Object

bonusAmount

number required

Количество бонусов

pointsAmount

number required

Количество баллов

exchangeRate

integer required

Коэффициент конвертации бонусов в баллы

Responses: RewardsResponse

Баннер для экрана витрины предложений/вознаграждений

Object

image

ImageUri required

imageAssetId

string

ID ассета, если баннер был загружен через Laika

url

string

Ссылка на обработку диплинка

Example:

sportmaster://ecosystem

string required

ИД баннера

slot

string required

Слот баннера

Example:

mobile_app_banner_rewards_1

Responses: RewardsResponse

Уровень клубной программы, при достижении которого вознаграждение станет беслпатным

string

Enumeration:

STANDART

SILVER

GOLD

Types: Reward

Object

forWhomShopping

Array of Interest

Список для кого покупают

sportInterests

Array of Interest

Список интересов

styles

Array of Interest

Список выбранных стилей

surveyPassed

boolean

Признак пройденности опроса

Responses: ClientInterestsResponse

Object

text

string required

Наименование

Example:

Теннис

image

ImageUri

Types: client-interests

Object

title

string required

Текст заголовка для экрана “Приветствия”

Example:

Настройте свой Спортмастер!

text

string required

Текст для экрана “Приветствия”

Example:

Улучшим подборку товаров и соберём персональные акции и предложения

questions

SurveyQuestions

Responses: ClientInterestsResponse

Object

code

string required

Код ответа в опросе

Example:

male или female

text

string required

Заголовок ответа

Example:

Плавание

image

ImageUri

isSelected

boolean required

Был ли ранее выбран этот ответ

Types: SurveyQuestion

Object

gender

SurveyQuestion required

forWhomShopping

SurveyQuestion required

sportInterests

SurveyQuestion required

styles

Array of SurveyQuestion required

Вопросы для выбора стилей

Types: ClientSurvey

Object

integer required

Идентификатор вопрос. Значение 1 означает, что это первый вопрос из списка

Example:

nextQuestionId

integer required

Идентификатор следующего вопроса. Значение -1 означает, что это последний вопрос из списка

Example:

mnemocode

string

Мнемокод вопроса (используется для вопросов “Нравится этот стиль?”)

Example:

SPORT_STYLE

title

string required

Заголовок вопроса

Example:

Нравится этот стиль?

answers

Array of SurveyAnswer required

Список ответов

content

GenderImages

Types: SurveyQuestions

Object

male

Array of ImageUri

Изображения для мужского пола

female

Array of ImageUri

Изображения для женского пола

Types: SurveyQuestion

Object

mnemocode

string required

Мнемокод стиля

selected

boolean required

Признак стиля (выбрано или нет)

Methods: Отправить интересы

Object

header

string

Заголовок в блоке с кнопкой

Example:

РЕКОМЕНДУЙТЕ НАС ДРУЗЬЯМ

subtitle

string

Подзаголовок в блоке с кнопкой

Example:

и получайте бонусы

referralButton

RefButton

document

RefProgDocument

Responses: ReferralProgramResponse

Object

string required

Example:

Идентификатор документа в CMS Gate

content

string required

Example:

Контент для экрана “Пригласи друга”

Types: ContentRefProg

Информация для отображения кнопки реферальной программы

Object

buttonUrl

string required

Url для кнопки “Поделиться ссылкой”

Example:

https://sportmaster.onelink.me/imJi/ref?deep_link_sub1=2132321332

buttonText

string

Текст для кнопки “Поделиться ссылкой”

Example:

Поделиться ссылкой

Types: ContentRefProg

Object

nodeId

string required

Идентификатор группы скидок

Example:

18208620009

Types: PersonalDiscount

Responses: PersonalDiscountsBaseResponse

Object

base

PersonalDiscountBase required

dateBegin

DateOnly

dateEnd

DateOnly

nodeName

string required

Название группы

Example:

15% на мужские жилеты

url

string

Ссылка на ветку каталога

miniatures

Array of ImageUri

Фотографии товаров данной группы

discountCode

string required

Код скидки

Example:

12345

badges

Array of BadgeParameters

Массив бейджей

buttonType

string

Тип кнопки

Enumeration:

ACTIVATION

CARD

discountPercent

integer required

Размер скидки в %

showDate

boolean required

Признак необходимости отображения даты

Responses: PersonalDiscountsResponse

Object

title

string required

Заголовок в кнопке

type

string required

Тип кнопки

Enumeration:

ACTIVATION

CARD

buttColor

Color required

textColor

Color required

Object

title

string required

Заголовок в плашке

bgColor

Color required

textColor

Color required

type

string required

Тип бейджа

Enumeration:

STATIC

TIMER

icon

string

Тип изображения в бейдже

Enumeration:

FIRE

expiresIn

Duration

Types: PersonalDiscount

Responses: PersonalDiscountActivationResponse

Информация о семейном счёте

Документация: https://confluence.app.local/pages/viewpage.action?pageId=845282762

Object

string required

Идентификатор семьи

currentMember

CurrentFamilyMember required

invitationSenderName

string

Имя отправителя приглашения (придёт, если статус текущего участника - INVITED)

invitationSenderPhone

string

Телефон отправителя приглашения (придёт, если статус текущего участника - INVITED)

Example:

79999999999

members

Array of FamilyMember required

Информация об участниках в семейном аккаунте

settings

FamilySettings required

Responses: FamilyResponse

Информация о статусе пользователя в семье

Object

string required

Идентификатор участника в семейном счёте

phone

string required

Номер телефона участника семейного счёта

status

familyStatus required

availableInvitationsAmount

integer

Количество доступных приглашений для владельца

limitsRefreshDate

DateOnly

invitationEndTime

OffsetDateTime

availableJoinsAmount

integer

Количество доступных переходов в другую семью

limitsJoinsRefreshDate

DateOnly

Types: Family

Статус участника семейного счёта

string

Enumeration:

OWNER

INVITED

NOT_REGISTERED

MEMBER

NOT_FAMILY_MEMBER

Types: BonusBalance CurrentFamilyMember FamilyMember

Responses: BonusHistoryResponse

Информация о других участниках в семейном счёте

Object

name

string required

Имя пользователя (для приглашённых участников задавалось владельцем)

phone

string required

Телефон пользователя

Example:

79999999999

status

familyStatus required

string required

Id участника

inviteCode

string

Код приглашения

Types: Family

Информация о бонусах и клубной программе

Документация: https://confluence.app.local/pages/viewpage.action?pageId=845282762

Object

bonusLevel

BonusLevel required

totalAmount

integer required

Текущее количество бонусов пользователя (вместе с семейными, если они есть)

personalAmount

integer

Текущее количество бонусов пользователя без учёта семейный бонусов

Responses: FamilyResponse

Общие настройки для семейного счёта

Object

maxInvitations

integer required

Количество приглашений доступное для владельца в промежутке времени

Example:

maxInvitationsDates

integer required

Период ограничения числа приглашений в семейный аккаунт (в днях)

Example:

maxJoins

integer required

Количество возможных присоединений к семейному счёту в промежутке времени

Example:

maxJoinsDays

integer required

Период ограничения числа присоединений к семейному счёту (в днях)

Example:

maxFamilySize

integer required

Количество участников семейного счёта (с учетом владельца)

Example:

Types: Family

Информация о частозадаваемых вопросах семейного счёта

Object

answerPageUrl

string required

URL статической страницы с ответом

Example:

/family/answer/1

title

string required

текст вопроса

Example:

Что такое семейный счёт?

Responses: FamilyQuestionsResponse

Секция с акцией

Object

type

TypeBenefitSection required

content

BenefitBanner required

Responses: BenefitsResponse

Справочник типов секций с акциями. Для независимых от условий секций (ФТ, тип пользователя и прочее. Т.е. те секции, которые не нужно дополнительно обрабатывать на бэкенде) задается общее название “section_порядковый номер”

string

Enumeration:

favourite_sport

rewards

section_1

section_2

section_3

section_4

other

Types: BenefitSection

Баннер для отображения секции с акцией

Object

title

string required

Название секции

image

ImageUri required

imageAssetId

string

ID ассета, если баннер был загружен через Laika

url

string

Ссылка на обработку диплинка

layout

BenefitBannerLayout required

string required

ID баннера

slot

string required

Баннерный слот

Types: BenefitSection

string

Enumeration:

half_h

half_v

quarter

Types: BenefitBanner

Модель магазина для списков

Object

string

Подразделение (в терминах МДМ)

Example:

13890299

address

string

Адрес магазина

Example:

г. Москва, Варшавское ш., д.129А

shopNumber

integer

Номер магазина

name

string

Название

Example:

Варшавское ш., 129А

weekSchedule

Array of WeekSchedule

График работы магазина

shopFormat

ShopFormat

geoPoint

GeoPoint

metroStations

Array of MetroStation

Станции метро

isConvenience

boolean

Круглосуточный ли магазин

shopCondition

string

Состояние магазина

Enumeration:

SHOP_NEW

SHOP_PRESENT

SHOP_CLOSED

phone

Phone

city

City

shopWay

string

Как добраться без машины

inventory

ShopInventory

Types: CartItemInternalAvailability2 ServiceCenter Shop SkuAvailabilityInShop

Responses: FavouriteShopsResponse ShopsResponse ShopsResponse2

Полная модель магазина. Обрати внимание на наследование

All of

BaseShop

Object

autoWay

string

Как добраться - на машине

shopWay

string

Как добраться - без машины

situationTc

string

Расположение в ТЦ

tcShortName

string

Наименование ТЦ

Responses: ShopResponse

Время работы магазина

Object

workStartTime

string

Время начала работы

workEndTime

string

Время закрытия

Types: WeekSchedule

График работы магазина по дням недели

Object

dayNumber

integer

Номер дня недели

dayName

string

День недели

workTime

WorkTime

Types: BaseShop

Формат магазина

Object

string

Код формата

onlineShopName

string

Название для интернет магазина. МП использует это

image

ImageUri

Types: BaseShop

Станция метро

Object

string

geoPoint

GeoPoint

line

MetroLine

name

string

название

Types: BaseShop Pickpoint

Линия метро

Object

string

name

string

color

Color

Types: MetroStation

Город с координатами

Object

string required

Айди города

name

string required

Название города

geoPoint

GeoPoint

Responses: ShopsResponse

Object

shopNumber

string required

Responses: FavouriteShopNumbersResponse

Точка самовывоза (ПВЗ)

Для БЭ: из запроса http://rest-app.geogate-uat.k8s-dev.gksm.local/swagger-ui/index.html?url=../openapi.json#/deliveryPoints/searchDeliveryPoint

Object

string required

Идентификатор ПВЗ

name

string required

Название ПВЗ

address

string

Адрес ПВЗ

routeDescription

string

Описание проезда

phone

string

Телефон

wareStoragePeriod

string

Срок хранения товара

Example:

2 дня

geoPoint

GeoPoint

metroStations

Array of MetroStation required

insideLocate

string

Расположение внутри

workTime

string

График работы

type

PickpointType required

providedServices

Array of PickpointService

Предоставляемые услуги

isConvenience

boolean

Круглосуточно ли работает ПВЗ.

Для БЭ: поле высчитывается искусственно по полю workTime. Если там “круглосуточно”, то тут true

unavailableServices

Array of PickpointService

Недоступные услуги для данного ПВЗ

Types: CartItemExternalAvailability2 SkuAvailabilityInShop

Responses: DropOffDeliveryPointAvailabilityResponse

Вид ПВЗ.

Для БЭ: http://rest-app.geogate-uat.k8s-dev.gksm.local/swagger-ui/index.html?url=../openapi.json#/deliveryPoints/searchDeliveryPoint

Калька с userDeliveryPointType

Картинок в гейте нет, картинки нужно взять у дизайнеров и залить в CMS гейт в соотвествии с типами.

Вроде как есть только 3 типа Отделение почты, Постамат, Пункт выдачи заказа. Так сказала ПЛ.

Object

string

Идентификатор типа ПВЗ для пользователя

name

string

Название

image

string

Иконка ПВЗ.

Для Дена: нужно как то узнать какие есть вообще виды пвз и составить им таблицу сотвествия по картинкам. В гейтах картинки нет.

Types: Pickpoint

Услуги, которые предоставялет ПВЗ.

Для БЭ: калька с http://rest-app.geogate-uat.k8s-dev.gksm.local/swagger-ui/index.html?url=../openapi.json#/deliveryPoints/searchDeliveryPoint providedServices

Object

string

Айди услуги

Example:

10020299

name

string

Название услуги

Example:

Оплата наличными

mnemocode

string

Мнемокод услуги, чтобы фронт хардкодился на него в своей логике

Example:

cash

Types: Pickpoint

Инвентаризация в магазине

Object

begin

Date

end

Date

beginDateTime

OffsetDateTime

endDateTime

OffsetDateTime

cause

string

Причина инвентаризации

Enumeration:

COMPLETE_INVENTORY

PARTIAL_INVENTORY

SCHEDULED_INVENTORY

Types: BaseShop

Пункт меню “Я в магазине”

Object

name

string required

Название пункта меню

icon

ImageUri required

linkUrl

string

Ссылка на раздел

Responses: InStoreMenuResponse

Модель магазина для сервиса “Я в магазине”

Object

shopNumber

string required

Номер магазина для сервиса “Я в магазине”

address

string required

Адрес магазина для сервиса “Я в магазине”

Responses: InStoreShopInfoResponse

Object

shopNames

Array of string

Массив названий магазинов

delivery

boolean required

Признак доставки

Methods: Список товаров

Types: ProductsMeta

Категория каталога

Object

string required

Идентификатор категории

Example:

muzhskaya_obuv

name

string required

Имя категории

Example:

Мужские полуботинки

uri

string required

Путь до ресурса. Используется для получения товаров и загрузки подкатегорий

Example:

category/muzhskaya_obuv/cross

image

ImageUri

displayCode

CatalogDisplayCode

type

string required

Тип страницы каталога: обычная ветка или страница с персональными товарами

Example:

"categoryBranch" или "categoryPromo" или "seller"

Types: ProductsMeta

Responses: SearchAutocompleteResponse SubcategoriesResponse

Бренд

Object

string required

Идентификатор бренда

Example:

nike

name

string required

Название бренда

Example:

Nike

image

ImageUri

url

string

Путь до ресурса. Используется для загрузки подкатегорий

Example:

brand/nike/cross

displayCode

CatalogDisplayCode

Types: MainSectionEntity

Responses: BrandsResponse

Способ отображения детальной информации

string

Enumeration:

tags

Array required

Теги тренировки

Object

string required

Идентификатор тега

Example:

URN0YCJ7ZD

name

string required

Название тега

textColor

Color required

backgroundColor

Color required

Types: ServiceSectionEntity

Событие в афише

Object

string required

image

ImageUri required

title

string required

Название мероприятия

type

string required

Тип мероприятия (лекция, мероприятия и т.д.). Локализованное значение

Example:

Лекция

format

string required

Формат мероприятия (онлайн, офлайн). Локализованное значение

Example:

Онлайн

labels

Array of string required

Массив тегов: количество бонусов, вид спорта. Если для мероприятия нет тегов, возвращается пустой массив

url

string required

Ссылка на обработку диплинка

Types: ServiceSectionEntity

Модель виджета сервиса.

Object

serviceId

ServicesEnum required

type

ServiceItemType required

url

string

Диплинк сервиса, для сервисов с типом отличным от DEFAULT

Example:

"sportmaster://bday"

image

ImageUri required

Types: ServiceSectionEntity

Группа сервисов

Object

title

string required

Заголовок группы сервисов

Example:

Избранное

services

Array of ServicesGroupItem required

Список сервисов

Responses: ServicesGroupsResponse

Элемент группы сервисов

Object

service

ServiceItem required

isFavorite

boolean required

Признак избранного элемента группы сервисов

Example:

true

Types: ServicesGroup

Достижение пользователя

Object

string required

Идентификатор достижения

isAchieved

boolean required

Признак полученного достижения

Example:

true

notReceivedImage

ImageUri required

receivedImage

ImageUri required

notReceivedColor

Color required

receivedColor

Color required

Types: ServiceSectionEntity

Object

image

ImageUri

imageAssetId

string

ID ассета, если баннер был загружен через Laika

url

string

Ссылка на обработку диплинка

Example:

/catalog/krossovki_?f-markers=new&icid=app!s-1!krossovki

string required

ИД баннера

slot

string required

Слот баннера

Example:

"sm_hh_mobileapp_get_300_bonus"

title

string

Заголовок

text

string

Текст для изображения

Responses: BannerResponse BannersResponse CatalogBannersResponse ProfileBannersResponse ServiceCategoriesResponse

Object

url

string

Ссылка на обработку диплинка

Example:

/catalog/krossovki_?f-markers=new&icid=app!s-1!krossovki

string required

ИД баннера

slot

string required

Слот баннера

Example:

"sm_hh_mobileapp_get_300_bonus"

text

string required

Текст для баннера

Responses: TickerResponse

Модель события для BFF аналитики

Object

string required

Уникальный идентификатор события UUID, создан чтобы добавить на бэке проверку по уникальности. Не должно быть дублей событий

version

string required

Версий спецификации события

Example:

1.0.0

type

string required

Название события

common

BffCommonParams required

custom

Any of

Собственные параметры события.

BffNotificationGetParams

BffNotificationClickParams

Methods: Событие в BFF

Модель с общими параметрами для каждого события BffEvent

Object

timestamp

integer int64 required

Время регистрации события у клиента в миллисекундах UTC.

client

Object required

userAgent

string required

Параметры user-agent

Example:

Android: Dalvik/2.1.0 (Linux; U; Android 14; Pixel 6a Build/UP1A.231005.007)

appVersion

string required

Версия приложения числовая

Example:

4.41.0

user

Object required

uid

string

Идентификатор пользователя в User gate. Берется из запроса, модель AuthResponse. data. profile. userGateUid. Значение меняется после авторизации, регистрации и логаута. (При анонимном профиле будет NULL)

profileId

string required

Берём AuthResponse. data. profile. id. (При анониме будет UUID, при авторизованном - числовой идентификатор клиента клубной программы)

location

Location

city

City

Types: BffEvent

Собственные параметры события bff_notification_get

Object

notification

Object required

Модель уведомления для аналитики BFF

string

Идентификатор уведомления, которое получил фронт

isSilent

boolean required

Флаг того, что уведомление было «скрытным» для пользователя

Types: BffEvent

Собственные параметры события bff_notification_click

Object

notification

Object required

Модель уведомления для аналитики BFF

string

Идентификатор уведомления, которое получил фронт

isSilent

boolean required

Флаг того, что уведомление было «скрытным» для пользователя

Types: BffEvent

Метка персонализации Pers Gate.

Object

type

integer required

Тип метки

value

string required

Значение метки

Responses: PersGateTagsResponse

Статическая страница из CMS Gate.

Object

string required

Идентификатор статической страницы

Example:

11458174

name

string

Заголовок статической страницы

Example:

Пользователь не может участвовать в реферальной программе

content

string

Контент статической страницы (текст, html)

Example:

chpu

string

URL статической страницы

Example:

/referral-program-not-available

slot

string

Слот статической страницы (если она оформлена как фрагмент)

Example:

mobile_app_fragment_referral

Responses: DocumentResponse

Публикация из CMS Gate.

Object

string required

Идентификатор публикации

Example:

999110

url

string required

URL публикации

Example:

/300bon/

publicationDate

DateOnly

endDate

DateOnly

title

string

Заголовок публикации

Example:

300 бонусов за применение виртуальной карты на кассе МП4.0

announcement

string

Анонс публикации

Example:

Получите 300 бонусов

body

string

Контент (текст, html). </br>Для метода “Список новостей” не заполняется.

Example:

<div class=\"ar-news_ur-text\">С 10.06.2021 по 09.09.2021 при совершении покупки в магазинах розничной сети от 1000 рублей и авторизации при помощи штрих кода виртуальной клубной карты в мобильном приложении начисляются 300 промо бонусов.</div>

sharingUrl

string

URL публикации для кнопок шеринга.

Формируется для метода "Получить публикацию по URL" по шаблону: https://sportmaster.ru/news/ {id}?utm_source={platform}_appshare&utm_medium=soc&utm_campaign=socsharing_news_{platform}&utm_content={id}

* id - айди публикации
* platform - ios или android
```

Example:

https://sportmaster.ru/news/300bon/?utm_source=ios_appshare&utm_medium=soc&utm_campaign=socsharing_news_ios&utm_content=999110

image

ImageUri

Responses: PublicationResponse PublicationsResponse

Основная информация о всплывающем окне

Object

string required

Идентификатор всплывающего окна из ContentGate

Example:

123123

name

string

Описание всплывающего окна

type

PopupType required

subtype

PopupSubtype required

displayInterval

integer

Интервал между переходом (секунды)

Responses: PopupResponse

Тип всплывающего окна

string

Enumeration:

SHEET

SLIDER

Types: PopupInfo

Подтип всплывающего окна

string

Enumeration:

MAIN

PUSH

Types: PopupInfo

Контент для всплывающего окна

Object

string required

Идентификатор контента для всплывающего окна из ContentGate

name

string

Название окна в карусели

image

ImageUri required

backgroundColor

Color required

controlsColor

Color required

title

string

Заголовок

text

string

Текст

fontColor

Color required

consentText

string

Текст согласия на рассылку (для формы e-mail)

Example:

Даю согласие на получение <a href="sportmaster://subscriptions/">информации </a> о специальных предложениях, новых товарах

url

string

Ссылка для перехода по клику на изображение (для формы main)

button

PopupButton required

buttons

Array of PopupButtons required

Кнопки

Responses: PopupResponse

Информация для кнопки во всплывающем окне

Object

text

string required

Текст кнопки

backgroundColor

Color required

fontColor

Color required

url

string

Ссылка в кнопке

Types: PopupContent

Информация для кнопки во всплывающем окне

Object

text

string required

Текст кнопки

backgroundColor

Color required

fontColor

Color required

url

string

Ссылка в кнопке

type

PopupButtonType

Types: PopupContent

Тип кнопки

string

Enumeration:

MAIN

MINOR

Types: PopupButtons

Информация по правилам показа всплывающих окон для фронта.

Object

string required

id всплывающего окна

Example:

123123

name

string required

Название (используется для аналитики)

dateTimeFrom

OffsetDateTime required

dateTimeTo

OffsetDateTime required

priority

integer required

Приоритет показа

Example:

totalDisplayCount

integer required

Общее количество показов окна на аккаунте (сколько мы одно и то же окно можем показать одному клиенту)

Example:

timeFromSessionStartSeconds

integer

Количество секунд, которое должно пройти при заходе на экран перед показом окна. Если значение не пустое, то как минимум 1 сек.

Example:

sessionDisplayCount

integer

DEP c 4.74 Максимальное количество показов окна до закрытия МП.

Example:

timeBetweenDisplaysSeconds

integer

Время, которое должно пройти между показами всплывающих окон в секундах

Example:

spentDisplayCount

integer

Количество показов пользователю окна за всё время (сколько раз всего было показано окно клиенту)

Example:

firstDisplayDateTime

OffsetDateTime

lastDisplayDateTime

OffsetDateTime

displayRules

Array of DisplayRule

Условия показа всплывающего окна с учётом экрана, на котором находится пользователя

Methods: Получить правила показа всплывающих окон

Responses: PopupSettingsResponse

Условия показа всплывающего окна

Object

show

boolean required

Флаг для определения показывать/не показывать окно с учётом условия по урлу

condition

ConditionEnum required

url

string required

Ссылка с диплинком или его частью

Example:

/catalog/zhenskaya_odezhda

Types: PopupSettings

Список условий для показа всплывающих окон по url.

string

Enumeration:

CONTAINS

MATCHES

STARTSWITH

ENDSWITH

Types: DisplayRule

29.09.2023: эту модель не удалять, а переместить в раздел Экран сервисов

Object

integer required

name

string required

description

string

image

ImageUri required

isActive

boolean required

isEnded

boolean required

isSubscribeAvailable

boolean required

Признак доступности подписки на стрим

isUserSubscribed

boolean required

Подписан ли пользователь на стрим.

startDate

Date required

streamUrl

string required

Ссылка на веб вью со стримом

tagIds

Array of integer required

Список id тэгов стрима

Types: ServiceSectionEntity

Responses: ActiveStreamResponse StreamsResponse

Object

integer required

name

string required

image

ImageUri required

isActive

boolean required

isEnded

boolean required

startDate

Date required

isUserSubscribed

boolean required

Подписан ли пользователь на стрим

streamUrl

string required

Ссылка на веб вью со стримом

video

Object

Данные о видео в стриме

url

string required

Ссылка на видео с трансляцией

Example:

https://kinescope.io/203606331/master.m3u8

provider

string required

Провайдер видео

Example:

Kinescope

promocode

Object

Данные о промокоде внутри стрима. Используется только для аналитики пользовательских действий.

description

string required

Описание промокода

Example:

Даёт скидку 20% на бренды FILA, Kappa, Termit до 14.10.22 включительно

code

string required

Код промокода

Example:

ТРЕНД

discount

integer required

Процент скидки по промокоду

Example:

deadline

string required

Срок действия промокода

Example:

14.10.22

products

Array required

Массив товаров

Object

string required

Идентификатор цветомодели товара

Example:

25878970299

price

integer required

Цена на товар

Example:

2499

discount

integer required

Цена на товар со скидкой

Example:

2249

name

string required

Наименование товара

Example:

Матрас надувной Outventure 191х137х22 см

Responses: StreamResponse

Object

string required

id кнопки Live для события аналитики

slotId

string required

mnemocode кнопки Live для события аналитики

Responses: ActiveStreamResponse

Тэг для фильтрации стримов

Object

integer required

Уникальный id тэга

name

string required

Строковое представление тэга для вывода в приложении

Responses: StreamsResponse