Akeneo PIM REST API
  1. Product [uuid]
Akeneo PIM REST API
  • Authentication
    • Get authentication token
      POST
  • Overview
    • Get list of all endpoints
      GET
  • PAM asset category
    • Get list of PAM asset categories
      GET
    • Update/create several PAM asset categories
      PATCH
    • Create a new PAM asset category
      POST
    • Get a PAM asset category
      GET
    • Update/create a PAM asset category
      PATCH
  • Asset family
    • Get list of asset families
      GET
    • Get an asset family
      GET
    • Update/create an asset family
      PATCH
  • Asset
    • Get the list of the assets of a given asset family
      GET
    • Update/create several assets
      PATCH
    • Delete an asset
      DELETE
    • Get an asset of a given asset family
      GET
    • Update/create an asset
      PATCH
  • Asset attribute
    • Get the list of attributes of a given asset family
      GET
    • Get an attribute of a given asset family
      GET
    • Update/create an attribute of a given asset family
      PATCH
  • 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
      GET
    • Update/create several products
      PATCH
    • Create a new product
      POST
    • Delete a product
      DELETE
    • Get a product
      GET
    • Update/create a product
      PATCH
    • Get a draft
      GET
    • Submit a draft for approval
      POST
  1. Product [uuid]

Get a product

GET
/api/rest/v1/products-uuid/{uuid}
Product [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.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/rest/v1/products-uuid/'
Response Response Example
200 - Example 1
{
  "associations": {
    "PACK": {
      "groups": [],
      "product_models": [],
      "products": [
        "d055527c-0698-4967-8f16-8a5f23f4e5cf"
      ]
    }
  },
  "categories": [
    "summer_collection"
  ],
  "completenesses": [
    {
      "data": 10,
      "locale": "en_US",
      "scope": "ecommerce"
    },
    {
      "data": 20,
      "locale": "fr_FR",
      "scope": "ecommerce"
    },
    {
      "data": 30,
      "locale": "en_US",
      "scope": "tablet"
    },
    {
      "data": 40,
      "locale": "fr_FR",
      "scope": "tablet"
    }
  ],
  "created": "2023-08-15T05:53:50.716Z",
  "enabled": true,
  "family": "tshirt",
  "groups": [],
  "parent": null,
  "quality_scores": [
    {
      "data": "A",
      "locale": "en_US",
      "scope": "ecommerce"
    },
    {
      "data": "B",
      "locale": "fr_FR",
      "scope": "ecommerce"
    },
    {
      "data": "D",
      "locale": "en_US",
      "scope": "tablet"
    },
    {
      "data": "E",
      "locale": "fr_FR",
      "scope": "tablet"
    }
  ],
  "quantified_associations": {
    "PRODUCT_SET": {
      "product_models": [
        {
          "identifier": "model-biker-jacket-leather",
          "quantity": 2
        }
      ],
      "products": [
        {
          "quantity": 2,
          "uuid": "fc24e6c3-933c-4a93-8a81-e5c703d134d5"
        },
        {
          "quantity": 1,
          "uuid": "a9b69002-a0b1-4ead-85c2-f8dbf59c6cfc"
        }
      ]
    }
  },
  "updated": "2023-08-15T05:53:50.716Z",
  "uuid": "25566245-55c3-42ce-86d9-8610ac459fa8",
  "values": {
    "collection": [
      {
        "data": [
          "winter_2016"
        ],
        "linked_data": {
          "winter_2016": {
            "attribute": "collection",
            "code": "winter_2016",
            "labels": {
              "en_US": "Winter 2016",
              "fr_FR": "Hiver 2016"
            }
          }
        },
        "locale": null,
        "scope": null
      }
    ],
    "color": [
      {
        "data": "black",
        "linked_data": {
          "attribute": "color",
          "code": "black",
          "labels": {
            "en_US": "Black",
            "fr_FR": "Noir"
          }
        },
        "locale": null,
        "scope": null
      }
    ],
    "description": [
      {
        "data": "Summer top",
        "locale": "en_US",
        "scope": "ecommerce"
      },
      {
        "data": "Top",
        "locale": "en_US",
        "scope": "tablet"
      },
      {
        "data": "Débardeur pour l'été",
        "locale": "fr_FR",
        "scope": "ecommerce"
      },
      {
        "data": "Débardeur",
        "locale": "fr_FR",
        "scope": "tablet"
      }
    ],
    "name": [
      {
        "data": "Top",
        "locale": "en_US",
        "scope": null
      },
      {
        "data": "Débardeur",
        "locale": "fr_FR",
        "scope": null
      }
    ],
    "price": [
      {
        "data": [
          {
            "amount": "15.5",
            "currency": "EUR"
          },
          {
            "amount": "15",
            "currency": "USD"
          }
        ],
        "locale": null,
        "scope": null
      }
    ],
    "size": [
      {
        "data": "m",
        "linked_data": {
          "attribute": "size",
          "code": "m",
          "labels": {
            "en_US": "M",
            "fr_FR": "M"
          }
        },
        "locale": null,
        "scope": null
      }
    ],
    "sku": [
      {
        "data": "top",
        "locale": null,
        "scope": null
      }
    ]
  }
}

Request

Path Params
uuid
string 
required
Uuid of the resource
Query Params
with_attribute_options
string 
optional
Return labels of attribute options in the response. (Only available since the 5.0 version)
with_quality_scores
string 
optional
Return product quality scores in the response. (Only available since the 5.0 version)
with_completenesses
string 
optional
Return product completenesses in the response. (Only available since the 6.0 version)

Responses

🟢200OK
application/json
Body
associations
object 
optional
Several associations related to groups, product models and/or other products, grouped by association types
associationTypeCode
object 
optional
categories
array[string]
optional
Codes of the categories in which the product is classified
completenesses
array [object {3}] 
optional
Product completenesses for each channel/locale combination (only available since the 7.0 version, and when the "with_completenesses" query parameter is set to "true")
data
integer 
optional
locale
string 
optional
scope
string 
optional
created
string <dateTime>
optional
Date of creation
enabled
boolean 
optional
Whether the product is enabled
Default:
true
family
string 
optional
Family code from which the product inherits its attributes and attributes requirements.
Default:
null only in the case of a non variant product
groups
array[string]
optional
Codes of the groups to which the product belong
metadata
object 
optional
More information around the product (only available since the v2.0 in the Enterprise Edition)
workflow_status
enum<string> 
optional
Status of the product regarding the user permissions
Allowed values:
read_onlydraft_in_progressproposal_waiting_for_approvalworking_copy
parent
string 
optional
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.
Default:
null
quality_scores
object 
optional
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")
quantified_associations
object 
optional
Several quantified associations related to products and/or product models, grouped by quantified association types (only available since the 5.0)
quantifiedAssociationTypeCode
object 
optional
updated
string <dateTime>
optional
Date of the last update
uuid
string 
optional
Product uuid
values
object 
optional
Product attributes values, see Product values section for more details
attributeCode
array [object {4}] 
optional
🟠401Authentication required
🟠403Access forbidden
🟠404Resource not found
🟠406Not Acceptable
Modified at 2023-08-15 05:53:55
Previous
Delete a product
Next
Update/create a product
Built with