Skip to main content

Akeneo

Use Akeneo to manage your Product Information Management (PIM) catalog. With these operations you can list, create, update, and delete products, product models, categories, attributes, families, reference entities, and more directly from your Boltic workflows.

Prerequisites​

To use Akeneo, you need:

  • An Akeneo PIM instance (Cloud or on-premise) with REST API access.
  • An Akeneo Connection (Connect > Connection settings) providing a Client ID, Secret, and an assigned user (username and password).

For the full API reference, visit the official Akeneo REST API Documentation.

Supported Authentication Methods​

  • OAuth 2.0 (password grant) using your Akeneo Connection credentials.

More details on authentication: Akeneo Authentication

Basic Operations​

Product​

  • List Products: Retrieve a paginated list of products.
  • Get a Product: Retrieve a single product by its UUID.
  • Create a Product: Create a new product.
  • Update a Product: Update (upsert) an existing product by its UUID.
  • Delete a Product: Delete a product by its UUID.

Product Model​

  • List Product Models: Retrieve a paginated list of product models.
  • Get a Product Model: Retrieve a single product model by its code.
  • Create a Product Model: Create a new product model.
  • Update a Product Model: Update (upsert) an existing product model.
  • Delete a Product Model: Delete a product model by its code.

Category​

  • List Categories: Retrieve a paginated list of categories.
  • Get a Category: Retrieve a single category by its code.
  • Create a Category: Create a new category.
  • Update a Category: Update (upsert) an existing category.

Attribute​

  • List Attributes: Retrieve a paginated list of attributes.
  • Get an Attribute: Retrieve a single attribute by its code.
  • Create an Attribute: Create a new attribute.
  • Update an Attribute: Update an existing attribute.

Attribute Option​

  • List Attribute Options: Retrieve the options of a select attribute.
  • Get an Attribute Option: Retrieve a single attribute option by its code.
  • Create an Attribute Option: Create a new attribute option.
  • Update an Attribute Option: Update an existing attribute option.

Attribute Group​

  • List Attribute Groups: Retrieve a paginated list of attribute groups.
  • Get an Attribute Group: Retrieve a single attribute group by its code.
  • Create an Attribute Group: Create a new attribute group.
  • Update an Attribute Group: Update an existing attribute group.

Family​

  • List Families: Retrieve a paginated list of families.
  • Get a Family: Retrieve a single family by its code.
  • Create a Family: Create a new family.
  • Update a Family: Update an existing family.
  • Delete a Family: Delete a family by its code.

Family Variant​

  • List Family Variants: Retrieve the variants of a family.
  • Get a Family Variant: Retrieve a single family variant by its code.
  • Create a Family Variant: Create a new family variant.
  • Update a Family Variant: Update an existing family variant.

Association Type​

  • List Association Types: Retrieve a paginated list of association types.
  • Get an Association Type: Retrieve a single association type by its code.
  • Create an Association Type: Create a new association type.
  • Update an Association Type: Update an existing association type.

Channel​

  • List Channels: Retrieve a paginated list of channels.
  • Get a Channel: Retrieve a single channel by its code.
  • Create a Channel: Create a new channel.
  • Update a Channel: Update an existing channel.

Locale​

  • List Locales: Retrieve a paginated list of locales.
  • Get a Locale: Retrieve a single locale by its code.

Currency​

  • List Currencies: Retrieve a paginated list of currencies.
  • Get a Currency: Retrieve a single currency by its code.

Measurement Family​

  • List Measurement Families: Retrieve a paginated list of measurement families.
  • Get a Measurement Family: Retrieve a single measurement family by its code.

Reference Entity​

  • List Reference Entities: Retrieve a paginated list of reference entities.
  • Get a Reference Entity: Retrieve a single reference entity by its code.
  • Update a Reference Entity: Create or update a reference entity.

Reference Entity Record​

  • List Reference Entity Records: Retrieve the records of a reference entity.
  • Get a Reference Entity Record: Retrieve a single record by its code.
  • Update a Reference Entity Record: Create or update a reference entity record.

Media File​

  • List Media Files: Retrieve a paginated list of product media files.
  • Get a Media File: Retrieve a single media file by its code.

Custom API​

  • Custom API: Run a custom Akeneo REST API request not covered by the other resources.

Further Reading​

For more information on the Akeneo API, refer to the official Akeneo REST API Documentation.