Склад
Страница описывает операции раздела API в едином формате карточек операций.
Предметы на складе
warehouse
Описание
Предметы на складе.
Входные данные
Операция не принимает переменные.
Результат
Тип ответа - [WarehouseItem!]!.
Ошибки
UNAUTHENTICATED- сессия не передана или истекла.ACCOUNT_NOT_FOUND- игровой аккаунт или персонаж не найден.VALIDATION- параметры запроса указаны неверно.
Пример обмена
Запрос
documentId: warehouse
{
"documentId": "warehouse",
"variables": {}
}
Ответ
200 OK
{
"data": {
"warehouse": {}
}
}
Связанные типы
Предмет склада по ID
warehouseItem
Описание
Предмет по ID.
Входные данные
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
id | Int | ✓ | ID сущности. |
Результат
Тип ответа - WarehouseItem.
Ошибки
UNAUTHENTICATED- сессия не передана или истекла.ACCOUNT_NOT_FOUND- игровой аккаунт или персонаж не найден.VALIDATION- параметры запроса указаны неверно.
Пример обмена
Запрос
documentId: warehouseItem
{
"documentId": "warehouseItem",
"variables": {
"id": 1
}
}
Ответ
200 OK
{
"data": {
"warehouseItem": {}
}
}
Связанные типы
Выдать несколько предметов
deliverWarehouseItems
Описание
Передать от 1 до 100 разных складских позиций одному персонажу.
Для своего персонажа укажите charName и accountLogin. Для передачи по имени
укажите только charNameOut; все выбранные предметы должны допускать такую передачу.
Входные данные
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
itemIds | [ID!]! | ✓ | От 1 до 100 положительных ID складских позиций без повторов. |
charName | String | Условно | Имя своего персонажа, до 80 символов. Не передавайте вместе с charNameOut. |
charNameOut | String | Условно | Имя другого получателя, до 80 символов. Не передавайте вместе с charName или accountLogin. |
accountLogin | String | Условно | Обязателен вместе с charName, до 80 символов. |
Результат
Тип ответа - PurchaseResult!. Поле message описывает результат,
warehouse содержит оставшиеся ожидающие предметы. При частичной выдаче сообщение
показывает число успешных и неподтверждённых передач. Если результат передачи
не подтверждён, обратитесь в поддержку перед повторной попыткой.
Ошибки
UNAUTHENTICATED- сессия не передана или истекла.VALIDATION- параметры запроса указаны неверно.ITEM_NOT_FOUND- выбранная складская позиция недоступна. Обновите список.NOT_PENDING- предмет уже передан или сейчас недоступен для передачи.TRANSFER_DISABLED- передача со склада отключена.TRANSFER_NOT_ALLOWED- выбранный предмет нельзя передать по имени другого персонажа.CHARACTER_NOT_FOUND- получатель не найден.ACCOUNT_REQUIRED- игровой аккаунт недоступен. Обновите список аккаунтов.ACCOUNT_NOT_OWNED- выберите доступный игровой аккаунт.CHARACTER_NOT_ON_ACCOUNT- персонаж не найден на выбранном аккаунте.LOCK_FAILED- состояние предмета изменилось. Обновите список перед новой попыткой.ALL_DELIVERIES_FAILED- передачу не удалось подтвердить. Обратитесь в поддержку перед повторной попыткой.
Пример обмена
Запрос
documentId: deliverWarehouseItems
{
"documentId": "deliverWarehouseItems",
"variables": {
"itemIds": [
"101",
"102"
],
"charName": "Hero",
"accountLogin": "GameLogin"
}
}
Ответ
200 OK
{
"data": {
"deliverWarehouseItems": {
"message": "2 предмета доставлено на персонажа Hero",
"warehouse": []
}
}
}