Developer Documentation

Quick Start

Ready in 3 Steps

1

Create an Account

Sign up for free on Pimelo and access your dashboard.

2

Generate an API Token

Go to Settings > API Tokens to create your access key with the desired scopes.

3

Send Your First Request

Use your Bearer token to query the API. Try with the /channels endpoint below.

# List your sales channels
curl -X GET https://www.pimelo.app/en/api/v1/channels \
  -H "Authorization: Bearer pim_your_token_here" \
  -H "Content-Type: application/json"

Security

Authentication

All API requests require a Bearer token. Include it in the Authorization header of every request.

Authorization: Bearer pim_xxxxxxxxxxxxxxxx

API tokens start with the pim_ prefix followed by a random string. Each token is linked to a user and an organization with specific scopes.

Available Scopes

Scope	Description
products:read	Read products and their values
products:write	Create and update products
entities:read	Read entities and their values
entities:write	Create and update entities
settings:read	Read configuration (channels, locales)
settings:write	Update configuration
media:read	Download and view media
media:write	Upload and manage media
import-export:read	Read import/export profiles and jobs
import-export:write	Run import and export jobs
attributes:read	Read attributes and attribute sets
attributes:write	Create and update attributes

Concepts

API Concepts

Base URL

All API requests use the same base prefix. Responses are in JSON format.

https://www.pimelo.app/api/v1/

Pagination

Result lists use cursor-based pagination (search_after). Each response includes a cursor for the next page.

Filtering

Search endpoints accept a JSON object with filters on attributes, status, channel and locale.

Error Handling

Errors follow the RFC 7807 (Problem Details) format with an HTTP code, type and descriptive message.

Rate Limits

600 requests per minute per token. X-RateLimit-Limit, X-RateLimit-Remaining and Retry-After headers are included in every response.

API

API Resources

Explore available endpoints to manage your product data.

MCP Server Available

MCP Server — AI-Powered PIM Management

Connect Claude, ChatGPT or any AI agent to Pimelo via the Model Context Protocol. 14 tools to search, create and update your product data using natural language.

View documentation

// MCP Configuration
{
  "mcpServers": {
    "pimelo": {
      "url": "https://…/_mcp"
    }
  }
}