Akeneo

Akeneo Mapping schema for products API

The mapping schema for products defines the expected structure of product data when synchronizing via the API. It describes the fields, their types, constraints, and transformation rules applied during the export or import of products in a catalog connected to an App. This schema ensures data consistency between Akeneo PIM and third-party applications by clarifying how PIM attributes correspond to those expected by the App. For each field, the schema specifies the data type (text, number, boolean, etc.), whether the field is required or optional, and any allowed values or transformations to apply.

Documentation GitHub OpenAPI

Operations 3

GET /api/rest/v1/catalogs/{id}/mapping-schemas/product Get the product mapping schema related to a catalog #

PUT /api/rest/v1/catalogs/{id}/mapping-schemas/product Create or update the product mapping schema related to a catalog #

DELETE /api/rest/v1/catalogs/{id}/mapping-schemas/product Delete the product mapping schema related to a catalog #

Documentation

📖

Documentation

https://api.akeneo.com/api-reference-index.html

📖

GettingStarted

https://api.akeneo.com/getting-started.html

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/akeneo/refs/heads/main/openapi/akeneo-mapping-schema-for-products-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/akeneo:akeneo-mapping-schema-for-products-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Akeneo API REFERENCE Mapping schema for products API
  version: 1.0.0
  description: 'This is the reference documentation for the Akeneo PIM REST API.

    It provides detailed information about the available endpoints, request and response formats, and authentication methods.


    For more information, visit the Akeneo PIM documentation.'
  license:
    name: Open Software License 3.0
    url: http://opensource.org/licenses/OSL-3.0
  contact:
    name: Akeneo Support
    url: https://www.akeneo.com/support-help-center/
    email: contact@akeneo.com
servers:
- url: '{your-pim-url}'
  variables:
    your-pim-url:
      default: ''
      description: 'Set the PIM url you want to target ex: https://my-pim.cloud.akeneo.com or https://localhost:8443'
tags:


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akeneo/refs/heads/main/openapi/akeneo-mapping-schema-for-products-api-openapi.yml