DOCSEARCHbyAlgolia
Submit Docs

Akeneo PIM API Reference

website·Indexed 42 days ago

https://api.akeneo.com

Technical documentation for the Akeneo PIM REST API, including PaaS version references (from 1.7 to 6.0), event API references for versions 5.0, 6.0, 7.0, and Serenity, and getting started tutorials for connecting the PIM and synchronizing products.

Tokens
202.1K
Snippets
726
Records
1.2K
Agent score
67%

What's inside Akeneo PIM

  1. Overview of Event Platform filtering

    Event filters allow subscribers to receive only a subset of events by applying readable conditions during subscription configuration. If no filter is defined, the subscription receives all events matching its type and source. Filters are evaluated automatically; matching events are forwarded to the destination, while non-matching events are silently skipped.

  2. Overview of Reference Entities in Akeneo PIM

    Reference entities are objects used to store complex information related to products that have their own attributes and lifecycle (e.g., brands, ranges, manufacturers, colors, materials). This is an Enterprise Edition (EE) only feature available in versions 3.x through 7.0 and SaaS.
    {
  "code": "brand",
  "labels": {
    "en_US": "Brand",
    "fr_FR": "Marque"
  },
  "image": "0/2/d/6/54d81dc888ba1501a8g765f3ab5797569f3bv756c_ref_img.png"
}

  3. Overview of Akeneo MCP Server

    The Akeneo MCP Server acts as a bridge between an Akeneo PIM instance and AI tools that support the Model Context Protocol (MCP). It enables users to interact with their product catalog using natural language for tasks such as searching products, updating attributes, and checking compliance directly from an IDE or AI assistant.

  4. Overview of Advanced Extension credential methods

    Credentials allow Advanced Extensions to make authenticated calls to external APIs. The PIM securely stores these credentials and automatically includes them as headers in API requests. Available methods include:

    • Bearer Token: Used for OAuth 2.0 or API tokens. Header: Authorization: Bearer {token_value}.
    • Basic Authentication: Used for username/password APIs. Header: Authorization: Basic {base64(username:password)}.
    • Custom Header: Used for custom authentication schemes. Header: {custom_header_key}: {custom_header_value}.
    • OAuth2: Used for APIs requiring short-lived tokens. The PIM manages the token exchange server-side. Header: Authorization: Bearer {fetched_access_token}.

  5. Overview of Akeneo Custom Component Extensions

    Custom component extensions are self-contained JavaScript applications built with the Akeneo Extension SDK that run securely within a sandbox environment inside the PIM. They allow developers to build rich, interactive user interfaces with full access to PIM APIs without requiring external hosting infrastructure.

    Common use cases include:

    • Enhancing product enrichment with specialized data entry interfaces.
    • Visualizing PIM data via charts and dashboards.
    • Implementing custom business logic, validations, or workflows.
    • Integrating external systems (ERPs, DAMs) or displaying real-time data from external APIs.
    • Creating interactive tools like multi-step wizards.

  6. Overview of Akeneo Catalogs for Apps

    A catalog is a selection of products defined by one or several criteria (such as families or categories). Catalogs are created by apps but configured by Akeneo users within the Akeneo Product Cloud. They allow apps to retrieve only the specific product data needed for processing, eliminating the need for developers to build their own product filtering interfaces.

  7. Overview of Akeneo Asset Manager

    The Asset Manager (available in Enterprise Edition since version 4.0) provides a structured way to manage assets linked to products and product models. Key capabilities include flexible asset structures via asset families, automated product linking through naming conventions and link rules, support for both internal and external binaries (via media link and media file attributes), and asset transformations.

  8. Overview of the Akeneo PHP API Client

    The Akeneo PHP client is designed to simplify the usage of the Akeneo REST API within PHP projects, specifically for developers building extensions or custom tools for the PIM (Product Information Management) system.

  9. Overview of Akeneo PIM core domains

    The Akeneo REST API resources are categorized by the following main PIM domains and features:

    • Products
    • Catalog structure
    • Target market settings
    • Reference entities
    • Asset Manager

  10. Overview of Akeneo MCP Server capabilities

    The Akeneo MCP Server allows AI assistants (such as Claude, Cursor, or VS Code) to interact with Akeneo PIM using natural language. The server provides a set of 'MCP Tools' that the LLM dynamically selects and parameterizes based on user intent. Key available tools include:

    • get_products: Retrieve one or multiple products.
    • get_families: List product families.
    • get_attributes: List attributes with filtering options.
    • upsert_products: Update or create several products.

  11. Overview of Akeneo Product Cloud Authorization and Authentication

    Akeneo Product Cloud distinguishes between authorization and authentication:

    • Authorization: The process of granting permissions to apps to access specific data (e.g., product and asset data) in Akeneo Product Cloud.
    • Authentication: The process of verifying the identity of a user or an app to secure API transactions.

    Akeneo uses OAuth 2.0 for managing app authorizations and the OpenID Connect protocol for authenticating users coming from Akeneo Product Cloud.

  12. Retrieve a single product by code

    Use the GET /api/rest/v1/products/{code} endpoint to retrieve detailed information about a specific product. In the Enterprise Edition (v2.0+), permissions based on user groups are applied to the request.

    Requirements:

    • Authorization header: Bearer <token>
    • Accept header: application/json

    Response Body: Returns a JSON object containing the product's identifier, enabled status, family, categories, groups, parent (for variants), values, associations, and timestamps for created and updated dates.

    curl -X GET "https://<your-pim-url>/api/rest/v1/products/my_product_code" \
     -H "Authorization: Bearer <token>" \
     -H "Accept: application/json"