Skip to content

CatalogItem

Source code in docs_src/capo_customer_profiles/types/catalog_item.py
class CatalogItem(TypedDict, closed=True):
    id: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The unique identifier for the catalog item.</p>"""
    name: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The display name of the catalog item.</p>"""
    code: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The product code or SKU of the catalog item.</p>"""
    type: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The type classification of the catalog item.</p>"""
    category: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The category to which the catalog item belongs.</p>"""
    description: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>A detailed description of the catalog item.</p>"""
    additional_information: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to1000.sensitiveString1To1000"
    ]
    """<p>Supplementary information about the catalog item beyond the basic description.</p>"""
    image_link: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to1000.sensitiveString1To1000"
    ]
    """<p>The URL link to the item's image.</p>"""
    link: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to1000.sensitiveString1To1000"
    ]
    """<p>The URL link to the item's detailed page or external resource.</p>"""
    created_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp when the catalog item was created.</p>"""
    updated_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp when the catalog item was last updated.</p>"""
    price: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The price of the catalog item.</p>"""
    attributes: NotRequired["capo_customer_profiles.types.attributes.Attributes"]
    """<p>Additional attributes or properties associated with the catalog item stored as key-value pairs.</p>"""

additional_information instance-attribute

additional_information: NotRequired[sensitiveString1To1000]

Supplementary information about the catalog item beyond the basic description.

attributes instance-attribute

attributes: NotRequired[Attributes]

Additional attributes or properties associated with the catalog item stored as key-value pairs.

category instance-attribute

category: NotRequired[sensitiveString1To255]

The category to which the catalog item belongs.

code instance-attribute

code: NotRequired[sensitiveString1To255]

The product code or SKU of the catalog item.

created_at instance-attribute

created_at: NotRequired[timestamp]

The timestamp when the catalog item was created.

description instance-attribute

description: NotRequired[sensitiveString1To255]

A detailed description of the catalog item.

id instance-attribute

id: NotRequired[sensitiveString1To255]

The unique identifier for the catalog item.

image_link: NotRequired[sensitiveString1To1000]

The URL link to the item's image.

link: NotRequired[sensitiveString1To1000]

The URL link to the item's detailed page or external resource.

name instance-attribute

name: NotRequired[sensitiveString1To255]

The display name of the catalog item.

price instance-attribute

price: NotRequired[sensitiveString1To255]

The price of the catalog item.

type instance-attribute

type: NotRequired[sensitiveString1To255]

The type classification of the catalog item.

updated_at instance-attribute

updated_at: NotRequired[timestamp]

The timestamp when the catalog item was last updated.