Skip to content

ecom

Jump to bottom
Francisco Dias edited this page Oct 2, 2024 · 1 revision

Ecom

Epic Online Services Interface: Ecom

The Ecom module gives developers using Epic Online Services the ability to interact with the Epic Games Store. With this interface, you can manage products ranging from full games and downloadable content (DLC) to virtual goods and in-game currency. This includes making offers, completing purchase transactions, verifying ownership, and redeeming purchased items.

Functions

These are the functions of the Ecom module:

Structs

These are the structs in the Ecom module:


Back To Top

EpicGames_Ecom_QueryOwnership

Epic Online Services Function: EOS_Ecom_QueryOwnership

This function queries the ownership status for a given list of catalog item IDs defined with Epic Online Services. This data will be cached for a limited time and retrieved again from the backend when necessary. Depending on the number of catalog item IDs passed, the SDK splits the query into smaller batch requests to the backend and aggregates the result.

Note

If one of the request batches fails, no data is cached and the entire query is marked as failed.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

EpicGames_Ecom_QueryOwnership(user, CatalogItemIds, catalogNamespace)
Argument Type Description
user String The Epic Account ID of the local user whose ownership to query
CatalogItemIds Array The array of Catalog Item IDs to check for ownership
catalogNamespace String Optional product namespace, if not the one specified during initialisation



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String "EpicGames_Ecom_QueryOwnership"
identifier Real The asynchronous listener ID
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String A text representation of the status code
account_id String The Epic Account ID of the local user whose ownership was queried


Back To Top

EpicGames_Ecom_QueryOwnershipBySandboxIds

Epic Online Services Function: EOS_Ecom_QueryOwnershipBySandboxIds

This function queries the ownership status of all catalog item IDs under the given list of Sandbox IDs defined with Epic Online Services. This data will be cached for a limited time and retrieved again from the backend when necessary.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

EpicGames_Ecom_QueryOwnershipBySandboxIds(user, SandboxIds)
Argument Type Description
user String The Epic Account ID of the local user whose ownership to query.
SandboxIds Array The array of Sandbox IDs to check for ownership.



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String "EpicGames_Ecom_QueryOwnershipBySandboxIds"
identifier Real The asynchronous listener ID
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String A text representation of the status code
account_id String The Epic Account ID of the local user whose ownership was queried


Back To Top

EpicGames_Ecom_QueryOwnershipToken

Epic Online Services Function: EOS_Ecom_QueryOwnershipToken

This function queries the ownership status for a given list of catalog item IDs defined with Epic Online Services. The data is returned via the Social Async Event in the form of a signed JWT that should be verified by an external backend server using a public key for authenticity.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

EpicGames_Ecom_QueryOwnershipToken(user, CatalogItemIds)
Argument Type Description
user String The Epic Account ID of the local user whose ownership token you want to query
CatalogItemIds Array The array of Catalog Item IDs to check for ownership, matching in number to the CatalogItemIdCount



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String "EpicGames_Ecom_QueryOwnershipToken"
identifier Real The asynchronous listener ID
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code
account_id String The Epic Account ID of the local user whose ownership token was queried
ownership_token String Ownership token containing details about the catalog items queried


Back To Top

EpicGames_Ecom_QueryEntitlements

Epic Online Services Function: EOS_Ecom_QueryEntitlements

This function queries the entitlement information defined with Epic Online Services.

A set of entitlement names can be provided to filter the set of entitlements associated with the account. This data will be cached for a limited time and retrieved again from the backend when necessary. Depending on the number of entitlements passed, the SDK splits the query into smaller batch requests to the backend and aggregates the result.

Note

If one of the request batches fails, no data is cached and the entire query is marked as failed.

Use EpicGames_Ecom_CopyEntitlementByIndex, EpicGames_Ecom_CopyEntitlementByNameAndIndex, and EpicGames_Ecom_CopyEntitlementById to get the entitlement details. Use EpicGames_Ecom_GetEntitlementsByNameCount to retrieve the number of entitlements with a specific entitlement name.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

