Akeneo PIM REST API

GET

/api/rest/v1

Get list of all endpoints

POST

/api/oauth/v1/token

Get authentication token

GET

/api/rest/v1/assets

Get list of PAM assets

POST

/api/rest/v1/assets

Create a new PAM asset

PATCH

/api/rest/v1/assets

Update/create several PAM assets

GET

/api/rest/v1/locales

Get a list of locales

GET

/api/rest/v1/catalogs

Get the list of owned catalogs

POST

/api/rest/v1/catalogs

Create a new catalog

GET

/api/rest/v1/channels

Get a list of channels

POST

/api/rest/v1/channels

Create a new channel

PATCH

/api/rest/v1/channels

Update/create several channels

GET

/api/rest/v1/families

Get list of families

POST

/api/rest/v1/families

Create a new family

PATCH

/api/rest/v1/families

Update/create several families

GET

/api/rest/v1/products

Get list of products

POST

/api/rest/v1/products

Create a new product

PATCH

/api/rest/v1/products

Update/create several products

GET

/api/rest/v1/asset-tags

Get list of PAM asset tags

GET

/api/rest/v1/attributes

Get list of attributes

POST

/api/rest/v1/attributes

Create a new attribute

PATCH

/api/rest/v1/attributes

Update/create several attributes

GET

/api/rest/v1/categories

Get list of categories

POST

/api/rest/v1/categories

Create a new category

PATCH

/api/rest/v1/categories

Update/create several categories

GET

/api/rest/v1/currencies

Get a list of currencies

GET

/api/rest/v1/media-files

Get a list of product media files

POST

/api/rest/v1/media-files

Create a new product media 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/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/products-uuid

Get list of products

POST

/api/rest/v1/products-uuid

Create a new product

PATCH

/api/rest/v1/products-uuid

Update/create several products

GET

/api/rest/v1/asset-families

Get list of asset families

GET

/api/rest/v1/locales/{code}

Get a locale

GET

/api/rest/v1/product-models

Get list of product models

POST

/api/rest/v1/product-models

Create a new product model

PATCH

/api/rest/v1/product-models

Update/create several product models

GET

/api/rest/v1/channels/{code}

Get a channel

PATCH

/api/rest/v1/channels/{code}

Update/create a channel

GET

/api/rest/v1/families/{code}

Get a family

PATCH

/api/rest/v1/families/{code}

Update/create a family

GET

/api/rest/v1/products/{code}

Get a product

PATCH

/api/rest/v1/products/{code}

Update/create a product

DELETE

/api/rest/v1/products/{code}

Delete a product

GET

/api/rest/v1/asset-categories

Get list of PAM asset categories

POST

/api/rest/v1/asset-categories

Create a new PAM asset category

PATCH

/api/rest/v1/asset-categories

Update/create several PAM asset categories

GET

/api/rest/v1/attribute-groups

Get list of attribute groups

POST

/api/rest/v1/attribute-groups

Create a new attribute group

PATCH

/api/rest/v1/attribute-groups

Update/create several attribute groups

GET

/api/rest/v1/measure-families

Get list of measure familiy

POST

/api/rest/v1/asset-media-files

Create a new media file for an asset

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/association-types

Get a list of association types

POST

/api/rest/v1/association-types

Create a new association type

PATCH

/api/rest/v1/association-types

Update/create several association types

GET

/api/rest/v1/attributes/{code}

Get an attribute

PATCH

/api/rest/v1/attributes/{code}

Update/create an attribute

GET

/api/rest/v1/categories/{code}

Get a category

PATCH

/api/rest/v1/categories/{code}

Update/create a category

GET

/api/rest/v1/currencies/{code}

Get a currency

GET

/api/rest/v1/media-files/{code}

Get a product media file

GET

/api/rest/v1/published-products

Get list of published products

GET

/api/rest/v1/reference-entities

Get list of reference entities

GET

/api/rest/v1/system-information

Get system information

GET

/api/rest/v1/measurement-families

Get list of measurement families

PATCH

/api/rest/v1/measurement-families

Update/create several measurement families

GET

/api/rest/v1/products-uuid/{uuid}

Get a product

PATCH

/api/rest/v1/products-uuid/{uuid}

Update/create a product

DELETE

/api/rest/v1/products-uuid/{uuid}

Delete a product

GET

/api/rest/v1/asset-families/{code}

Get an asset family

PATCH

/api/rest/v1/asset-families/{code}

Update/create an asset family

GET

/api/rest/v1/product-models/{code}

Get a product model

PATCH

/api/rest/v1/product-models/{code}

Update/create a product model

DELETE

/api/rest/v1/product-models/{code}

Delete a product model

GET

/api/rest/v1/products/{code}/draft

Get a draft

GET

/api/rest/v1/catalogs/{id}/products

Get the list of products related to a catalog

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/attribute-groups/{code}

Get an attribute group

PATCH

/api/rest/v1/attribute-groups/{code}

Update/create an attribute group

GET

/api/rest/v1/measure-families/{code}

Get a measure family

GET

/api/rest/v1/asset-media-files/{code}

Download the media file associated to an asset

GET

/api/rest/v1/association-types/{code}

Get an association type

PATCH

/api/rest/v1/association-types/{code}

Update/create an association type

POST

/api/rest/v1/products/{code}/proposal

Submit a draft for approval

GET

/api/rest/v1/published-products/{code}

Get a published product

GET

/api/rest/v1/reference-entities/{code}

Get a reference entity

PATCH

/api/rest/v1/reference-entities/{code}

Update/create a reference entity

GET

/api/rest/v1/products-uuid/{uuid}/draft

Get a draft

GET

/api/rest/v1/catalogs/{id}/product-uuids

Get the list of product uuids

GET

/api/rest/v1/media-files/{code}/download

Download a product media file

GET

/api/rest/v1/product-models/{code}/draft

Get a draft

GET

/api/rest/v1/catalogs/{id}/products/{uuid}

Get a product related to a catalog

POST

/api/rest/v1/products-uuid/{uuid}/proposal

Submit a draft for approval

POST

/api/rest/v1/product-models/{code}/proposal

Submit a draft for approval

POST

/api/rest/v1/reference-entities-media-files

Create a new media file for a reference entity or a record

GET

/api/rest/v1/families/{family_code}/variants

Get list of family variants

POST

/api/rest/v1/families/{family_code}/variants

Create a new family variant

PATCH

/api/rest/v1/families/{family_code}/variants

Update/create several family variants

GET

/api/rest/v1/attributes/{attribute_code}/options

Get list of attribute options

POST

/api/rest/v1/attributes/{attribute_code}/options

Create a new attribute option

PATCH

/api/rest/v1/attributes/{attribute_code}/options

Update/create several attribute options

GET

/api/rest/v1/category-media-files/{code}/download

Download a category media file [COMING SOON]

GET

/api/rest/v1/reference-entities-media-files/{code}

Download the media file associated to a reference entity or a record

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/asset-families/{asset_family_code}/assets

Get the list of the assets of a given asset family

PATCH

/api/rest/v1/asset-families/{asset_family_code}/assets

Update/create several assets

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/asset-families/{asset_family_code}/attributes

Get the list of attributes of a given asset family

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/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/reference-entities/{reference_entity_code}/records

Get the list of the records of a reference entity

PATCH

/api/rest/v1/reference-entities/{reference_entity_code}/records

Update/create several reference entity records

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/reference-entities/{reference_entity_code}/attributes

Get the list of attributes of a given reference entity

GET

/api/rest/v1/reference-entities/{reference_entity_code}/records/{code}

Get a record of a given reference entity

PATCH

/api/rest/v1/reference-entities/{reference_entity_code}/records/{code}

Update/create a record of a given reference entity

GET

/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/download

Download a reference file

GET

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}

Get an attribute of a given reference entity

PATCH

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}

Update/create an attribute of a given reference entity

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/asset-families/{asset_family_code}/attributes/{attribute_code}/options

Get a list of attribute options of a given attribute for a given asset family

GET

/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/download

Download a variation file

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/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options

Get a list of attribute options of a given attribute for a given reference entity

GET

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}

Get an attribute option for a given attribute of a given reference entity

PATCH

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}

Update/create a reference entity attribute option

Endpoints

Akeneo PIM REST API

Endpoints

Akeneo PIM REST API

Endpoints

Akeneo PIM REST API

Endpoints