Akeneoconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 140 actions for the Akeneoconnector v1.

Asset attribute option (3)

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

/api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Attribute Code`	Code of the attribute
`Response Type`	N/A

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

/api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Attribute Code`	Code of the attribute
`Code`	Code of the resource
`Response Type`	N/A

PATCH Update/create an asset attribute option for a given asset family

/api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}

This endpoint allows you to update a given option for a given attribute and a given asset family. Learn more about the Update behavior. Note that if the option does not already exist for the given attribute of the given asset family, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Attribute Code`	Code of the attribute
`Code`	Code of the resource
`Response Type`	N/A

Options (1)

Option Name	Description
`Code`	Attribute's option code

Asset attribute (3)

GET Get an attribute of a given asset family

/api/rest/v1/asset-families/{asset_family_code}/attributes/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Code`	Code of the resource
`Response Type`	N/A

GET Get the list of attributes of a given asset family

/api/rest/v1/asset-families/{asset_family_code}/attributes

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Response Type`	N/A

PATCH Update/create an attribute of a given asset family

/api/rest/v1/asset-families/{asset_family_code}/attributes/{code}

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.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Code`	Code of the resource
`Response Type`	N/A

Options (19)

Option Name	Description
`Code`	Attribute code
`Type`	Attribute type. See type section for more details.
`Value Per Locale`	Whether the attribute is localizable, i.e. can have one value by locale
`Value Per Channel`	Whether the attribute is scopable, i.e. can have one value by channel
`Is Required For Completeness`	Whether the attribute should be part of the record's completeness calculation
`Is Read Only`	Whether the attribute should be in read only mode only in the UI, but you can still update it with the API
`Max Characters`	Maximum number of characters allowed for the value of the attribute when the attribute type is text
`Is Textarea`	Whether the UI should display a text area instead of a simple field when the attribute type is text
`Is Rich Text Editor`	Whether the UI should display a rich text editor instead of a simple text area when the attribute type is text
`Validation Rule`	Validation rule type used to validate the attribute value when the attribute type is text
`Validation Regexp`	Regexp expression used to validate the attribute value when the attribute type is text
`Allowed Extensions`	Extensions allowed when the attribute type is media_file
`Max File Size`	Max file size in MB when the attribute type is media_file
`Decimals Allowed`	Whether decimals are allowed when the attribute type is number
`Min Value`	Minimum value allowed when the attribute type is number
`Max Value`	Maximum value allowed when the attribute type is number
`Media Type`	For the media_link attribute type, it is the type of the media behind the url, to allow its preview in the PIM. For the media_file attribute type, it is the type of the file.
`Prefix`	Prefix of the media_link attribute type. The common url root that prefixes the link to the media
`Suffix`	Suffix of the media_link attribute type. The common url suffix for the media

Asset family (3)

GET Get an asset family

/api/rest/v1/asset-families/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of asset families

/api/rest/v1/asset-families

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Response Type`	N/A

PATCH Update/create an asset family

/api/rest/v1/asset-families/{code}

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (2)

Option Name	Description
`Code`	Asset family code
`Attribute As Main Media`	Attribute code that is used as the main media of the asset family.

Asset media file (2)

POST Create a new media file for an asset

/api/rest/v1/asset-media-files

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	Equal to 'multipart/form-data', no other value allowed
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	The binary of the media file

GET Download the media file associated to an asset

/api/rest/v1/asset-media-files/{code}

This endpoint allows you to download a given media file that is associated with an asset.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Asset (5)

DELETE Delete an asset

/api/rest/v1/asset-families/{asset_family_code}/assets/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Code`	Code of the resource
`Response Type`	N/A

GET Get an asset of a given asset family

/api/rest/v1/asset-families/{asset_family_code}/assets/{code}

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Code`	Code of the resource
`Response Type`	N/A

GET Get the list of the assets of a given asset family

/api/rest/v1/asset-families/{asset_family_code}/assets

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter assets, for more details see the Asset filters section
`Channel`	Filter asset values to return scopable asset attributes for the given channel as well as the non localizable/non scopable asset attributes, for more details see the Filter asset values by channel section
`Locales`	Filter asset values to return localizable attributes for the given locales as well as the non localizable/non scopable asset attributes, for more details see the Filter asset values by locale section
`Asset Family Code`	Code of the asset family
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Response Type`	N/A

PATCH Update/create an asset

/api/rest/v1/asset-families/{asset_family_code}/assets/{code}

This endpoint allows you to update a given asset of a given asset family. Learn more about the Update behavior. 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.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Code`	Code of the resource
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Code of the asset
`Created`	Date of creation (Only available on SaaS versions)
`Updated`	Date of the last update (Only available on SaaS versions)

PATCH Update/create several assets

/api/rest/v1/asset-families/{asset_family_code}/assets

This endpoint allows you to update and/or create several assets of one given asset family at once. Learn more about the Update behavior. 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.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Family Code`	Code of the asset family
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Code of the asset
`Created`	Date of creation (Only available on SaaS versions)
`Updated`	Date of the last update (Only available on SaaS versions)

Association type (5)

POST Create a new association type

/api/rest/v1/association-types

This endpoint allows you to create a new association type.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Association type code
`Is Quantified`	When true, the association is a quantified association (Only available in the PIM Serenity version.)
`Is Two Way`	When true, the association is a two-way association (Only available in the PIM Serenity version.)

GET Get a list of association types

/api/rest/v1/association-types

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

GET Get an association type

/api/rest/v1/association-types/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

PATCH Update/create an association type

/api/rest/v1/association-types/{code}

