Akeneo PIM REST API

API version: 1.0.0

Auth

ApiKey Authorization in header

Base URL

http://demo.akeneo.com

Setup

1. Set your API key in the appropriate header
2. GET /api/rest/v1/products-uuid -- verify access
3. POST /api/rest/v1/products-uuid -- create first products-uuid

Endpoints

137 endpoints across 1 groups. See references/api-spec.lap for full details.

api

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Search products-uuid?" -> GET /api/rest/v1/products-uuid
• "Create a products-uuid?" -> POST /api/rest/v1/products-uuid
• "Create a search?" -> POST /api/rest/v1/products-uuid/search
• "Get products-uuid details?" -> GET /api/rest/v1/products-uuid/{uuid}
• "Partially update a products-uuid?" -> PATCH /api/rest/v1/products-uuid/{uuid}
• "Delete a products-uuid?" -> DELETE /api/rest/v1/products-uuid/{uuid}
• "Create a proposal?" -> POST /api/rest/v1/products-uuid/{uuid}/proposal
• "List all draft?" -> GET /api/rest/v1/products-uuid/{uuid}/draft
• "Search products?" -> GET /api/rest/v1/products
• "Create a product?" -> POST /api/rest/v1/products
• "Get product details?" -> GET /api/rest/v1/products/{code}
• "Partially update a product?" -> PATCH /api/rest/v1/products/{code}
• "Delete a product?" -> DELETE /api/rest/v1/products/{code}
• "Create a proposal?" -> POST /api/rest/v1/products/{code}/proposal
• "List all draft?" -> GET /api/rest/v1/products/{code}/draft
• "Search product-models?" -> GET /api/rest/v1/product-models
• "Create a product-model?" -> POST /api/rest/v1/product-models
• "Get product-model details?" -> GET /api/rest/v1/product-models/{code}
• "Partially update a product-model?" -> PATCH /api/rest/v1/product-models/{code}
• "Delete a product-model?" -> DELETE /api/rest/v1/product-models/{code}
• "Create a proposal?" -> POST /api/rest/v1/product-models/{code}/proposal
• "List all draft?" -> GET /api/rest/v1/product-models/{code}/draft
• "Search published-products?" -> GET /api/rest/v1/published-products
• "Get published-product details?" -> GET /api/rest/v1/published-products/{code}
• "List all media-files?" -> GET /api/rest/v1/media-files
• "Create a media-file?" -> POST /api/rest/v1/media-files
• "Get media-file details?" -> GET /api/rest/v1/media-files/{code}
• "List all download?" -> GET /api/rest/v1/media-files/{code}/download
• "Search families?" -> GET /api/rest/v1/families
• "Create a family?" -> POST /api/rest/v1/families
• "Get family details?" -> GET /api/rest/v1/families/{code}
• "Partially update a family?" -> PATCH /api/rest/v1/families/{code}
• "Delete a family?" -> DELETE /api/rest/v1/families/{code}
• "List all variants?" -> GET /api/rest/v1/families/{family_code}/variants
• "Create a variant?" -> POST /api/rest/v1/families/{family_code}/variants
• "Get variant details?" -> GET /api/rest/v1/families/{family_code}/variants/{code}
• "Partially update a variant?" -> PATCH /api/rest/v1/families/{family_code}/variants/{code}
• "Search attributes?" -> GET /api/rest/v1/attributes
• "Create a attribute?" -> POST /api/rest/v1/attributes
• "Get attribute details?" -> GET /api/rest/v1/attributes/{code}
• "Partially update a attribute?" -> PATCH /api/rest/v1/attributes/{code}
• "List all options?" -> GET /api/rest/v1/attributes/{attribute_code}/options
• "Create a option?" -> POST /api/rest/v1/attributes/{attribute_code}/options
• "Get option details?" -> GET /api/rest/v1/attributes/{attribute_code}/options/{code}
• "Partially update a option?" -> PATCH /api/rest/v1/attributes/{attribute_code}/options/{code}
• "Search attribute-groups?" -> GET /api/rest/v1/attribute-groups
• "Create a attribute-group?" -> POST /api/rest/v1/attribute-groups
• "Get attribute-group details?" -> GET /api/rest/v1/attribute-groups/{code}
• "Partially update a attribute-group?" -> PATCH /api/rest/v1/attribute-groups/{code}
• "List all association-types?" -> GET /api/rest/v1/association-types
• "Create a association-type?" -> POST /api/rest/v1/association-types
• "Get association-type details?" -> GET /api/rest/v1/association-types/{code}
• "Partially update a association-type?" -> PATCH /api/rest/v1/association-types/{code}
• "List all channels?" -> GET /api/rest/v1/channels
• "Create a channel?" -> POST /api/rest/v1/channels
• "Get channel details?" -> GET /api/rest/v1/channels/{code}
• "Partially update a channel?" -> PATCH /api/rest/v1/channels/{code}
• "Search locales?" -> GET /api/rest/v1/locales
• "Get locale details?" -> GET /api/rest/v1/locales/{code}
• "Search categories?" -> GET /api/rest/v1/categories
• "Create a category?" -> POST /api/rest/v1/categories
• "Get category details?" -> GET /api/rest/v1/categories/{code}
• "Partially update a category?" -> PATCH /api/rest/v1/categories/{code}
• "Create a category-media-file?" -> POST /api/rest/v1/category-media-files
• "List all download?" -> GET /api/rest/v1/category-media-files/{file_path}/download
• "Search currencies?" -> GET /api/rest/v1/currencies
• "Get currency details?" -> GET /api/rest/v1/currencies/{code}
• "List all measure-families?" -> GET /api/rest/v1/measure-families
• "Get measure-family details?" -> GET /api/rest/v1/measure-families/{code}
• "List all measurement-families?" -> GET /api/rest/v1/measurement-families
• "List all reference-entities?" -> GET /api/rest/v1/reference-entities
• "Get reference-entity details?" -> GET /api/rest/v1/reference-entities/{code}
• "Partially update a reference-entity?" -> PATCH /api/rest/v1/reference-entities/{code}
• "List all attributes?" -> GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes
• "Get attribute details?" -> GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}
• "Partially update a attribute?" -> PATCH /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}
• "List all options?" -> GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options
• "Get option details?" -> GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}
• "Partially update a option?" -> PATCH /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}
• "Search records?" -> GET /api/rest/v1/reference-entities/{reference_entity_code}/records
• "Get record details?" -> GET /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}
• "Partially update a record?" -> PATCH /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}
• "Create a reference-entities-media-file?" -> POST /api/rest/v1/reference-entities-media-files
• "Get reference-entities-media-file details?" -> GET /api/rest/v1/reference-entities-media-files/{code}
• "List all asset-families?" -> GET /api/rest/v1/asset-families
• "Get asset-family details?" -> GET /api/rest/v1/asset-families/{code}
• "Partially update a asset-family?" -> PATCH /api/rest/v1/asset-families/{code}
• "List all attributes?" -> GET /api/rest/v1/asset-families/{asset_family_code}/attributes
• "Get attribute details?" -> GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}
• "Partially update a attribute?" -> PATCH /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}
• "List all options?" -> GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options
• "Get option details?" -> GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}
• "Partially update a option?" -> PATCH /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}
• "Create a asset-media-file?" -> POST /api/rest/v1/asset-media-files
• "Get asset-media-file details?" -> GET /api/rest/v1/asset-media-files/{code}
• "Search assets?" -> GET /api/rest/v1/asset-families/{asset_family_code}/assets
• "Get asset details?" -> GET /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
• "Partially update a asset?" -> PATCH /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
• "Delete a asset?" -> DELETE /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
• "List all assets?" -> GET /api/rest/v1/assets
• "Create a asset?" -> POST /api/rest/v1/assets
• "Get asset details?" -> GET /api/rest/v1/assets/{code}
• "Partially update a asset?" -> PATCH /api/rest/v1/assets/{code}
• "Get reference-file details?" -> GET /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}
• "List all download?" -> GET /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/download
• "Get variation-file details?" -> GET /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}
• "List all download?" -> GET /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/download
• "List all asset-categories?" -> GET /api/rest/v1/asset-categories
• "Create a asset-category?" -> POST /api/rest/v1/asset-categories
• "Get asset-category details?" -> GET /api/rest/v1/asset-categories/{code}
• "Partially update a asset-category?" -> PATCH /api/rest/v1/asset-categories/{code}
• "List all asset-tags?" -> GET /api/rest/v1/asset-tags
• "Get asset-tag details?" -> GET /api/rest/v1/asset-tags/{code}
• "Partially update a asset-tag?" -> PATCH /api/rest/v1/asset-tags/{code}
• "List all rest?" -> GET /api/rest/v1
• "Create a token?" -> POST /api/oauth/v1/token
• "List all system-information?" -> GET /api/rest/v1/system-information
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

CLI

# Update this spec to the latest version
npx @lap-platform/lapsh get akeneo-pim-rest-api -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search akeneo-pim-rest-api

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP