Sign in

v1

latestSwagger 2.02026-07-13137761.0 MB
Product [uuid]

Get a product

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

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

Path parameters

uuidstring required

Uuid of the resource

Query parameters

with_attribute_optionsboolean

Return labels of attribute options in the response. See <a href='/concepts/products.html#the-linked_data-format'>the linked_data format</a> section for more details. (Only available since the 5.0 version)

with_quality_scoresboolean

Return product quality scores in the response. (Only available since the 5.0 version)

with_completenessesboolean

Return product completenesses in the response. (Only available since the 6.0 version)

Response

OK

uuidstring

Product uuid

enabledboolean

Whether the product is enabled

familystring

<a href='api-reference-paas.html#Family'>Family</a> code from which the product inherits its attributes and attributes requirements.

categoriesstring[]

Codes of the <a href='api-reference-paas.html#Category'>categories</a> in which the product is classified

groupsstring[]

Codes of the groups to which the product belong

parentstring

Code of the parent <a href='api-reference-paas.html#Productmodel'>product model</a> when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3.

valuesobject

Product attributes values, see <a href='/concepts/products.html#focus-on-the-product-values'>Product values</a> section for more details

createdstring dateTime

Date of creation

updatedstring dateTime

Date of the last update

quality_scoresobject

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")

Example response

{
  "uuid": "25566245-55c3-42ce-86d9-8610ac459fa8",
  "enabled": true,
  "family": "tshirt",
  "categories": [
    "summer_collection"
  ],
  "groups": [],
  "parent": null,
  "values": {
    "sku": [
      {
        "data": "top",
        "locale": null,
        "scope": null
      }
    ],
    "name": [
      {
        "data": "Top",
        "locale": "en_US",
        "scope": null
      },
      {
        "data": "Débardeur",
        "locale": "fr_FR",
        "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"
      }
    ],
    "price": [
      {
        "locale": null,
        "scope": null,
        "data": [
          {
            "amount": "15.5",
            "currency": "EUR"
          },
          {
            "amount": "15",
            "currency": "USD"
          }
        ]
      }
    ],
    "color": [
      {
        "locale": null,
        "scope": null,
        "data": "black",
        "linked_data": {
          "attribute": "color",
          "code": "black",
          "labels": {
            "en_US": "Black",
            "fr_FR": "Noir"
          }
        }
      }
    ],
    "size": [
      {
        "locale": null,
        "scope": null,
        "data": "m",
        "linked_data": {
          "attribute": "size",
          "code": "m",
          "labels": {
            "en_US": "M",
            "fr_FR": "M"
          }
        }
      }
    ],
    "collection": [
      {
        "locale": null,
        "scope": null,
        "data": [
          "winter_2016"
        ],
        "linked_data": {
          "winter_2016": {
            "attribute": "collection",
            "code": "winter_2016",
            "labels": {
              "en_US": "Winter 2016",
              "fr_FR": "Hiver 2016"
            }
          }
        }
      }
    ]
  },
  "created": "2016-06-23T18:24:44+02:00",
  "updated": "2016-06-25T17:56:12+02:00",
  "associations": {
    "PACK": {
      "products": [
        "d055527c-0698-4967-8f16-8a5f23f4e5cf"
      ],
      "product_models": [],
      "groups": []
    }
  },
  "quantified_associations": {
    "PRODUCT_SET": {
      "products": [
        {
          "uuid": "fc24e6c3-933c-4a93-8a81-e5c703d134d5",
          "quantity": 2
        },
        {
          "uuid": "a9b69002-a0b1-4ead-85c2-f8dbf59c6cfc",
          "quantity": 1
        }
      ],
      "product_models": [
        {
          "identifier": "model-biker-jacket-leather",
          "quantity": 2
        }
      ]
    }
  },
  "root_parent": "clothes",
  "quality_scores": [
    {
      "scope": "ecommerce",
      "locale": "en_US",
      "data": "A"
    },
    {
      "scope": "ecommerce",
      "locale": "fr_FR",
      "data": "B"
    },
    {
      "scope": "tablet",
      "locale": "en_US",
      "data": "D"
    },
    {
      "scope": "tablet",
      "locale": "fr_FR",
      "data": "E"
    }
  ],
  "completenesses": [
    {
      "scope": "ecommerce",
      "locale": "en_US",
      "data": 10
    },
    {
      "scope": "ecommerce",
      "locale": "fr_FR",
      "data": 20
    },
    {
      "scope": "tablet",
      "locale": "en_US",
      "data": 30
    },
    {
      "scope": "tablet",
      "locale": "fr_FR",
      "data": 40
    }
  ]
}