MarketplaceDiscovery / Paginator / ListPurchaseOptions

ListPurchaseOptions

class MarketplaceDiscovery.Paginator.ListPurchaseOptions

paginator = client.get_paginator('list_purchase_options')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MarketplaceDiscovery.Client.list_purchase_options().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'filterType': 'PRODUCT_ID'|'SELLER_OF_RECORD_PROFILE_ID'|'PURCHASE_OPTION_TYPE'|'VISIBILITY_SCOPE'|'AVAILABILITY_STATUS',
            'filterValues': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• 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. Multiple values within the same filter are combined with OR logic.

      • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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'
                },
            ],
            '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) –

    A token to resume pagination.