Akeneo PIM REST API, an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://demo.akeneo.com
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Akeneo PIM REST API, an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
POST | /api/oauth/v1/token | Get authentication token This endpoint allows you to get an authentication token. No need to be authenticated |
GET | /api/rest/v1 | Get list of all endpoints This endpoint allows you to get the list of all the available endpoints. No need to |
GET | /api/rest/v1/asset-categories | Get list of PAM asset categories This endpoint allows you to get a list of PAM asset categories. PAM asset cat |
POST | /api/rest/v1/asset-categories | Create a new PAM asset category This endpoint allows you to create a new PAM asset category. PAM asset categor |
PATCH | /api/rest/v1/asset-categories | Update/create several PAM asset categories This endpoint allows you to update several PAM asset categories at |
GET | /api/rest/v1/asset-categories/{code} | Get a PAM asset category This endpoint allows you to get the information about a given PAM asset category. PAM |
PATCH | /api/rest/v1/asset-categories/{code} | Update/create a PAM asset category This endpoint allows you to update a given PAM asset category. Know more ab |
GET | /api/rest/v1/asset-families | Get list of asset families This endpoint allows you to get a list of asset families. Asset families are pagina |
GET | /api/rest/v1/asset-families/{asset_family_code}/assets | Get the list of the assets of a given asset family This endpoint allows you to get a list of assets of a given |
PATCH | /api/rest/v1/asset-families/{asset_family_code}/assets | Update/create several assets This endpoint allows you to update and/or create several assets of one given asse |
GET | /api/rest/v1/asset-families/{asset_family_code}/assets/{code} | Get an asset of a given asset family This endpoint allows you to get the information about a given asset for a |
PATCH | /api/rest/v1/asset-families/{asset_family_code}/assets/{code} | Update/create an asset This endpoint allows you to update a given asset of a given asset family. Learn more ab |
DELETE | /api/rest/v1/asset-families/{asset_family_code}/assets/{code} | Delete an asset This endpoint allows you to delete a given asset. This endpoint is case sensitive on the asset |
GET | /api/rest/v1/asset-families/{asset_family_code}/attributes | Get the list of attributes of a given asset family This endpoint allows you to get the list of attributes of a |
GET | /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options | Get a list of attribute options of a given attribute for a given asset family This endpoint allows you to get |
GET | /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code} | Get an attribute option for a given attribute of a given asset family This endpoint allows you to get the info |
PATCH | /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code} | Update/create an asset attribute option for a given asset family This endpoint allows you to update a given op |
GET | /api/rest/v1/asset-families/{asset_family_code}/attributes/{code} | Get an attribute of a given asset family This endpoint allows you to get the information about a given attribu |
PATCH | /api/rest/v1/asset-families/{asset_family_code}/attributes/{code} | Update/create an attribute of a given asset family This endpoint allows you to update a given attribute for a |
GET | /api/rest/v1/asset-families/{code} | Get an asset family This endpoint allows you to get the information about a given asset family. Asset family |
PATCH | /api/rest/v1/asset-families/{code} | Update/create an asset family This endpoint allows you to update a given asset family. Note that if the asset |
POST | /api/rest/v1/asset-media-files | Create a new media file for an asset This endpoint allows you to create a new media file and associate it to a |
GET | /api/rest/v1/asset-media-files/{code} | Download the media file associated to an asset This endpoint allows you to download a given media file that is |
GET | /api/rest/v1/asset-tags | Get list of PAM asset tags This endpoint allows you to get a list of PAM asset tags. PAM asset tags are pagina |
GET | /api/rest/v1/asset-tags/{code} | Get a PAM asset tag This endpoint allows you to get the information about a given PAM asset tag. PAM asset tag |
PATCH | /api/rest/v1/asset-tags/{code} | Update/create a PAM asset tag This endpoint allows you to update a given PAM asset tag. Know more about Update |
GET | /api/rest/v1/assets | Get list of PAM assets This endpoint allows you to get a list of PAM assets. PAM assets are paginated. PAM ass |
POST | /api/rest/v1/assets | Create a new PAM asset This endpoint allows you to create a new PAM asset. PAM asset |
PATCH | /api/rest/v1/assets | Update/create several PAM assets This endpoint allows you to update several PAM assets at once. PAM asset |
GET | /api/rest/v1/assets/{asset_code}/reference-files/{locale_code} | Get a reference file This endpoint allows you to get the information about a reference file of a given PAM ass |
POST | /api/rest/v1/assets/{asset_code}/reference-files/{locale_code} | Upload a new reference file This endpoint allows you to upload a new reference file for a given PAM asset and |
GET | /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/download | Download a reference file This endpoint allows you to download a given reference file. PAM asset reference fil |
GET | /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code} | Get a variation file This endpoint allows you to get the information about a variation file of a given PAM ass |
POST | /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code} | Upload a new variation file This endpoint allows you to upload a new variation file for a given PAM asset, cha |
GET | /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/download | Download a variation file This endpoint allows you to download a given variation file. PAM asset variation fil |
GET | /api/rest/v1/assets/{code} | Get a PAM asset This endpoint allows you to get the information about a given PAM asset. PAM asset |
PATCH | /api/rest/v1/assets/{code} | Update/create a PAM asset This endpoint allows you to update a given PAM asset. Know more about Update behavio |
GET | /api/rest/v1/association-types | Get a list of association types This endpoint allows you to get a list of association types. Association types |
POST | /api/rest/v1/association-types | Create a new association type This endpoint allows you to create a new association type. Association type |
PATCH | /api/rest/v1/association-types | Update/create several association types This endpoint allows you to update and/or create several association t |
and 100 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/akeneo/pim-api-docs/master/content/swagger/akeneo-web-ap
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.