Create a new media file for a reference entity or a record

This endpoint allows you to create a new media file and associate it to the image of a reference entity, or to the main image or to an attribute value of a record.

Source

actionPOSTv1.0.0

Create a new media file for an asset

This endpoint allows you to create a new media file and associate it to a media file attribute value of an asset.

Source

actionPOSTv1.0.0

Create a new PAM asset

This endpoint allows you to create a new PAM asset.

Source

actionPOSTv1.0.0

Create a new PAM asset category

This endpoint allows you to create a new PAM asset category.

Source

actionPOSTv1.0.0

Create a new product

This endpoint allows you to create a new product. In the Enterprise Edition, since the v2.0, permissions based on your user groups are applied to the product you try to create.

Source

actionPOSTv1.0.0

This endpoint allows you to create a new product. In the Enterprise Edition, permissions based on your user groups are applied to the product you try to create. If no uuid is provided, the PIM will generate one for you.

Source

actionPOSTv1.0.0

Create a new product media file

This endpoint allows you to create a new media file and associate it to an attribute value of a given product or product model.

Source

actionPOSTv1.0.0

Create a new product model

This endpoint allows you to create a new product model. In the Enterprise Edition, since the v2.3, permissions based on your user groups are applied to the product model you try to create.

Source

actionDELETEv1.0.0

Delete a catalog

This endpoint allows you to delete a catalog.

Source

actionDELETEv1.0.0

Delete a product

This endpoint allows you to delete a given product. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the product you try to delete.

Source

actionDELETEv1.0.0

Delete a product

This endpoint allows you to delete a given product. In the Enterprise Edition, permissions based on your user groups are applied to the product you try to delete.

Source

actionDELETEv1.0.0

Delete a product model

This endpoint allows you to delete a given product model. All its children, product models and variant products, will be also deleted. In the Enterprise Edition, the permissions based on your connection user group are applied to the product model you try to delete.

Source

actionDELETEv1.0.0

Delete an asset

This endpoint allows you to delete a given asset. This endpoint is case sensitive on the asset family code.

Source

actionGETv1.0.0

Get a catalog

This endpoint allows you to get the information about a catalog.

Source

actionGETv1.0.0

Get a category

This endpoint allows you to get the information about a given category.

Source

actionGETv1.0.0

Get a channel

This endpoint allows you to get the information about a given channel.

Source

actionGETv1.0.0

Get a currency

This endpoint allows you to get the information about a given currency.

Source

actionGETv1.0.0

Get a draft

This endpoint allows you to get the information about a given draft.

Source

actionGETv1.0.0

Get a draft

This endpoint allows you to get the information about a given draft.

Source

actionGETv1.0.0

Get a draft

This endpoint allows you to get the information about a given product model draft.

Source

actionGETv1.0.0

Get a family

This endpoint allows you to get the information about a given family.

Source

actionGETv1.0.0

Get a family variant

This endpoint allows you to get the information about a given family variant.

Source

actionGETv1.0.0

Get a list of association types

This endpoint allows you to get a list of association types. Association types are paginated and sorted by code.

Source

actionGETv1.0.0

Get a list of attribute options of a given attribute for a given asset family

This endpoint allows you to get a list of attribute options for a given asset family.

Source

actionGETv1.0.0

Get a list of attribute options of a given attribute for a given reference entity

This endpoint allows you to get a list of attribute options for a given reference entity.

Source

actionGETv1.0.0

Get a list of channels

This endpoint allows you to get a list of channels. Channels are paginated and sorted by code.

Source

actionGETv1.0.0

Get a list of currencies

This endpoint allows you to get a list of currencies. Currencies are paginated and sorted by code.

Source

actionGETv1.0.0

Get a list of locales

This endpoint allows you to get a list of locales. Locales are paginated and sorted by code.

Source

actionGETv1.0.0

Get a list of product media files

This endpoint allows you to get a list of media files that are used as attribute values in products or product models.

Source

actionGETv1.0.0

Get a locale

This endpoint allows you to get the information about a given locale.

Source

actionGETv1.0.0

Get a measure family

This endpoint allows you to get the information about a given measure family.

Source

actionGETv1.0.0

Get a PAM asset

This endpoint allows you to get the information about a given PAM asset.

Source

actionGETv1.0.0

Get a PAM asset category

This endpoint allows you to get the information about a given PAM asset category.

Source

actionGETv1.0.0

Get a PAM asset tag

This endpoint allows you to get the information about a given PAM asset tag.

Source

actionGETv1.0.0

Get a product

This endpoint allows you to get the information about a given product. In the Entreprise Edition, since the v2.0, permissions based on your user groups are applied to the product you request.

Source