This endpoint allows you to update a given association type. Know more about Update behavior. Note that if no association type exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Association type code
`Is Quantified`	When true, the association is a quantified association (Only available in the PIM Serenity version.)
`Is Two Way`	When true, the association is a two-way association (Only available in the PIM Serenity version.)

PATCH Update/create several association types

/api/rest/v1/association-types

This endpoint allows you to update and/or create several association types at once.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Association type code
`Is Quantified`	When true, the association is a quantified association (Only available in the PIM Serenity version.)
`Is Two Way`	When true, the association is a two-way association (Only available in the PIM Serenity version.)

Attribute group (5)

POST Create a new attribute group

/api/rest/v1/attribute-groups

This endpoint allows you to create a new attribute group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Attribute group code
`Sort Order`	Attribute group order among other attribute groups
`Attributes`	Attribute codes that compose the attribute group

GET Get an attribute group

/api/rest/v1/attribute-groups/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of attribute groups

/api/rest/v1/attribute-groups

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter attribute groups, for more details see the Filters section.
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

PATCH Update/create an attribute group

/api/rest/v1/attribute-groups/{code}

This endpoint allows you to update a given attribute group. Know more about Update behavior. Note that if no attribute group exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Attribute group code
`Sort Order`	Attribute group order among other attribute groups
`Attributes`	Attribute codes that compose the attribute group

PATCH Update/create several attribute groups

/api/rest/v1/attribute-groups

This endpoint allows you to update and/or create several attribute groups at once.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Attribute group code
`Sort Order`	Attribute group order among other attribute groups
`Attributes`	Attribute codes that compose the attribute group

Attribute option (5)

POST Create a new attribute option

/api/rest/v1/attributes/{attribute_code}/options

This endpoint allows you to create a new attribute option.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Attribute Code`	Code of the attribute
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Code of option
`Attribute`	Code of attribute related to the attribute option
`Sort Order`	Order of attribute option

GET Get an attribute option

/api/rest/v1/attributes/{attribute_code}/options/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Attribute Code`	Code of the attribute
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of attribute options

/api/rest/v1/attributes/{attribute_code}/options

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Attribute Code`	Code of the attribute
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

PATCH Update/create an attribute option

/api/rest/v1/attributes/{attribute_code}/options/{code}

This endpoint allows you to update a given attribute option. Know more about Update behavior. Note that if no attribute option exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Attribute Code`	Code of the attribute
`Code`	Code of the resource
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Code of option
`Attribute`	Code of attribute related to the attribute option
`Sort Order`	Order of attribute option

PATCH Update/create several attribute options

/api/rest/v1/attributes/{attribute_code}/options

