Skip to main content

Account data types

Characters and warehouse​

Character​

FieldTypeDescription
idID!Character ID
nameString!Name
levelInt!Level
classIdInt!Class ID
classNameString!Class name
clanNameStringClan name
onlineBoolean!Online state
karmaInt!Karma
pkKillsInt!PK kills
pvpKillsInt!PvP kills
sexInt!Gender
lastAccessDateTimeLast login

CharacterItem​

FieldTypeDescription
idID!Inventory object ID
itemIdInt!Item type ID
nameString!Name
countInt!Quantity
enchantLevelInt!Enchant level
iconStringIcon
augmentationStringAugmentation
attributesJSONAttributes

CharacterOwner​

FieldTypeDescription
accountLoginString!Game account login
characterCharacter!Character

WarehouseItem​

FieldTypeDescription
idID!Record ID
itemIdInt!Item ID
nameString!Name
countInt!Quantity
enchantLevelInt!Enchant level
iconStringIcon
statusInt!Delivery state
giveTypeInt!Delivery method
createdAtDateTime!Creation time
deliveredAtDateTimeDelivery time

PurchaseResult​

FieldTypeDescription
messageStringMessage
itemWarehouseItemDelivered item
balanceFloatUpdated balance
bonusBalanceFloatUpdated bonus balance
warehouse[WarehouseItem!]Updated warehouse

ServiceResult​

FieldTypeDescription
messageStringMessage
balanceFloatUpdated balance
bonusBalanceFloatUpdated bonus balance

Player marketplace​

All marketplace money and quantity values are strings. This preserves DECIMAL(20, 6) and large game-stack precision on every client.

MarketplaceConfiguration​

FieldTypeDescription
enabledBoolean!Marketplace state
gameServerIdInt!Game server
currencyMarketplaceCurrency!Marketplace currency
versionString!Published configuration version
listingPolicyMarketplaceListingPolicy!Global listing rules
paymentSources[MarketplacePaymentSourceDefinition!]!Payment sources
sections[MarketplaceSection!]!Catalog sections
sellerTiers[MarketplaceSellerTier!]!Seller tiers
transfersMarketplaceTransferConfiguration!Main-balance transfers
withdrawalsMarketplaceWithdrawalConfiguration!External withdrawals

MarketplaceListingPolicy​

FieldTypeDescription
sellerFeeBasisPointsInt!Seller fee in basis points
minimumPrice / maximumPriceString! / StringPrice range
maximumAssetsPerListingInt!Assets per listing
maximumActiveListingsInt!Active listing limit
itemModerationRequiredBoolean!Item moderation
characterModerationRequiredBoolean!Character moderation
stackableItemsAllowedBoolean!Stackable items
augmentedItemsAllowedBoolean!Augmented items
attributedItemsAllowedBoolean!Attributed items
sellerTiersEnabledBoolean!Seller tiers

MarketplaceWithdrawalMethod​

FieldTypeDescription
code / nameString!Code and localized name
instructionsStringPlayer instructions
destinationKindString!Destination kind
destinationFields[MarketplaceWithdrawalDestinationField!]!Published form schema
minimumAmount / maximumAmountStringMethod limits
feeBasisPointsIntMethod fee
payoutCurrencyCodeString!Payout currency

MarketplaceWithdrawalDestinationField.type is TEXT, EMAIL, PHONE, or SELECT. The field also publishes required, length limits, a safe pattern, and select options.

MarketplaceCatalogConnection​

FieldTypeDescription
nodes[MarketplaceCatalogOffer!]!Current page
pageInfoMarketplaceCursorPageInfo!Opaque cursors and next-page flag
totalCountInt!All published offers
filteredCountInt!Offers after filters

MarketplaceCatalogOffer​

FieldTypeDescription
id / listingIdID!Offer and listing
sectionMarketplaceCatalogSection!Section
saleModeMarketplaceListingSaleMode!Sale mode
title / descriptionStringSeller text
unitPrice / currencyCodeString!Unit price and currency
availableUnitsString!Available units
minimumPurchaseUnits / maximumPurchaseUnitsString! / StringPurchase limits
assetMarketplaceCatalogAsset!Primary asset
publishedAtDateTime!Publication time

MarketplaceCatalogAsset​

FieldTypeDescription
typeMarketplaceAssetType!ITEM or CHARACTER
itemIdIDGame item ID
nameString!Current parsed catalog name or character name
additionalNameStringCurrent item subtitle
gradeCodeStringCurrent grade
icon / panelIconStringSafe local images
enchantLevelInt!Enchant level
modifiersMarketplaceItemModifiersAugmentation and attributes
characterMarketplaceCharacterSnapshotCharacter state at listing time
characterInventory[MarketplaceCharacterInventoryItem!]Character inventory with current item presentation

If the parsed item catalog entry is absent, the API does not fall back to a stored display_name; it fails the read as a data-integrity error.

MarketplaceListing​

FieldTypeDescription
idID!Public listing ID
sectionMarketplaceListingSection!Section
saleModeMarketplaceListingSaleMode!Sale mode
publicationStateMarketplaceListingPublicationState!Publication lifecycle
moderationStateMarketplaceListingModerationState!Moderation lifecycle
title / descriptionStringSeller text
sellerFeeBasisPointsInt!Captured seller fee
offers[MarketplaceOffer!]!Purchase variants
publishedAtDateTime!Publication time

MarketplaceOffer contains an exact unit price, available units, purchase limits, and [MarketplaceOfferAsset!]! quantities per purchased unit.

MarketplaceViewer​

