EOS_Ecom_CatalogOffer

EOS API reference page for EOS_Ecom_CatalogOffer

4 mins to read

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

PropertyValue
int32_t ApiVersionAPI Version: Set this to EOS_ECOM_CATALOGOFFER_API_LATEST.
int32_t ServerIndexThe index of this offer as it exists on the server. This is useful for understanding pagination data.
const char* CatalogNamespaceProduct namespace in which this offer exists
EOS_Ecom_CatalogOfferId IdThe ID of this offer
const char* TitleTextLocalized UTF-8 title of this offer
const char* DescriptionTextLocalized UTF-8 description of this offer
const char* LongDescriptionTextLocalized UTF-8 long description of this offer
const char* TechnicalDetailsText_DEPRECATEDDeprecated. EOS_Ecom_CatalogItem::TechnicalDetailsText is still valid.
const char* CurrencyCodeThe Currency Code for this offer
EOS_EResult PriceResultIf 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_DEPRECATEDThe original price of this offer as a 32-bit number is deprecated.
uint32_t CurrentPrice_DEPRECATEDThe current price including discounts of this offer as a 32-bit number is deprecated..
uint8_t DiscountPercentageA value from 0 to 100 define the percentage of the OrignalPrice that the CurrentPrice represents
int64_t ExpirationTimestampContains the POSIX timestamp that the offer expires or -1 if it does not expire
uint32_t PurchasedCount_DEPRECATEDThe number of times that the requesting account has purchased this offer. This value is deprecated and the backend no longer returns this value.
int32_t PurchaseLimitThe maximum number of times that the offer can be purchased. A negative value implies there is no limit.
EOS_Bool bAvailableForPurchaseTrue if the user can purchase this offer.
uint64_t OriginalPrice64The original price of this offer as a 64-bit number.
uint64_t CurrentPrice64The current price including discounts of this offer as a 64-bit number.
uint32_t DecimalPointThe decimal point for the provided price. For example, DecimalPoint '2' and CurrentPrice64 '12345' would be '123.45'.
int64_t ReleaseDateTimestampTimestamp indicating when the time when the offer was released. Can be ignored if set to -1.
int64_t EffectiveDateTimestampTimestamp indicating the effective date of the offer. Can be ignored if set to -1.