Получение списка подарков
Возвращает список подарков магазина с пагинацией.
Request
GET
https://api.kit.yandex.net/v1/gifts
Query parameters
|
Name |
Description |
|
page |
Type: integer Номер страницы. Default: Min value: |
|
per_page |
Type: integer Количество элементов на странице. Default: Min value: Max value: |
|
status |
Type: GiftStatus Фильтр по статусу подарка. Статус подарка:
Enum: |
GiftStatus
Статус подарка:
ACTIVE— активный подарок (доступен покупателям).INACTIVE— неактивный подарок.
Type: string
Enum: ACTIVE, INACTIVE
Responses
200 OK
Список подарков.
Body
application/json
{
"gifts": [
{
"id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
"title": "Подарок при заказе от 1000 рублей",
"min_cart_total": "1000.00",
"status": "ACTIVE",
"default_sort": "POPULARITY",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z"
}
],
"total_count": 100
}
|
Name |
Description |
|
gifts |
Type: Gift[] Example |
|
total_count |
Type: integer Общее количество подарков. |
GiftID
Идентификатор подарка.
Type: string<uuid>
Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9
GiftDefaultSort
Сортировка товаров подарка по умолчанию:
POPULARITY— по популярности.CHEAPEST— сначала дешевые.EXPENSIVE— сначала дорогие.NEWEST— сначала новые.OLDEST— сначала старые.
Type: string
Default: POPULARITY
Enum: POPULARITY, CHEAPEST, EXPENSIVE, NEWEST, OLDEST
Gift
Подарок за покупку.
|
Name |
Description |
|
created_at |
Type: string<date-time> Дата создания подарка. Example: |
|
default_sort |
Type: GiftDefaultSort Сортировка товаров подарка по умолчанию:
Default: Enum: |
|
id |
Type: GiftID Идентификатор подарка. Example: |
|
min_cart_total |
Type: string<decimal> Минимальная сумма корзины для получения подарка. Example: |
|
status |
Type: GiftStatus Статус подарка:
Enum: |
|
title |
Type: string Название подарка. Example: |
|
updated_at |
Type: string<date-time> Дата последнего обновления подарка. Example: |
Example
{
"id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
"title": "Подарок при заказе от 1000 рублей",
"min_cart_total": "1000.00",
"status": "ACTIVE",
"default_sort": "POPULARITY",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z"
}
400 Bad Request
Некорректный запрос.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |
401 Unauthorized
Не авторизован.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"trace_id": "00000000000000000000000000000000"
}
|
Name |
Description |
|
code |
Type: string Example: |
|
message |
Type: string Example: |
|
trace_id |
Type: string Уникальный идентификатор запроса для отладки. Example: |