Changelog
Every change to the published API contract and the MCP connector, newest first.
Within v1, changes are additive only — clients must ignore response fields they do
not recognize. A breaking change would ship as v2 with a
Deprecation/Sunset window on v1.
2026-07-28 — Public API: v1 read API
Added, all requiring the pim:read scope:
GET /api/v1/products,/api/v1/variants,/api/v1/collections,/api/v1/media— cursor-paginated lists (limitdefault 50, max 250; opaquecursor), filterable byupdated_since,status, andsearch.GET /api/v1/{resource}/{id}— one entity's canonical values,draft_revision, relationships (product_id,variant_ids,media_ids), and per-store publish state.GET /api/v1/{resource}/{id}/storesandGET /api/v1/{resource}/{id}/stores/{store_id}— the entity's store-local values, one item per store.GET /api/v1/stores— the account's linked Shopify stores.
Notes for integrators:
updated_sincematches an entity's own record recency. Editing one store's version of an entity does not widen it — re-read that entity's store versions when you need store-local changes.statusis publish state (never_published,pending,published,failed), not Shopify's per-store product status.- Every list response is
{"data": [...], "next_cursor": ...}. The store-scoped lists are bounded by the account's stores and always returnnext_cursor: null.
Already live from the platform foundations, unchanged here:
GET /api/v1/ping, pk_live_ bearer keys with scopes, the
typed error envelope, the X-RateLimit-* headers and 429 budget, and
ETag/If-None-Match on reads.
2026-07 — MCP connector: v1 tools
- Remote MCP endpoint at
https://api.peak-pim.com/mcp(streamable HTTP) with OAuth 2.1: dynamic client registration, PKCE S256, refresh tokens, and a browser consent page with three permission tiers (read / read & write / read, write & publish). - 12 versioned tools:
list_products_v1,list_collections_v1,list_variants_v1,list_masters_v1,get_master_v1,get_master_with_projections_v1,get_master_related_v1,list_projections_v1,get_projection_v1,update_master_attributes_v1,update_projection_attributes_v1,publish_master_v1. - Connection management (list / disconnect / revoke all) in Settings → AI assistants (MCP).