Warehouse

This page documents API operations for this section in a unified operation-card format.

Warehouse items

QuerydocumentId: warehouseauth: Bearer session

warehouse

Description

Warehouse items.

Input

The operation does not accept variables.

Result

Response type - [WarehouseItem!]!.

Errors

• UNAUTHENTICATED - the session is missing or expired.
• ACCOUNT_NOT_FOUND - game account or character was not found.
• VALIDATION - request parameters are invalid.

Exchange example

Request

documentId: warehouse

{
  "documentId": "warehouse",
  "variables": {}
}

Response

200 OK

{
  "data": {
    "warehouse": {}
  }
}

Related types

WarehouseItem

Warehouse item by ID

QuerydocumentId: warehouseItemauth: Bearer session

warehouseItem

Description

Warehouse item by ID.

Input

Field	Type	Required	Description
id	Int	✓	Entity ID.

Result

Response type - WarehouseItem.

Errors

• UNAUTHENTICATED - the session is missing or expired.
• ACCOUNT_NOT_FOUND - game account or character was not found.
• VALIDATION - request parameters are invalid.

Exchange example

Request

documentId: warehouseItem

{
  "documentId": "warehouseItem",
  "variables": {
    "id": 1
  }
}

Response

200 OK

{
  "data": {
    "warehouseItem": {}
  }
}

Related types

WarehouseItem

Deliver multiple items

MutationdocumentId: deliverWarehouseItemsauth: Bearer session

deliverWarehouseItems

Description

Deliver 1 to 100 distinct warehouse entries to one character. For your character, provide charName and accountLogin. To deliver by name, provide only charNameOut; every selected entry must allow this delivery option.

Input

Field	Type	Required	Description
itemIds	[ID!]!	✓	1 to 100 distinct positive warehouse entry IDs.
charName	String	Conditional	Your character's name, up to 80 characters. Do not combine with charNameOut.
charNameOut	String	Conditional	Another recipient's name, up to 80 characters. Do not combine with charName or accountLogin.
accountLogin	String	Conditional	Required with charName, up to 80 characters.

Result

Response type - PurchaseResult!. The message describes the outcome; warehouse contains the remaining pending items. For partial delivery, the message reports successful and unconfirmed entries separately. Contact support before retrying an unconfirmed delivery.

Errors

• UNAUTHENTICATED - the session is missing or expired.
• VALIDATION - request parameters are invalid.
• ITEM_NOT_FOUND - a selected warehouse entry is unavailable. Refresh the list.
• NOT_PENDING - an item has already been delivered or is currently unavailable for delivery.
• TRANSFER_DISABLED - warehouse delivery is disabled.
• TRANSFER_NOT_ALLOWED - a selected item cannot be sent to another character by name.
• CHARACTER_NOT_FOUND - the recipient was not found.
• ACCOUNT_REQUIRED - the game account is unavailable. Refresh the account list.
• ACCOUNT_NOT_OWNED - select an available game account.
• CHARACTER_NOT_ON_ACCOUNT - the character was not found on the selected account.
• LOCK_FAILED - the item state has changed. Refresh the list before another attempt.
• ALL_DELIVERIES_FAILED - delivery could not be confirmed. Contact support before trying again.

Exchange example

Request

documentId: deliverWarehouseItems

{
  "documentId": "deliverWarehouseItems",
  "variables": {
    "itemIds": [
      "101",
      "102"
    ],
    "charName": "Hero",
    "accountLogin": "GameLogin"
  }
}

Response

200 OK

{
  "data": {
    "deliverWarehouseItems": {
      "message": "2 items delivered to character Hero",
      "warehouse": []
    }
  }
}

Related types

PurchaseResult