v1

latestSwagger 2.02026-07-13137761.0 MB

Published product

Get list of published products

This endpoint allows you to get a list of published products. Published products are paginated and they can be filtered.

get/api/rest/v1/published-products

Query parameters

searchstring

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

scopestring

Filter published 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#filter-published-product-values">Filter on published product values</a> section

localesstring

Filter published 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#filter-published-product-values">Filter on published product values</a> section

attributesstring

Filter published 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

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

Response

Return published products paginated

current_pageinteger

Current page number

Example response

{
  "_embedded": {
    "items": [
      {
        "identifier": "top",
        "enabled": true,
        "family": "tshirt",
        "categories": [
          "summer_collection"
        ],
        "groups": [],
        "values": {
          "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"
            }
          ],
          "size": [
            {
              "locale": null,
              "scope": null,
              "data": "m"
            }
          ]
        },
        "created": "2016-06-23T18:24:44+02:00",
        "updated": "2016-06-25T17:56:12+02:00",
        "associations": {
          "PACK": {
            "products": [
              "sunglass"
            ],
            "product_models": [],
            "groups": []
          }
        }
      }
    ]
  }
}