EpicGames_Ecom_QueryEntitlements(user, EntitlementNames, bIncludeRedeemed)
Argument Type Description
user String The Epic Account ID of the local user whose entitlements you want to retrieve
EntitlementNames Array An array of entitlement names that you want to check
bIncludeRedeemed Boolean If true, entitlements that have been redeemed will be included in the results



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String "EpicGames_Ecom_QueryEntitlements
identifier Real The asynchronous listener ID
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code
account_id String The Epic Account ID of the local user whose entitlement was queried


Back To Top

EpicGames_Ecom_QueryEntitlementToken

Epic Online Services Function: EOS_Ecom_QueryEntitlementToken

This function queries the entitlement verification status defined with Epic Online Services.

An optional set of entitlement names can be provided to filter the set of entitlements associated with the account. The data is returned via the Social Async Event in the form of a signed JWT that should be verified by an external backend server using a public key for authenticity.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

EpicGames_Ecom_QueryEntitlementToken(user, EntitlementNames)
Argument Type Description
user String The Epic Account ID of the local user whose Entitlements you want to retrieve
EntitlementNames Array An array of Entitlement Names that you want to check



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String "EpicGames_Ecom_QueryEntitlementToken"
identifier Real The asynchronous listener ID
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String A text representation of the status code
account_id String The Epic Account ID of the local user whose entitlement was queried
entitlement_token String Entitlements token containing details about the catalog items queried


Back To Top

EpicGames_Ecom_QueryOffers

Epic Online Services Function: EOS_Ecom_QueryOffers

This function queries for a list of catalog offers defined with Epic Online Services. This data will be cached for a limited time and retrieved again from the backend when necessary.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

EpicGames_Ecom_QueryOffers(user, OverrideCatalogNamespace)
Argument Type Description
user String The Epic Account ID of the local user whose offer to query
OverrideCatalogNamespace String If not provided then the SandboxId is used as the catalog namespace



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String "EpicGames_Ecom_QueryOffers"
identifier Real The asynchronous listener ID
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code
account_id String The Epic Account ID of the local user whose offer was queried; needed for localisation of Catalog Item (Item) description text and pricing information


Back To Top

EpicGames_Ecom_Checkout

Epic Online Services Function: EOS_Ecom_Checkout

This function initiates the purchase flow for a set of offers. The Social Async Event is triggered after the purchase flow.

On success, the set of entitlements that were unlocked will be cached. On success, a Transaction ID will be returned. The Transaction ID can be used with the EpicGames_Ecom_Transaction_* functions to retrieve the entitlements rewarded by the purchase.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

EpicGames_Ecom_Checkout(user, Entries, OverrideCatalogNamespace)
Argument Type Description
user String The Epic Account ID of the local user who is making the purchase
Entries Array of String An array of strings, each containing the details of a single offer
OverrideCatalogNamespace String The catalog namespace will be the current Sandbox ID, unless overridden by this field



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String "EpicGames_Ecom_Checkout"
identifier Real The asynchronous listener ID
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String A text representation of the status code
account_id String The Epic Account ID of the user who initiated the purchase
transaction_id String The transaction ID
offer_ids Array of String An array of offer IDs


Back To Top

EpicGames_Ecom_RedeemEntitlements

Epic Online Services Function: EOS_Ecom_RedeemEntitlements

This function requests that the provided entitlement be marked redeemed. This will cause that entitlement to no longer be returned from EpicGames_Ecom_QueryEntitlements unless the bIncludeRedeemed request flag is set to true.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.


Syntax:

EpicGames_Ecom_RedeemEntitlements(user, EntitlementIds)
Argument Type Description
user String The Epic Account ID of the user who is redeeming Entitlements
EntitlementIds Array The array of Entitlements to redeem



Returns:

N/A


Triggers:

Social Async Event

Key Type Description
type String "EpicGames_Ecom_RedeemEntitlements"
identifier Real The asynchronous listener ID
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code
account_id String The Epic Account ID of the user who has redeemed entitlements
redeemed_entitlement_ids_count Real The number of redeemed entitlements


Back To Top

EpicGames_Ecom_GetLastRedeemedEntitlementsCount

Epic Online Services Function: EOS_Ecom_GetLastRedeemedEntitlementsCount

This function returns the number of entitlements that were redeemed during the last EpicGames_Ecom_RedeemEntitlements call.


Syntax:

