Akeneo PIM REST API
  1. Schemas
Akeneo PIM REST API
  • Authentication
    • Get authentication token
  • Overview
    • Get list of all endpoints
  • PAM asset category
    • Get list of PAM asset categories
    • Update/create several PAM asset categories
    • Create a new PAM asset category
    • Get a PAM asset category
    • Update/create a PAM asset category
  • Asset family
    • Get list of asset families
    • Get an asset family
    • Update/create an asset family
  • Asset
    • Get the list of the assets of a given asset family
    • Update/create several assets
    • Delete an asset
    • Get an asset of a given asset family
    • Update/create an asset
  • Asset attribute
    • Get the list of attributes of a given asset family
    • Get an attribute of a given asset family
    • Update/create an attribute of a given asset family
  • Asset attribute option
    • Get a list of attribute options of a given attribute for a given asset family
    • Get an attribute option for a given attribute of a given asset family
    • Update/create an asset attribute option for a given asset family
  • Asset media file
    • Create a new media file for an asset
    • Download the media file associated to an asset
  • PAM asset tag
    • Get list of PAM asset tags
    • Get a PAM asset tag
    • Update/create a PAM asset tag
  • PAM asset
    • Get list of PAM assets
    • Update/create several PAM assets
    • Create a new PAM asset
    • Get a PAM asset
    • Update/create a PAM asset
  • PAM asset reference file
    • Get a reference file
    • Upload a new reference file
    • Download a reference file
  • PAM asset variation file
    • Get a variation file
    • Upload a new variation file
    • Download a variation file
  • Association type
    • Get a list of association types
    • Update/create several association types
    • Create a new association type
    • Get an association type
    • Update/create an association type
  • Attribute group
    • Get list of attribute groups
    • Update/create several attribute groups
    • Create a new attribute group
    • Get an attribute group
    • Update/create an attribute group
  • Attribute
    • Get list of attributes
    • Update/create several attributes
    • Create a new attribute
    • Get an attribute
    • Update/create an attribute
  • Attribute option
    • Get list of attribute options
    • Update/create several attribute options
    • Create a new attribute option
    • Get an attribute option
    • Update/create an attribute option
  • Category
    • Get list of categories
    • Update/create several categories
    • Create a new category
    • Get a category
    • Update/create a category
    • Download a category media file [COMING SOON]
  • Channel
    • Get a list of channels
    • Update/create several channels
    • Create a new channel
    • Get a channel
    • Update/create a channel
  • Currency
    • Get a list of currencies
    • Get a currency
  • Family
    • Get list of families
    • Update/create several families
    • Create a new family
    • Get a family
    • Update/create a family
    • Create a new family variant
  • Family variant
    • Get list of family variants
    • Update/create several family variants
    • Get a family variant
    • Update/create a family variant
  • Locale
    • Get a list of locales
    • Get a locale
  • Measure family
    • Get list of measure familiy
    • Get a measure family
  • Measurement family
    • Get list of measurement families
    • Update/create several measurement families
  • Product media file
    • Get a list of product media files
    • Create a new product media file
    • Get a product media file
    • Download a product media file
  • Product model
    • Get list of product models
    • Update/create several product models
    • Create a new product model
    • Delete a product model
    • Get a product model
    • Update/create a product model
    • Get a draft
    • Submit a draft for approval
  • Product
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Published product
    • Get list of published products
    • Get a published product
  • Reference entity
    • Get list of reference entities
    • Get a reference entity
    • Update/create a reference entity
  • Reference entity media file
    • Create a new media file for a reference entity or a record
    • Download the media file associated to a reference entity or a record
  • Reference entity attribute
    • Get the list of attributes of a given reference entity
    • Get an attribute of a given reference entity
    • Update/create an attribute of a given reference entity
  • Reference entity attribute option
    • Get a list of attribute options of a given attribute for a given reference entity
    • Get an attribute option for a given attribute of a given reference entity
    • Update/create a reference entity attribute option
  • Reference entity record
    • Get the list of the records of a reference entity
    • Update/create several reference entity records
    • Get a record of a given reference entity
    • Update/create a record of a given reference entity
  • System
    • Get system information
    • Get system information
  • Catalogs
    • Get the list of owned catalogs
    • Create a new catalog
    • Delete a catalog
    • Get a catalog
    • Update a catalog
  • Catalog products
    • Get the list of product uuids
    • Get the list of products related to a catalog
    • Get a product related to a catalog
  • Product [identifier]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Product [uuid]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Schemas
    • Schemas
      • AssetAttributeList
      • AppCatalogList
      • AssetAttributeOptionList
      • AssetFamilyItemList
      • AssetFamilyList
      • AssetItemList
      • AssetList
      • AssociationType
      • AssociationTypeList
      • Attribute
      • AttributeGroup
      • AttributeGroupList
      • AttributeList
      • AttributeOption
      • AttributeOptionList
      • Category
      • CategoryList
      • Channel
      • ChannelList
      • Currency
      • CurrencyList
      • DeprecatedAsset
      • DeprecatedAssetCategory
      • DeprecatedAssetCategoryList
      • DeprecatedAssetList
      • DeprecatedAssetReferenceFile
      • DeprecatedAssetReferenceFileUploadWarning
      • DeprecatedAssetTag
      • DeprecatedAssetTagList
      • DeprecatedAssetVariationFile
      • Error
      • ErrorByLine
      • ErrorByObject
      • Family
      • ErrorByLineProductUuid
      • FamilyList
      • FamilyVariant
      • FamilyVariantList
      • ItemList
      • Locale
      • LocaleList
      • MeasureFamily
      • MeasureFamilyList
      • MeasurementFamily
      • MeasurementFamilyList
      • MediaFile
      • MediaFileItemList
      • MediaFileList
      • Pagination
      • Product
      • ProductList
      • ProductModel
      • ProductModelList
      • ProductExamples
      • PublishedProduct
      • PublishedProductList
      • ReferenceEntity
      • ReferenceEntityAttribute
      • ProductUuid
      • ReferenceEntityAttributeList
      • ProductUuidExamples
      • ReferenceEntityAttributeOption
      • ProductUuidList
      • ReferenceEntityAttributeOptionList
      • ReferenceEntityItemList
      • ReferenceEntityList
      • ReferenceEntityRecord
      • ReferenceEntityRecordItemList
      • ReferenceEntityRecordList
      • SearchAfterPagination
    • Response
      • 400Error
      • 401Error
      • 403Error
      • 403CatalogError
      • 404Error
      • 406Error
      • 404CatalogError
      • 413Error
      • 415Error
      • 415ErrorMultipart
      • 415ErrorStream
      • 422Error
      • DeprecatedAssetReferenceFileUploaded
    • RequestBodies
      • post_asset_media_filesBody
      • post_reference_files__locale_code_Body
      • post_app_catalogBody
  1. Schemas

