Akeneo PIM Data Source

Akeneo PIM centralizes, enriches, and distributes product data across commerce channels. Follow the instructions below to create a new data flow that ingests data from an Akeneo PIM source in Nexla.

Akeneo PIM

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the Akeneo PIM connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Akeneo PIM instance, and click Next; or, create a new Akeneo PIM credential for use in this flow.

3. In Nexla, Akeneo PIM data sources can be created using pre-built endpoint templates, which expedite source setup for common Akeneo PIM endpoints. Each template is designed specifically for the corresponding Akeneo PIM endpoint, making source configuration easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   Akeneo PIM sources can also be configured manually, allowing you to ingest data from Akeneo PIM endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Akeneo PIM endpoints. Each template is designed specifically for the corresponding Akeneo PIM endpoint, making data source setup easy and efficient.

Endpoint Settings

• Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

  Get a product

  This endpoint retrieves a single product by its UUID. Use it to enrich an existing dataset of product UUIDs with the latest Akeneo product details, or to drive downstream lookups against the canonical product catalog.

  • Enter the product UUID in the Product UUID field. This field is required. Product UUIDs are returned by the Akeneo products list endpoints and are the recommended product identifier going forward.
  • The response is a single product object — the path to data is set to the response root, so the product is treated as the record.

  Akeneo recommends UUID-based product endpoints over the legacy code-based endpoints because product identifiers can change but UUIDs are stable for the lifetime of the product. For full payload reference, see the Akeneo products UUID API documentation.

  Get Product by Code

  This endpoint retrieves a single product by its product code (the legacy product identifier). Use it when an upstream system stores Akeneo product codes rather than UUIDs.

  • Enter the product code in the Product Code field. This field is required. Product codes are the human-readable product identifiers used by the legacy products endpoint.
  • The response is a single product object — the path to data is set to the response root.

  Akeneo is migrating product endpoints from code-based identifiers to UUID-based identifiers. When possible, use the Get a product endpoint with UUIDs instead.

  List product models

  This endpoint returns all product models in the PIM. Product models group product variants that share common attributes (for example, all colorways and sizes of a single t-shirt design). Use it to sync the product model catalog into a warehouse or downstream system.

  • No configuration is required for this endpoint beyond selecting it. All product models accessible to the credential are returned automatically.
  • The endpoint is paginated. Nexla advances the page query parameter automatically with a page size of 100 and stops when an empty page is returned.

  Product models are the parent records for variant products in Akeneo. Pair this endpoint with a products source to assemble the full hierarchy of models and variants.

  Get a product model

  This endpoint retrieves a single product model by its code. Use it to enrich an existing dataset of product model codes with the full Akeneo record.

  • Enter the product model code in the Product Model Code field. This field is required. Product model codes can be obtained from the List product models endpoint.
  • The response is a single product model object — the path to data is set to the response root.

  List Attributes

  This endpoint returns all attributes defined in the Akeneo PIM — the fields that products and product models can carry, including their data type, scope (channel-aware), locale-awareness, and validation rules. Use it as a reference dataset for mapping product fields downstream.

  • No configuration is required for this endpoint beyond selecting it. All attributes defined in the PIM are returned automatically.
  • The endpoint is paginated. Nexla advances the page query parameter automatically with a page size of 100 and stops when an empty page is returned.

  Attributes describe the structure of the Akeneo catalog. Combine this endpoint with the Get an Attribute Group endpoint to group attributes into the logical sections used in the PIM UI.

  List Categories

  This endpoint returns all product categories in the Akeneo catalog. Categories form the merchandising tree used to organize products for each channel. Use it to sync the category tree into a warehouse or downstream commerce system.

  • No configuration is required for this endpoint beyond selecting it. All categories accessible to the credential are returned automatically.
  • The endpoint is paginated. Nexla advances the page query parameter automatically with a page size of 100 and stops when an empty page is returned.

  Get Category

  This endpoint retrieves a single category by its code. Use it to fetch the full record for a specific category — including its parent, position, and labels.

  • Enter the category code in the Category Code field. This field is required. Category codes can be obtained from the List Categories endpoint.
  • The response is a single category object — the path to data is set to the response root.

  List Channels

  This endpoint returns all sales channels configured in the Akeneo PIM. Channels define the locales, currencies, and category trees that products are projected onto when published — for example, "ecommerce", "print", or "mobile". Use it as a reference dataset for channel-aware product exports.

  • No configuration is required for this endpoint beyond selecting it. All channels configured in the PIM are returned automatically.
  • The endpoint is paginated. Nexla advances the page query parameter automatically with a page size of 100 and stops when an empty page is returned.

  Channel codes are required by other endpoints (and by the Akeneo product API itself) when filtering product values by channel scope.

  Get Channel

  This endpoint retrieves a single channel by its code. Use it to inspect the locales, currencies, and category tree configured for a specific channel.

  • Enter the channel code in the Channel Code field. This field is required. Channel codes can be obtained from the List Channels endpoint.
  • The response is a single channel object — the path to data is set to the response root.

  Get Catalog

  This endpoint retrieves the metadata for a single Akeneo App catalog by its catalog ID. Akeneo App catalogs scope the subset of products that a Connected App is allowed to read from the PIM.

  • Enter the catalog ID in the Catalog ID field. This field is required. Catalog IDs are returned when the catalog is created and are managed under the Connected App's settings.
  • The response is a single catalog object — the path to data is set to the response root.

  Akeneo App catalogs are a separate concept from the merchandising category tree returned by the List Categories endpoint.

  Get a Family

  This endpoint retrieves a single family by its code. Families define the set of attributes that a product carries (for example, "tshirt", "shoe", "book"), the required attributes per channel, and the family variants used for product models.

  • Enter the family code in the Family Code field. This field is required. Family codes are managed under Settings > Families in the Akeneo PIM.
  • The response is a single family object — the path to data is set to the response root.

  Get a Family Variant

  This endpoint retrieves a single family variant by family code and variant code. Family variants define the variant axes (for example, color and size) that drive how products are grouped under a product model.

  • Enter the parent family code in the Family Code field. This field is required.
  • Enter the family variant code in the Variant Code field. This field is required.
  • The response is a single family variant object — the path to data is set to the response root.

  Family variant codes are unique within a family but not globally — the family code is required to disambiguate them.

  Get an Attribute Group

  This endpoint retrieves a single attribute group by its code. Attribute groups organize attributes into the sections shown on the product edit page in the Akeneo PIM (for example, "Marketing", "Technical", "SEO").

  • Enter the attribute group code in the Attribute Group Code field. This field is required. Attribute group codes are managed under Settings > Attribute groups in the Akeneo PIM.
  • The response is a single attribute group object — the path to data is set to the response root.

  Get an Association Type

  This endpoint retrieves a single association type by its code. Association types define the relationships between products and product models — for example, "X-SELL", "UPSELL", or "SUBSTITUTION".

  • Enter the association type code in the Association Type Code field. This field is required. Association type codes are managed under Settings > Association types in the Akeneo PIM.
  • The response is a single association type object — the path to data is set to the response root.

  List Asset Families

  This endpoint returns all asset families configured in the Akeneo PIM. Asset families define the structure of rich media assets — images, videos, documents — that can be attached to products. Use it to sync the asset family catalog into a downstream DAM or commerce system.

  • No configuration is required for this endpoint beyond selecting it. All asset families accessible to the credential are returned automatically.
  • This endpoint uses Akeneo's HAL-style next-link pagination — Nexla advances through pages by following the $._links.next.href link in each response and stops when no next link is present.

  Asset families are part of the Akeneo Asset Manager feature. The set of asset families available depends on the Akeneo edition and the scopes granted to the Connected App.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Akeneo PIM data sources can be manually configured to ingest data from any valid Akeneo PIM API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates — for example, the products list endpoint with custom search filters, locale and channel scopes, or attribute filters.

