Drive Commerce Customizer

Status of a promotion preview or apply: Created (queued), Running, Success or Exception, with what the batch contains, which shared entities already exist in the target, and the job log. The import lives in the target workspace; any workspace the caller can reach is searched.

get_import_status

Workspaces (instances such as production and staging) the caller may work in, with the current one flagged.

list_workspaces

Starts a dry-run promotion of a product from the current workspace into another workspace (for example staging to production). Target catalog data is unchanged; a preview import is queued, and its job reports what apply_import would create or overwrite, including shared placements, definitions and options the target already has. Poll get_import_status with the returned importId, show its summary and warnings to the user verbatim, then call apply_import if they confirm. Use dependencies="recursive" only when the user explicitly asks to include parent products: it promotes every parent product that references this one, so list the products from the preview summary and get a separate confirmation before applying.

promote_product

Starts a dry-run promotion of specific options, with their option definitions, from the current workspace into another workspace. Target catalog data is unchanged; a preview import is queued, and its job reports what apply_import would create or overwrite in the target. Address options by definition and code exactly as find_options returns them; an unknown code queues nothing. Poll get_import_status with the returned importId, show its summary and warnings to the user, then call apply_import if they confirm.

promote_options

One product with everything needed to judge availability on any site and date: status, global inactive and activeFrom, the sites it is assigned to, per-site overrides (a site entry replaces the global switches for that site), and the active version (null when none). Also groups and their placements, tags and custom attributes. Packages (generators: placement plus the option codes enabled per definition) and rules (type, source/target/except tags, rule code, condition, action, inactive flag) are omitted unless requested with includePackages and includeRules; packageCount and ruleCount always say how many exist. To explain why an option behaves differently in two workspaces, fetch the product with both included in each workspace and compare generators and rules, then compare the option itself with find_options.

find_product

Records a short fact or convention about this client's catalog in the shared notes that every colleague's assistant sees in get_session, or removes one by id, or both. Notes are shared across the client's workspaces and across assistants, so record only what any colleague would need: vocabulary, where a setting lives, conventions such as which workspace an option family may be enabled in. Never record preferences, conversation history or personal data. Show the exact text to the user and get their confirmation before calling. At most 30 notes of 300 characters; when the pool is full, forget one first.

remember_this

Activates, deactivates or schedules up to 200 options, globally or per site. inactive=true hides an option; activeFrom makes it active from that moment (ISO 8601 with UTC offset); clearActiveFrom removes a scheduled date. Per-site entries override the global setting for that site; removeSites deletes an override. Omitted fields stay unchanged. Address options by definition and code from find_options; an unknown code or site rejects the whole call.

set_option_availability

Ends this connection's Customizer login by revoking its tokens. The next call fails with 401 and the assistant asks to reconnect; on the Customizer sign-in page choose "Login to a different account" to switch users. Use when the user wants to log out or sign in as someone else. API keys have no login to end.

sign_out

Makes another workspace current for this connection; every later call acts on it. Use a companyId from list_workspaces. API keys are bound to one workspace and cannot switch.

switch_workspace

Changes name, description, order key, end-of-list placement, custom attributes or tags of up to 200 options in one call. Omitted fields stay unchanged. Address each option by definition and code exactly as find_options returns them; an unknown code rejects the whole call and nothing is written. Confirm the list with the user first.

update_options

Changes name, description, custom attributes or tags of up to 200 products in one call. Omitted fields stay unchanged. Address each product by style code exactly as find_products returns it; an unknown style code rejects the whole call and nothing is written. Status, versions, packages, sites and availability are not changed here. The blueprint cache is refreshed once afterwards so storefronts see the change. Confirm the list with the user first.

update_products