This endpoint allows you to update several attribute options at once.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Attribute Code`	Code of the attribute
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Code of option
`Attribute`	Code of attribute related to the attribute option
`Sort Order`	Order of attribute option

Attribute (5)

POST Create a new attribute

/api/rest/v1/attributes

This endpoint allows you to create a new attribute.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (25)

Option Name	Description
`Code`	Attribute code
`Type`	Attribute type. See type section for more details.
`Group`	Attribute group
`Sort Order`	Order of the attribute in its group
`Localizable`	Whether the attribute is localizable, i.e. can have one value by locale
`Scopable`	Whether the attribute is scopable, i.e. can have one value by channel
`Available Locales`	To make the attribute locale specfic, specify here for which locales it is specific
`Unique`	Whether two values for the attribute cannot be the same
`Useable As Grid Filter`	Whether the attribute can be used as a filter for the product grid in the PIM user interface
`Max Characters`	Number maximum of characters allowed for the value of the attribute when the attribute type is pim_catalog_text, pim_catalog_textarea or pim_catalog_identifier
`Validation Rule`	Validation rule type used to validate any attribute value when the attribute type is pim_catalog_text or pim_catalog_identifier
`Validation Regexp`	Regexp expression used to validate any attribute value when the attribute type is pim_catalog_text or pim_catalog_identifier
`Wysiwyg Enabled`	Whether the WYSIWYG interface is shown when the attribute type is pim_catalog_textarea
`Number Min`	Minimum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
`Number Max`	Maximum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
`Decimals Allowed`	Whether decimals are allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
`Negative Allowed`	Whether negative values are allowed when the attribute type is pim_catalog_metric or pim_catalog_number
`Metric Family`	Metric family when the attribute type is pim_catalog_metric
`Default Metric Unit`	Default metric unit when the attribute type is pim_catalog_metric
`Date Min`	Minimum date allowed when the attribute type is pim_catalog_date
`Date Max`	Maximum date allowed when the attribute type is pim_catalog_date
`Allowed Extensions`	Extensions allowed when the attribute type is pim_catalog_file or pim_catalog_image
`Max File Size`	Max file size in MB when the attribute type is pim_catalog_file or pim_catalog_image
`Reference Data Name`	Reference entity code when the attribute type is akeneo_reference_entity or akeneo_reference_entity_collection OR Asset family code when the attribute type is pim_catalog_asset_collection
`Default Value`	Default value for a Yes/No attribute, applied when creating a new product or product model (only available since the 5.0)

GET Get an attribute

/api/rest/v1/attributes/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`With Table Select Options`	Return the options of 'select' column types (of a table attribute) in the response. (Only available on SaaS platforms)
`Response Type`	N/A

GET Get list of attributes

/api/rest/v1/attributes

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter attributes, for more details see the Filters section.
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`With Table Select Options`	Return the options of 'select' column types (of a table attribute) in the response. (Only available on SaaS platforms)
`Response Type`	N/A

PATCH Update/create an attribute

/api/rest/v1/attributes/{code}

This endpoint allows you to update a given attribute. Know more about Update behavior. Note that if no attribute exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (25)

Option Name	Description
`Code`	Attribute code
`Type`	Attribute type. See type section for more details.
`Group`	Attribute group
`Sort Order`	Order of the attribute in its group
`Localizable`	Whether the attribute is localizable, i.e. can have one value by locale
`Scopable`	Whether the attribute is scopable, i.e. can have one value by channel
`Available Locales`	To make the attribute locale specfic, specify here for which locales it is specific
`Unique`	Whether two values for the attribute cannot be the same
`Useable As Grid Filter`	Whether the attribute can be used as a filter for the product grid in the PIM user interface
`Max Characters`	Number maximum of characters allowed for the value of the attribute when the attribute type is pim_catalog_text, pim_catalog_textarea or pim_catalog_identifier
`Validation Rule`	Validation rule type used to validate any attribute value when the attribute type is pim_catalog_text or pim_catalog_identifier
`Validation Regexp`	Regexp expression used to validate any attribute value when the attribute type is pim_catalog_text or pim_catalog_identifier
`Wysiwyg Enabled`	Whether the WYSIWYG interface is shown when the attribute type is pim_catalog_textarea
`Number Min`	Minimum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
`Number Max`	Maximum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
`Decimals Allowed`	Whether decimals are allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
`Negative Allowed`	Whether negative values are allowed when the attribute type is pim_catalog_metric or pim_catalog_number
`Metric Family`	Metric family when the attribute type is pim_catalog_metric
`Default Metric Unit`	Default metric unit when the attribute type is pim_catalog_metric
`Date Min`	Minimum date allowed when the attribute type is pim_catalog_date
`Date Max`	Maximum date allowed when the attribute type is pim_catalog_date
`Allowed Extensions`	Extensions allowed when the attribute type is pim_catalog_file or pim_catalog_image
`Max File Size`	Max file size in MB when the attribute type is pim_catalog_file or pim_catalog_image
`Reference Data Name`	Reference entity code when the attribute type is akeneo_reference_entity or akeneo_reference_entity_collection OR Asset family code when the attribute type is pim_catalog_asset_collection
`Default Value`	Default value for a Yes/No attribute, applied when creating a new product or product model (only available since the 5.0)

PATCH Update/create several attributes

/api/rest/v1/attributes

This endpoint allows you to update and/or create several attributes at once.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (25)

Option Name	Description
`Code`	Attribute code
`Type`	Attribute type. See type section for more details.
`Group`	Attribute group
`Sort Order`	Order of the attribute in its group
`Localizable`	Whether the attribute is localizable, i.e. can have one value by locale
`Scopable`	Whether the attribute is scopable, i.e. can have one value by channel
`Available Locales`	To make the attribute locale specfic, specify here for which locales it is specific
`Unique`	Whether two values for the attribute cannot be the same
`Useable As Grid Filter`	Whether the attribute can be used as a filter for the product grid in the PIM user interface
`Max Characters`	Number maximum of characters allowed for the value of the attribute when the attribute type is pim_catalog_text, pim_catalog_textarea or pim_catalog_identifier
`Validation Rule`	Validation rule type used to validate any attribute value when the attribute type is pim_catalog_text or pim_catalog_identifier
`Validation Regexp`	Regexp expression used to validate any attribute value when the attribute type is pim_catalog_text or pim_catalog_identifier
`Wysiwyg Enabled`	Whether the WYSIWYG interface is shown when the attribute type is pim_catalog_textarea
`Number Min`	Minimum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
`Number Max`	Maximum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
`Decimals Allowed`	Whether decimals are allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
`Negative Allowed`	Whether negative values are allowed when the attribute type is pim_catalog_metric or pim_catalog_number
`Metric Family`	Metric family when the attribute type is pim_catalog_metric
`Default Metric Unit`	Default metric unit when the attribute type is pim_catalog_metric
`Date Min`	Minimum date allowed when the attribute type is pim_catalog_date
`Date Max`	Maximum date allowed when the attribute type is pim_catalog_date
`Allowed Extensions`	Extensions allowed when the attribute type is pim_catalog_file or pim_catalog_image
`Max File Size`	Max file size in MB when the attribute type is pim_catalog_file or pim_catalog_image
`Reference Data Name`	Reference entity code when the attribute type is akeneo_reference_entity or akeneo_reference_entity_collection OR Asset family code when the attribute type is pim_catalog_asset_collection
`Default Value`	Default value for a Yes/No attribute, applied when creating a new product or product model (only available since the 5.0)

Authentication

POST Get authentication token

/api/oauth/v1/token

This endpoint allows you to get an authentication token. No need to be authenticated to use this endpoint.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	Equal to 'application/json' or 'application/x-www-form-urlencoded', no other value allowed
`Authorization`	Equal to 'Basic xx', where 'xx' is the base 64 encoding of the client id and secret. Find out how to generate them in the Client ID/secret generation section.
`Response Type`	N/A

Options (3)

Option Name	Description
`Username`	Your PIM username
`Password`	Your PIM password
`Grant Type`	Always equal to "password"

Catalog products (3)

GET Get a product related to a catalog

/api/rest/v1/catalogs/{id}/products/{uuid}

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 App Catalog section.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Catalog ID
`Uuid`	Product UUID
`Response Type`	N/A

GET Get the list of product uuids

/api/rest/v1/catalogs/{id}/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 App Catalog section.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Id of the catalog
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`Updated Before`	Filter products that have been updated BEFORE the provided date (Only available on Catalogs endpoints)
`Updated After`	Filter products that have been updated AFTER the provided date (Only available on Catalogs endpoints)
`Response Type`	N/A

GET Get the list of products related to a catalog

/api/rest/v1/catalogs/{id}/products

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 App Catalog section.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Catalog ID
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`Updated Before`	Filter products that have been updated BEFORE the provided date (Only available on Catalogs endpoints)
`Updated After`	Filter products that have been updated AFTER the provided date (Only available on Catalogs endpoints)
`Response Type`	N/A

Catalogs (5)

POST Create a new catalog

/api/rest/v1/catalogs

This endpoint allows you to create a new catalog.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	Catalog name

DELETE Delete a catalog

/api/rest/v1/catalogs/{id}

This endpoint allows you to delete a catalog.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Catalog ID
`Response Type`	N/A

GET Get a catalog

/api/rest/v1/catalogs/{id}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Catalog ID
`Response Type`	N/A

GET Get the list of owned catalogs

/api/rest/v1/catalogs

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`Response Type`	N/A

PATCH Update a catalog

/api/rest/v1/catalogs/{id}

This endpoint allows you to update a catalog.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	Catalog ID
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	Catalog name

Category (5)

POST Create a new category

/api/rest/v1/categories

This endpoint allows you to create a new category.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Code`	Category code
`Parent`	Category code of the parent's category
`Updated`	Date of the last update
`Position`	Position of the category in its level, start from 1 (only available on SaaS platforms and when query parameter "with_position" is set to "true")