FieldTypeDescription
gameServerIdInt!Session-selected server
addonActiveBoolean!Project owns an active add-on
configurationPresent / configurationEnabledBoolean!Configuration state
currencyMarketplaceCurrencyCurrency or null without configuration
capabilitiesMarketplaceAccountCapabilities!Server decision for each action
restrictions[MarketplaceRestrictionScope!]!Active restrictions
sellerMarketplaceSellerProfile!Limits, fee, and tier
wallets[MarketplaceWallet!]!Available and reserved balances
statisticsMarketplaceAccountStatistics!Purchases, sales, and turnover

MarketplaceActionCapability contains allowed and reason. Reasons are ADDON_INACTIVE, CONFIGURATION_MISSING, CONFIGURATION_DISABLED, SELL_RESTRICTED, PURCHASE_RESTRICTED, PAYMENT_SOURCES_UNAVAILABLE, WITHDRAWAL_RESTRICTED, ACTIVE_LISTING_LIMIT_REACHED, NO_CANCELLABLE_LISTINGS, MAIN_BALANCE_TRANSFERS_DISABLED, EXTERNAL_WITHDRAWALS_DISABLED, and WITHDRAWAL_METHODS_UNAVAILABLE.

MarketplaceSellerListing​

Seller listings additionally expose:

  • endedReason, moderationNote, and canCancel;
  • exact originalQuantity, reservedQuantity, deliveredQuantity, and returnedQuantity values for every asset;
  • totalUnits, reservedUnits, soldUnits, and availableUnits for offers;
  • publishedAt, suspendedAt, endedAt, createdAt, and updatedAt.

MarketplaceOrder​

FieldTypeDescription
idID!Order
roleMarketplaceOrderRole!Current player's role
outcomeMarketplaceOrderOutcome!Order outcome
grossAmountString!Gross amount
sellerFeeAmountString!Seller fee
sellerNetAmountString!Seller proceeds
paymentMarketplaceOrderPayment!Payment source and lifecycle
lines[MarketplaceOrderLine!]!Assets, delivery, and settlement
completedAt / cancelledAtDateTimeTerminal timestamps

Payment, delivery, and settlement are independent lifecycles. They cannot be derived from one generic status.

MarketplaceWalletEntry​

FieldTypeDescription
typeMarketplaceWalletEntryType!Movement type
sourceTypeMarketplaceWalletEntrySourceType!Operation source
sourceReferenceIDPublic source reference
availableDelta / reservedDeltaString!Balance changes
availableBalanceAfter / reservedBalanceAfterString!Post-entry balance
currencyCodeString!Currency
occurredAtDateTime!Posting time

MarketplaceBalanceTransfer​

FieldTypeDescription
idID!Transfer
stateMarketplaceBalanceTransferState!Lifecycle
amount / currencyCodeString!Amount and currency
completedAt / reversalStartedAt / reversedAtDateTimeTransition times
createdAt / updatedAtDateTime!Record times

MarketplaceWithdrawal​

FieldTypeDescription
idID!Withdrawal
methodMarketplaceWithdrawalMethodSummary!Method
reviewStateMarketplaceWithdrawalReviewState!Review
payoutStateMarketplaceWithdrawalPayoutState!Payout
fundsStateMarketplaceWithdrawalFundsState!Funds
sourceAmount / feeAmount / netSourceAmountString!Source calculation
conversionRate / payoutAmountString!Conversion and payout
sourceCurrencyCode / payoutCurrencyCodeString!Currencies
destinationPreviewString!Masked destination
reviewReasonCode / payoutReferenceStringDecision and payout reference
lifecycle timestampsDateTimeReview, payout, and cancellation

Mutation submissions​

TypePurpose
MarketplaceListingSubmissionrequestId, listing, publication, moderation, and offer IDs
MarketplacePurchaseSubmissionrequestId, order, outcome, payment, and settlement
MarketplaceListingCancellationSubmissionEnded listing and returned quantity
MarketplaceBalanceTransferSubmissionCreated transfer, amount, and state
MarketplaceWithdrawalSubmissionCreated withdrawal and complete payout calculation

Lifecycles​

EnumValues
MarketplaceListingSaleModeBUNDLE, INDIVIDUAL, CHARACTER
MarketplaceListingPublicationStateUNPUBLISHED, PUBLISHED, SUSPENDED, ENDED
MarketplaceListingModerationStateNOT_REQUIRED, PENDING, APPROVED, REJECTED
MarketplaceListingEndReasonSOLD_OUT, WITHDRAWN_BY_SELLER, REJECTED_BY_MODERATOR, REMOVED_BY_ADMIN
MarketplacePaymentSourceMAIN_BALANCE, MARKETPLACE_WALLET
MarketplaceOrderOutcomeOPEN, COMPLETED, CANCELLED
MarketplacePaymentStatePENDING, CAPTURED, REFUNDING, REFUNDED, CANCELLED
MarketplaceDeliveryStatePENDING, DELIVERING, DELIVERED, RETURNING, RETURNED, CANCELLED
MarketplaceSettlementStatePENDING, POSTED, REVERSING, REVERSED, CANCELLED
MarketplaceBalanceTransferStatePROCESSING, COMPLETED, REVERSING, REVERSED
MarketplaceWithdrawalReviewStatePENDING, APPROVED, REJECTED
MarketplaceWithdrawalPayoutStateNOT_STARTED, PROCESSING, PAID, CANCELLED
MarketplaceWithdrawalFundsStateRESERVED, SETTLED, RELEASED, FROZEN