@datafire/akeneo

Client library for Akeneo PIM API

Installation and Usage

npm install --save @datafire/akeneo

let akeneo = require('@datafire/akeneo').create();

.then(data => {
  console.log(data);
});

Description

Actions

post_token

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

akeneo.post_token({
  "Content-type": "",
  "Authorization": ""
}, context)

Input

• input object
  • Content-type required string: Equal to 'application/json' or 'application/x-www-form-urlencoded', no other value allowed
  • Authorization required string: 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.
  • body object
    • grant_type required string: Always equal to "password"
    • password required string: Your PIM password
    • username required string: Your PIM username

Output

• output object
  • access_token string: Authentication token that should be given in every authenticated request to the API
  • expires_in integer: Validity of the token given in seconds, 3600s = 1h by default
  • refresh_token string: Use this token when your access token has expired. See Refresh an expired token section for more details.
  • scope string: Unused, always equal to "null"
  • token_type string: Token type, always equal to "bearer"

get_endpoints

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

akeneo.get_endpoints(null, context)

Input

This action has no parameters

Output

• output object
  • authentication object: Endpoint to get the authentication token
  • host string: Host name
  • routes object: All the availables endpoints

get_asset_categories

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

akeneo.get_asset_categories({}, context)

Input

• input object
  • page integer: Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
  • limit integer: Number of results by page, see Pagination section
  • with_count boolean: Return the count of products in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

Output

• output object
  • _links object
    • first object
      • href string: URI of the first page of resources
    • next object
      • href string: URI of the next page of resources
    • previous object
      • href string: URI of the previous page of resources
    • self object
      • href string: URI of the current page of resources
  • current_page integer: Current page number
  • _embedded object
    • items array
      • items object
        • _links object
          • self object
        • code required string: PAM asset category code
        • labels object: PAM asset category labels for each locale
          • localeCode string: PAM asset category label for the locale localeCode
        • parent string: PAM ssset category code of the parent's asset category

patch_asset_categories

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

akeneo.patch_asset_categories({}, context)

Input

• input object
  • body object
    • code required string: PAM asset category code
    • labels object: PAM asset category labels for each locale
      • localeCode string: PAM asset category label for the locale localeCode
    • parent string: PAM ssset category code of the parent's asset category

Output

• output object
  • code string: Resource code, only filled when the resource is not a product
  • identifier string: Resource identifier, only filled when the resource is a product
  • line integer: Line number
  • message string: Message explaining the error
  • status_code integer: HTTP status code, see Client errors to understand the meaning of each code

post_asset_categories

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

akeneo.post_asset_categories({}, context)

Input

• input object
  • body object
    • code required string: PAM asset category code
    • labels object: PAM asset category labels for each locale
      • localeCode string: PAM asset category label for the locale localeCode
    • parent string: PAM ssset category code of the parent's asset category

Output

Output schema unknown

get_asset_categories__code_

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

akeneo.get_asset_categories__code_({
  "code": ""
}, context)

Input

• input object
  • code required string: Code of the resource

Output

• output object
  • code required string: PAM asset category code
  • labels object: PAM asset category labels for each locale
    • localeCode string: PAM asset category label for the locale localeCode
  • parent string: PAM ssset category code of the parent's asset category

patch_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.

akeneo.patch_asset_categories__code_({
  "code": "",
  "body": {
    "code": ""
  }
}, context)

Input

• input object
  • code required string: Code of the resource
  • body required object
    • code required string: PAM asset category code
    • labels object: PAM asset category labels for each locale
      • localeCode string: PAM asset category label for the locale localeCode
    • parent string: PAM ssset category code of the parent's asset category

Output

Output schema unknown

get_asset_families

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

akeneo.get_asset_families({}, context)

Input

• input object
  • search_after string: Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section

Output

• output object
  • _links object
    • first object
      • href string: URI of the first page of resources
    • next object
      • href string: URI of the next page of resources
    • self object
      • href string: URI of the current page of resources
  • _embedded object
    • _items array
      • items object
        • _links object
          • self object
        • attribute_as_main_media string: Attribute code that is used as the main media of the asset family.
        • code required string: Asset family code
        • labels object: Asset family labels for each locale
          • localeCode string: Asset family label for the locale localeCode
        • naming_convention object: The naming convention ran over the asset code or the main media filename upon each asset creation, in order to automatically set several values in asset attributes. To learn more and see the format of this property, take a look at here.
          • abort_asset_creation_on_error boolean: Whether the asset should be created if the naming convention failed to apply. More details here.
          • pattern string: The regular expression that should be applied on the source. More details here.
          • source object: The string on which the naming convention should be applied. More details here.
        • product_link_rules array: The rules that will be run after the asset creation, in order to automatically link the assets of this family to a set of products. To understand the format of this property, see here.
          • items object
        • transformations array: The transformations to perform on source files in order to generate new files into your asset attributes (only available since v4.0). To understand the format of this property, see here.
          • items object