GET Get a category

/api/rest/v1/categories/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`With Position`	Return information about category position into its category tree (only available on SaaS platforms)
`Response Type`	N/A

GET Get list of categories

/api/rest/v1/categories

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter categories, for more details see the Filters section.
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`With Position`	Return information about category position into its category tree (only available on SaaS platforms)
`Response Type`	N/A

PATCH Update/create a category

/api/rest/v1/categories/{code}

This endpoint allows you to update a given category. Know more about Update behavior. Note that if no category exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (4)

Option Name	Description
`Code`	Category code
`Parent`	Category code of the parent's category
`Updated`	Date of the last update
`Position`	Position of the category in its level, start from 1 (only available on SaaS platforms and when query parameter "with_position" is set to "true")

PATCH Update/create several categories

/api/rest/v1/categories

This endpoint allows you to update several categories at once.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Code`	Category code
`Parent`	Category code of the parent's category
`Updated`	Date of the last update
`Position`	Position of the category in its level, start from 1 (only available on SaaS platforms and when query parameter "with_position" is set to "true")

Channel (5)

POST Create a new channel

/api/rest/v1/channels

This endpoint allows you to create a new channel.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Code`	Channel code
`Locales`	Codes of activated locales for the channel
`Currencies`	Codes of activated currencies for the channel
`Category Tree`	Code of the category tree linked to the channel

GET Get a channel

/api/rest/v1/channels/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get a list of channels

/api/rest/v1/channels

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

PATCH Update/create a channel

/api/rest/v1/channels/{code}

This endpoint allows you to update a given channel. Know more about Update behavior. Note that if no channel exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (4)

Option Name	Description
`Code`	Channel code
`Locales`	Codes of activated locales for the channel
`Currencies`	Codes of activated currencies for the channel
`Category Tree`	Code of the category tree linked to the channel

PATCH Update/create several channels

/api/rest/v1/channels

This endpoint allows you to update and/or create several channels at once.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Code`	Channel code
`Locales`	Codes of activated locales for the channel
`Currencies`	Codes of activated currencies for the channel
`Category Tree`	Code of the category tree linked to the channel

Currency (2)

GET Get a currency

/api/rest/v1/currencies/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get a list of currencies

/api/rest/v1/currencies

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

Download

GET Download Asset

x-oneteg-downloader-path-with-authorization

Parameters

Parameter Name	Description
`HTTP Method`	N/A
`Download Url`	N/A
`Asset Name`	N/A
`Try Count`	N/A
`Read Timeout (seconds)`	N/A
`Connection Timeout (seconds)`	N/A
`Load File Content As Output`	This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details.
`Follow Redirects`	Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects.
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A

Family variant (4)

GET Get a family variant

/api/rest/v1/families/{family_code}/variants/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Family Code`	Code of the family
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of family variants

/api/rest/v1/families/{family_code}/variants

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Family Code`	Code of the family
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

PATCH Update/create a family variant

/api/rest/v1/families/{family_code}/variants/{code}

This endpoint allows you to update a given family variant. Know more about Update behavior. Note that if no family variant exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Family Code`	Code of the family
`Code`	Code of the resource
`Response Type`	N/A

Options (1)

Option Name	Description
`Code`	Family variant code

PATCH Update/create several family variants

/api/rest/v1/families/{family_code}/variants

This endpoint allows you to update and/or create several family variants at once, for a given family.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Family Code`	Code of the family
`Response Type`	N/A

Options (1)

Option Name	Description
`Code`	Family variant code

Family (6)

POST Create a new family

/api/rest/v1/families

This endpoint allows you to create a new family.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Code`	Family code
`Attribute As Label`	Attribute code used as label
`Attribute As Image`	Attribute code used as the main picture in the user interface (only since v2.0)
`Attributes`	Attributes codes that compose the family

POST Create a new family variant

/api/rest/v1/families/{family_code}/variants