With manual configuration, you can also create more complex Akeneo PIM sources, such as sources that chain calls to multiple endpoints — for example, listing products and then fetching the family record for each.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the Akeneo PIM API from the Method pulldown menu. Akeneo read endpoints use GET:

   • GET: For retrieving data from the API (list and get endpoints)
   • POST: For sending data to the API or triggering actions
   • PATCH: For updating or upserting existing data
   • DELETE: For removing data

API Endpoint URL

3. Enter the URL of the Akeneo PIM API endpoint from which this source will fetch data in the Set API URL field. All Akeneo PIM API URLs use your instance Base URL followed by /api/rest/v1/ and the resource path (for example, https://my-company.cloud.akeneo.com/api/rest/v1/products-uuid).

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. Akeneo enforces the OAuth scopes granted to the Connected App on every call, so 403 responses typically indicate a missing scope rather than a malformed URL.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. They are particularly useful for the Akeneo products endpoints, which support a search query parameter that can filter on updated timestamps.

Macros are particularly useful for APIs that require date ranges or other dynamic values that change between data ingestion runs. For example, use {now-1} with a Day time unit to fetch only the products updated in the last 24 hours on each run.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime

   • {now-1} – The datetime one time unit before the current datetime

   • {now+1} – The datetime one time unit after the current datetime

   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. Akeneo's updated search operator expects timestamps in the ISO 8601 format YYYY-MM-DD HH:MM:SS, so the selected format must match.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that adapt based on existing data. For Akeneo PIM, this is useful when you have a Nexla dataset of product UUIDs, product codes, or category codes and want to fetch the related record for each.

Lookup-based macros are useful when you need to create Akeneo PIM URLs that reference specific IDs from another data source — for example, fetching the full product detail for each UUID returned by a List Products source.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data returned by an Akeneo PIM endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) by specifying the path to the relevant data within the response.

Akeneo list endpoints (such as /products-uuid, /product-models, /categories, /channels) wrap result records in a HAL envelope under _embedded.items, so the path to data is $._embedded.items[*]. Endpoints that return a single object (such as /products-uuid/{'{uuid}'}) use $ to treat the entire response body as a single record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (for example, $._embedded.items[*] to access every item in an Akeneo list response).
  Path to Data Example:

  For an Akeneo PIM list endpoint that returns a HAL envelope (for example, GET /api/rest/v1/products-uuid), enter $._embedded.items[*] as the path to data. For an endpoint that returns a single object (for example, GET /api/rest/v1/products-uuid/{'{uuid}'}), enter $.

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful for Akeneo list endpoints because the HAL envelope returned by Akeneo includes _links (with first, self, and next hrefs) and pagination metadata alongside the embedded items.

Metadata paths are particularly useful for preserving Akeneo HAL pagination context (_links.next.href, _links.first.href) or request timestamps with each record.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata (for example, $._links to capture the HAL link object).

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (for example, header1:value1,header2:value2).

  You do not need to include any headers already present in the credentials. The Authorization: Bearer header is added automatically based on your Akeneo PIM credential's OAuth access token, and Nexla refreshes the token before expiration.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Akeneo PIM data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.