Overview
Returns a leaderboard of store items ranked by creation timestamp.
Client
Require permission rules storeInventory.getCreateLeaderboard.selfEnable. See PermissionRules
HTTP
POST /api/rJson/storeInventory/client/getCreateLeaderboard
Request Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Auth-Token | string | true | A token used to authenticate the user. It is issued after successful login from the client type authenticate (e.g., loginByAccount, loginWithCustomId, etc.) or when an admin logs in via the GearN Dashboard. This token identifies the request sender and determines their access level. |
| Secret-Key | string | true | The SecretKey in SecretInfo with role must is Player. |
| Game-Id | string | Optional if the gameId in the SecretInfo use in headers Secret-Key has assign a valid value, if not, let unique identifier of the game this request is targeting. | |
| Content-Type | string | true | application/json |
Request Body
| Code | Type | Required | Description |
|---|---|---|---|
| infoRequestParam | InfoRequestParam | true | Optional flags that determine which additional metadata to include in the response. See InfoRequestParam |
| skip | number int | The number of items to skip when paginating results. (from 0) (Default: 0) | |
| limit | number int | The maximum number of results to return per request. (from 1 to 100) (Default: 10) | |
| loadFromCache | boolean | Indicates whether cached results are acceptable for this operation. (Default: true) |
Server
Require permission rules storeInventory.getCreateLeaderboard.serverSelfEnable. See PermissionRules
HTTP
POST /api/rJson/storeInventory/server/getCreateLeaderboard
Request Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Secret-Key | string | true | The SecretKey in SecretInfo with role must is Admin. |
| Game-Id | string | Optional if the gameId in the SecretInfo use in headers Secret-Key has assign a valid value, if not, let unique identifier of the game this request is targeting. | |
| Content-Type | string | true | application/json |
Request Body
| Code | Type | Required | Description |
|---|---|---|---|
| infoRequestParam | InfoRequestParam | true | Optional flags that determine which additional metadata to include in the response. See InfoRequestParam |
| skip | number int | The number of items to skip when paginating results. (from 0) (Default: 0) | |
| limit | number int | The maximum number of results to return per request. (from 1 to 100) (Default: 10) | |
| loadFromCache | boolean | Indicates whether cached results are acceptable for this operation. (Default: true) |
Admin
Require permission rules storeInventory.getCreateLeaderboard.adminSelfEnable. See PermissionRules
HTTP
POST /api/rJson/storeInventory/admin/getCreateLeaderboard
Request Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Secret-Key | string | true | The SecretKey in SecretInfo with role must is Admin. |
| Game-Id | string | Optional if the gameId in the SecretInfo use in headers Secret-Key has assign a valid value, if not, let unique identifier of the game this request is targeting. | |
| Content-Type | string | true | application/json |
Request Body
| Code | Type | Required | Description |
|---|---|---|---|
| infoRequestParam | InfoRequestParam | true | Optional flags that determine which additional metadata to include in the response. See InfoRequestParam |
| skip | number int | The number of items to skip when paginating results. (from 0) (Default: 0) | |
| limit | number int | The maximum number of results to return per request. (from 1 to 100) (Default: 10) | |
| loadFromCache | boolean | Indicates whether cached results are acceptable for this operation. (Default: true) |
Response Body
200 Ok
| Code | Type | Required | Description |
|---|---|---|---|
| returnCode | ReturnCode | true | Additional metadata that can be attached to any request. Especially useful when working with advanced features such as EventCallbackScript. See ReturnCode |
| debugMessage | string | A developer-oriented message that provides additional context useful for debugging and internal logging. This field is not intended for end-users and may include stack traces, validation failures, or internal error diagnostics. | |
| invalidRequestParameters | InvalidMember[] | Just had data when the returnCode is InvalidRequestParameters.A list of members that failed validation or could not be processed during the request. Each entry typically includes identifying information and an error reason. This is useful for partial success scenarios where some members are accepted and others are rejected. See InvalidMember | |
| parameters | ResponseData | Just had data when the returnCode is Ok. A dynamic set of key-value pairs included in the response to provide additional context or metadata. These parameters may vary depending on the operation and typically contain optional fields such as timestamps, identifiers, or computed values relevant to the result. See ResponseData |
ReturnCode
| Name | Code | Description |
|---|---|---|
| SecretInvalid | -10 | The selected secret key is missing, wrong, or does not match the current route/game context. |
| MaxSizeRequestReject | -9 | The serialized request payload exceeded the maximum size accepted by the backend. |
| MaxRequestReject | -8 | The backend rejected the request because the current caller exceeded a request-rate limit. |
| MaxCCUReject | -7 | The backend rejected the request because the current concurrent-user/session limit was exceeded. |
| OperationNotAuthorized | -6 | The target operation exists, but the caller is not authorized for the selected role or target resource. |
| InvalidRequestParameters | -5 | The request shape or one or more request-member values are invalid. When available, inspect `invalidMembers` for field-level details. |
| OperationInvalid | -4 | The requested operation code is unknown or is not valid for the selected request type/role. |
| InternalServerError | -3 | The backend hit an unhandled internal failure before producing a valid business response. |
| OperationNotAllow | -2 | The operation is known and the secret key is valid, but the permission rules attached to the current secret key do not allow this operation in the current target context. This usually maps to missing `selfEnable`, `otherSelfEnable`, `serverSelfEnable`, or `adminSelfEnable` permission for the resolved request. |
| OperationTimeout | -1 | The request timed out before a response was received. This code may be synthesized by the SDK timeout layer as well as returned by the backend. |
| UnknownError | 0 | The request failed, but no more specific low-level return code was mapped. |
| Ok | 1 | The request completed successfully at protocol level and produced a response payload. Callers must still validate the business `errorCode` in that payload. |
ResponseData
| Code | Type | Required | Description |
|---|---|---|---|
| errorCode | ErrorCode | A string that represents the status of the operation. It indicates whether the request was successful or failed due to a specific error condition. See ErrorCode | |
| results | StoreInventoryLeaderboardResponseData[] | true | Results field in GetCreateLeaderboardResponseData. See StoreInventoryLeaderboardResponseData |
InfoRequestParam
Flags specifying optional fields to include in store responses.
| Code | Type | Required | Description |
|---|---|---|---|
| storeItems | boolean | StoreItems field in InfoRequestParam. (Default: false) | |
| storeItemType | boolean | StoreItemType field in InfoRequestParam. (Default: false) | |
| storeCurrencies | boolean | StoreCurrencies field in InfoRequestParam. (Default: false) | |
| priceCurrencies | boolean | PriceCurrencies field in InfoRequestParam. (Default: false) | |
| inAppPurchase | boolean | InAppPurchase field in InfoRequestParam. (Default: false) | |
| removeStatus | boolean | RemoveStatus field in InfoRequestParam. (Default: false) | |
| displayName | boolean | Display name shown to users for this store item. (Default: false) | |
| avatar | boolean | Visual image or icon associated with the store item. (Default: false) | |
| tsCreate | boolean | TsCreate field in InfoRequestParam. (Default: false) | |
| tags | boolean | Tags field in InfoRequestParam. (Default: false) | |
| storeDatas | boolean | StoreDatas field in InfoRequestParam. (Default: false) |
StoreInventoryLeaderboardResponseData
Leaderboard entry related to store item activity.
| Code | Type | Required | Description |
|---|---|---|---|
| position | number | true | Position field in StoreInventoryLeaderboardResponseData. |
| storeId | string | true | Unique identifier assigned to the store item. |
| infoResponseParameters | InfoResponseParameters | true | InfoResponseParameters field in StoreInventoryLeaderboardResponseData. See InfoResponseParameters |
InfoResponseParameters
Optional fields included in store item responses.
| Code | Type | Required | Description |
|---|---|---|---|
| storeItems | StoreInventoryItem[] | StoreItems field in InfoResponseParameters. See StoreInventoryItem | |
| storeItemType | number | StoreItemType field in InfoResponseParameters. | |
| storeCurrencies | PriceCurrencyItem[] | StoreCurrencies field in InfoResponseParameters. See PriceCurrencyItem | |
| priceCurrencies | PriceCurrencyItem[] | PriceCurrencies field in InfoResponseParameters. See PriceCurrencyItem | |
| inAppPurchase | InAppPurchaseItem | InAppPurchase field in InfoResponseParameters. See InAppPurchaseItem | |
| removeStatus | GenericModels.RemoveStatusItem | RemoveStatus field in InfoResponseParameters. See GenericModels.RemoveStatusItem | |
| displayName | string | Display name shown to users for this store item. | |
| avatar | GenericModels.AvatarItem | Visual image or icon associated with the store item. See GenericModels.AvatarItem | |
| tsCreate | number | TsCreate field in InfoResponseParameters. | |
| tags | GenericModels.TagItem[] | Tags field in InfoResponseParameters. See GenericModels.TagItem | |
| storeDatas | GenericModels.DataItem[] | StoreDatas field in InfoResponseParameters. See GenericModels.DataItem |
StoreInventoryItem
Metadata and state information for a single store item.
| Code | Type | Required | Description |
|---|---|---|---|
| catalogId | string | true | CatalogId field in StoreInventoryItem. |
| classId | string | true | ClassId field in StoreInventoryItem. |
| amount | number | true | The quantity or count related to the item operation. |
PriceCurrencyItem
Details a price definition using a virtual currency.
| Code | Type | Required | Description |
|---|---|---|---|
| key | string | true | Key field in PriceCurrencyItem. |
| value | number | true | Value field in PriceCurrencyItem. |
InAppPurchaseItem
Describes an individual in-app purchase item configuration.
| Code | Type | Required | Description |
|---|---|---|---|
| facebookStoreId | string | true | FacebookStoreId field in InAppPurchaseItem. |
| appleAppStoreId | string | true | AppleAppStoreId field in InAppPurchaseItem. |
| googlePlayStoreId | string | true | GooglePlayStoreId field in InAppPurchaseItem. |
| analyticsPrice | number | true | AnalyticsPrice field in InAppPurchaseItem. |
Generic.RemoveStatusItem
Represents soft-remove metadata for an entity.
| Code | Type | Required | Description |
|---|---|---|---|
| tsRemove | number | true | Removal timestamp when the entity was soft-removed. |
| reason | string | Removal reason when the backend provides one. |
Generic.AvatarItem
Represents a generic avatar payload.
| Code | Type | Required | Description |
|---|---|---|---|
| type | number | true | Backend-defined avatar type identifier. The public SDK currently does not export a dedicated avatar enum. |
| value | string | true | Avatar value, typically a URL, file id, or provider-specific string. |
Generic.TagItem
Represents a key-value tag entry.
| Code | Type | Required | Description |
|---|---|---|---|
| key | string | true | Tag key used to identify the metadata entry. |
| value | string | true | Tag value associated with `key`. |
Generic.DataItem
Represents an arbitrary key-value data entry.
| Code | Type | Required | Description |
|---|---|---|---|
| key | string | true | Data entry key used to identify the payload. |
| value | any | true | Raw value returned by the backend. This may be a primitive, `GNHashtable`, `GNArray`, or plain object-like data. |
ErrorCode
| Name | Code | Description |
|---|---|---|
| Ok | 1 | The business operation completed successfully. |
InvalidMember
| Code | Type | Description |
|---|---|---|
| code | string | The parameterCode invalid. |
| invalidMemberType | InvalidMemberType | The invalid member type of this parameterCode. See InvalidMemberType |
InvalidMemberType
| Name | Code | Description |
|---|---|---|
| UnknownError | 1 | The backend rejected the member but did not map it to a more specific validation category. |
| DataRequired | 2 | The member is required but missing. |
| TypeInvalid | 3 | The member type does not match the expected runtime type. |
| StringNull | 4 | A required string member is null or empty when null is not allowed. |
| StringMinLength | 5 | A string member is shorter than the configured minimum length. |
| StringMaxLength | 6 | A string member is longer than the configured maximum length. |
| NumberMinValue | 7 | A numeric member is lower than the configured minimum value. |
| NumberMaxValue | 8 | A numeric member is higher than the configured maximum value. |
| NumberMustInt | 9 | A numeric member must be an integer but received a non-integer value. |
| GNHashtableNull | 10 | A required `GNHashtable` member is null. |
| GNHashtableMinLength | 11 | A `GNHashtable` member contains fewer entries than allowed. |
| GNHashtableMaxLength | 12 | A `GNHashtable` member contains more entries than allowed. |
| GNArrayNull | 13 | A required `GNArray` member is null. |
| GNArrayMinLength | 14 | A `GNArray` member contains fewer items than allowed. |
| GNArrayMaxLength | 15 | A `GNArray` member contains more items than allowed. |