@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface Catalog

    Catalog of items the buyer wants to promote. The seller matches catalog items against its inventory and returns products where matches exist. Supports all catalog types: a job catalog finds job ad products, a product catalog finds sponsored product slots. Reference a synced catalog by catalog_id, or provide inline items.

    interface Catalog {
        catalog_id?: string;
        name?: string;
        type: CatalogType;
        url?: string;
        feed_format?: FeedFormat;
        update_frequency?: UpdateFrequency;
        items?: {}[];
        ids?: string[];
        gtins?: string[];
        tags?: string[];
        category?: string;
        query?: string;
        conversion_events?: EventType[];
        content_id_type?: ContentIDType;
        feed_field_mappings?: CatalogFieldMapping[];
    }
    Index

    Properties

    catalog_id? name? type url? feed_format? update_frequency? items? ids? gtins? tags? category? query? conversion_events? content_id_type? feed_field_mappings?

    Properties

    catalog_id?: string

    Buyer's identifier for this catalog. Required when syncing via sync_catalogs. When used in creatives, references a previously synced catalog on the account.

    name?: string

    Human-readable name for this catalog (e.g., 'Summer Products 2025', 'Amsterdam Store Locations').

    type: CatalogType
    url?: string

    URL to an external catalog feed. The platform fetches and resolves items from this URL. For offering-type catalogs, the feed contains an array of Offering objects. For other types, the feed format is determined by feed_format. When omitted with type 'product', the platform uses its synced copy of the brand's product catalog.

    feed_format?: FeedFormat
    update_frequency?: UpdateFrequency
    items?: {}[]

    Inline catalog data. The item schema depends on the catalog type: Offering objects for 'offering', StoreItem for 'store', HotelItem for 'hotel', FlightItem for 'flight', JobItem for 'job', VehicleItem for 'vehicle', RealEstateItem for 'real_estate', EducationItem for 'education', DestinationItem for 'destination', AppItem for 'app', or freeform objects for 'product', 'inventory', and 'promotion'. Mutually exclusive with url — provide one or the other, not both. Implementations should validate items against the type-specific schema.

    ids?: string[]

    Filter catalog to specific item IDs. For offering-type catalogs, these are offering_id values. For product-type catalogs, these are SKU identifiers.

    gtins?: string[]

    Filter product-type catalogs by GTIN identifiers for cross-retailer catalog matching. Accepts standard GTIN formats (GTIN-8, UPC-A/GTIN-12, EAN-13/GTIN-13, GTIN-14). Only applicable when type is 'product'.

    tags?: string[]

    Filter catalog to items with these tags. Tags are matched using OR logic — items matching any tag are included.

    category?: string

    Filter catalog to items in this category (e.g., 'beverages/soft-drinks', 'chef-positions').

    query?: string

    Natural language filter for catalog items (e.g., 'all pasta sauces under $5', 'amsterdam vacancies').

    conversion_events?: EventType[]

    Event types that represent conversions for items in this catalog. Declares what events the platform should attribute to catalog items — e.g., a job catalog converts via submit_application, a product catalog via purchase. The event's content_ids field carries the item IDs that connect back to catalog items. Use content_id_type to declare what identifier type content_ids values represent.

    Optionalcontent_id_type

    content_id_type?: ContentIDType
    feed_field_mappings?: CatalogFieldMapping[]

    Declarative normalization rules for external feeds. Maps non-standard feed field names, date formats, price encodings, and image URLs to the AdCP catalog item schema. Applied during sync_catalogs ingestion. Supports field renames, named transforms (date, divide, boolean, split), static literal injection, and assignment of image URLs to typed asset pools.

    Settings

    Member Visibility

    On This Page

    Properties