REST API reference
Complete reference on how to handle Akeneo PIM resources
Products
Product [uuid]
This API provides two endpoints for interacting with products:
- Product (UUID): We strongly recommend using this endpoint for its reliability and flexibility. UUIDs, or Universally Unique Identifiers, are guaranteed to be unique and never change, even if other product identifiers like SKUs are modified. This ensures consistent product identification regardless of future changes. Additionally, UUIDs allow interaction with products that lack a traditional identifier.
- Product (Identifier): This endpoint is useful when you already have a product identifier within your systems. This identifier, which could be a SKU or internal code, can be used to directly interact with the corresponding product in our API. This simplifies integration for workflows that rely on existing product identification methods.
Get list of products
get /api/rest/v1/products-uuid
Create a new product
post /api/rest/v1/products-uuid
Update/create several products
patch /api/rest/v1/products-uuid
Search list of products
post /api/rest/v1/products-uuid/search
Get a product
get /api/rest/v1/products-uuid/{uuid}
Update/create a product
patch /api/rest/v1/products-uuid/{uuid}
Delete a product
delete /api/rest/v1/products-uuid/{uuid}
Submit a draft for approval
post /api/rest/v1/products-uuid/{uuid}/proposal
Get a draft
get /api/rest/v1/products-uuid/{uuid}/draft
Product [identifier]
This API provides two endpoints for interacting with products:
- Product (UUID): We strongly recommend using this endpoint for its reliability and flexibility. UUIDs, or Universally Unique Identifiers, are guaranteed to be unique and never change, even if other product identifiers like SKUs are modified. This ensures consistent product identification regardless of future changes. Additionally, UUIDs allow interaction with products that lack a traditional identifier.
- Product (Identifier): This endpoint is useful when you already have a product identifier within your systems. This identifier, which could be a SKU or internal code, can be used to directly interact with the corresponding product in our API. This simplifies integration for workflows that rely on existing product identification methods.
Get list of products
get /api/rest/v1/products
Create a new product
post /api/rest/v1/products
Update/create several products
patch /api/rest/v1/products
Get a product
get /api/rest/v1/products/{code}
Update/create a product
patch /api/rest/v1/products/{code}
Delete a product
delete /api/rest/v1/products/{code}
Submit a draft for approval
post /api/rest/v1/products/{code}/proposal
Get a draft
get /api/rest/v1/products/{code}/draft
Product model
Get list of product models
get /api/rest/v1/product-models
Create a new product model
post /api/rest/v1/product-models
Update/create several product models
patch /api/rest/v1/product-models
Get a product model
get /api/rest/v1/product-models/{code}
Update/create a product model
patch /api/rest/v1/product-models/{code}
Delete a product model
delete /api/rest/v1/product-models/{code}
Submit a draft for approval
post /api/rest/v1/product-models/{code}/proposal
Get a draft
get /api/rest/v1/product-models/{code}/draft
Product media file
Get a list of product media files
get /api/rest/v1/media-files
Create a new product media file
post /api/rest/v1/media-files
Get a product media file
get /api/rest/v1/media-files/{code}
Download a product media file
get /api/rest/v1/media-files/{code}/download
Jobs
Jobs
Launch export job by code
post /api/rest/v1/jobs/export/{code}
Launch import job by code
post /api/rest/v1/jobs/import/{code}
Catalog structure
Family
Get list of families
get /api/rest/v1/families
Create a new family
post /api/rest/v1/families
Update/create several families
patch /api/rest/v1/families
Get a family
get /api/rest/v1/families/{code}
Update/create a family
patch /api/rest/v1/families/{code}
Family variant
Get list of family variants
get /api/rest/v1/families/{family_code}/variants
Create a new family variant
post /api/rest/v1/families/{family_code}/variants
Update/create several family variants
patch /api/rest/v1/families/{family_code}/variants
Get a family variant
get /api/rest/v1/families/{family_code}/variants/{code}
Update/create a family variant
patch /api/rest/v1/families/{family_code}/variants/{code}
Attribute
Get list of attributes
get /api/rest/v1/attributes
Create a new attribute
post /api/rest/v1/attributes
Update/create several attributes
patch /api/rest/v1/attributes
Get an attribute
get /api/rest/v1/attributes/{code}
Update/create an attribute
patch /api/rest/v1/attributes/{code}
Attribute option
Get list of attribute options
get /api/rest/v1/attributes/{attribute_code}/options
Create a new attribute option
post /api/rest/v1/attributes/{attribute_code}/options
Update/create several attribute options
patch /api/rest/v1/attributes/{attribute_code}/options
Get an attribute option
get /api/rest/v1/attributes/{attribute_code}/options/{code}
Update/create an attribute option
patch /api/rest/v1/attributes/{attribute_code}/options/{code}
Attribute group
Get list of attribute groups
get /api/rest/v1/attribute-groups
Create a new attribute group
post /api/rest/v1/attribute-groups
Update/create several attribute groups
patch /api/rest/v1/attribute-groups
Get an attribute group
get /api/rest/v1/attribute-groups/{code}
Update/create an attribute group
patch /api/rest/v1/attribute-groups/{code}
Association type
Get a list of association types
get /api/rest/v1/association-types
Create a new association type
post /api/rest/v1/association-types
Update/create several association types
patch /api/rest/v1/association-types
Get an association type
get /api/rest/v1/association-types/{code}
Update/create an association type
patch /api/rest/v1/association-types/{code}
Category
Get the list of categories
get /api/rest/v1/categories
Create a new category
post /api/rest/v1/categories
Create or update several categories
patch /api/rest/v1/categories
Get a category
get /api/rest/v1/categories/{code}
Create or update a category
patch /api/rest/v1/categories/{code}
Create a category media file
post /api/rest/v1/category-media-files
Download a category media file
get /api/rest/v1/category-media-files/{file_path}/download
Target market settings
Channel
Get a list of channels
get /api/rest/v1/channels
Create a new channel
post /api/rest/v1/channels
Update/create several channels
patch /api/rest/v1/channels
Get a channel
get /api/rest/v1/channels/{code}
Update/create a channel
patch /api/rest/v1/channels/{code}
Locale
Currency
Get a list of currencies
get /api/rest/v1/currencies
Get a currency
get /api/rest/v1/currencies/{code}
Measurement family
Get list of measurement families
get /api/rest/v1/measurement-families
Update/create several measurement families
patch /api/rest/v1/measurement-families
Reference entities
Reference entity
Get list of reference entities
get /api/rest/v1/reference-entities
Get a reference entity
get /api/rest/v1/reference-entities/{code}
Update/create a reference entity
patch /api/rest/v1/reference-entities/{code}
Reference entity attribute
Get the list of attributes of a given reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/attributes
Get an attribute of a given reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}
Update/create an attribute of a given reference entity
patch /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}
Reference entity attribute option
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
Get an attribute option for a given attribute of a given reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}
Update/create a reference entity attribute option
patch /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}
Reference entity record
Get the list of the records of a reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/records
Update/create several reference entity records
patch /api/rest/v1/reference-entities/{reference_entity_code}/records
Get a record of a given reference entity
get /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}
Update or create a record of a given reference entity
patch /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}
Reference entity media file
Create a new media file for a reference entity or a record
post /api/rest/v1/reference-entities-media-files
Download the media file associated to a reference entity or a record
get /api/rest/v1/reference-entities-media-files/{code}
Asset Manager
Asset family
Get list of asset families
get /api/rest/v1/asset-families
Get an asset family
get /api/rest/v1/asset-families/{code}
Update/create an asset family
patch /api/rest/v1/asset-families/{code}
Asset attribute
Get the list of attributes of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/attributes
Get an attribute of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}
Update/create an attribute of a given asset family
patch /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}
Asset attribute option
Get a list of attribute options of a given attribute for a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options
Get an attribute option for a given attribute of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}
Update/create an asset attribute option for a given asset family
patch /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}
Asset media file
Create a new media file for an asset
post /api/rest/v1/asset-media-files
Download the media file associated to an asset
get /api/rest/v1/asset-media-files/{code}
Asset
Get the list of the assets of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/assets
Update/create several assets
patch /api/rest/v1/asset-families/{asset_family_code}/assets
Get an asset of a given asset family
get /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
Update/create an asset
patch /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
Delete an asset
delete /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
Catalogs for Apps
Catalogs
Get the list of owned catalogs
get /api/rest/v1/catalogs
Create a new catalog
post /api/rest/v1/catalogs
Get a catalog
get /api/rest/v1/catalogs/{id}
Update a catalog
patch /api/rest/v1/catalogs/{id}
Delete a catalog
delete /api/rest/v1/catalogs/{id}
Duplicate a catalog
post /api/rest/v1/catalogs/{id}/duplicate
Catalog products
Get the list of product uuids
get /api/rest/v1/catalogs/{id}/product-uuids
Get the list of products related to a catalog
get /api/rest/v1/catalogs/{id}/products
Get a product related to a catalog
get /api/rest/v1/catalogs/{id}/products/{uuid}
Get the list of mapped flattened products or simple products related to a catalog
get /api/rest/v1/catalogs/{id}/mapped-products
Get the list of mapped models related to a catalog
get /api/rest/v1/catalogs/{id}/mapped-models
Get the list of mapped variants of a model related to a catalog
get /api/rest/v1/catalogs/{id}/mapped-models/{model_code}/variants
Mapping schema for products
Get the product mapping schema related to a catalog
get /api/rest/v1/catalogs/{id}/mapping-schemas/product
Create or update the product mapping schema related to a catalog
put /api/rest/v1/catalogs/{id}/mapping-schemas/product
Delete the product mapping schema related to a catalog
delete /api/rest/v1/catalogs/{id}/mapping-schemas/product
Utilities
Overview
Authentication
System
Extensions
UI Extensions
List UI extensions
get /api/rest/v1/ui-extensions
Create a new UI extension
post /api/rest/v1/ui-extensions
Update a UI extension
patch /api/rest/v1/ui-extensions/{uuid}
Delete a UI extension
delete /api/rest/v1/ui-extensions/{uuid}
Workflows
Workflows
Get list of workflows
get /api/rest/v1/workflows
Get a workflow
get /api/rest/v1/workflows/{uuid}
Get list of workflow step assignees
get /api/rest/v1/workflows/steps/{uuid}/assignees