Get list of published products

GET

/api/rest/v1/published-products

Published product

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

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"
        ],
        "created": "2023-08-15T05:53:50.717Z",
        "enabled": true,
        "family": "tshirt",
        "groups": [],
        "identifier": "top",
        "updated": "2023-08-15T05:53:50.717Z",
        "values": {
          "color": [
            {
              "data": "black",
              "locale": null,
              "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"
            }
          ],
          "name": [
            {
              "data": "Top",
              "locale": "en_US",
              "scope": null
            },
            {
              "data": "Débardeur",
              "locale": "fr_FR",
              "scope": null
            }
          ],
          "price": [
            {
              "data": [
                {
                  "amount": "15.5",
                  "currency": "EUR"
                },
                {
                  "amount": "15",
                  "currency": "USD"
                }
              ],
              "locale": null,
              "scope": null
            }
          ],
          "size": [
            {
              "data": "m",
              "locale": null,
              "scope": null
            }
          ]
        }
      }
    ]
  }
}

Request

Query Params

string

optional

Filter published products, for more details see the Filters section

scope

string

optional

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 Filter on published product values section

locales

string

optional

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 Filter on published product values section

attributes

string

optional

Filter published product values to only return those concerning the given attributes, for more details see the Filter on product values 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

Responses

🟢200Return published products 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 {11}]

optional

🟠400Bad request

🟠401Authentication required

🟠403Access forbidden

🟠406Not Acceptable

🟠422Unprocessable entity

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

Submit a draft for approval

Get a published product