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.

Request Syntax

response = client.get_offer(
    offerId='string'
)

Parameters:

offerId (string) –

[REQUIRED]

The unique identifier of the offer to retrieve.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- 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.
- agreementProposalId (string) –
  
  An encoded string to be passed by the acceptor of the terms when creating an agreement.
- 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.
- 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.
- 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.

Exceptions

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