Tools
Activity & operational state
Twelve read tools over what happened and what is in flight: change history, the home dashboard, the two on-demand data-health analyses (read-only compute), whole-shop refresh status, the import/refresh review surface, the supplier-import wizard, and the saved bulk-edit views and import/export templates. All require pim:read.
list_history_v1
list_history_v1pim:readRead who changed what, when: the account-wide feed (filterable by entity type, action, store, actor, source, and the saved-vs-published lens) or, with master_id, one entity's timeline including its variants. Each event carries the field-level before/after changes and, for publish events, the outcome detail. Newest first.
| Argument | Type | Description |
|---|---|---|
action | string, one of created, updated, deleted, published, publish_failed, linked, unlinked, reverted, imported, refreshed | Feed filter: one action. |
actor_id | string | Feed filter: one actor id. |
channel_id | string | Feed filter: one store. |
entity_type | string | Feed filter: entity type (Product, Variant, Collection, Media, …). |
lens | string, one of saved, published | Feed filter: "saved" (edits, links, imports) or "published" (publish outcomes). |
master_id | string | Read one entity's timeline instead of the account feed (the other filters do not apply). |
page | integer | 1-based page number. |
page_size | integer | Rows per page (clamped to the server max). |
source | string, one of app, bulk_edit, harmonize, completeness_fill, supplier_import, drops, mcp, assistant, import, refresh, computed_field, system | Feed filter: the surface that made the change. |
get_home_dashboard_v1
get_home_dashboard_v1pim:readRead the home summary: item and store-version totals, pending updates, items published today, the six most recently updated items with their status, at-a-glance counts (collections, files, metaobjects, variants), and per-store publish coverage (published / pending / failed / total).
| Argument | Type | Description |
|---|---|---|
type | string | Which entity type the totals and recent list cover (default Product). |
analyze_data_health_v1
analyze_data_health_v1pim:readEvaluate the catalog on demand without writing anything: analysis "completeness" lists the items missing values for the given fields (per store, or every store), analysis "value_divergence" lists the items whose stores disagree on the given fields (always cross-store) with each store's value and a signature per field. Both page through matches and report exact totals. Fields: the type's scannable fields plus any mf: key; completeness also takes "Image" and "Collections" for products, divergence "Media", "Media Alt Text", "Variant count" (products) and "Members" (collections). At most 40 fields.
| Argument | Type | Description |
|---|---|---|
analysis | string, one of completeness, value_divergence, required | Which analysis to run. |
entity_type | string, one of Product, Variant, Collection, Media, required | Which kind of item to evaluate. |
fields | array of string, required | The field keys to evaluate (1–40). |
channel_id | string | Completeness only: scope to one store. |
dismissals | array of object | Divergence only: previously reviewed (item, field, signature) triples to leave out (at most 2000). |
page | integer | 1-based page number. |
page_size | integer | Rows per page (clamped to the server max). |
- Extended timeout. 120 s per call — the operation runs server-side orchestration or a live Shopify read.
get_shop_refresh_status_v1
get_shop_refresh_status_v1pim:readRead whether a whole-shop refresh from Shopify is running on one store, its live stage and progress counters when it is, and the last run's result: what was refreshed, created, unchanged or failed per entity class, the deletion candidates it found (refresh deletes nothing itself — they await review), and its warnings.
| Argument | Type | Description |
|---|---|---|
channel_id | string, required | The store id. |
get_import_reconciliation_v1
get_import_reconciliation_v1pim:readRead whether a store import or whole-shop refresh is awaiting review (while one is unfinalized, every write in the PIM answers 423 pim_locked): the run (store, mode, status, timestamps), per-type tallies (matched, created, reviewed, refreshed, deleted), and — with include_deletions on a refresh run — the full deletion-candidate list with each candidate's keep decision. status "none" means nothing is under review.
| Argument | Type | Description |
|---|---|---|
include_deletions | boolean | Also list the refresh run's deletion candidates (refresh runs only). |
list_import_reconciliation_items_v1
list_import_reconciliation_items_v1pim:readList the items of the open import or refresh review for one entity type: each with its outcome (matched, created; refreshed or deleted on a refresh run), match score and the keys that matched, whether it was reviewed, its parent, nested variants for products, and on a refresh run the fields the refresh changed. Answers 409 when nothing is under review.
| Argument | Type | Description |
|---|---|---|
object_type | string, one of Product, Variant, Collection, Media, MetafieldDefinition, Page, Blog, Article | Which entity type (default Product). |
outcome | string, one of matched, created, refreshed, deleted | Narrow to one outcome (refreshed and deleted exist on refresh runs only). |
page | integer | 1-based page number. |
page_size | integer | Rows per page (clamped to the server max). |
reviewed | string, one of reviewed, unreviewed | Narrow to reviewed or unreviewed items. |
search | string | Free-text search. |
get_import_reconciliation_item_changes_v1
get_import_reconciliation_item_changes_v1pim:readFor the open refresh review, read the field-level before/after changes the refresh applied to one item: the shared (all-store) fields and the store's own fields. Refresh runs only; answers 409 for an import review or when nothing is under review.
| Argument | Type | Description |
|---|---|---|
master_id | string, required | The item id. |
preview_import_reconciliation_match_v1
preview_import_reconciliation_match_v1pim:readFor the open import/refresh review, preview which existing items one imported item would match under the run's matching rules (or a proposed match_config): each candidate's score, the keys that fired, and whether it would match. Read-only.
| Argument | Type | Description |
|---|---|---|
master_id | string, required | The imported item's id. |
match_config | object | Optional proposed matching rules (the run's own config shape: per-entity keys, fields, confidence, match_mode). |
object_type | string, one of Product, Variant, Collection, Media | The item's type (default Product). |
get_supplier_import_v1
get_supplier_import_v1pim:readRead the account's current supplier-file import run: its status, source file, mode, row count, the saved column-to-field mappings, the match selection (which stores, which key), manual matches, and — once committed — how many entities were written or failed. status "none" means no run is in progress.
No arguments.
list_supplier_import_preview_v1
list_supplier_import_preview_v1pim:readPage through the computed plan of the current supplier-file import: totals (matched, unmatched, ambiguous, to create, changed and invalid fields) and each row's outcome, the item it matched (or would create), and its field-level before/after changes with validation flags. Answers 409 until the plan has been computed in the wizard.
| Argument | Type | Description |
|---|---|---|
outcome | string, one of matched, unmatched, ambiguous, will_create, not_creatable | Narrow to one row outcome. |
page | integer | 1-based page number. |
page_size | integer | Rows per page (clamped to the server max). |
list_bulk_edit_views_v1
list_bulk_edit_views_v1pim:readList the account's saved bulk-edit grid layouts for one entity type, each with its name and its config — the grid's own layout object (columns, filters, sort, grouping) exactly as the interface saved it. Apply one by feeding its filter/sort into list_bulk_edit_rows_v1. entity_type values: product, collection, variant, media, blog, article, or metaobject_entry:<definition id>.
| Argument | Type | Description |
|---|---|---|
entity_type | string, required | The grid's entity type key. |
list_import_export_templates_v1
list_import_export_templates_v1pim:readList the account's saved mapping templates of one kind: "import" templates snapshot a supplier-import wizard configuration, "export" templates an export field selection. Each carries its name and config exactly as the interface saved it; an export template's field selection can be fed into export_bulk_edit_v1.
| Argument | Type | Description |
|---|---|---|
kind | string, one of import, export, required | Which template kind. |