Tools

Tool index

Twenty-eight v1 tools: 22 reads, 5 draft-side writes, one publish. Names are versioned (_v1) and stable. Each row links to the detail page that documents the tool's arguments and behavior.

Vocabulary: master, projection, channel

Tool names use Peak PIM's internal words.

A master is the canonical item every store inherits (a product, collection, variant, metafield definition, or media file). A projection is one store's version of that item — the values that store actually publishes. A channel is a connected Shopify store, so channel_id means store id.

All 28 tools

ToolScopeWhat it does
list_products_v1readLean product rows with paging/search/sort
list_collections_v1readLean collection rows
list_variants_v1readLean variant rows
list_masters_v1readPower-read: full-detail items of any type
get_master_v1readOne item by id
get_master_with_projections_v1readOne item plus its per-store versions
get_master_related_v1readOne item plus related entities
list_projections_v1readPer-store versions, filterable
get_projection_v1readOne per-store version by id
update_master_attributes_v1writePatch an item's draft fields, with optional optimistic concurrency
update_projection_attributes_v1writePatch a store version's draft fields
publish_master_v1publishPublish an item live to Shopify
list_markets_v1readMarkets with per-store records and catalogs
get_market_v1readOne market by id
list_metafield_definitions_v1readCustom-field definitions and how each is typed
list_metaobject_definitions_v1readStructured-content types with field structure and entry count
list_metaobject_entries_v1readRecords under one metaobject definition
get_master_translations_v1readEvery locale a product or collection is translated into, per store
list_store_sales_channels_v1readA store's Shopify sales channels (live Shopify read)
get_master_sales_channels_v1readThe channels one item is published to on one store (live)
list_drops_v1readThe account's Drops — scheduled change windows
get_drop_v1readOne Drop with every change and its apply/revert status
list_master_drops_v1readThe Drops that will change one item, and when
get_data_health_v1readCached catalog-quality state per dimension
list_data_health_issues_v1readThe individual items behind one section's numbers
run_data_health_scan_v1writeRecompute one dimension (non-destructive)
fill_completeness_gaps_v1writeBatch-fill fields that are still empty (drafts)
reconcile_value_divergence_v1writeBatch-harmonize a field across stores (drafts)

Behaviors shared by every tool