MarketplaceDiscovery / Client / list_purchase_options

list_purchase_options¶

MarketplaceDiscovery.Client.list_purchase_options(**kwargs)¶

Returns the purchase options (offers and offer sets) available to the buyer. You can filter results by product, seller, purchase option type, visibility scope, and availability status.

Note

You must include at least one of the following filters in the request: a PRODUCT_ID filter to specify the product for which to retrieve purchase options, or a VISIBILITY_SCOPE filter to retrieve purchase options by visibility.

Request Syntax

response = client.list_purchase_options(
    locale='string',
    filters=[
        {
            'filterType': 'PRODUCT_ID'|'SELLER_OF_RECORD_PROFILE_ID'|'PURCHASE_OPTION_TYPE'|'VISIBILITY_SCOPE'|'AVAILABILITY_STATUS',
            'filterValues': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

locale (string) – A BCP 47 language tag or comma-separated priority list specifying the preferred locale for response content. See Locale for supported values, constraints, fallback behavior, and the default locale. If omitted, the service returns content in the default locale.
filters (list) –
Filters to narrow the results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.
- (dict) –
  
  A filter used to narrow purchase option results by product, seller, type, visibility, or availability.
  - filterType (string) – [REQUIRED]
    
    The type of filter to apply, such as PRODUCT_ID, VISIBILITY_SCOPE, or PURCHASE_OPTION_TYPE.
  - filterValues (list) – [REQUIRED]
    
    The values to filter by. Supported values depend on filterType:
    - PRODUCT_ID – One or more product identifiers to filter by.
    - SELLER_OF_RECORD_PROFILE_ID – One or more seller profile identifiers to filter by.
    - PURCHASE_OPTION_TYPE – One or more purchase option types to filter by: OFFER or OFFERSET.
    - VISIBILITY_SCOPE – The visibility scope to filter by: PRIVATE.
    - AVAILABILITY_STATUS – One or more availability statuses to filter by: AVAILABLE or EXPIRED.
    To retrieve private offers and offer sets visible to you, use VISIBILITY_SCOPE with PRIVATE. OR logic combines multiple values within the same filter.
    - (string) –
maxResults (integer) – The maximum number of results that are returned per call. You can use nextToken to get more results.
nextToken (string) – If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

Return type:

dict

Returns:

Response Syntax

{
    'purchaseOptions': [
        {
            'purchaseOptionId': 'string',
            'catalog': 'string',
            'purchaseOptionType': 'OFFER'|'OFFERSET',
            'purchaseOptionName': 'string',
            'availableFromTime': datetime(2015, 1, 1),
            'expirationTime': datetime(2015, 1, 1),
            'sellerOfRecord': {
                'sellerProfileId': 'string',
                'displayName': 'string'
            },
            'badges': [
                {
                    'displayName': 'string',
                    'badgeType': 'PRIVATE_PRICING'|'FUTURE_DATED'|'REPLACEMENT_OFFER'|'AUTO_RENEW'
                },
            ],
            'associatedEntities': [
                {
                    'product': {
                        'productId': 'string',
                        'productName': 'string',
                        'manufacturer': {
                            'sellerProfileId': 'string',
                            'displayName': 'string'
                        }
                    },
                    'offer': {
                        'offerId': 'string',
                        'offerName': 'string',
                        'sellerOfRecord': {
                            'sellerProfileId': 'string',
                            'displayName': 'string'
                        }
                    },
                    'offerSet': {
                        'offerSetId': 'string',
                        'sellerOfRecord': {
                            'sellerProfileId': 'string',
                            'displayName': 'string'
                        }
                    }
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- purchaseOptions (list) –
  
  The purchase options available to the buyer. Each option is either an offer for a single product or an offer set spanning multiple products.
  - (dict) –
    
    Summary information about a purchase option (offer or offer set) available to the buyer, including the seller, badges, and associated products.
    - purchaseOptionId (string) –
      
      The unique identifier of the purchase option.
    - catalog (string) –
      
      The name of the catalog that the purchase option belongs to.
    - purchaseOptionType (string) –
      
      The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set.
    - purchaseOptionName (string) –
      
      The display name of the purchase option.
    - availableFromTime (datetime) –
      
      The date and time when the purchase option became available to the buyer.
    - expirationTime (datetime) –
      
      The date and time when the purchase option expires and is no longer available for procurement.
    - sellerOfRecord (dict) –
      
      The entity responsible for selling the product under this purchase option.
      - sellerProfileId (string) –
        
        The unique identifier of the seller profile.
      - displayName (string) –
        
        The human-readable name of the seller.
    - badges (list) –
      
      Badges indicating special attributes of the purchase option, such as private pricing or future dated.
      - (dict) –
        
        A badge indicating a special attribute of a purchase option, such as private pricing or future dated.
        
        displayName (string) –
        
        The human-readable name of the badge.
        
        badgeType (string) –
        
        The machine-readable type of the badge.
    - associatedEntities (list) –
      
      The products, offers, and offer sets associated with this purchase option.
      - (dict) –
        
        A product, offer, and optional offer set associated with a purchase option.
        
        product (dict) –
        
        Information about the product associated with the purchase option.
        
        productId (string) –
        
        The unique identifier of the product.
        
        productName (string) –
        
        The human-readable display name of the product.
        
        manufacturer (dict) –
        
        The entity who manufactured the product.
        
        sellerProfileId (string) –
        
        The unique identifier of the seller profile.
        
        displayName (string) –
        
        The human-readable name of the seller.
        
        offer (dict) –
        
        Information about the offer associated with the purchase option.
        
        offerId (string) –
        
        The unique identifier of the offer.
        
        offerName (string) –
        
        The display name of the offer.
        
        sellerOfRecord (dict) –
        
        The entity responsible for selling the product under this offer.
        
        sellerProfileId (string) –
        
        The unique identifier of the seller profile.
        
        displayName (string) –
        
        The human-readable name of the seller.
        
        offerSet (dict) –
        
        Information about the offer set, if the purchase option is part of a bundled offer set.
        
        offerSetId (string) –
        
        The unique identifier of the offer set.
        
        sellerOfRecord (dict) –
        
        The entity responsible for selling the products under this offer set.
        
        sellerProfileId (string) –
        
        The unique identifier of the seller profile.
        
        displayName (string) –
        
        The human-readable name of the seller.
- nextToken (string) –
  
  If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.

Exceptions

MarketplaceDiscovery.Client.exceptions.ThrottlingException
MarketplaceDiscovery.Client.exceptions.AccessDeniedException
MarketplaceDiscovery.Client.exceptions.ValidationException
MarketplaceDiscovery.Client.exceptions.InternalServerException