This endpoint allows you to create a family variant.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Family Code`	Code of the family
`Response Type`	N/A

Options (1)

Option Name	Description
`Code`	Family variant code

GET Get a family

/api/rest/v1/families/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of families

/api/rest/v1/families

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter families, for more details see the Filters section.
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

PATCH Update/create a family

/api/rest/v1/families/{code}

This endpoint allows you to update a given family. Know more about Update behavior. Note that if no family exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (4)

Option Name	Description
`Code`	Family code
`Attribute As Label`	Attribute code used as label
`Attribute As Image`	Attribute code used as the main picture in the user interface (only since v2.0)
`Attributes`	Attributes codes that compose the family

PATCH Update/create several families

/api/rest/v1/families

This endpoint allows you to update and/or create several families at once.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Code`	Family code
`Attribute As Label`	Attribute code used as label
`Attribute As Image`	Attribute code used as the main picture in the user interface (only since v2.0)
`Attributes`	Attributes codes that compose the family

Locale (2)

GET Get a list of locales

/api/rest/v1/locales

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter locales, for more details see the Filters section
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

GET Get a locale

/api/rest/v1/locales/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Measure family (2)

GET Get a measure family

/api/rest/v1/measure-families/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of measure familiy

/api/rest/v1/measure-families

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Measurement family (2)

GET Get list of measurement families

/api/rest/v1/measurement-families

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

PATCH Update/create several measurement families

/api/rest/v1/measurement-families

This endpoint allows you to update and/or create several measurement families at once.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Code`	Measurement family code
`Standard Unit Code`	Unit code used as the standard unit for this measurement family

Overview

GET Get list of all endpoints

/api/rest/v1

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

PAM asset category (5)

POST Create a new PAM asset category

/api/rest/v1/asset-categories

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Code`	PAM asset category code
`Parent`	PAM ssset category code of the parent's asset category

GET Get a PAM asset category

/api/rest/v1/asset-categories/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of PAM asset categories

/api/rest/v1/asset-categories

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

PATCH Update/create a PAM asset category

/api/rest/v1/asset-categories/{code}

This endpoint allows you to update a given PAM asset category. Know more about Update behavior. Note that if no category exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (2)

Option Name	Description
`Code`	PAM asset category code
`Parent`	PAM ssset category code of the parent's asset category

PATCH Update/create several PAM asset categories

/api/rest/v1/asset-categories

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Code`	PAM asset category code
`Parent`	PAM ssset category code of the parent's asset category

PAM asset reference file (3)

GET Download a reference file

/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/download

This endpoint allows you to download a given reference file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Code`	Code of the asset
`Locale Code`	Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable
`Response Type`	N/A

GET Get a reference file

/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Code`	Code of the asset
`Locale Code`	Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable
`Response Type`	N/A

POST Upload a new reference file

/api/rest/v1/assets/{asset_code}/reference-files/{locale_code}

This endpoint allows you to upload a new reference file for a given PAM asset and locale. It will also automatically generate all the variation files corresponding to this reference file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Code`	Code of the asset
`Locale Code`	Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable
`Content-type`	Equal to 'multipart/form-data', no other value allowed
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	The binaries of the file

PAM asset tag (3)

GET Get a PAM asset tag

/api/rest/v1/asset-tags/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of PAM asset tags

/api/rest/v1/asset-tags

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

PATCH Update/create a PAM asset tag

/api/rest/v1/asset-tags/{code}

This endpoint allows you to update a given PAM asset tag. Know more about Update behavior. Note that if no tag exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (1)

Option Name	Description
`Code`	PAM asset tag code

PAM asset variation file (3)

GET Download a variation file

/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/download

This endpoint allows you to download a given variation file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Code`	Code of the asset
`Channel Code`	Code of the channel
`Locale Code`	Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable
`Response Type`	N/A

GET Get a variation file

/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Code`	Code of the asset
`Channel Code`	Code of the channel
`Locale Code`	Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable
`Response Type`	N/A

POST Upload a new variation file

/api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}

This endpoint allows you to upload a new variation file for a given PAM asset, channel and locale.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Asset Code`	Code of the asset
`Channel Code`	Code of the channel
`Locale Code`	Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable
`Content-type`	Equal to 'multipart/form-data', no other value allowed
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	The binaries of the file

PAM asset (5)

POST Create a new PAM asset

/api/rest/v1/assets

This endpoint allows you to create a new PAM asset.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Code`	PAM asset code
`Categories`	Codes of the PAM asset categories in which the asset is classified
`Description`	Description of the PAM asset
`Localizable`	Whether the asset is localized or not, meaning if you want to have different reference files for each of your locale
`Tags`	Tags of the PAM asset
`End Of Use`	Date on which the PAM asset expire

GET Get a PAM asset

/api/rest/v1/assets/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of PAM assets

/api/rest/v1/assets

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Pagination Type`	Pagination method type, see Pagination section
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

PATCH Update/create a PAM asset

/api/rest/v1/assets/{code}

This endpoint allows you to update a given PAM asset. Know more about Update behavior. Note that if no asset exists for the given code, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (6)

Option Name	Description
`Code`	PAM asset code
`Categories`	Codes of the PAM asset categories in which the asset is classified
`Description`	Description of the PAM asset
`Localizable`	Whether the asset is localized or not, meaning if you want to have different reference files for each of your locale
`Tags`	Tags of the PAM asset
`End Of Use`	Date on which the PAM asset expire

PATCH Update/create several PAM assets

/api/rest/v1/assets

This endpoint allows you to update several PAM assets at once.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Code`	PAM asset code
`Categories`	Codes of the PAM asset categories in which the asset is classified
`Description`	Description of the PAM asset
`Localizable`	Whether the asset is localized or not, meaning if you want to have different reference files for each of your locale
`Tags`	Tags of the PAM asset
`End Of Use`	Date on which the PAM asset expire

Product [identifier] (8)

POST Create a new product

/api/rest/v1/products

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.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (10)

