MarketplaceDiscovery / Client / get_offer

get_offer

MarketplaceDiscovery.Client.get_offer(**kwargs)

Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products.

See also: AWS API Documentation

Request Syntax

response = client.get_offer(
    locale='string',
    offerId='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.

  • offerId (string) –

    [REQUIRED]

    The unique identifier of the offer to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'locale': 'string',
    'offerId': 'string',
    'catalog': 'string',
    'offerName': 'string',
    'expirationTime': datetime(2015, 1, 1),
    'availableFromTime': datetime(2015, 1, 1),
    'sellerOfRecord': {
        'sellerProfileId': 'string',
        'displayName': 'string'
    },
    'associatedEntities': [
        {
            'product': {
                'productId': 'string',
                'productName': 'string',
                'manufacturer': {
                    'sellerProfileId': 'string',
                    'displayName': 'string'
                }
            },
            'offerSet': {
                'offerSetId': 'string',
                'sellerOfRecord': {
                    'sellerProfileId': 'string',
                    'displayName': 'string'
                }
            }
        },
    ],
    'agreementProposalId': 'string',
    'replacementAgreementId': 'string',
    'pricingModel': {
        'pricingModelType': 'USAGE'|'CONTRACT'|'BYOL'|'FREE',
        'displayName': 'string'
    },
    'badges': [
        {
            'displayName': 'string',
            'badgeType': 'PRIVATE_PRICING'|'FUTURE_DATED'|'REPLACEMENT_OFFER'|'AUTO_RENEW'
        },
    ]
}

Response Structure

  • (dict) –

    • locale (string) –

      The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.

    • offerId (string) –

      The unique identifier of the offer.

    • catalog (string) –

      The name of the catalog that the offer belongs to.

    • offerName (string) –

      The display name of the offer. This is free-form text provided by the seller.

    • expirationTime (datetime) –

      The date and time until when the offer can be procured. This value is null for offers that never expire.

    • availableFromTime (datetime) –

      The date and time when the offer became available to the buyer.

    • 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.

    • associatedEntities (list) –

      The products and offer sets associated with this offer.

      • (dict) –

        A product and optional offer set associated with an offer.

        • product (dict) –

          Information about the product associated with the offer.

          • 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.

        • offerSet (dict) –

          Information about the offer set, if the offer 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.

    • agreementProposalId (string) –

      An encoded string to be passed by the acceptor of the terms when creating an agreement.

    • replacementAgreementId (string) –

      The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.

    • pricingModel (dict) –

      The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.

      • pricingModelType (string) –

        The machine-readable type of the pricing model.

      • displayName (string) –

        The human-readable name of the pricing model.

    • badges (list) –

      Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.

      • (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.

Exceptions