Get list of product models

GET

/api/rest/v1/product-models

Product model

This endpoint allows you to get a list of product models. Product models are paginated. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the set of products you request.

Response Example

200 - Example 1

{
  "_links": {
    "first": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  },
  "current_page": 0,
  "_embedded": {
    "items": [
      {
        "_links": {
          "self": {
            "href": "string"
          }
        },
        "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

Query Params

string

optional

Filter product models, for more details see the Filters section

scope

string

optional

Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section

locales

string

optional

Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section

attributes

string

optional

Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section and the Filter on product model properties section

pagination_type

string

optional

Pagination method type, see Pagination section

page

integer

optional

Number of the page to retrieve when using the page pagination method type. Should never be set manually, see Pagination section

search_after

string

optional

Cursor when using the search_after pagination method type. Should never be set manually, see Pagination section

limit

integer

optional

Number of results by page, see Pagination section

with_count

string

optional

Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

with_quality_scores

string

optional

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

Responses

🟢200Return product models paginated

application/json

Body

_links

object

optional

first

object

optional

object

optional

object

optional

self

object

optional

current_page

integer

optional

Current page number

_embedded

object

optional

items

array [object {13}]

optional

🟠401Authentication required

🟠406Not Acceptable

🟠422Unprocessable entity

Modified at 2023-08-15 05:53:55

Download a product media file

Update/create several product models