Skip to content

Akeneo PIM REST API API

by akeneo.com

No authHTTPSBusiness
Open documentation ↗

Overview

Transform your e-commerce strategy with Akeneo, the leader in Product Experience Management (PXM) and PIM solutions. Centralize, enrich, and syndicate product data to deliver consistent omnichannel experiences that drive sales.

Akeneo PIM REST API is a business API from akeneo.com. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 140 endpoints.

At a glance

Authentication
No auth
HTTPS
Yes
CORS
Unknown
Category
Business
Base URL
http://demo.akeneo.com
Version
1.0.0
Endpoints
140
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "http://demo.akeneo.com/api/rest/v1" \
  -H "Accept: application/json"
JavaScript
const response = await fetch("http://demo.akeneo.com/api/rest/v1", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "http://demo.akeneo.com/api/rest/v1",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/api/oauth/v1/tokenGet authentication token
GET/api/rest/v1Get list of all endpoints
GET/api/rest/v1/asset-categoriesGet list of PAM asset categories
POST/api/rest/v1/asset-categoriesCreate a new PAM asset category
PATCH/api/rest/v1/asset-categoriesUpdate/create several PAM asset categories
GET/api/rest/v1/asset-categories/{code}Get a PAM asset category
PATCH/api/rest/v1/asset-categories/{code}Update/create a PAM asset category
GET/api/rest/v1/asset-familiesGet list of asset families
GET/api/rest/v1/asset-families/{asset_family_code}/assetsGet the list of the assets of a given asset family
PATCH/api/rest/v1/asset-families/{asset_family_code}/assetsUpdate/create several assets
GET/api/rest/v1/asset-families/{asset_family_code}/assets/{code}Get an asset of a given asset family
PATCH/api/rest/v1/asset-families/{asset_family_code}/assets/{code}Update/create an asset
DELETE/api/rest/v1/asset-families/{asset_family_code}/assets/{code}Delete an asset
GET/api/rest/v1/asset-families/{asset_family_code}/attributesGet the list of attributes of a given asset family
GET/api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/optionsGet a list of attribute options of a given attribute for a given asset family
GET/api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}Get an attribute option for a given attribute of a given asset family
PATCH/api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}Update/create an asset attribute option for a given asset family
GET/api/rest/v1/asset-families/{asset_family_code}/attributes/{code}Get an attribute of a given asset family
PATCH/api/rest/v1/asset-families/{asset_family_code}/attributes/{code}Update/create an attribute of a given asset family
GET/api/rest/v1/asset-families/{code}Get an asset family
PATCH/api/rest/v1/asset-families/{code}Update/create an asset family
POST/api/rest/v1/asset-media-filesCreate a new media file for an asset
GET/api/rest/v1/asset-media-files/{code}Download the media file associated to an asset
GET/api/rest/v1/asset-tagsGet list of PAM asset tags
GET/api/rest/v1/asset-tags/{code}Get a PAM asset tag
PATCH/api/rest/v1/asset-tags/{code}Update/create a PAM asset tag
GET/api/rest/v1/assetsGet list of PAM assets
POST/api/rest/v1/assetsCreate a new PAM asset
PATCH/api/rest/v1/assetsUpdate/create several PAM assets
GET/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}Get a reference file
POST/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}Upload a new reference file
GET/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/downloadDownload a reference file
GET/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}Get a variation file
POST/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}Upload a new variation file
GET/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/downloadDownload a variation file
GET/api/rest/v1/assets/{code}Get a PAM asset
PATCH/api/rest/v1/assets/{code}Update/create a PAM asset
GET/api/rest/v1/association-typesGet a list of association types
POST/api/rest/v1/association-typesCreate a new association type
PATCH/api/rest/v1/association-typesUpdate/create several association types
GET/api/rest/v1/association-types/{code}Get an association type
PATCH/api/rest/v1/association-types/{code}Update/create an association type
GET/api/rest/v1/attribute-groupsGet list of attribute groups
POST/api/rest/v1/attribute-groupsCreate a new attribute group
PATCH/api/rest/v1/attribute-groupsUpdate/create several attribute groups
GET/api/rest/v1/attribute-groups/{code}Get an attribute group
PATCH/api/rest/v1/attribute-groups/{code}Update/create an attribute group
GET/api/rest/v1/attributesGet list of attributes
POST/api/rest/v1/attributesCreate a new attribute
PATCH/api/rest/v1/attributesUpdate/create several attributes
GET/api/rest/v1/attributes/{attribute_code}/optionsGet list of attribute options
POST/api/rest/v1/attributes/{attribute_code}/optionsCreate a new attribute option
PATCH/api/rest/v1/attributes/{attribute_code}/optionsUpdate/create several attribute options
GET/api/rest/v1/attributes/{attribute_code}/options/{code}Get an attribute option
PATCH/api/rest/v1/attributes/{attribute_code}/options/{code}Update/create an attribute option
GET/api/rest/v1/attributes/{code}Get an attribute
PATCH/api/rest/v1/attributes/{code}Update/create an attribute
GET/api/rest/v1/catalogsGet the list of owned catalogs
POST/api/rest/v1/catalogsCreate a new catalog
GET/api/rest/v1/catalogs/{id}Get a catalog
PATCH/api/rest/v1/catalogs/{id}Update a catalog
DELETE/api/rest/v1/catalogs/{id}Delete a catalog
GET/api/rest/v1/catalogs/{id}/product-uuidsGet the list of product uuids
GET/api/rest/v1/catalogs/{id}/productsGet the list of products related to a catalog
GET/api/rest/v1/catalogs/{id}/products/{uuid}Get a product related to a catalog
GET/api/rest/v1/categoriesGet list of categories
POST/api/rest/v1/categoriesCreate a new category
PATCH/api/rest/v1/categoriesUpdate/create several categories
GET/api/rest/v1/categories/{code}Get a category
PATCH/api/rest/v1/categories/{code}Update/create a category
GET/api/rest/v1/category-media-files/{code}/downloadDownload a category media file [COMING SOON]
GET/api/rest/v1/channelsGet a list of channels
POST/api/rest/v1/channelsCreate a new channel
PATCH/api/rest/v1/channelsUpdate/create several channels
GET/api/rest/v1/channels/{code}Get a channel
PATCH/api/rest/v1/channels/{code}Update/create a channel
GET/api/rest/v1/currenciesGet a list of currencies
GET/api/rest/v1/currencies/{code}Get a currency
GET/api/rest/v1/familiesGet list of families
POST/api/rest/v1/familiesCreate a new family
PATCH/api/rest/v1/familiesUpdate/create several families
GET/api/rest/v1/families/{code}Get a family
PATCH/api/rest/v1/families/{code}Update/create a family
GET/api/rest/v1/families/{family_code}/variantsGet list of family variants
POST/api/rest/v1/families/{family_code}/variantsCreate a new family variant
PATCH/api/rest/v1/families/{family_code}/variantsUpdate/create several family variants
GET/api/rest/v1/families/{family_code}/variants/{code}Get a family variant
PATCH/api/rest/v1/families/{family_code}/variants/{code}Update/create a family variant
GET/api/rest/v1/localesGet a list of locales
GET/api/rest/v1/locales/{code}Get a locale
GET/api/rest/v1/measure-familiesGet list of measure familiy
GET/api/rest/v1/measure-families/{code}Get a measure family
GET/api/rest/v1/measurement-familiesGet list of measurement families
PATCH/api/rest/v1/measurement-familiesUpdate/create several measurement families
GET/api/rest/v1/media-filesGet a list of product media files
POST/api/rest/v1/media-filesCreate a new product media file
GET/api/rest/v1/media-files/{code}Get a product media file
GET/api/rest/v1/media-files/{code}/downloadDownload a product media file
GET/api/rest/v1/product-modelsGet list of product models
POST/api/rest/v1/product-modelsCreate a new product model

Showing the first 100 of 140 endpoints; the full list is in the documentation.

Questions

Does the Akeneo PIM REST API API need an API key?

No. The Akeneo PIM REST API API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the Akeneo PIM REST API API support HTTPS?

Yes, the Akeneo PIM REST API API is served over HTTPS.

How many endpoints does the Akeneo PIM REST API API have?

Its OpenAPI description lists 140 endpoints in version 1.0.0. The first 100 are shown on this page.

What are alternatives to the Akeneo PIM REST API API?

Other Business APIs include Gmail, Google Analytics, Apache Superset, Trello, Square.

Compare alternatives →

Listed from APIs.guru (CC0).