# Peak PIM Developers

> Peak PIM is a PIM (product information management) app for Shopify merchants running one or more stores. It keeps one canonical version of every product, variant, collection, and media file, plus one overridable version per store, and publishes changes back to Shopify. Developers can build on it two ways: a versioned REST API (scoped `pk_live_` bearer keys) and a remote MCP connector for AI assistants (OAuth 2.1 with consent tiers).

Key facts:

- REST API base URL: https://app.peak-pim.com, versioned under /api/v1, read-only today, additive changes only within v1.
- Auth: `Authorization: Bearer pk_live_...` API key created in the Peak PIM app under Settings → API. Scopes: pim:read, pim:write, pim:publish, pim:webhooks. All current endpoints need pim:read.
- Rate limits: 120 requests/minute per key, 240/minute per account; X-RateLimit-* headers on every response; 429 + Retry-After when over.
- Errors: always `{"error": {"code", "message", "request_id"}}`. Branch on `code`: unauthorized, forbidden, forbidden_scope, not_found, validation_failed, pim_locked, rate_limited, conflict, internal_error.
- MCP connector URL: https://api.peak-pim.com/mcp (remote MCP, streamable HTTP, OAuth 2.1 with dynamic client registration + PKCE). 12 tools: 9 reads, 2 draft writes, 1 live publish. Consent tiers: read / read_write / read_write_publish.
- Data model: each entity has canonical values (inherited by every store) and per-store versions (overrides). MCP tool names call these "master" and "projection"; "channel" means a connected Shopify store.

## Docs

- [Developer home](https://developers.peak-pim.com/): What you can build; how the API and MCP surfaces relate.
- [REST API overview](https://developers.peak-pim.com/api/): Base URL, data model, pagination, filtering, conditional reads, compatibility promise.
- [Authentication](https://developers.peak-pim.com/api/authentication): Creating pk_live_ keys, scopes, security model, rotation.
- [API quickstart](https://developers.peak-pim.com/api/quickstart): First calls with curl — ping, stores, products, store versions, efficient polling.
- [API reference](https://developers.peak-pim.com/api/reference): Every endpoint, parameter, and response field for products, variants, collections, media, and stores.
- [Errors & limits](https://developers.peak-pim.com/api/errors): Error envelope, published codes, rate limits, retry guidance.
- [OpenAPI 3.1 spec](https://developers.peak-pim.com/api/openapi.yaml): The formal machine-readable API contract.
- [MCP overview](https://developers.peak-pim.com/mcp/): Connector URL, OAuth consent tiers, security model, operational limits.
- [MCP quickstart](https://developers.peak-pim.com/mcp/quickstart): Connect Claude, ChatGPT, Claude Code, Cursor, or any MCP client.
- [MCP tool reference](https://developers.peak-pim.com/mcp/tools): All 12 tools with arguments, scopes, and behavior notes.
- [Changelog](https://developers.peak-pim.com/changelog): Every contract change, newest first.

## Optional

- [llms-full.txt](https://developers.peak-pim.com/llms-full.txt): The entire documentation as one plain-text file.
- [Peak PIM marketing site](https://peak-pim.com): Product overview and pricing.
- [Peak PIM app](https://app.peak-pim.com): Sign in to create API keys and manage MCP connections.