actionGETv1.0.0

Get a product

This endpoint allows you to get the information about a given product. In the Entreprise Edition, permissions based on your user groups are applied to the product you request.

Source

actionGETv1.0.0

Get a product media file

This endpoint allows you to get the information about a given media file that is used as an attribute value of a product or a product model.

Source

actionGETv1.0.0

Get a product model

This endpoint allows you to get the information about a given product model. In the Entreprise Edition, since the v2.0, permissions based on your user groups are applied to the product model you request.

Source

actionGETv1.0.0

Get a product related to a catalog

This endpoint allows you to get a specific product related to a catalog. In the Enterprise Edition, permissions based on your app settings are applied on the product you request. Please, note that a disabled catalog can return an HTTP 200 with a payload containing an error message, for more details see the <a href="apps/catalogs.html#troubleshooting">App Catalog</a> section.

Source

actionGETv1.0.0

Get a published product

This endpoint allows you to get the information about a given published product.

Source

actionGETv1.0.0

Get a record of a given reference entity

This endpoint allows you to get the information about a given record for a given reference entity.

Source

actionGETv1.0.0

Get a reference entity

This endpoint allows you to get the information about a given reference entity.

Source

actionGETv1.0.0

Get a reference file

This endpoint allows you to get the information about a reference file of a given PAM asset.

Source

actionGETv1.0.0

Get a variation file

This endpoint allows you to get the information about a variation file of a given PAM asset.

Source

actionGETv1.0.0

Get an asset family

This endpoint allows you to get the information about a given asset family.

Source

actionGETv1.0.0

Get an asset of a given asset family

This endpoint allows you to get the information about a given asset for a given asset family. This endpoint is case sensitive on the asset family code.

Source

actionGETv1.0.0

Get an association type

This endpoint allows you to get the information about a given association type.

Source

actionGETv1.0.0

Get an attribute

This endpoint allows you to get the information about a given attribute.

Source

actionGETv1.0.0

Get an attribute group

This endpoint allows you to get the information about a given attribute group.

Source

actionGETv1.0.0

Get an attribute of a given asset family

This endpoint allows you to get the information about a given attribute for a given asset family.

Source

actionGETv1.0.0

Get an attribute of a given reference entity

This endpoint allows you to get the information about a given attribute for a given reference entity.

Source

actionGETv1.0.0

Get an attribute option

This endpoint allows you to get the information about a given attribute option.

Source

actionGETv1.0.0

Get an attribute option for a given attribute of a given asset family

This endpoint allows you to get the information about a given asset attribute option.

Source

actionGETv1.0.0

Get an attribute option for a given attribute of a given reference entity

This endpoint allows you to get the information about a given attribute option.

Source

actionGETv1.0.0

Get list of all endpoints

This endpoint allows you to get the list of all the available endpoints. No need to be authenticated to use this endpoint.

Source

actionGETv1.0.0

Get list of asset families

This endpoint allows you to get a list of asset families. Asset families are paginated.

Source

actionGETv1.0.0

Get list of attribute groups

This endpoint allows you to get a list of attribute groups. Attribute groups are paginated and sorted by code.

Source

actionGETv1.0.0

Get list of attribute options

This endpoint allows you to get a list of attribute options. Attribute options are paginated and sorted by code.

Source

actionGETv1.0.0

Get list of attributes

This endpoint allows you to get a list of attributes. Attributes are paginated and sorted by code.

Source

actionGETv1.0.0

Get list of categories

This endpoint allows you to get a list of categories. Categories are paginated and sorted by `root/left`.

Source

actionGETv1.0.0

Get list of families

This endpoint allows you to get a list of families. Families are paginated and sorted by code.

Source

actionGETv1.0.0

Get list of family variants

This endpoint allows you to get a list of family variants. Family variants are paginated and sorted by code.

Source

actionGETv1.0.0

Get list of measure familiy

This endpoint allows you to get a list of measure families. Measure families are paginated and sorted by code.

Source

actionGETv1.0.0

Get list of measurement families

This endpoint allows you to get a list of measurement families.

Source

actionGETv1.0.0

Get list of PAM asset categories

This endpoint allows you to get a list of PAM asset categories. PAM asset categories are paginated and sorted by `root/left`.

Source

actionGETv1.0.0

Get list of PAM asset tags

This endpoint allows you to get a list of PAM asset tags. PAM asset tags are paginated.

Source

actionGETv1.0.0

Get list of PAM assets

This endpoint allows you to get a list of PAM assets. PAM assets are paginated.

Source

actionGETv1.0.0

Get list of product models

This endpoint allows you to get a list of product models. Product models are paginated. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the set of products you request.

Source

actionGETv1.0.0