EpicGames_Ecom_GetLastRedeemedEntitlementsCount(user)
Argument Type Description
user String The Epic Account ID of the local user for who to retrieve the last redeemed entitlements count



Returns:

Real



Back To Top

EpicGames_Ecom_CopyLastRedeemedEntitlementByIndex

Epic Online Services Function: EOS_Ecom_CopyLastRedeemedEntitlementByIndex

This function fetches a redeemed entitlement ID from a given index. Only entitlements that were redeemed during the last EpicGames_Ecom_RedeemEntitlements call can be copied.


Syntax:

EpicGames_Ecom_CopyLastRedeemedEntitlementByIndex(user, RedeemedEntitlementIndex)
Argument Type Description
user String The Epic Account ID of the local user whose last redeemed entitlement ID is being copied
RedeemedEntitlementIndex Real Index of the last redeemed entitlement ID to retrieve from the cache



Returns:

String



Back To Top

EpicGames_Ecom_GetEntitlementsCount

Epic Online Services Function: EOS_Ecom_GetEntitlementsCount

This function returns the number of entitlements that are cached for a given local user.


Syntax:

EpicGames_Ecom_GetEntitlementsCount(user)
Argument Type Description
user String The Epic Account ID of the local user for which to retrieve the entitlement count



Returns:

Real



Back To Top

EpicGames_Ecom_GetEntitlementsByNameCount

Epic Online Services Function: EOS_Ecom_GetEntitlementsByNameCount

This function returns the number of entitlements with the given entitlement name that are cached for a given local user.


Syntax:

EpicGames_Ecom_GetEntitlementsByNameCount(user, entitlementName)
Argument Type Description
user String The Epic Account ID of the local user for which to retrieve the entitlement count
entitlementName String Name of the entitlement to count in the cache



Returns:

Real



Back To Top

EpicGames_Ecom_CopyEntitlementByIndex

Epic Online Services Function: EOS_Ecom_CopyEntitlementByIndex

This function fetches an entitlement from a given index.


Syntax:

EpicGames_Ecom_CopyEntitlementByIndex(user, index)
Argument Type Description
user String The Epic Account ID of the local user whose entitlement is being copied
index Real Index of the entitlement to retrieve from the cache



Returns:

Entitlement



Back To Top

EpicGames_Ecom_CopyEntitlementByNameAndIndex

Epic Online Services Function: EOS_Ecom_CopyEntitlementByIndex

This function fetches a single entitlement with a given Entitlement Name. The Index is used to access individual entitlements among those with the same Entitlement Name. The Index can be a value from 0 to one less than the result from EpicGames_Ecom_GetEntitlementsByNameCount.


Syntax:

EpicGames_Ecom_CopyEntitlementByNameAndIndex(user, EntitlementName, Index)
Argument Type Description
user String The Epic Account ID of the local user whose entitlement is being copied
EntitlementName String Name of the entitlement to retrieve from the cache
Index Real Index of the entitlement within the named set to retrieve from the cache



Returns:

Entitlement



Back To Top

EpicGames_Ecom_CopyEntitlementById

Epic Online Services Function: EOS_Ecom_CopyEntitlementById

This function fetches the entitlement with the given ID.


Syntax:

EpicGames_Ecom_CopyEntitlementById(user, EntitlementName)
Argument Type Description
user String The Epic Account ID of the local user whose entitlement is being copied
EntitlementName String ID of the entitlement to retrieve from the cache



Returns:

Entitlement



Back To Top

EpicGames_Ecom_GetOfferCount

Epic Online Services Function: EOS_Ecom_GetOfferCount

This function returns the number of offers that are cached for a given local user.


Syntax:

EpicGames_Ecom_GetOfferCount(user)
Argument Type Description
user String The Epic Account ID of the local user whose offers are being accessed



Returns:

Real



Back To Top

EpicGames_Ecom_CopyOfferByIndex

Epic Online Services Function: EOS_Ecom_CopyOfferByIndex

This function fetches an offer from a given index. The pricing and text are localised to the provided account.


Syntax:

EpicGames_Ecom_CopyOfferByIndex(user, OfferIndex)
Argument Type Description
user String The Epic Account ID of the local user whose offer is being copied
OfferIndex Real The index of the offer to get.



Returns:

CatalogOffer



Back To Top

EpicGames_Ecom_CopyOfferById

Epic Online Services Function: EOS_Ecom_CopyOfferById

This function fetches an offer with a given ID. The pricing and text are localised to the provided account.


Syntax:

EpicGames_Ecom_CopyOfferById(user, OfferId)
Argument Type Description
user String The Epic Account ID of the local user whose offer is being copied
OfferId String The ID of the offer to get.



Returns:

CatalogOffer



Back To Top

EpicGames_Ecom_GetOfferItemCount

Epic Online Services Function: EOS_Ecom_GetOfferItemCount

This function fetches the number of items that are associated with a given cached offer for a local user.


Syntax:

EpicGames_Ecom_GetOfferItemCount(user, OfferId)
Argument Type Description
user String The Epic Account ID of the local user who made the initial request for the Catalog Offer through EpicGames_Ecom_QueryOffers
OfferId String An ID that corresponds to a cached Catalog Offer (retrieved by EpicGames_Ecom_CopyOfferByIndex)



Returns:

Real



Back To Top

EpicGames_Ecom_CopyOfferItemByIndex

Epic Online Services Function: EOS_Ecom_CopyOfferItemByIndex

This function fetches an item from a given index.


Syntax:

EpicGames_Ecom_CopyOfferItemByIndex(user, OfferId, ItemIndex)
Argument Type Description
user String The Epic Account ID of the local user whose item is being copied
OfferId String The ID of the offer to get the items for.
ItemIndex Real The index of the item to get



Returns:

CatalogItem



Back To Top

EpicGames_Ecom_CopyItemById

Epic Online Services Function: EOS_Ecom_CopyItemById

This function fetches an item with a given ID.


Syntax:

EpicGames_Ecom_CopyItemById(user, ItemId)
Argument Type Description
user String The Epic Account ID of the local user whose item is being copied
ItemId String The ID of the item to get



Returns:

CatalogItem



Back To Top

EpicGames_Ecom_GetOfferImageInfoCount

Epic Online Services Function: EOS_Ecom_GetOfferImageInfoCount

This function returns the number of images that are associated with a given cached offer for a local user.


Syntax:

EpicGames_Ecom_GetOfferImageInfoCount(user, OfferId)
Argument Type Description
user String The Epic Account ID of the local user whose offer image is being accessed.
OfferId String The ID of the offer to get the images for.



Returns:

Real



Back To Top

EpicGames_Ecom_CopyOfferImageInfoByIndex

Epic Online Services Function: EOS_Ecom_CopyOfferByIndex

This function fetches an image from a given index.


Syntax:

EpicGames_Ecom_CopyOfferImageInfoByIndex(user, OfferId, ImageInfoIndex)
Argument Type Description
user String The Epic Account ID of the local user whose offer image is being copied.
OfferId String The ID of the offer to get the images for.
ImageInfoIndex Real The index of the image to get.



Returns:

KeyImageInfo



Back To Top

EpicGames_Ecom_GetItemImageInfoCount

Epic Online Services Function: EOS_Ecom_GetItemImageInfoCount

This function returns the number of images that are associated with a given cached item for a local user.


Syntax:

EpicGames_Ecom_GetItemImageInfoCount(user, ItemId)
Argument Type Description
user String The Epic Account ID of the local user whose item image is being accessed
ItemId String The ID of the item to get the images for.



Returns:

Real



Back To Top

EpicGames_Ecom_CopyItemImageInfoByIndex

Epic Online Services Function: EOS_Ecom_CopyItemImageInfoByIndex

This function fetches an image from a given index.


Syntax:

EpicGames_Ecom_CopyItemImageInfoByIndex(user, ItemId, ImageInfoIndex)
Argument Type Description
user String The Epic Account ID of the local user whose item image is being copied
ItemId String The ID of the item to get the images for
ImageInfoIndex Real The index of the image to get



Returns:

KeyImageInfo



Back To Top

EpicGames_Ecom_GetItemReleaseCount

Epic Online Services Function: EOS_Ecom_GetItemReleaseCount

This function returns the number of releases that are associated with a given cached item for a local user.


Syntax:

EpicGames_Ecom_GetItemReleaseCount(user, ItemId)
Argument Type Description
user String The Epic Account ID of the local user whose item release is being accessed
ItemId String The ID of the item to get the releases for



