One API for your whole multi-store catalog

Search complete product context, update master or store-specific data with validation, and publish to the right Shopify storefronts through one consistent API.

Talk to us View API documentation

PeakDeveloper APIrevision 42200 Published

Product modelAlpine JacketMaster data rev 42US store ActiveFR store DraftDE store Active

PATCH/v1/products/prod_82/stores/fr

{
  "revision": 42,
  "title": "Veste Alpine",
  "seo_description": "Une veste…"
}

Validated draftrevision 43

POST/v1/products/prod_82/publish

{ "stores": ["fr"], "status": "published" }

Trusted by 50+ top merchants worldwide

A catalog API, not raw tables

Build on the product model Peak PIM already manages

Give integrations a reliable way to understand shared data, storefront differences, safe writes, and publishing state.

Storefront data fragments the product model

Custom integrations often reconstruct master data and store-specific versions from separate calls before they can do useful work.

Catalog writes need more than an endpoint

Validation, revision conflicts, drafts, variants, media, and collection relationships all matter when a partial update reaches production.

Publishing is its own workflow

Moving a validated change to one, several, or all Shopify stores should use a predictable pipeline, not another collection of custom scripts.

See how it works

Read, write, publish

A predictable path from request to storefront

Use structured catalog reads, controlled partial updates, and the same multi-store publishing workflow as the Peak PIM app.

GET /products

GET /v1/products
?search=alpine
&store=fr
&status=draft

200 · 24 results
page 1 of 3

Query

Read the whole product context

Search and filter products, variants, collections, media, and metafield definitions, then retrieve master data and store versions together.

PATCH /products/:id

PATCH /stores/fr
If-Match: revision-42

title: "Veste Alpine"

200 · revision-43
status: draft

Update

Patch the exact layer you intend

Update master data or one store version with field validation, draft-first behavior, scoped bearer tokens, and revision checks that reject stale writes.

POST /publish

1ValidateMaster + versions2PublishUS · FR · DE3SyncVariants + mediaCompleted through Peak pipeline

Publish

Use one multi-store pipeline

Publish to one, several, or all connected stores while Peak PIM coordinates variants, media, and collection memberships through the same workflow as the app.

Built for integrations

The controls production catalog work needs

The API makes permissions, revisions, drafts, and publishing explicit so your integration can fail safely.

Learn more

Unified product model

Read master product information and per-store versions in one structured response instead of rebuilding their relationship client-side.

Deep reads and precise queries

Use full-text search, filters, sorting, pagination, and related records to retrieve the context an integration actually needs.

Safe partial updates

Scopes separate read, write, and publish access. Optimistic concurrency returns a conflict instead of silently accepting a stale revision.

Explicit Shopify publishing

Writes remain drafts until a publish request targets the intended stores, keeping catalog mutation separate from storefront release.

Frequently asked questions

Everything developers need to know before building with the Peak PIM API.

What can I build with the Peak PIM API?

You can build catalog integrations, supplier and ERP connections, internal product tools, automation, reporting, and other workflows that need structured access to Peak PIM's multi-store catalog.

Which catalog resources are available?

The API covers products, variants, collections, media, metafield definitions, master data, and store-specific versions, with search, filtering, sorting, pagination, and related-record reads.

Can I update one Shopify store without changing the others?

Yes. Patch a store-specific version when the change belongs to one storefront, or patch master data when it should apply at the shared product layer.

How does publishing work?

Publishing is an explicit action after a write. Target one, several, or all connected stores, and Peak PIM runs the change through its Shopify publishing pipeline with the related variants, media, and collection memberships.

How is API access scoped?

Bearer credentials use separate pim:read, pim:write, and pim:publish scopes so an integration receives only the capabilities it needs. There is no delete scope.

How are concurrent updates handled?

Update requests include the record revision. If another change has advanced that revision, Peak PIM rejects the stale write with HTTP 409 so the client can refresh and resolve it deliberately.

Does an API update immediately change Shopify?

No. Updates are draft-first. The client sends a separate publish request when the validated change is ready for the selected storefronts.

Where can I access the API documentation?

The public developer documentation includes the API reference, authentication guidance, and endpoint details at https://developers.peak-pim.com/.

View API documentation

How is the API related to the AI Connector (MCP)?

The AI Connector (MCP) exposes the same catalog capabilities as typed conversational tools over a remote MCP server. Use the REST API for custom software, or the connector when an off-the-shelf AI assistant is the interface.

Still have questions?

Reach out to our team and we’ll help you find the right setup.

Talk to us