Portal/Instance Identifier: ipaascom.demo.cloud
Base URLs:
Sandbox/Test:
https://ipaascom.demo.cloud.akeneo.comProduction/Live:
N/A
Common Query Parameters
Parameter | Description | Example |
| Unique identifier for the reference entity |
|
| Unique identifier for record entity |
|
HTTP Methods Used
GET: Retrieve data.
POST: Create new entities.
Table of Contents
Attribute Endpoints
Retrieve Attributes Modified Since a Specific Time: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/attributes?pagination_type=page&page={page}&limit=100
Get an Attributes by Id: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/attributes/{id}
Category Endpoints
Get a Category by Id: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/categories/{id}?with_position=true
Retrieve Categories Modified Since a Specific Time: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/categories?with_position=true&with_count=true&search={{\"updated\":[{{\"operator\":\">\",\"value\":\"{lastModifiedDT}\"}}]}}&pagination_type=page&page={page}&limit=100
Location Endpoints
Get a Location by Id: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/attributes/{Ids[0]}/options/{Ids[1]}
Option Endpoints
Retrieve Options by Family Variant Id: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/families/{ids[0]}/variants/{ids[1]}
Get Option by Id: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/attributes/{id}
Option Value Endpoints
Retrieve Option Value Modified Since a Specific Time: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/attributes/{Ids[0]}/options?with_position=true&pagination_type=page&page={page}&limit=100
Product Endpoints
Get Product by UUID: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/products-uuid/{id}
Get Product by ID: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/products/{id}
Get Product Model by ID: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/product-models/{id}
Get Product by SKU: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/products/{sku}
Retrieve Product Modified Since a Specific Time: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/products?with_count=true&search={{\"updated\":[{{\"operator\":\">\",\"value\":\"{lastModifiedDT}\"}}]}}&pagination_type=page&page={page}&limit=100
Retrieve Product Model Modified Since a Specific Time: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/product-models?with_count=true&search={{\"updated\":[{{\"operator\":\">\",\"value\":\"{lastModifiedDT}\"}}],\"parent\":[{{\"operator\":\"EMPTY\"}}]}}&pagination_type=page&page={page}&limit=100
Product Variant Endpoints
Get Product Variant by UUID: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/products-uuid/{id}
Get Product Variant by ID: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/products/{id}
Get Product Model by ID: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/product-models/{id}
Retrieve Product Variant Modified Since a Specific Time: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/products?with_count=true&search={{\"updated\":[{{\"operator\":\">\",\"value\":\"{lastModifiedDT}\"}}]}}&pagination_type=page&page={page}&limit=100
Retrieve Product Variant by Parent Id Filter Product API: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/products ?search={{\"parent\":[{{\"operator\":\"=\",\"value\":\"{id}\"}}]}}&with_position=true&pagination_type=page&page={page}&limit=100
Retrieve Product Variant by Parent Id Filter Product UUID API: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/products-uuid ?search={{\"parent\":[{{\"operator\":\"=\",\"value\":\"{id}\"}}]}}&with_position=true&pagination_type=page&page={page}&limit=100
Authentication/OAuth Endpoints
Get Access Token: (Post)
https://ipaascom.demo.cloud.akeneo.com/api/oauth/v1/token
Save Refresh Token: (POST)
https://ipaascom.demo.cloud.akeneo.com/api/oauth/v1/token
Public APP Authorization Token: (POST)
https://ipaascom.demo.cloud.akeneo.com/connect/apps/v1/oauth2/token
Utility/Generic Endpoints
Get All Reference Entity by Specific Reference Code: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/reference-entities/{referenceCode}/records
Get All Reference Entity by Specific Reference Code: (GET)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/reference-entities/{referenceCode}/records
Get Reference Entity Record by Code: (GET/POST)
https://ipaascom.demo.cloud.akeneo.com/api/rest/v1/reference-entities/{referenceCode}/records/{entityCode}