Returns:

Real



Back To Top

EpicGames_Ecom_CopyItemReleaseByIndex

Epic Online Services Function: EOS_Ecom_CopyItemReleaseByIndex

This function fetches a release from a given index.


Syntax:

EpicGames_Ecom_CopyItemReleaseByIndex(user, ItemId, ReleaseIndex)
Argument Type Description
user String The Epic Account ID of the local user whose item release is being copied
ItemId String The ID of the item to get the releases for
ReleaseIndex Real The index of the release to get



Returns:

CatalogRelease



Back To Top

EpicGames_Ecom_GetTransactionCount

Epic Online Services Function: EOS_Ecom_GetTransactionCount

This function returns the number of transactions that are cached for a given local user.


Syntax:

EpicGames_Ecom_GetTransactionCount(user)
Argument Type Description
user String The Epic Account ID of the local user whose transaction count to get



Returns:

Real



Back To Top

EpicGames_Ecom_Transaction_GetTransactionIdByIndexTransaction

Epic Online Services Function: EOS_Ecom_Transaction_GetTransactionId

This function gets the ID of the transaction with the given index.


Syntax:

EpicGames_Ecom_Transaction_GetTransactionIdByIndexTransaction(user, index)
Argument Type Description
user String The Epic Account ID of the local user who is associated with the transaction
index Real The index of the transaction to get



Returns:

String



Back To Top

EpicGames_Ecom_Transaction_GetEntitlementsCountByIndexTransaction

Epic Online Services Function: EOS_Ecom_Transaction_GetEntitlementsCount

This function returns the number of entitlements that are part of this transaction.


Syntax:

EpicGames_Ecom_Transaction_GetEntitlementsCountByIndexTransaction(user, index)
Argument Type Description
user String The Epic Account ID of the local user who is associated with the transaction
index Real The index of the transaction to get



Returns:

Real



Back To Top

EpicGames_Ecom_Transaction_GetEntitlementsCountByIdTransaction

Epic Online Services Function: EOS_Ecom_Transaction_GetEntitlementsCount

This function returns the number of entitlements that are part of this transaction.


Syntax:

EpicGames_Ecom_Transaction_GetEntitlementsCountByIdTransaction(user, TransactionId)
Argument Type Description
user String The Epic Account ID of the local user who is associated with the transaction
TransactionId String The ID of the transaction to get



Returns:

Real



Back To Top

EpicGames_Ecom_Transaction_CopyEntitlementByIndexByIndexTransaction

Epic Online Services Function: EOS_Ecom_CopyEntitlementByIndex

This function fetches an entitlement from a given index.


Syntax:

EpicGames_Ecom_Transaction_CopyEntitlementByIndexByIndexTransaction(user, TransactionIndex, EntitlementIndex)
Argument Type Description
user String The Epic Account ID of the local user who is associated with the transaction
TransactionIndex Real The index of the transaction to get
EntitlementIndex Real The index of the entitlement to get



Returns:

Entitlement



Back To Top

EpicGames_Ecom_Transaction_CopyEntitlementByIndexByIdTransaction

Epic Online Services Function: EOS_Ecom_CopyEntitlementById

This function fetches an entitlement from a given index.


Syntax:

EpicGames_Ecom_Transaction_CopyEntitlementByIndexByIdTransaction(user, TransactionId, EntitlementIndex)
Argument Type Description
user String The Epic Account ID of the local user who is associated with the transaction
TransactionId String The ID of the transaction to get
EntitlementIndex Real The index of the entitlement to get



Returns:

Entitlement



Back To Top

Entitlement

Epic Online Services Struct: EOS_Ecom_Entitlement

This struct contains information about a single entitlement associated with an account.

Note

status and status_message will always be present in the struct, all other variables are only present on success (i.e. when status equals EpicGames_Success).

This struct is referenced by the following functions:


Member Type Description
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code
Redeemed Boolean If true then the catalog has this entitlement marked as redeemed
CatalogItemId String ID of the item associated with the offer which granted this entitlement
EndTimestamp Int64 If not -1 then this is a POSIX timestamp that this entitlement will end
EntitlementId String ID of the entitlement owned by an account
EntitlementName String Name of the entitlement
ServerIndex Real If queried using pagination then ServerIndex represents the index of the entitlement as it exists on the server. If not queried using pagination then ServerIndex will be -1.

