MarketplaceDiscovery / Client / get_offer_set

get_offer_set¶

MarketplaceDiscovery.Client.get_offer_set(**kwargs)¶

Provides details about an offer set, which is a bundle of offers across multiple products. Includes the seller, availability dates, buyer notes, and associated product-offer pairs.

Request Syntax

response = client.get_offer_set(
    offerSetId='string'
)

Parameters:

offerSetId (string) –

[REQUIRED]

The unique identifier of the offer set to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'offerSetId': 'string',
    'catalog': 'string',
    'offerSetName': 'string',
    'availableFromTime': datetime(2015, 1, 1),
    'expirationTime': datetime(2015, 1, 1),
    'buyerNotes': 'string',
    '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'
                }
            }
        },
    ]
}

Response Structure

(dict) –
- offerSetId (string) –
  
  The unique identifier of the offer set.
- catalog (string) –
  
  The name of the catalog that the offer set belongs to.
- offerSetName (string) –
  
  The display name of the offer set.
- availableFromTime (datetime) –
  
  The date and time when the offer set became available to the buyer.
- expirationTime (datetime) –
  
  The date and time when the offer set expires and is no longer available for procurement.
- buyerNotes (string) –
  
  Detailed information about the offer set that helps buyers understand its purpose and contents.
- 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.
- badges (list) –
  
  Badges indicating special attributes of the offer set, 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 and offers included in this offer set.
  - (dict) –
    
    A product and offer associated with an offer set.
    - product (dict) –
      
      Information about the product associated with the offer set.
      - 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 offer set.
      - 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.

Exceptions

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