Option Name	Description
`Uuid`	Product UUID
`Identifier`	Product identifier, i.e. the value of the only pim_catalog_identifier attribute
`Enabled`	Whether the product is enabled
`Family`	Family code from which the product inherits its attributes and attributes requirements.
`Categories`	Codes of the categories in which the product is classified
`Groups`	Codes of the groups to which the product belong
`Parent`	Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3.
`Created`	Date of creation
`Updated`	Date of the last update
`Quality Scores`	Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true")

DELETE Delete a product

/api/rest/v1/products/{code}

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get a draft

/api/rest/v1/products/{code}/draft

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get a product

/api/rest/v1/products/{code}

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`With Attribute Options`	Return labels of attribute options in the response. (Only available since the 5.0 version)
`With Quality Scores`	Return product quality scores in the response. (Only available since the 5.0 version)
`With Completenesses`	Return product completenesses in the response. (Only available on SaaS platforms)
`Response Type`	N/A

GET Get list of products

/api/rest/v1/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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter products, for more details see the Filters section
`Scope`	Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section
`Locales`	Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section
`Attributes`	Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section
`Pagination Type`	Pagination method type, see Pagination section
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`With Attribute Options`	Return labels of attribute options in the response. (Only available since the 5.0 version)
`With Quality Scores`	Return product quality scores in the response. (Only available since the 5.0 version)
`With Completenesses`	Return product completenesses in the response. (Only available on SaaS platforms)
`Response Type`	N/A

POST Submit a draft for approval

/api/rest/v1/products/{code}/proposal

This endpoint allows you to submit a draft for approval.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

PATCH Update/create a product

/api/rest/v1/products/{code}

This endpoint allows you to update a given product. Learn more about Update behavior. Note that if no product exists for the given identifier, it creates it. In the Entreprise Edition, since the v2.0, permissions based on your user groups are applied to the product you try to update. It may result in the creation of a draft if you only have edit rights through the product's categories.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (11)

Option Name	Description
`Uuid`	Product UUID
`Identifier`	Product identifier, i.e. the value of the only pim_catalog_identifier attribute
`Enabled`	Whether the product is enabled
`Family`	Family code from which the product inherits its attributes and attributes requirements.
`Categories`	Codes of the categories in which the product is classified
`Groups`	Codes of the groups to which the product belong
`Parent`	Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3.
`Created`	Date of creation
`Updated`	Date of the last update
`Quality Scores`	Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true")
`Completenesses`	Product completenesses for each channel/locale combination (only available on SaaS platforms, and when the "with_completenesses" query parameter is set to "true")

PATCH Update/create several products

/api/rest/v1/products

This endpoint allows you to update and/or create several products at once. Learn more about Update behavior. Note that if no product exists for the given identifier, it creates it. In the Enterprise Edition, since the v2.0, permissions based on your user groups are applied to the products you try to update. It may result in the creation of drafts if you only have edit rights through the product's categories.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (10)

Option Name	Description
`Uuid`	Product UUID
`Identifier`	Product identifier, i.e. the value of the only pim_catalog_identifier attribute
`Enabled`	Whether the product is enabled
`Family`	Family code from which the product inherits its attributes and attributes requirements.
`Categories`	Codes of the categories in which the product is classified
`Groups`	Codes of the groups to which the product belong
`Parent`	Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3.
`Created`	Date of creation
`Updated`	Date of the last update
`Quality Scores`	Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true")

Product [uuid] (8)

POST Create a new product

/api/rest/v1/products-uuid

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.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Uuid`	Product uuid
`Enabled`	Whether the product is enabled
`Family`	Family code from which the product inherits its attributes and attributes requirements.
`Categories`	Codes of the categories in which the product is classified
`Groups`	Codes of the groups to which the product belong
`Parent`	Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3.
`Created`	Date of creation
`Updated`	Date of the last update
`Quality Scores`	Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true")

DELETE Delete a product

/api/rest/v1/products-uuid/{uuid}

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Uuid`	Uuid of the resource
`Response Type`	N/A

GET Get a draft

/api/rest/v1/products-uuid/{uuid}/draft

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Uuid`	Uuid of the resource
`Response Type`	N/A

GET Get a product

/api/rest/v1/products-uuid/{uuid}

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Uuid`	Uuid of the resource
`With Attribute Options`	Return labels of attribute options in the response. (Only available since the 5.0 version)
`With Quality Scores`	Return product quality scores in the response. (Only available since the 5.0 version)
`With Completenesses`	Return product completenesses in the response. (Only available on SaaS platforms)
`Response Type`	N/A

GET Get list of products

/api/rest/v1/products-uuid

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter products, for more details see the Filters section
`Scope`	Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section
`Locales`	Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section
`Attributes`	Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section
`Pagination Type`	Pagination method type, see Pagination section
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`With Attribute Options`	Return labels of attribute options in the response. (Only available since the 5.0 version)
`With Quality Scores`	Return product quality scores in the response. (Only available since the 5.0 version)
`With Completenesses`	Return product completenesses in the response. (Only available on SaaS platforms)
`Response Type`	N/A

POST Submit a draft for approval

/api/rest/v1/products-uuid/{uuid}/proposal

This endpoint allows you to submit a draft for approval.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Uuid`	Uuid of the resource
`Response Type`	N/A

PATCH Update/create a product

/api/rest/v1/products-uuid/{uuid}

This endpoint allows you to update a given product. Learn more about Update behavior. Note that if no product exists for the given uuid, it creates it. In the Entreprise Edition, permissions based on your user groups are applied to the product you try to update. It may result in the creation of a draft if you only have edit rights through the product's categories.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Uuid`	Uuid of the resource
`Response Type`	N/A