Back To Top

CatalogOffer

Epic Online Services Struct: EOS_Ecom_CatalogOffer

This struct contains information about a single offer within the catalog.

Prices are stored in the lowest denomination for the associated currency. If CurrencyCode is "USD" then a price of 299 represents "$2.99".

Note

status and status_message will always be present in the struct, all other variables are only present on success (i.e. when status equals EpicGames_Success).

This struct is referenced by the following functions:


Member Type Description
status EpicGames_Result The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code
bAvailableForPurchase Boolean True if the user can purchase this offer.
CatalogNamespace String Product namespace in which this offer exists
CurrencyCode String The Currency Code for this offer
CurrentPrice64 Int64 The current price including discounts of this offer as a 64-bit number.
DecimalPoint Real The decimal point for the provided price. For example, DecimalPoint '2' and CurrentPrice64 '12345' would be '123.45'.
DescriptionText String Localised UTF-8 description of this offer
DiscountPercentage Real A value from 0 to 100 define the percentage of the OrignalPrice that the CurrentPrice represents
EffectiveDateTimestamp Int64 Timestamp indicating the effective date of the offer. Can be ignored if set to -1.
Id Real The ID of this offer
LongDescriptionText String Localised UTF-8 long description of this offer
OriginalPrice64 Int64 The original price of this offer as a 64-bit number
PriceResult EpicGames_Result If this value is EpicGames_Success then OriginalPrice64, CurrentPrice64, and DiscountPercentage contain valid data. Otherwise, this value represents the error that occurred on the price query.
PurchaseLimit Real The maximum number of times that the offer can be purchased. A negative value implies there is no limit.
ReleaseDateTimestamp Int64 Timestamp indicating when the time when the offer was released. Can be ignored if set to -1.
ServerIndex Real The index of this offer as it exists on the server. This is useful for understanding pagination data.
TitleText String Localised UTF-8 title of this offer

Back To Top

CatalogItem

Epic Online Services Struct: EOS_Ecom_CatalogItem

This struct contains information about a single item within the catalog.

Note

status and status_message will always be present in the struct, all other variables are only present on success (i.e. when status equals EpicGames_Success).

This struct is referenced by the following functions:


Member Type Description
status Real The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code
bAvailableForPurchase Boolean
CatalogNamespace String Product namespace in which this item exists
DescriptionText String Localised UTF-8 description of this item
DeveloperText String Localised UTF-8 developer of this item
EntitlementEndTimestamp Int64 If not -1 then this is the POSIX timestamp that the entitlement will end
EntitlementName String The entitlement name associated with this item
Id Real The ID of this item
ItemType Real The type of item as defined in the catalog
LongDescriptionText String Localised UTF-8 long description of this item
TechnicalDetailsText String Localised UTF-8 technical details of this item
TitleText String Localised UTF-8 title of this item

Back To Top

KeyImageInfo

Epic Online Services Struct: EOS_Ecom_KeyImageInfo

This struct contains information about a key image used by the catalog.

A Key Image is defined within Dev Portal and is associated with a Catalog Item. It is intended to be used to provide imagery for an in-game store.

Note

status and status_message will always be present in the struct, all other variables are only present on success (i.e. when status equals EpicGames_Success).

This struct is referenced by the following functions:


Member Type Description
status Real The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code
Height Real The expected height in pixels of the image
Width Real The expected width in pixels of the image
Type String Describes the usage of the image (ex home_thumbnail)
Url String The URL of the image

Back To Top

CatalogRelease

Epic Online Services Function: EOS_Ecom_CatalogRelease

This struct contains information about a single release within the catalog.

Note

status and status_message will always be present in the struct, all other variables are only present on success (i.e. when status equals EpicGames_Success).

This struct is referenced by the following functions:


Member Type Description
status Real The status code for the operation. EpicGames_Success indicates that the operation succeeded; other codes indicate errors
status_message String Text representation of the status code
CompatibleAppIds Array of String An array of compatible App IDs
CompatiblePlatforms Array of String An array of compatible platforms
ReleaseNote String Release note for compatible versions

YoYoGames 2024

Clone this wiki locally