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

    Interface SyncCatalogsSuccess

    Success response - sync operation processed catalogs (may include per-catalog failures)

    interface SyncCatalogsSuccess {
        dry_run?: boolean;
        catalogs: {
            catalog_id: string;
            action: CatalogAction;
            platform_id?: string;
            item_count?: number;
            items_approved?: number;
            items_pending?: number;
            items_rejected?: number;
            item_issues?: {
                item_id: string;
                status: CatalogItemStatus;
                reasons?: string[];
            }[];
            last_synced_at?: string;
            next_fetch_at?: string;
            changes?: string[];
            errors?: string[];
            warnings?: string[];
        }[];
        sandbox?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    dry_run? catalogs sandbox? context? ext?

    Properties

    dry_run?: boolean

    Whether this was a dry run (no actual changes made)

    catalogs: {
        catalog_id: string;
        action: CatalogAction;
        platform_id?: string;
        item_count?: number;
        items_approved?: number;
        items_pending?: number;
        items_rejected?: number;
        item_issues?: {
            item_id: string;
            status: CatalogItemStatus;
            reasons?: string[];
        }[];
        last_synced_at?: string;
        next_fetch_at?: string;
        changes?: string[];
        errors?: string[];
        warnings?: string[];
    }[]

    Results for each catalog processed. Items with action='failed' indicate per-catalog validation/processing failures, not operation-level failures.

    Type Declaration

    • catalog_id: string

      Catalog ID from the request

    • action: CatalogAction
    • Optionalplatform_id?: string

      Platform-specific ID assigned to the catalog

    • Optionalitem_count?: number

      Total number of items in the catalog after sync

    • Optionalitems_approved?: number

      Number of items approved by the platform. Populated when the platform performs item-level review.

    • Optionalitems_pending?: number

      Number of items pending platform review. Common for product catalogs where items must pass content policy checks.

    • Optionalitems_rejected?: number

      Number of items rejected by the platform. Check item_issues for rejection reasons.

    • Optionalitem_issues?: { item_id: string; status: CatalogItemStatus; reasons?: string[] }[]

      Per-item issues reported by the platform (rejections, warnings). Only present when the platform performs item-level review.

    • Optionallast_synced_at?: string

      ISO 8601 timestamp of when the most recent sync was accepted by the platform

    • Optionalnext_fetch_at?: string

      ISO 8601 timestamp of when the platform will next fetch the feed URL. Only present for URL-based catalogs with update_frequency.

    • Optionalchanges?: string[]

      Field names that were modified (only present when action='updated')

    • Optionalerrors?: string[]

      Validation or processing errors (only present when action='failed')

    • Optionalwarnings?: string[]

      Non-fatal warnings about this catalog

    sandbox?: boolean

    When true, this response contains simulated data from sandbox mode.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties