Получение списка заказов карт
Метод для получения списка заказов карт.
URL
GET https://rest.lksup.ru/v1/orders
Описание
Метод возвращает список всех заказов карт.
Для выполнения запроса необходимо предоставить: - Авторизационные данные — JWT access токен - Данные о странице — Данные для получения определенного списка заказов.
Примечание: Перед отправкой убедитесь, что тело запроса зашифровано корректно.
Структура запроса
В HTTP Header необходимо передать x-nonce, также в заголовок Authorization, помещается JWT токен. - Данные пагинации. - X-Nonce: — значение состоит из случайных символов, используется в шифровании (передается в заголовке).
Пример запроса:
Формат запроса:
GET https://rest.lksup.ru/v1/orders
Тело запроса:
{
"page": integer,
"per_page": integer
}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
page |
integer | Номер получаемой страницы (значение по умолчанию = 1) | Нет | Да |
per_page |
integer | Количество записей на странице (значение по умолчанию = 15) | Нет | Да |
Структура ответа
Пример успешного ответа - код 200
{
"data": [
{"orderId": uuid,
"status": "string"}
]
"meta": {
"current_page": 0,
"from": 0,
"to": 0,
"total": 0,
"per_page": 0,
"last_page": 0,
"path": "string",
}
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
data |
dict | Словарь, содержащий данные по заказам |
orderId |
uuid | Идентификатор заказа карт |
status |
string | Статус заказа карт |
current_page |
integer | Номер текущей страницы |
from |
integer | Номер текущей страницы |
to |
integer | Номер записи, на которой заканчивается список |
total |
integer | Количество всех записей |
per_page |
integer | Количество записей на странице |
last_page" |
integer | Номер последней страница |
path |
string | Путь |
Статусы карт:
| Параметр | Описание |
|---|---|
| CREATED | Создан (для виртуальных и пластиковых карт) |
| CANCELED | Отменен партнером до обработки (для виртуальных и пластиковых карт) |
| CANCELED_MANAGER_BEFORE_PRECESSING | Отменен менеджером до обработки (для виртуальных и пластиковых карт) |
| IN_PROCESS | Заказ взят в работу (для виртуальных и пластиковых карт) |
| DOCUMENTS_SENT | Документы отправлены (бухгалтерские документы, для пластиковых карт) |
| PREPARING_CARDS | Подготовка карт к отправке (для пластиковых) |
| PREPARING_CARDS_VIRTUA | Подготовка карт (для виртуальных карт) |
| PREPARING_ORDER | Подготовка заказа к отправке (для пластиковых карт) |
| CARDS_SENT | Карты отправлены (для пластиковых карт) |
| DONE | Заказ выполнен (для виртуальных и пластиковых карт) |
| CANCELED_ON_REQUEST | Заказ отменен по запросу партнера (отмена оффлайн, для пластиковых карт) |
| CANCELED_MANAGER | -Заказ отменен менеджером во время обработки (для пластиковых карт) |
| REFUND_REQUESTED | Запрошен возврат карт (для пластиковых карт) |
Пример ответа с ошибкой
Ответы с ошибкой могут быть двух видов.
Пример ответа для кода состояния 422
{
"data":[
{"field": "string",
"message": "string"}
]
}
Пример ответа для кодов состояния 4хх, за исключением 422
{
"success": false;
"message": "string"
}
Возможные ошибки
| Статус | Описание |
|---|---|
| 401 | Не авторизован. Некорректный токен |
| 422 | Передано некорректное значение |