v1
latestOpenAPI 3.1.02026-07-241765501.1 MBCreate or replace catalog
🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: catalog(w), search_suggestions(w).
Replace the current catalog using one of two modes: Full mode (mode=full, default): Send full catalog files to replace the current catalog. You may upload up to three files in the form data under the following keys: items, variations, item_groups. If you do not wish to replace one of these types of resources then omit it from the request. Any records that already exist will be deleted and replaced with the records you provide in the files. IDs mode (mode=ids): Send files containing only the IDs of records to keep. Files should contain only an id column (CSV) or id field (JSONL). All records whose IDs are not present in the uploaded files will be deleted from the catalog. Returns an identifier for a background task.
Query parameters
The key of the index to use.
The section of the index to use. Defaults to Products.
The ID of the client and version that the request is coming from, such as cio-js-2.90.
A flag to process the catalog even if it will invalidate a large part of existing data. By default, operations that would invalidate more than 50% of existing data are blocked unless force=true is used. Defaults to False.
The email address(es) to send a notification to if the task fails. Multiple addresses may be specified for multiple recipients.
[ "user@example.com" ]
Response
OK