Available Akeneo APIs

Tanisha Ray

Updated November 25, 2024 20:33

When you configure an export, import, or other type of flow step using the prebuilt Akeneo connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Akeneo API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Product [identifier]	Get list of products	X
	Get a product	X
	Get a draft	X
	Create a new product		X
	Update/Create several products		X
	Update a product		X
	Delete a product		X
	Submit a draft for approval		X
	Update a product		X
	Delete a product		X
	Get a draft	X
	Get a product model	X
Product [uuid]	Get list of products	X
	Get a product	X
	Create a new product		X
	Update/Create several products		X
	Delete a product		X
	Submit a draft for approval		X
Product model	Get list of product models	X
	Get a draft	X
	Create new product model		X
	Submit a draft for approval		X
Product media file	Get a list of product media files	X
Product media file	Get a product media file	X
Published product	Get list of published products	X
Published product	Get a published product	X
Catalog structure	Get list of families	X
	Get a family	X
	Get list of family variants	X
	Get a family variant	X
	Attribute: Get list of attributes	X
	Get an attribute	X
	Attribute option: Get list of attributes options	X
	Attribute option: Get an attribute option	X
	Attribute group: Get list of attributes groups	X
	Attribute group: Get an attribute group	X
	Association types: Get list of association types	X
	Association types: Get an association type	X
	Category: Get list of categories	X
	Category: Get a category	X
	Update/create a family variant		X
	Create a new attribute option		X
	Update/create an association type		X
	Create an association type		X
Target market settings	Channel: Get list of channels	X
	Channel: Get a channel	X
	Locale: Get list of locales	X
	Locale: Get a locale	X
	Currency: Get list of currencies	X
	Currency: Get a currency	X
	Measure family: Get list of measure family	X
	Measure family: Get a measure family	X
	Measurement family: Get list of measurement family	X
	Channel: Create a new channel		X
	Channel: Update a channel		X
	Measurement family: Update/create several measurement families		X
Reference entities	Reference entity: Get list of reference entity	X
	Reference entity: Get a reference entity	X
	Reference entity attribute: Get list of reference entity attribute	X
	Reference entity attribute: Get a reference entity attribute	X
	Reference entity record: Get the list of the records of a reference entity	X
	Reference entity record: Get a record of a given reference entity	X
	Reference entity: Update/Create a reference entity		X
	Update/create a reference entity attribute option		X
	Reference entity : Update/create an attribute of a given reference entity		X
	Reference entity attribute option:Get a list of attribute options of a given attribute for a given reference entity	X
	Reference entity attribute option:Get an attribute options of a given attribute for a given reference entity	X
	Update/create a record of a given reference entity		X
Asset manager	Asset family:Get list of asset families	X
	Asset family: Get an asset family	X
	Asset family: Get the list of attributes of a given asset family	X
	Asset family: Get an attribute of a given asset family	X
	Asset family: Get an asset of a given asset family	X
	Asset family: Get the list of the assets of a given asset family	X
	Asset family: Get a list of attribute options of a given attribute for a given asset family	X
	Asset family: Get an attribute option of a given attribute for a given asset family	X
	Asset: Update/create an asset		X
	Delete an asset		X
	Update/create an asset family		X
	Update/create an asset attribute option for a given asset family		X
	Asset attribute: Update/create an attribute of a given asset family		X
Catalogs	Get a catalog	X
	Get the list of owned catalogs	X
	Catalog products: Get a product related to a catalog	X
	Catalog products: Get the list of product uuids	X
	Catalog products: Get the list of products related to a catalog	X
	Catalog products: Get the list of mapped products related to a catalog	X
	Mapping schema for products: Get the product mapping schema related to a catalog	X
	Create a new catalog		X
	Update a catalog		X
	Delete a catalog		X
	Mapping schema for products: Create or update the product mapping schema related to a catalog		X
	Mapping schema for products: Delete the product mapping schema related to a catalog		X
Catalog structure	Create a new family		X
	Create a new family variant		X
	Update a family		X
	Category: Create a new category		X
	Category: Update a new category		X
	Attribute: Create a new attribute		X
	Attribute: Update a new attribute		X
	Attribute group: Update/create an attribute group		X
	Attribute option: Update/create an attribute option		X