Options (9)

Option Name	Description
`Uuid`	Product uuid
`Enabled`	Whether the product is enabled
`Family`	Family code from which the product inherits its attributes and attributes requirements.
`Categories`	Codes of the categories in which the product is classified
`Groups`	Codes of the groups to which the product belong
`Parent`	Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3.
`Created`	Date of creation
`Updated`	Date of the last update
`Quality Scores`	Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true")

PATCH Update/create several products

/api/rest/v1/products-uuid

This endpoint allows you to update and/or create several products at once. Learn more about Update behavior. Note that if no product exists for the given uuid, it creates it. In the Enterprise Edition, permissions based on your user groups are applied to the products you try to update. It may result in the creation of drafts if you only have edit rights through the product's categories.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Uuid`	Product uuid
`Enabled`	Whether the product is enabled
`Family`	Family code from which the product inherits its attributes and attributes requirements.
`Categories`	Codes of the categories in which the product is classified
`Groups`	Codes of the groups to which the product belong
`Parent`	Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3.
`Created`	Date of creation
`Updated`	Date of the last update
`Quality Scores`	Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true")

Product media file (4)

POST Create a new product media file

/api/rest/v1/media-files

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	Equal to 'multipart/form-data', no other value allowed
`Response Type`	N/A

Options (3)

Option Name	Description
`Product`	The product to which the media file will be associated. It is a JSON string that follows this format '{"identifier":"product_identifier", "attribute":"attribute_code", "scope":"channel_code","locale":"locale_code"}'. You have to either use this field or the product_model field, but not both at the same time.
`Product Model`	The product model to which the media file will be associated. It is a JSON string that follows this format '{"code":"product_model_code", "attribute":"attribute_code", "scope":"channel_code","locale":"locale_code"}'. You have to either use this field or the product field, but not both at the same time.
`File`	The binaries of the file

GET Download a product media file

/api/rest/v1/media-files/{code}/download

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get a list of product media files

/api/rest/v1/media-files

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

GET Get a product media file

/api/rest/v1/media-files/{code}

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Product model (8)

POST Create a new product model

/api/rest/v1/product-models

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.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Code`	Product model code
`Family`	Family code from which the product inherits its attributes and attributes requirements (since the 3.2)
`Family Variant`	Family variant code from which the product model inherits its attributes and variant attributes
`Parent`	Code of the parent product model. This parent can be modified since the 2.3.
`Categories`	Codes of the categories in which the product model is categorized
`Created`	Date of creation
`Updated`	Date of the last update
`Quality Scores`	Product model quality scores for each channel/locale combination (only available on SaaS platforms and when the "with_quality_scores" query parameter is set to "true")

DELETE Delete a product model

/api/rest/v1/product-models/{code}

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get a draft

/api/rest/v1/product-models/{code}/draft

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get a product model

/api/rest/v1/product-models/{code}

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`With Quality Scores`	Return product model quality scores in the response. (Only available on SaaS platforms)
`Response Type`	N/A

GET Get list of product models

/api/rest/v1/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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter product models, for more details see the Filters section
`Scope`	Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section
`Locales`	Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section
`Attributes`	Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section and the Filter on product model properties section
`Pagination Type`	Pagination method type, see Pagination section
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`With Quality Scores`	Return product model quality scores in the response. (Only available on SaaS platforms)
`Response Type`	N/A

POST Submit a draft for approval

/api/rest/v1/product-models/{code}/proposal

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

PATCH Update/create a product model

/api/rest/v1/product-models/{code}

This endpoint allows you to update a given product model. Learn more about Update behavior. Note that if no product model exists for the given code, it creates it. In the Enterprise Edition PIM since the 2.3, permissions based on your user groups are applied to the product model you try to update. It may result in the creation of a draft if you only have edit rights through the product model's categories.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (8)

Option Name	Description
`Code`	Product model code
`Family`	Family code from which the product inherits its attributes and attributes requirements (since the 3.2)
`Family Variant`	Family variant code from which the product model inherits its attributes and variant attributes
`Parent`	Code of the parent product model. This parent can be modified since the 2.3.
`Categories`	Codes of the categories in which the product model is categorized
`Created`	Date of creation
`Updated`	Date of the last update
`Quality Scores`	Product model quality scores for each channel/locale combination (only available on SaaS platforms and when the "with_quality_scores" query parameter is set to "true")

PATCH Update/create several product models

/api/rest/v1/product-models

This endpoint allows you to update and/or create several product models at once. Learn more about Update behavior. Note that if no product models exists for the given code, it creates it. In the Enterprise Edition, since the v2.3, permissions based on your user groups are applied to the product models you try to update. It may result in the creation of drafts if you only have edit rights through the product model's categories.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (8)

Option Name	Description
`Code`	Product model code
`Family`	Family code from which the product inherits its attributes and attributes requirements (since the 3.2)
`Family Variant`	Family variant code from which the product model inherits its attributes and variant attributes
`Parent`	Code of the parent product model. This parent can be modified since the 2.3.
`Categories`	Codes of the categories in which the product model is categorized
`Created`	Date of creation
`Updated`	Date of the last update
`Quality Scores`	Product model quality scores for each channel/locale combination (only available on SaaS platforms and when the "with_quality_scores" query parameter is set to "true")

Published product (2)

GET Get a published product

/api/rest/v1/published-products/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of published products

/api/rest/v1/published-products

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter published products, for more details see the Filters section
`Scope`	Filter published product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter on published product values section
`Locales`	Filter published product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter on published product values section
`Attributes`	Filter published product values to only return those concerning the given attributes, for more details see the Filter on product values section
`Pagination Type`	Pagination method type, see Pagination section
`Page`	Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Limit`	Number of results by page, see Pagination section
`With Count`	Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way
`Response Type`	N/A

Reference entity attribute option (3)

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

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Reference Entity Code`	Code of the reference entity
`Attribute Code`	Code of the attribute
`Response Type`	N/A

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

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Reference Entity Code`	Code of the reference entity
`Attribute Code`	Code of the attribute
`Code`	Code of the resource
`Response Type`	N/A

PATCH Update/create a reference entity attribute option

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}

This endpoint allows you to update a given option for a given attribute and a given reference entity. Learn more about Update behavior. Note that if the option does not already exist for the given attribute of the given reference entity, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Reference Entity Code`	Code of the reference entity
`Attribute Code`	Code of the attribute
`Code`	Code of the resource
`Response Type`	N/A

Options (1)

Option Name	Description
`Code`	Attribute's option code

Reference entity attribute (3)

GET Get an attribute of a given reference entity

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Reference Entity Code`	Code of the reference entity
`Code`	Code of the resource
`Response Type`	N/A

GET Get the list of attributes of a given reference entity

/api/rest/v1/reference-entities/{reference_entity_code}/attributes

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Reference Entity Code`	Code of the reference entity
`Response Type`	N/A

PATCH Update/create an attribute of a given reference entity

/api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Reference Entity Code`	Code of the reference entity
`Code`	Code of the resource
`Response Type`	N/A

Options (16)

Option Name	Description
`Code`	Attribute code
`Type`	Attribute type. See type section for more details.
`Value Per Locale`	Whether the attribute is localizable, i.e. can have one value by locale
`Value Per Channel`	Whether the attribute is scopable, i.e. can have one value by channel
`Is Required For Completeness`	Whether the attribute should be part of the record's completeness calculation
`Max Characters`	Maximum number of characters allowed for the value of the attribute when the attribute type is text
`Is Textarea`	Whether the UI should display a text area instead of a simple field when the attribute type is text
`Is Rich Text Editor`	Whether the UI should display a rich text editor instead of a simple text area when the attribute type is text
`Validation Rule`	Validation rule type used to validate the attribute value when the attribute type is text
`Validation Regexp`	Regexp expression used to validate the attribute value when the attribute type is text
`Allowed Extensions`	Extensions allowed when the attribute type is image
`Max File Size`	Max file size in MB when the attribute type is image
`Reference Entity Code`	Code of the linked reference entity when the attribute type is reference_entity_single_link or reference_entity_multiple_links
`Decimals Allowed`	Whether decimals are allowed when the attribute type is number
`Min Value`	Minimum value allowed when the attribute type is number
`Max Value`	Maximum value allowed when the attribute type is number

Reference entity media file (2)

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

/api/rest/v1/reference-entities-media-files

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.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	Equal to 'multipart/form-data', no other value allowed
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	The binary of the media file

GET Download the media file associated to a reference entity or a record

/api/rest/v1/reference-entities-media-files/{code}

This endpoint allows you to download a given media file that is associated with a reference entity or a record.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Reference entity record (4)

GET Get a record of a given reference entity

/api/rest/v1/reference-entities/{reference_entity_code}/records/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Reference Entity Code`	Code of the reference entity
`Code`	Code of the resource
`Response Type`	N/A

GET Get the list of the records of a reference entity

/api/rest/v1/reference-entities/{reference_entity_code}/records

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search`	Filter records of the reference entity, for more details see the Filters section
`Channel`	Filter attribute values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter attribute values by channel section
`Locales`	Filter attribute values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter attribute values by locale section
`Reference Entity Code`	Code of the reference entity
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Response Type`	N/A

PATCH Update/create a record of a given reference entity

/api/rest/v1/reference-entities/{reference_entity_code}/records/{code}

This endpoint allows you to update a given record of a given renference entity. Learn more about Update behavior. Note that if the record does not already exist for the given reference entity, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Reference Entity Code`	Code of the reference entity
`Code`	Code of the resource
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Code of the record
`Created`	Date of creation. (Only available on SaaS platforms)
`Updated`	Date of the last update. (Only available on SaaS platforms)

PATCH Update/create several reference entity records

/api/rest/v1/reference-entities/{reference_entity_code}/records

This endpoint allows you to update and/or create several records of one given reference entity at once. Learn more about Update behavior. Note that if the record does not already exist for the given reference entity, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Reference Entity Code`	Code of the reference entity
`Response Type`	N/A

Options (3)

Option Name	Description
`Code`	Code of the record
`Created`	Date of creation. (Only available on SaaS platforms)
`Updated`	Date of the last update. (Only available on SaaS platforms)

Reference entity (3)

GET Get a reference entity

/api/rest/v1/reference-entities/{code}

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

GET Get list of reference entities

/api/rest/v1/reference-entities

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Search After`	Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
`Response Type`	N/A

PATCH Update/create a reference entity

/api/rest/v1/reference-entities/{code}

This endpoint allows you to update a given reference entity. Note that if the reference entity does not already exist, it creates it.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Code`	Code of the resource
`Response Type`	N/A

Options (2)

Option Name	Description
`Code`	Reference entity code
`Image`	Code of the reference entity image

System

GET Get system information

/api/rest/v1/system-information

This endpoint allows you to get the version and the edition of the PIM. Example of what you can get Environment Edition Version SaaS EE Serenity 20210531021241 SaaS CE GE growth-v20210526040645 PaaS or onPrem EE EE 5.0.28 PaaS or onPrem CE CE 5.0.28

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A