Get a product model

GET

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

Product model

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.

Response Example

200 - Example 1

{
  "associations": {
    "PACK": {
      "groups": [],
      "product_models": [],
      "products": [
        "sunglass"
      ]
    }
  },
  "categories": [
    "summer_collection"
  ],
  "code": "model-biker-jacket-leather",
  "created": "2023-08-15T05:53:50.712Z",
  "family": "clothing",
  "family_variant": "clothing_material_size",
  "parent": "model-biker-jacket",
  "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": [
        {
          "code": "model-biker-jacket-leather",
          "quantity": 2
        }
      ],
      "products": [
        {
          "identifier": "top",
          "quantity": 2
        },
        {
          "identifier": "cap",
          "quantity": 1
        }
      ]
    }
  },
  "updated": "2023-08-15T05:53:50.712Z",
  "values": {
    "collection": [
      {
        "data": [
          "summer_2017"
        ],
        "locale": null,
        "scope": null
      }
    ],
    "color": [
      {
        "data": "antique_white",
        "locale": null,
        "scope": null
      }
    ],
    "description": [
      {
        "data": "Biker jacket",
        "locale": "en_US",
        "scope": "ecommerce"
      }
    ],
    "material": [
      {
        "data": "leather",
        "locale": null,
        "scope": null
      }
    ],
    "name": [
      {
        "data": "Biker jacket",
        "locale": "en_US",
        "scope": null
      }
    ],
    "variation_name": [
      {
        "data": "Biker jacket leather",
        "locale": "en_US",
        "scope": null
      }
    ]
  }
}

Request

Path Params

code

string

required

Code of the resource

Query Params

with_quality_scores

string

optional

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

Responses

🟢200OK

application/json

Body

associations

object

optional

Several associations related to groups, product and/or other product models, grouped by association types

associationTypeCode

object

optional