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

    Interface SyncCatalogsRequest

    Request parameters for syncing catalog feeds with upsert semantics. Supports bulk operations across multiple catalog types (products, inventory, stores, promotions, offerings). Existing catalogs matched by catalog_id are updated, new ones are created. When catalogs is omitted, the call is discovery-only: returns all catalogs on the account without modification.

    interface SyncCatalogsRequest {
        account: AccountReference;
        catalogs?: Catalog[];
        catalog_ids?: string[];
        delete_missing?: boolean;
        dry_run?: boolean;
        validation_mode?: ValidationMode;
        push_notification_config?: PushNotificationConfig;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    account catalogs? catalog_ids? delete_missing? dry_run? validation_mode? push_notification_config? context? ext?

    Properties

    account: AccountReference
    catalogs?: Catalog[]

    Array of catalog feeds to sync (create or update). When omitted, the call is discovery-only and returns all existing catalogs on the account without modification.

    catalog_ids?: string[]

    Optional filter to limit sync scope to specific catalog IDs. When provided, only these catalogs will be created/updated. Other catalogs on the account are unaffected.

    delete_missing?: boolean

    When true, buyer-managed catalogs on the account not included in this sync will be removed. Does not affect seller-managed catalogs. Do not combine with an omitted catalogs array or all buyer-managed catalogs will be deleted.

    dry_run?: boolean

    When true, preview changes without applying them. Returns what would be created/updated/deleted.

    validation_mode?: ValidationMode
    push_notification_config?: PushNotificationConfig
    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties