Tools

Translations & channels

Three read tools: one over Peak PIM's translation data, and the two sales-channel reads — the only tools in the catalog that read from Shopify live. All require pim:read.

get_master_translations_v1

get_master_translations_v1pim:read

Get every locale an item is translated into, with the translated values per store, plus the catalog of fields that can carry a translation. Supported for products and collections only.

ArgumentTypeDescription
idstring, requiredThe item id.
channel_idstringRestrict to one store.

The two live Shopify reads

These are the catalog's only open-world reads.

Every other read touches Peak PIM's own rows. The two sales-channel tools query Shopify live, so they are slower than the PIM reads and can fail when Shopify is unavailable. They are still pure reads — nothing is mutated.

list_store_sales_channels_v1

list_store_sales_channels_v1pim:read

List the Shopify sales channels (publications) one store owns — Online Store, Point of Sale, marketplace apps.

ArgumentTypeDescription
channel_idstring, requiredThe store id.

get_master_sales_channels_v1

get_master_sales_channels_v1pim:read

List the Shopify sales channels one item is published to on one store. An item that is not on the store, or was never published there, is a member of zero channels — an empty list, not an error.

ArgumentTypeDescription
idstring, requiredThe item id.
channel_idstring, requiredThe store id.

Using them together

A typical channel audit: get_master_with_projections_v1 shows which stores carry the item, list_store_sales_channels_v1 shows what channels each store has, and get_master_sales_channels_v1 shows where the item actually appears. Publishing afterwards goes through publish_master_v1.