Sign in

v1

latestSwagger 2.02026-07-13137761.0 MB
Product [uuid]

Search list of products

This endpoint allows you to search for products that match the filters provided in the request body. Products are paginated and can be filtered by scope, locales, attributes, and other criteria. User-group-based permissions are applied to the products you request. <br /><br /> <b>Important limitations</b><br />

  • The maximum number of attributes in the request body is 800.<br />
  • The maximum number of search criteria is 20.<br />
  • The maximum number of items in an array (e.g., values for filters like <code>IN</code> or <code>NOT IN</code>) is 800.
post/api/rest/v1/products-uuid/search

Query parameters

pagination_type'page' | 'search_after'

Pagination method type, see <a href="/documentation/pagination.html">Pagination</a> section

pageinteger

Number of the page to retrieve when using the page pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html#pagination">Pagination</a> section

search_afterstring

Cursor when using the search_after pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html">Pagination</a> section

limitinteger

Number of results by page, see <a href="/documentation/pagination.html">Pagination</a> section

with_countboolean

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

Request body

searchstring

Stringified JSON to filter products, for more details see the <a href="/documentation/filter.html">Filters</a> section

scopestring

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 <a href="/documentation/filter.html#via-channel">Filter product values via channel</a> section

localesstring

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 <a href="/documentation/filter.html#via-locale">Filter product values via locale</a> section

attributesstring

Filter product values to only return those concerning the given attributes. For more details, see the <a href="/documentation/filter.html#filter-product-values">Filter on product values</a> section

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_scores__productsboolean

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

Return products paginated

current_pageinteger

Current page number

Example response

{
  "_embedded": {
    "items": [
      {
        "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
          }
        ]
      }
    ]
  }
}