Skip to content

PurchaseOptionSummary

Source code in docs_src/capo_marketplace_discovery/types/purchase_option_summary.py
class PurchaseOptionSummary(TypedDict, closed=True):
    purchase_option_id: (
        "capo_marketplace_discovery.types.non_empty_string.NonEmptyString"
    )
    """<p>The unique identifier of the purchase option.</p>"""
    catalog: "capo_marketplace_discovery.types.catalog.Catalog"
    """<p>The name of the catalog that the purchase option belongs to.</p>"""
    purchase_option_type: (
        "capo_marketplace_discovery.types.purchase_option_type.PurchaseOptionType"
    )
    """<p>The type of purchase option. Values are <code>OFFER</code> for a single-product offer or <code>OFFERSET</code> for a bundled offer set.</p>"""
    purchase_option_name: NotRequired[
        "capo_marketplace_discovery.types.non_empty_string.NonEmptyString"
    ]
    """<p>The display name of the purchase option.</p>"""
    available_from_time: NotRequired["datetime.datetime"]
    """<p>The date and time when the purchase option became available to the buyer.</p>"""
    expiration_time: NotRequired["datetime.datetime"]
    """<p>The date and time when the purchase option expires and is no longer available for procurement.</p>"""
    seller_of_record: (
        "capo_marketplace_discovery.types.seller_information.SellerInformation"
    )
    """<p>The entity responsible for selling the product under this purchase option.</p>"""
    badges: NotRequired[
        "capo_marketplace_discovery.types.purchase_option_badge_list.PurchaseOptionBadgeList"
    ]
    """<p>Badges indicating special attributes of the purchase option, such as private pricing or future dated.</p>"""
    associated_entities: "capo_marketplace_discovery.types.purchase_option_associated_entity_list.PurchaseOptionAssociatedEntityList"
    """<p>The products, offers, and offer sets associated with this purchase option.</p>"""

associated_entities instance-attribute

The products, offers, and offer sets associated with this purchase option.

available_from_time instance-attribute

available_from_time: NotRequired[datetime]

The date and time when the purchase option became available to the buyer.

badges instance-attribute

badges: NotRequired[PurchaseOptionBadgeList]

Badges indicating special attributes of the purchase option, such as private pricing or future dated.

catalog instance-attribute

catalog: Catalog

The name of the catalog that the purchase option belongs to.

expiration_time instance-attribute

expiration_time: NotRequired[datetime]

The date and time when the purchase option expires and is no longer available for procurement.

purchase_option_id instance-attribute

purchase_option_id: NonEmptyString

The unique identifier of the purchase option.

purchase_option_name instance-attribute

purchase_option_name: NotRequired[NonEmptyString]

The display name of the purchase option.

purchase_option_type instance-attribute

purchase_option_type: PurchaseOptionType

The type of purchase option. Values are OFFER for a single-product offer or OFFERSET for a bundled offer set.

seller_of_record instance-attribute

seller_of_record: SellerInformation

The entity responsible for selling the product under this purchase option.