get_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.

akeneo.get_assets({
  "asset_family_code": ""
}, context)

Input

• input object
  • search string: Filter assets, for more details see the Asset filters section
  • channel string: 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 string: 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 required string: Code of the asset family
  • search_after string: Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section

Output

• output object
  • _links object
    • first object
      • href string: URI of the first page of resources
    • next object
      • href string: URI of the next page of resources
    • self object
      • href string: URI of the current page of resources
  • _embedded object
    • _items array
      • items object
        • _links object
          • self object
        • code required string: Code of the asset
        • values object: Asset attributes values, see the Focus on the asset values section for more details.
          • attributeCode array

patch_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.

akeneo.patch_assets({
  "asset_family_code": "",
  "body": []
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family
  • body required array
    • items object
      • code required string: Code of the asset
      • values object: Asset attributes values, see the Focus on the asset values section for more details.
        • attributeCode array
          • items object

Output

• output array
  • items object
    • code string: Resource code
    • message string: Message explaining the error
    • status_code integer: HTTP status code, see Client errors to understand the meaning of each code

delete_assets__code_

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

akeneo.delete_assets__code_({
  "asset_family_code": "",
  "code": ""
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family
  • code required string: Code of the resource

Output

Output schema unknown

get_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.

akeneo.get_assets__code_({
  "asset_family_code": "",
  "code": ""
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family
  • code required string: Code of the resource

Output

• output object
  • code required string: Code of the asset
  • values object: Asset attributes values, see the Focus on the asset values section for more details.
    • attributeCode array
      • items object
        • channel string: Channel code of the asset attribute value
        • data object: Asset attribute value
        • locale string: Locale code of the asset attribute value

patch_asset__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.

akeneo.patch_asset__code_({
  "asset_family_code": "",
  "code": "",
  "body": {
    "code": ""
  }
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family
  • code required string: Code of the resource
  • body required object
    • code required string: Code of the asset
    • values object: Asset attributes values, see the Focus on the asset values section for more details.
      • attributeCode array
        • items object
          • channel string: Channel code of the asset attribute value
          • data object: Asset attribute value
          • locale string: Locale code of the asset attribute value

Output

Output schema unknown

get_asset_families__code__attributes

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

akeneo.get_asset_families__code__attributes({
  "asset_family_code": ""
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family

Output

• output array
  • items object
    • allowed_extensions array: Extensions allowed when the attribute type is media_file
      • items string
    • code required string: Attribute code
    • decimals_allowed boolean: Whether decimals are allowed when the attribute type is number
    • is_read_only boolean: Whether the attribute should be in read only mode only in the UI, but you can still update it with the API
    • is_required_for_completeness boolean: Whether the attribute should be part of the record's completeness calculation
    • is_rich_text_editor boolean: Whether the UI should display a rich text editor instead of a simple text area when the attribute type is text
    • is_textarea boolean: Whether the UI should display a text area instead of a simple field when the attribute type is text
    • labels object: Attribute labels for each locale
      • localeCode string: Attribute label for the locale localeCode
    • max_characters integer: Maximum number of characters allowed for the value of the attribute when the attribute type is text
    • max_file_size string: Max file size in MB when the attribute type is media_file
    • max_value string: Maximum value allowed when the attribute type is number
    • media_type required string (values: image, pdf, youtube, vimeo, other): 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.
    • min_value string: Minimum value allowed when the attribute type is number
    • prefix string: Prefix of the media_link attribute type. The common url root that prefixes the link to the media
    • suffix string: Suffix of the media_link attribute type. The common url suffix for the media
    • type required string (values: text, media_link, number, media_file, single_option, multiple_options, reference_entity_single_link, reference_entity_multiple_links): Attribute type
    • validation_regexp string: Regexp expression used to validate the attribute value when the attribute type is text
    • validation_rule string (values: email, url, regexp, none): Validation rule type used to validate the attribute value when the attribute type is text
    • value_per_channel boolean: Whether the attribute is scopable, i.e. can have one value by channel
    • value_per_locale boolean: Whether the attribute is localizable, i.e. can have one value by locale

get_asset_family_attributes__attribute_code__options

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

akeneo.get_asset_family_attributes__attribute_code__options({
  "asset_family_code": "",
  "attribute_code": ""
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family
  • attribute_code required string: Code of the attribute

Output

• output array
  • items object
    • code required string: Attribute's option code
    • labels object: Attribute labels for each locale
      • localeCode string: Attribute label for the locale localeCode

get_asset_attributes__attribute_code__options__code_

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

akeneo.get_asset_attributes__attribute_code__options__code_({
  "asset_family_code": "",
  "attribute_code": "",
  "code": ""
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family
  • attribute_code required string: Code of the attribute
  • code required string: Code of the resource

Output

• output object
  • code required string: Attribute's option code
  • labels object: Attribute labels for each locale
    • localeCode string: Attribute label for the locale localeCode

patch_asset_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.

akeneo.patch_asset_attributes__attribute_code__options__code_({
  "asset_family_code": "",
  "attribute_code": "",
  "code": "",
  "body": {
    "code": ""
  }
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family
  • attribute_code required string: Code of the attribute
  • code required string: Code of the resource
  • body required object
    • code required string: Attribute's option code
    • labels object: Attribute labels for each locale
      • localeCode string: Attribute label for the locale localeCode

Output

Output schema unknown

get_asset_family_attributes__code_

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

akeneo.get_asset_family_attributes__code_({
  "asset_family_code": "",
  "code": ""
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family
  • code required string: Code of the resource

Output

• output object
  • allowed_extensions array: Extensions allowed when the attribute type is media_file
    • items string
  • code required string: Attribute code
  • decimals_allowed boolean: Whether decimals are allowed when the attribute type is number
  • is_read_only boolean: Whether the attribute should be in read only mode only in the UI, but you can still update it with the API
  • is_required_for_completeness boolean: Whether the attribute should be part of the record's completeness calculation
  • is_rich_text_editor boolean: Whether the UI should display a rich text editor instead of a simple text area when the attribute type is text
  • is_textarea boolean: Whether the UI should display a text area instead of a simple field when the attribute type is text
  • labels object: Attribute labels for each locale
    • localeCode string: Attribute label for the locale localeCode
  • max_characters integer: Maximum number of characters allowed for the value of the attribute when the attribute type is text
  • max_file_size string: Max file size in MB when the attribute type is media_file
  • max_value string: Maximum value allowed when the attribute type is number
  • media_type required string (values: image, pdf, youtube, vimeo, other): 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.
  • min_value string: Minimum value allowed when the attribute type is number
  • prefix string: Prefix of the media_link attribute type. The common url root that prefixes the link to the media
  • suffix string: Suffix of the media_link attribute type. The common url suffix for the media
  • type required string (values: text, media_link, number, media_file, single_option, multiple_options, reference_entity_single_link, reference_entity_multiple_links): Attribute type
  • validation_regexp string: Regexp expression used to validate the attribute value when the attribute type is text
  • validation_rule string (values: email, url, regexp, none): Validation rule type used to validate the attribute value when the attribute type is text
  • value_per_channel boolean: Whether the attribute is scopable, i.e. can have one value by channel
  • value_per_locale boolean: Whether the attribute is localizable, i.e. can have one value by locale

patch_asset_family_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.

akeneo.patch_asset_family_attributes__code_({
  "asset_family_code": "",
  "code": "",
  "body": {
    "code": "",
    "type": "",
    "media_type": ""
  }
}, context)

Input

• input object
  • asset_family_code required string: Code of the asset family
  • code required string: Code of the resource
  • body required object
    • allowed_extensions array: Extensions allowed when the attribute type is media_file
      • items string
    • code required string: Attribute code
    • decimals_allowed boolean: Whether decimals are allowed when the attribute type is number
    • is_read_only boolean: Whether the attribute should be in read only mode only in the UI, but you can still update it with the API
    • is_required_for_completeness boolean: Whether the attribute should be part of the record's completeness calculation
    • is_rich_text_editor boolean: Whether the UI should display a rich text editor instead of a simple text area when the attribute type is text
    • is_textarea boolean: Whether the UI should display a text area instead of a simple field when the attribute type is text
    • labels object: Attribute labels for each locale
      • localeCode string: Attribute label for the locale localeCode
    • max_characters integer: Maximum number of characters allowed for the value of the attribute when the attribute type is text
    • max_file_size string: Max file size in MB when the attribute type is media_file
    • max_value string: Maximum value allowed when the attribute type is number
    • media_type required string (values: image, pdf, youtube, vimeo, other): 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.
    • min_value string: Minimum value allowed when the attribute type is number
    • prefix string: Prefix of the media_link attribute type. The common url root that prefixes the link to the media
    • suffix string: Suffix of the media_link attribute type. The common url suffix for the media
    • type required string (values: text, media_link, number, media_file, single_option, multiple_options, reference_entity_single_link, reference_entity_multiple_links): Attribute type
    • validation_regexp string: Regexp expression used to validate the attribute value when the attribute type is text
    • validation_rule string (values: email, url, regexp, none): Validation rule type used to validate the attribute value when the attribute type is text
    • value_per_channel boolean: Whether the attribute is scopable, i.e. can have one value by channel
    • value_per_locale boolean: Whether the attribute is localizable, i.e. can have one value by locale

Output

Output schema unknown

get_asset_family__code_

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

akeneo.get_asset_family__code_({
  "code": ""
}, context)

Input

• input object
  • code required string: Code of the resource

Output

• output object
  • attribute_as_main_media string: Attribute code that is used as the main media of the asset family.
  • code required string: Asset family code
  • labels object: Asset family labels for each locale
    • localeCode string: Asset family label for the locale localeCode
  • naming_convention object: The naming convention ran over the asset code or the main media filename upon each asset creation, in order to automatically set several values in asset attributes. To learn more and see the format of this property, take a look at here.
    • abort_asset_creation_on_error boolean: Whether the asset should be created if the naming convention failed to apply. More details here.
    • pattern string: The regular expression that should be applied on the source. More details here.
    • source object: The string on which the naming convention should be applied. More details here.
  • product_link_rules array: The rules that will be run after the asset creation, in order to automatically link the assets of this family to a set of products. To understand the format of this property, see here.
    • items object
      • assign_assets_to array: The product value in which your assets will be assigned. More details here.
        • items object
          • attribute required string
          • channel string
          • locale string
          • mode required string
      • product_selections array: The product selection to which the assets of the asset family to be automatically linked. More details here.
        • items object
          • channel string
          • field required string
          • locale string
          • operator required string
          • value required string
  • transformations array: The transformations to perform on source files in order to generate new files into your asset attributes (only available since v4.0). To understand the format of this property, see here.
    • items object
      • filename_prefix string: The prefix that will be prepended to the source filename to generate the target filename. More details here.
      • filename_suffix string: The suffix that will be appended to the source filename to generate the target filename. More details here.
      • label required string: The name of the transformation
      • operations required object: The transformations that should be applied to your source file to generate the target file. More details here.
        • parameters object
          • colorspace string
          • height integer
          • quality integer
          • ratio integer
          • resolution-unit string
          • resolution-x integer
          • resolution-y integer
          • width integer
        • type string
      • source required object: The attribute value in which is stored the media file you want to use as the source file for your transformation. More details here.
        • attribute required string
        • channel required string
        • locale required string
      • target required object: The attribute value in which the PIM will generate the new transformed file, aka the target file. More details here.
        • attribute required string
        • channel required string
        • locale required string

patch_asset_family__code_

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

akeneo.patch_asset_family__code_({
  "code": "",
  "body": {
    "code": ""
  }
}, context)

Input

• input object
  • code required string: Code of the resource
  • body required object
    • attribute_as_main_media string: Attribute code that is used as the main media of the asset family.
    • code required string: Asset family code
    • labels object: Asset family labels for each locale
      • localeCode string: Asset family label for the locale localeCode
    • naming_convention object: The naming convention ran over the asset code or the main media filename upon each asset creation, in order to automatically set several values in asset attributes. To learn more and see the format of this property, take a look at here.
      • abort_asset_creation_on_error boolean: Whether the asset should be created if the naming convention failed to apply. More details here.
      • pattern string: The regular expression that should be applied on the source. More details here.
      • source object: The string on which the naming convention should be applied. More details here.
    • product_link_rules array: The rules that will be run after the asset creation, in order to automatically link the assets of this family to a set of products. To understand the format of this property, see here.
      • items object
        • assign_assets_to array: The product value in which your assets will be assigned. More details here.
          • items object
        • product_selections array: The product selection to which the assets of the asset family to be automatically linked. More details here.
          • items object
    • transformations array: The transformations to perform on source files in order to generate new files into your asset attributes (only available since v4.0). To understand the format of this property, see here.
      • items object
        • filename_prefix string: The prefix that will be prepended to the source filename to generate the target filename. More details here.
        • filename_suffix string: The suffix that will be appended to the source filename to generate the target filename. More details here.
        • label required string: The name of the transformation
        • operations required object: The transformations that should be applied to your source file to generate the target file. More details here.
          • parameters object
          • type string
        • source required object: The attribute value in which is stored the media file you want to use as the source file for your transformation. More details here.
          • attribute required string
          • channel required string
          • locale required string
        • target required object: The attribute value in which the PIM will generate the new transformed file, aka the target file. More details here.
          • attribute required string
          • channel required string
          • locale required string

Output

Output schema unknown

post_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.

akeneo.post_asset_media_files({
  "Content-type": ""
}, context)

Input

• input object
  • Content-type required string: Equal to 'multipart/form-data', no other value allowed
  • body object
    • file required string: The binary of the media file

Output

Output schema unknown

get_asset_media_files__code

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

akeneo.get_asset_media_files__code({
  "code": ""
}, context)

Input

• input object
  • code required string: Code of the resource

Output

Output schema unknown

get_asset_tags

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

akeneo.get_asset_tags({}, context)

Input

• input object
  • page integer: Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
  • limit integer: Number of results by page, see Pagination section
  • with_count boolean: Return the count of products in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

Output

• output object
  • _links object
    • first object
      • href string: URI of the first page of resources
    • next object
      • href string: URI of the next page of resources
    • previous object
      • href string: URI of the previous page of resources
    • self object
      • href string: URI of the current page of resources
  • current_page integer: Current page number
  • _embedded object
    • items array
      • items object
        • _links object
          • self object
        • code required string: PAM asset tag code

get_asset_tags__code_

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

akeneo.get_asset_tags__code_({
  "code": ""
}, context)

Input

• input object
  • code required string: Code of the resource

Output

• output object
  • code required string: PAM asset tag code

patch_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.

akeneo.patch_asset_tags__code_({
  "code": "",
  "body": {
    "code": ""
  }
}, context)

Input

• input object
  • code required string: Code of the resource
  • body required object
    • code required string: PAM asset tag code

Output

Output schema unknown

get_pam_assets

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

akeneo.get_pam_assets({}, context)

Input

• input object
  • pagination_type string (values: page, search_after): Pagination method type, see Pagination section
  • page integer: Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
  • search_after string: Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section
  • limit integer: Number of results by page, see Pagination section
  • with_count boolean: Return the count of products in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

Output

• output object
  • _links object
    • first object
      • href string: URI of the first page of resources
    • next object
      • href string: URI of the next page of resources
    • previous object
      • href string: URI of the previous page of resources
    • self object
      • href string: URI of the current page of resources
  • current_page integer: Current page number
  • _embedded object
    • items array
      • items object
        • _links object
          • self object
        • categories array: Codes of the PAM asset categories in which the asset is classified
          • items string
        • code required string: PAM asset code
        • description string: Description of the PAM asset
        • end_of_use string: Date on which the PAM asset expire
        • localizable boolean: Whether the asset is localized or not, meaning if you want to have different reference files for each of your locale
        • reference_files array: Reference files of the PAM asset
          • items object
        • tags array: Tags of the PAM asset
          • items string
        • variation_files array: Variations of the PAM asset
          • items object

patch_pam_assets

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

akeneo.patch_pam_assets({}, context)

Input

• input object
  • body object
    • categories array: Codes of the PAM asset categories in which the asset is classified
      • items string
    • code required string: PAM asset code
    • description string: Description of the PAM asset
    • end_of_use string: Date on which the PAM asset expire
    • localizable boolean: Whether the asset is localized or not, meaning if you want to have different reference files for each of your locale
    • reference_files array: Reference files of the PAM asset
      • items object
        • _link object: Links to get and download the reference file
          • download object
          • self object
        • code string: Code of the reference file
        • locale string: Locale code of the reference file
    • tags array: Tags of the PAM asset
      • items string
    • variation_files array: Variations of the PAM asset
      • items object
        • _link object: Links to get and download the variation file
          • download object
          • self object
        • code string: Code of the variation
        • locale string: Locale code of the variation
        • scope string: Channel code of the variation

Output

• output object
  • code string: Resource code, only filled when the resource is not a product
  • identifier string: Resource identifier, only filled when the resource is a product
  • line integer: Line number
  • message string: Message explaining the error
  • status_code integer: HTTP status code, see Client errors to understand the meaning of each code

post_pam_assets

This endpoint allows you to create a new PAM asset.

akeneo.post_pam_assets({}, context)

Input

• input object
  • body object
    • categories array: Codes of the PAM asset categories in which the asset is classified
      • items string
    • code required string: PAM asset code
    • description string: Description of the PAM asset
    • end_of_use string: Date on which the PAM asset expire
    • localizable boolean: Whether the asset is localized or not, meaning if you want to have different reference files for each of your locale
    • reference_files array: Reference files of the PAM asset
      • items object
        • _link object: Links to get and download the reference file
          • download object
          • self object
        • code string: Code of the reference file
        • locale string: Locale code of the reference file
    • tags array: Tags of the PAM asset
      • items string
    • variation_files array: Variations of the PAM asset
      • items object
        • _link object: Links to get and download the variation file
          • download object
          • self object
        • code string: Code of the variation
        • locale string: Locale code of the variation
        • scope string: Channel code of the variation

Output

Output schema unknown

get_reference_files__locale_code_

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

akeneo.get_reference_files__locale_code_({
  "asset_code": "",
  "locale_code": ""
}, context)

Input

• input object
  • asset_code required string: Code of the asset
  • locale_code required string: Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable

Output

• output object
  • _link object: Links to get and download the reference file
    • download object
      • href string: URI to download the reference file
  • code string: Code of the PAM asset reference file
  • locale string: Locale of the PAM asset reference file, equal to null if the asset is not localizable

post_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.

akeneo.post_reference_files__locale_code_({
  "asset_code": "",
  "locale_code": "",
  "Content-type": ""
}, context)

Input

• input object
  • asset_code required string: Code of the asset
  • locale_code required string: Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable
  • Content-type required string: Equal to 'multipart/form-data', no other value allowed
  • body object
    • file required string: The binaries of the file

Output

• output object
  • errors array
    • items object
      • channel string: Channel for which the variation file generation failed
      • locale string: Locale for which the variation file generation failed
      • message string: Message explaining why the variation file generation failed
  • message string: Message explaining the warning

get_reference_files__channel_code__locale_code__download

This endpoint allows you to download a given reference file.

akeneo.get_reference_files__channel_code__locale_code__download({
  "asset_code": "",
  "locale_code": ""
}, context)

Input

• input object
  • asset_code required string: Code of the asset
  • locale_code required string: Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable

Output

Output schema unknown

get_variation_files__channel_code__locale_code

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

akeneo.get_variation_files__channel_code__locale_code({
  "asset_code": "",
  "channel_code": "",
  "locale_code": ""
}, context)

Input

• input object
  • asset_code required string: Code of the asset
  • channel_code required string: Code of the channel
  • locale_code required string: Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable

Output

• output object
  • _link object: Links to get and download the reference file
    • download object
      • href string: URI to download the variation file
  • code string: Code of the PAM asset variation file
  • locale string: Locale of the PAM asset variation file, equal to null if the asset is not localizable
  • scope string: Channel of the PAM asset variation file

post_variation_files__channel_code__locale_code_

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

akeneo.post_variation_files__channel_code__locale_code_({
  "asset_code": "",
  "channel_code": "",
  "locale_code": "",
  "Content-type": ""
}, context)

Input

• input object
  • asset_code required string: Code of the asset
  • channel_code required string: Code of the channel
  • locale_code required string: Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable
  • Content-type required string: Equal to 'multipart/form-data', no other value allowed
  • body object
    • file required string: The binaries of the file

Output

Output schema unknown

get_variation_files__channel_code__locale_code__download

This endpoint allows you to download a given variation file.

akeneo.get_variation_files__channel_code__locale_code__download({
  "asset_code": "",
  "channel_code": "",
  "locale_code": ""
}, context)

Input

• input object
  • asset_code required string: Code of the asset
  • channel_code required string: Code of the channel
  • locale_code required string: Code of the locale if the asset is localizable or equal to no-locale if the asset is not localizable

Output

Output schema unknown

get_pam_assets__code_

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

akeneo.get_pam_assets__code_({
  "code": ""
}, context)

Input

• input object
  • code required string: Code of the resource

Output

• output object
  • categories array: Codes of the PAM asset categories in which the asset is classified
    • items string
  • code required string: PAM asset code
  • description string: Description of the PAM asset
  • end_of_use string: Date on which the PAM asset expire
  • localizable boolean: Whether the asset is localized or not, meaning if you want to have different reference files for each of your locale
  • reference_files array: Reference files of the PAM asset
    • items object
      • _link object: Links to get and download the reference file
        • download object
          • href string: URI to download the reference file
        • self object
          • href string: URI of the reference file entity
      • code string: Code of the reference file
      • locale string: Locale code of the reference file
  • tags array: Tags of the PAM asset
    • items string
  • variation_files array: Variations of the PAM asset
    • items object
      • _link object: Links to get and download the variation file
        • download object
          • href string: URI to download the variation file
        • self object
          • href string: URI of the variation entity
      • code string: Code of the variation
      • locale string: Locale code of the variation
      • scope string: Channel code of the variation

patch_pam_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.

akeneo.patch_pam_assets__code_({
  "code": "",
  "body": {
    "code": ""
  }
}, context)

Input

• input object
  • code required string: Code of the resource
  • body required object
    • categories array: Codes of the PAM asset categories in which the asset is classified
      • items string
    • code required string: PAM asset code
    • description string: Description of the PAM asset
    • end_of_use string: Date on which the PAM asset expire
    • localizable boolean: Whether the asset is localized or not, meaning if you want to have different reference files for each of your locale
    • reference_files array: Reference files of the PAM asset
      • items object
        • _link object: Links to get and download the reference file
          • download object
          • self object
        • code string: Code of the reference file
        • locale string: Locale code of the reference file
    • tags array: Tags of the PAM asset
      • items string
    • variation_files array: Variations of the PAM asset
      • items object
        • _link object: Links to get and download the variation file
          • download object
          • self object
        • code string: Code of the variation
        • locale string: Locale code of the variation
        • scope string: Channel code of the variation

Output

Output schema unknown

association_types_get_list

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

akeneo.association_types_get_list({}, context)

Input

• input object
  • page integer: Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
  • limit integer: Number of results by page, see Pagination section
  • with_count boolean: Return the count of products in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

Output

• output object
  • _links object
    • first object
      • href string: URI of the first page of resources
    • next object
      • href string: URI of the next page of resources
    • previous object
      • href string: URI of the previous page of resources
    • self object
      • href string: URI of the current page of resources
  • current_page integer: Current page number
  • _embedded object
    • items array
      • items object
        • _links object
          • self object
        • code required string: Association type code
        • is_quantified boolean: When true, the association is a quantified association
        • is_two_way boolean: When true, the association is a two-way association
        • labels object: Association type labels for each locale
          • localeCode string: Association type label for the locale localeCode

several_association_types_patch

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

akeneo.several_association_types_patch({}, context)

Input

• input object
  • body object
    • code required string: Association type code
    • is_quantified boolean: When true, the association is a quantified association
    • is_two_way boolean: When true, the association is a two-way association
    • labels object: Association type labels for each locale
      • localeCode string: Association type label for the locale localeCode

Output

• output object
  • code string: Resource code, only filled when the resource is not a product
  • identifier string: Resource identifier, only filled when the resource is a product
  • line integer: Line number
  • message string: Message explaining the error
  • status_code integer: HTTP status code, see Client errors to understand the meaning of each code

association_types_post

This endpoint allows you to create a new association type.

akeneo.association_types_post({}, context)

Input

• input object
  • body object
    • code required string: Association type code
    • is_quantified boolean: When true, the association is a quantified association
    • is_two_way boolean: When true, the association is a two-way association
    • labels object: Association type labels for each locale
      • localeCode string: Association type label for the locale localeCode

Output

Output schema unknown

association_types_get

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

akeneo.association_types_get({
  "code": ""
}, context)

Input

• input object
  • code required string: Code of the resource

Output

• output object
  • code required string: Association type code
  • is_quantified boolean: When true, the association is a quantified association
  • is_two_way boolean: When true, the association is a two-way association
  • labels object: Association type labels for each locale
    • localeCode string: Association type label for the locale localeCode

association_types_patch

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.

akeneo.association_types_patch({
  "code": "",
  "body": {
    "code": ""
  }
}, context)

Input

• input object
  • code required string: Code of the resource
  • body required object
    • code required string: Association type code
    • is_quantified boolean: When true, the association is a quantified association
    • is_two_way boolean: When true, the association is a two-way association
    • labels object: Association type labels for each locale
      • localeCode string: Association type label for the locale localeCode

Output

Output schema unknown

attribute_groups_get_list

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

akeneo.attribute_groups_get_list({}, context)

Input

• input object
  • search string: Filter attribute groups, for more details see the Filters section.
  • page integer: Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
  • limit integer: Number of results by page, see Pagination section
  • with_count boolean: Return the count of products in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

Output

• output object
  • _links object
    • first object
      • href string: URI of the first page of resources
    • next object
      • href string: URI of the next page of resources
    • previous object
      • href string: URI of the previous page of resources
    • self object
      • href string: URI of the current page of resources
  • current_page integer: Current page number
  • _embedded object
    • items array
      • items object
        • _links object
          • self object
        • attributes array: Attribute codes that compose the attribute group
          • items string
        • code required string: Attribute group code
        • labels object: Attribute group labels for each locale
          • localeCode string: Attribute group label for the locale localeCode
        • sort_order integer: Attribute group order among other attribute groups

several_attribute_groups_patch

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

akeneo.several_attribute_groups_patch({}, context)

Input

• input object
  • body object
    • attributes array: Attribute codes that compose the attribute group
      • items string
    • code required string: Attribute group code
    • labels object: Attribute group labels for each locale
      • localeCode string: Attribute group label for the locale localeCode
    • sort_order integer: Attribute group order among other attribute groups

Output

• output object
  • code string: Resource code, only filled when the resource is not a product
  • identifier string: Resource identifier, only filled when the resource is a product
  • line integer: Line number
  • message string: Message explaining the error
  • status_code integer: HTTP status code, see Client errors to understand the meaning of each code

attribute_groups_post

This endpoint allows you to create a new attribute group.

akeneo.attribute_groups_post({}, context)

Input

• input object
  • body object
    • attributes array: Attribute codes that compose the attribute group
      • items string
    • code required string: Attribute group code
    • labels object: Attribute group labels for each locale
      • localeCode string: Attribute group label for the locale localeCode
    • sort_order integer: Attribute group order among other attribute groups

Output

Output schema unknown

attribute_groups_get

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

akeneo.attribute_groups_get({
  "code": ""
}, context)

Input

• input object
  • code required string: Code of the resource

Output

• output object
  • attributes array: Attribute codes that compose the attribute group
    • items string
  • code required string: Attribute group code
  • labels object: Attribute group labels for each locale
    • localeCode string: Attribute group label for the locale localeCode
  • sort_order integer: Attribute group order among other attribute groups

attribute_groups_patch

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.

akeneo.attribute_groups_patch({
  "code": "",
  "body": {
    "code": ""
  }
}, context)

Input

• input object
  • code required string: Code of the resource
  • body required object
    • attributes array: Attribute codes that compose the attribute group
      • items string
    • code required string: Attribute group code
    • labels object: Attribute group labels for each locale
      • localeCode string: Attribute group label for the locale localeCode
    • sort_order integer: Attribute group order among other attribute groups

Output

Output schema unknown

get_attributes

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

akeneo.get_attributes({}, context)

Input

• input object
  • search string: Filter attributes, for more details see the Filters section.
  • page integer: Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section
  • limit integer: Number of results by page, see Pagination section
  • with_count boolean: Return the count of products in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

Output

• output object
  • _links object
    • first object
      • href string: URI of the first page of resources
    • next object
      • href string: URI of the next page of resources
    • previous object
      • href string: URI of the previous page of resources
    • self object
      • href string: URI of the current page of resources
  • current_page integer: Current page number
  • _embedded object
    • items array
      • items object
        • _links object
          • self object
        • allowed_extensions array: Extensions allowed when the attribute type is pim_catalog_file or pim_catalog_image
          • items string
        • available_locales array: To make the attribute locale specfic, specify here for which locales it is specific
          • items string
        • code required string: Attribute code
        • date_max string: Maximum date allowed when the attribute type is pim_catalog_date
        • date_min string: Minimum date allowed when the attribute type is pim_catalog_date
        • decimals_allowed boolean: Whether decimals are allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
        • default_metric_unit string: Default metric unit when the attribute type is pim_catalog_metric
        • group required string: Attribute group
        • group_labels object: Group labels for each locale
          • localeCode string: Group label for the locale localeCode
        • labels object: Attribute labels for each locale
          • localeCode string: Attribute label for the locale localeCode
        • localizable boolean: Whether the attribute is localizable, i.e. can have one value by locale
        • max_characters integer: 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
        • max_file_size string: Max file size in MB when the attribute type is pim_catalog_file or pim_catalog_image
        • metric_family string: Metric family when the attribute type is pim_catalog_metric
        • negative_allowed boolean: Whether negative values are allowed when the attribute type is pim_catalog_metric or pim_catalog_number
        • number_max string: Maximum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
        • number_min string: Minimum integer value allowed when the attribute type is pim_catalog_metric, pim_catalog_price or pim_catalog_number
        • reference_data_name string: 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
        • scopable boolean: Whether the attribute is scopable, i.e. can have one value by channel
        • sort_order integer: Order of the attribute in its group
        • type required string (values: pim_catalog_identifier, pim_catalog_metric, pim_catalog_number, pim_catalog_reference_data_multi_select, pim_catalog_reference_data_simple_select, pim_catalog_simpleselect, pim_catalog_multiselect, pim_catalog_date, pim_catalog_textarea, pim_catalog_text, pim_catalog_file, pim_catalog_image, pim_catalog_price_collection, pim_catalog_boolean, akeneo_reference_entity, akeneo_reference_entity_collection, pim_catalog_asset_collection): Attribute type
        • unique boolean: Whether two values for the attribute cannot be the same
        • useable_as_gri