Get list of products

This endpoint allows you to get a list of products. Products are paginated and they can be filtered. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the set of products you request.

Source

actionGETv1.0.0

Get list of products

This endpoint allows you to get a list of products. Products are paginated and they can be filtered. In the Enterprise Edition, permissions based on your user groups are applied to the set of products you request.

Source

actionGETv1.0.0

Get list of published products

This endpoint allows you to get a list of published products. Published products are paginated and they can be filtered.

Source

actionGETv1.0.0

Get list of reference entities

This endpoint allows you to get a list of reference entities. Reference entities are paginated.

Source

actionGETv1.0.0

Get system information

This endpoint allows you to get the version and the edition of the PIM. Example of what you can get <table class="description-table"> <thead> <tr> <th align="center">Environment</th> <th align="center">Edition</th> <th align="center">Version</th> </tr> </thead> <tbody> <tr> <td align="center">SaaS EE</td> <td align="center">Serenity</td> <td align="center">v20230112013744</td> </tr> <tr> <td align="center">SaaS CE</td> <td align="center">GE</td> <td align="center">v20210526040645</td> </tr> <tr> <td align="center">PaaS or onPrem EE</td> <td align="center">EE</td> <td align="center">5.0.28</td> </tr> <tr> <td align="center">PaaS or onPrem CE</td> <td align="center">CE</td> <td align="center">5.0.28</td> </tr> </tbody> </table>

Source

actionGETv1.0.0

Get the list of attributes of a given asset family

This endpoint allows you to get the list of attributes of a given asset family.

Source

actionGETv1.0.0

Get the list of attributes of a given reference entity

This endpoint allows you to get the list of attributes of a given reference entity.

Source

actionGETv1.0.0

Get the list of owned catalogs

This endpoint allows you to get the list of catalogs you owned.

Source

actionGETv1.0.0

Get the list of product uuids

This endpoint allows you to get the list of uuids of products contained in a catalog. Please, note that a disabled catalog can return an HTTP 200 with a payload containing an error message, for more details see the <a href="apps/catalogs.html#troubleshooting">App Catalog</a> section.

Source

actionGETv1.0.0

Get the list of products related to a catalog

This endpoint allows you to get the list of products related to a catalog. Products are paginated and they can be filtered. In the Enterprise Edition, permissions based on your app settings are applied to the set of products you request. Please, note that a disabled catalog can return an HTTP 200 with a payload containing an error message, for more details see the <a href="apps/catalogs.html#troubleshooting">App Catalog</a> section.

Source

actionGETv1.0.0

Get the list of the assets of a given asset family

This endpoint allows you to get a list of assets of a given asset family. Assets are paginated. This endpoint is case sensitive on the asset family code.

Source

actionGETv1.0.0

Get the list of the records of a reference entity

This endpoint allows you to get a list of records of a given reference entity. Records are paginated and can be filtered.

Source

actionPOSTv1.0.0

Submit a draft for approval

This endpoint allows you to submit a product model draft for approval.

Source

actionPOSTv1.0.0

Submit a draft for approval

This endpoint allows you to submit a draft for approval.

Source

actionPOSTv1.0.0

Submit a draft for approval

This endpoint allows you to submit a draft for approval.

Source

actionPATCHv1.0.0

Update a catalog

This endpoint allows you to update a catalog.

Source

actionPATCHv1.0.0

Update/create a channel

This endpoint allows you to update a given channel. Know more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no channel exists for the given code, it creates it.

Source

actionPATCHv1.0.0

Update/create a PAM asset category

This endpoint allows you to update a given PAM asset category. Know more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no category exists for the given code, it creates it.

Source

actionPATCHv1.0.0

Update/create an asset

This endpoint allows you to update a given asset of a given asset family. Learn more about the <a href="/documentation/update.html#patch-asset-attribute-values">Update behavior</a>. Note that if the asset does not already exist for the given asset family, it creates it. This endpoint is case sensitive on the asset family code.

Source

actionPATCHv1.0.0

Update/create an association type

This endpoint allows you to update a given association type. Know more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no association type exists for the given code, it creates it.

Source

actionPATCHv1.0.0

Update/create an attribute group

This endpoint allows you to update a given attribute group. Know more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no attribute group exists for the given code, it creates it.

Source

actionPATCHv1.0.0

Update/create an attribute of a given asset family

This endpoint allows you to update a given attribute for a given asset family. Note that if the attribute does not already exist for the given asset family, it creates it.

Source

actionPATCHv1.0.0

Update/create several PAM asset categories

This endpoint allows you to update several PAM asset categories at once.

Source

Akeneo PIM REST

Any provider, on request.

Request it

Generate it