PurchaseOptionSummary
Summary information about a purchase option (offer or offer set) available to the buyer, including the seller, badges, and associated products.
Contents
Note
In the following list, the required parameters are described first.
- associatedEntities
-
The products, offers, and offer sets associated with this purchase option.
Type: Array of PurchaseOptionAssociatedEntity objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: Yes
- catalog
-
The name of the catalog that the purchase option belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\w\-]+Required: Yes
- purchaseOptionId
-
The unique identifier of the purchase option.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.*Required: Yes
- purchaseOptionType
-
The type of purchase option. Values are
OFFERfor a single-product offer orOFFERSETfor a bundled offer set.Type: String
Valid Values:
OFFER | OFFERSETRequired: Yes
- sellerOfRecord
-
The entity responsible for selling the product under this purchase option.
Type: SellerInformation object
Required: Yes
- availableFromTime
-
The date and time when the purchase option became available to the buyer.
Type: Timestamp
Required: No
- badges
-
Badges indicating special attributes of the purchase option, such as private pricing or future dated.
Type: Array of PurchaseOptionBadge objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
- expirationTime
-
The date and time when the purchase option expires and is no longer available for procurement.
Type: Timestamp
Required: No
- purchaseOptionName
-
The display name of the purchase option.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
