Akeneo API Endpoints
This integration connects to Akeneo PIM through Akeneo's REST API to read product information from your catalog and transfer it into iPaaS.com. Akeneo is the source system; the integration pulls records and never writes back to Akeneo (it is Add/Update only on the iPaaS.com side, and outbound delete is not supported).
Every endpoint below is called against the base URL you supply in the API Url subscription setting. In the URL patterns, [Base URL] stands for that value (for example, https://your-company.cloud.akeneo.com). The connector authenticates to Akeneo's REST API with your configured credentials to obtain an access token, then includes that token on each request.
Product reads are routed by the Akeneo Product ID Format setting. This subscription setting has two options:
UUID — product reads use the UUID endpoint (
[Base URL]/api/rest/v1/products-uuid/{uuid}). This is the default for current Akeneo catalogs.Identifier — product reads use the identifier endpoint (
[Base URL]/api/rest/v1/products/{identifier}). Use this for older Akeneo versions or catalogs that do not use UUIDs.
Variant (product model) reads always use the product-models endpoint regardless of the format setting. See Connections and Settings for how to configure the Akeneo Product ID Format, and Known Limitations for the version-dependence this setting addresses.
For the full Akeneo REST API reference, see the Akeneo developer documentation: https://api.akeneo.com/api-reference-paas-index-70.html
Table of Contents
Products
Products are transferred TO iPaaS.com from Akeneo. The integration polls for products changed since the last poll timestamp (incremental) and retrieves each product's full record. Standalone variant transfer is not supported — variants transfer only as children of their base product.
Poll Products (GET)
Retrieves products updated since the last poll timestamp. Pagination uses Akeneo's search-after cursor at 100 records per page.
GET [Base URL]/api/rest/v1/products?with_count=true&search={"updated":[{"operator":">","value":"{lastModifiedDT}"}]}&pagination_type=search_after&limit=100Get Product by UUID (GET)
Used when the Akeneo Product ID Format setting is UUID. Retrieves a single product's full record by its UUID.
GET [Base URL]/api/rest/v1/products-uuid/{uuid}Get Product by Identifier (GET)
Used when the Akeneo Product ID Format setting is Identifier. Retrieves a single product's full record by its identifier (SKU).
GET [Base URL]/api/rest/v1/products/{identifier}The product record returned by these endpoints supplies the child data the integration derives during transfer — option values, inventory (per location, from the values object), units, related products, and bundles/kits (from the product's associations and quantified associations).
Product Models (Variants)
Variant products in Akeneo are represented as product models. They are retrieved as children of their base product.
Get Product Model (GET)
Retrieves a single product model (variant) by its code.
GET [Base URL]/api/rest/v1/product-models/{id}Product Categories
Product Categories are transferred TO iPaaS.com. They support scheduled polling and a one-time bulk initialization that preserves parent ordering. Category attributes (enriched attributes) can be mapped to iPaaS.com custom fields.
Poll Product Categories (GET)
Retrieves categories updated since the last poll timestamp. Pagination is page-based at 100 records per page.
GET [Base URL]/api/rest/v1/categories?with_position=true&with_count=true&search={"updated":[{"operator":">","value":"{lastModifiedDT}"}]}&pagination_type=page&page={page}&limit=100Get Product Category (GET)
Retrieves a single category by its code, including position and enriched (mappable) category attributes.
GET [Base URL]/api/rest/v1/categories/{id}?with_position=true&with_enriched_attributes=trueAttributes
Attribute definitions back the option and custom-field data the integration resolves during product transfer.
List Attributes (GET)
Retrieves all attribute definitions, page by page at 100 records per page.
GET [Base URL]/api/rest/v1/attributes?pagination_type=page&page={page}&limit=100Get Attribute (GET)
Retrieves a single attribute definition by its code.
GET [Base URL]/api/rest/v1/attributes/{id}Attribute Options
Attribute options supply the selectable values for simple-select and multi-select attributes, and underpin Location and option-value resolution.
List Attribute Options (GET)
Retrieves all options for a given attribute, page by page at 100 records per page.
GET [Base URL]/api/rest/v1/attributes/{attribute_code}/options?with_position=true&pagination_type=page&page={page}&limit=100Get Attribute Option (GET)
Retrieves a single attribute option by its attribute code and option code.
GET [Base URL]/api/rest/v1/attributes/{attribute_code}/options/{option_code}Family Variants
Family variants define the axes and attributes that distinguish a base product's variants.
Get Family Variant (GET)
Retrieves a variant definition for a family by family code and variant code.
GET [Base URL]/api/rest/v1/families/{family_code}/variants/{variant_code}Reference Entities
Reference entity records supply data for Reference Entity attributes, which subscribers can map to iPaaS.com custom fields (both single values and collections with an integer suffix).
List Reference Entity Records (GET)
Retrieves the records for a reference entity. This endpoint returns a cursor for the next page when more records are available.
GET [Base URL]/api/rest/v1/reference-entities/{reference_entity_code}/recordsGet Reference Entity Record (GET)
Retrieves a single reference entity record by its reference entity code and record code.
GET [Base URL]/api/rest/v1/reference-entities/{reference_entity_code}/records/{record_code}Asset Families
Asset family assets supply media and asset attribute values referenced by products.
Get Asset Family Asset (GET)
Retrieves a single asset from an asset family by its asset family code and asset code.
GET [Base URL]/api/rest/v1/asset-families/{asset_family_code}/assets/{asset_code}Authorization Endpoint
The integration authenticates to Akeneo's REST API to obtain an access token before making any data request. The token request is made against your API Url base URL.
Request Access Token (POST)
Exchanges your configured credentials for an access token. The connector sends the request as application/x-www-form-urlencoded with the client id and client secret supplied as HTTP Basic authentication. It uses the password grant on the initial request and the refresh_token grant to renew an expiring token.
POST [Base URL]/api/oauth/v1/token
Related Documents