AssetFamilyList

{
    "_links": {
        "self": {
            "href": "string"
        }
    },
    "attribute_as_main_media": "main_image",
    "code": "model_pictures",
    "labels": {
        "en_US": "Model pictures",
        "fr_FR": "Photographies en pied"
    },
    "naming_convention": {
        "abort_asset_creation_on_error": true,
        "pattern": "/(?P<product_ref>.*)-.*/",
        "source": {
            "channel": null,
            "locale": null,
            "property": "code"
        }
    },
    "product_link_rules": [
        {
            "assign_assets_to": [
                {
                    "attribute": "model_pictures",
                    "mode": "replace"
                }
            ],
            "product_selections": [
                {
                    "field": "sku",
                    "operator": "EQUALS",
                    "value": "{{product_ref}}"
                }
            ]
        }
    ],
    "transformations": [
        {
            "filename_suffix": "_thumbnailBW",
            "label": "Thumbnail plus black and white transformation",
            "operations": [
                {
                    "parameters": {
                        "height": 150,
                        "width": 150
                    },
                    "type": "thumbnail"
                },
                {
                    "parameters": {
                        "colorspace": "grey"
                    },
                    "type": "colorspace"
                }
            ],
            "source": {
                "attribute": "main_image",
                "channel": null,
                "locale": null
            },
            "target": {
                "attribute": "thumbnail",
                "channel": null,
                "locale": null
            }
        }
    ]
}
Built with