Choose your implementation method:
C
C#
This data structure is part of the Ecom Interface.
Remarks
Contains information about a single offer within the catalog. Instances of this structure are created by EOS_Ecom_CopyOfferByIndex. They must be passed to EOS_Ecom_CatalogOffer_Release. Prices are stored in the lowest denomination for the associated currency. If CurrencyCode is "USD" then a price of 299 represents "$2.99".
Properties
EOS_Ecom_CatalogOffer
|
Property |
Value |
|---|---|
|
int32_t ApiVersion |
API Version: Set this to EOS_ECOM_CATALOGOFFER_API_LATEST. |
|
int32_t ServerIndex |
The index of this offer as it exists on the server. This is useful for understanding pagination data. |
|
const char* CatalogNamespace |
Product namespace in which this offer exists |
|
EOS_Ecom_CatalogOfferId Id |
The ID of this offer |
|
const char* TitleText |
Localized UTF-8 title of this offer |
|
const char* DescriptionText |
Localized UTF-8 description of this offer |
|
const char* LongDescriptionText |
Localized UTF-8 long description of this offer |
|
const char* TechnicalDetailsText_DEPRECATED |
Deprecated. EOS_Ecom_CatalogOffer::TechnicalDetailsText has been deprecated. EOS_Ecom_CatalogItem::TechnicalDetailsText is still valid. |
|
const char* CurrencyCode |
The Currency Code for this offer |
|
EOS_EResult PriceResult |
If this value is EOS_Success then OriginalPrice, CurrentPrice, and DiscountPercentage contain valid data. Otherwise this value represents the error that occurred on the price query. |
|
uint32_t OriginalPrice_DEPRECATED |
The original price of this offer as a 32-bit number is deprecated. |
|
uint32_t CurrentPrice_DEPRECATED |
The current price including discounts of this offer as a 32-bit number is deprecated.. |
|
uint8_t DiscountPercentage |
A value from 0 to 100 define the percentage of the OrignalPrice that the CurrentPrice represents |
|
int64_t ExpirationTimestamp |
Contains the POSIX timestamp that the offer expires or -1 if it does not expire |
|
uint32_t PurchasedCount |
The number of times that the requesting account has purchased this offer. |
|
int32_t PurchaseLimit |
The maximum number of times that the offer can be purchased. A negative value implies there is no limit. |
|
EOS_Bool bAvailableForPurchase |
True if the user can purchase this offer. |
|
uint64_t OriginalPrice64 |
The original price of this offer as a 64-bit number. |
|
uint64_t CurrentPrice64 |
The current price including discounts of this offer as a 64-bit number. |
|
uint32_t DecimalPoint |
The decimal point for the provided price. For example, DecimalPoint '2' and CurrentPrice64 '12345' would be '123.45'. |
Related API Members
This data structure is part of the Ecom Interface.
Remarks
Contains information about a single offer within the catalog. Instances of this structure are created by {EcomInterface.CopyOfferByIndex}. They must be passed to {EcomInterface.Release}. Prices are stored in the lowest denomination for the associated currency. If CurrencyCode is "USD" then a price of 299 represents "$2.99".
Properties
Ecom.CatalogOffer
|
Property |
Value |
|---|---|
|
int ApiVersion |
API Version: Set this to EOS_ECOM_CATALOGOFFER_API_LATEST. |
|
int ServerIndex |
The index of this offer as it exists on the server. This is useful for understanding pagination data. |
|
string CatalogNamespace |
Product namespace in which this offer exists |
|
string Id |
The ID of this offer |
|
string TitleText |
Localized UTF-8 title of this offer |
|
string DescriptionText |
Localized UTF-8 description of this offer |
|
string LongDescriptionText |
Localized UTF-8 long description of this offer |
|
string TechnicalDetailsText_DEPRECATED |
Deprecated. EOS_Ecom_CatalogOffer::TechnicalDetailsText has been deprecated. EOS_Ecom_CatalogItem::TechnicalDetailsText is still valid. |
|
string CurrencyCode |
The Currency Code for this offer |
|
Result PriceResult |
If this value is EOS_Success then OriginalPrice, CurrentPrice, and DiscountPercentage contain valid data. Otherwise this value represents the error that occurred on the price query. |
|
uint OriginalPrice_DEPRECATED |
The original price of this offer as a 32-bit number is deprecated. |
|
uint CurrentPrice_DEPRECATED |
The current price including discounts of this offer as a 32-bit number is deprecated.. |
|
byte DiscountPercentage |
A value from 0 to 100 define the percentage of the OrignalPrice that the CurrentPrice represents |
|
long ExpirationTimestamp |
Contains the POSIX timestamp that the offer expires or -1 if it does not expire |
|
uint PurchasedCount |
The number of times that the requesting account has purchased this offer. |
|
int PurchaseLimit |
The maximum number of times that the offer can be purchased. A negative value implies there is no limit. |
|
bool AvailableForPurchase |
True if the user can purchase this offer. |
|
ulong OriginalPrice64 |
The original price of this offer as a 64-bit number. |
|
ulong CurrentPrice64 |
The current price including discounts of this offer as a 64-bit number. |
|
uint DecimalPoint |
The decimal point for the provided price. For example, DecimalPoint '2' and CurrentPrice64 '12345' would be '123.45'. |