/
Отзывы

Отзывы

Описание: Получение всех отзывов

Адрес: https://api.cloudtips.ru/api/feedbacks

Тип: GET

Запрос:

Наименование

Тип

Обязательность

Описание

Наименование

Тип

Обязательность

Описание

dateFrom

String

Нет

Дата начала поиска транзакций

dateTo

String

Нет

Дата окончания посика транзакций

placeId

Array of string

Нет

Поиск по уникальному идентификатору заведения

phoneNumber

String

Нет

Поиск по телефонному номеру получателя

transactionId

String

Нет

Поиск по уникальному идентификатору транзакции

userId

String

Нет

Поиск по уникальному идентификатору получателя

page

Integer

Нет

Постраничный поиск

limit

Integer

Да

Ограничение на количество записей, от 1 до 2000.

Пример запроса:

{ "dateFrom": "string", "dateTo": "string", "placeId: [ "string" ], "phoneNumer": "string", "transactonId": "string", "userId": "string", "page": 0, "limit": 0 }

Ответ:

Наименование

Тип

Обязательность

Описание

Наименование

Тип

Обязательность

Описание

date

String

Да

Дата транзакции

amount

Integer

Да

Сумма транзакции

userId

String

Да

Уникальный идентификатор получателя

userPhoneNumber

String

Да

Телефон получателя

userName

String

Да

Почта получателя

userExternalId

 

String

Да

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

placeId

String

Да

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

placeName

String

Да

Название заведения

placeExternaslId

String

Да

Идентификатор заведения из внешней системы

invoiceId

String

Да

Внешний идентификатор

layoutId

String

Да

Уникальный идентификатор страницы оплаты

comment

String

Да

Комментарий оставленный платящим

rating

 

Да

Компоненты рейтинга

score

Integer

Да

Количество звезд

components

 

Да

Категории рейтинга

id

String

Да

Уникальный идентификатор

title

String

Да

Название

selected

Boolean

Да

Выбрана или нет

transactionId

Integer

Да

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

totalCount

Integer

Да

Количество записей

succeed

String

Да

Стату запроса

errors

Array of string

Да

Возвращатеся список ошибок, относящихся целиком к запросу

validationErrors

Array of string

Да

Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

Пример ответа:

{ "data": { "items": [ { "id": "string", "date": "2022-03-28T12:33:04.260Z", "userId": "string", "userPhoneNumber": "string", "userName": "string", "placeId": "string", "placeName": "string", "layoutId": "string", "comment": "string", "ratingInfo": { "score": 0, "components": [ { "id": "string", "title": "string", "selected": true } ] }, "transactionId": 0 } ], "totalCount": 0 }, "succeed": true, "statusCode": 0, "errors": [ "string" ], "validationErrors": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] } }

 

Related content