GET /api/rest/v1/retailer/products

This endpoint allows you to get a paginated list of retailer products. Results are automatically filtered to only include enabled products belonging to the authenticated retailer.

Query parameters

  • limit integer

    Number of results per page

    Default value is 10.

  • page integer

    Page number

    Default value is 1.

  • with_count boolean

    Return the count of items in the response. Do not activate it on large catalogs, it can decrease performance.

    Default value is false.

  • pagination_type string

    Pagination method type

    Default value is page.

Responses

  • 200 application/json

    Return retailer products paginated

    Hide response attributes Show response attributes object
    • current_page integer

      Current page number

    • _embedded object
      Hide _embedded attribute Show _embedded attribute object
      • items array[object]
        Hide items attributes Show items attributes object
        • uuid string

          Unique identifier of the product (UUID v4)

        • identifier string

          Child product identifier, i.e. child sku

        • parent string

          Product group identifier, i.e. sku

        • enabled boolean

          Whether the product is enabled

        • categories array[string]

          Category codes in which the product is classified

        • values object

          Product attribute values

          Hide values attribute Show values attribute object
          • attributeCode array[object]
            Hide attributeCode attributes Show attributeCode attributes object
            • locale string

              Locale code of the product value

            • data object

              Product value

        • created string(dateTime)

          Date of creation

        • updated string(dateTime)

          Date of the last update

  • 401 application/json

    Authentication required

    Hide response attributes Show response attributes object
    • code integer

      HTTP status code

    • message string

      Message explaining the error

  • 403 application/json

    Access forbidden

    Hide response attributes Show response attributes object
    • code integer

      HTTP status code

    • message string

      Message explaining the error

GET /api/rest/v1/retailer/products
curl \
 --request GET 'https://content.winkelstraat.nl/api/rest/v1/retailer/products'
Response examples (200)
{
  "next": {
    "href": "/api/rest/v1/retailer/products?page=2&with_count=false&pagination_type=page&limit=10"
  },
  "self": {
    "href": "/api/rest/v1/retailer/products?page=1&with_count=false&pagination_type=page&limit=10"
  },
  "first": {
    "href": "/api/rest/v1/retailer/products?page=1&with_count=false&pagination_type=page&limit=10"
  }
}
1
{
  "items": [
    {
      "uuid": "d437d77f-7358-4d96-b4ab-8fe400825855",
      "_links": {
        "self": {
          "href": "/api/rest/v1/retailer/products/wsnl-SKU123-m"
        }
      },
      "parent": "wsnl-SKU123",
      "values": {
        "ean": [
          {
            "data": "1234567890123"
          }
        ],
        "msrp": [
          {
            "data": [
              {
                "amount": "39.95",
                "currency": "EUR"
              }
            ]
          }
        ],
        "size": [
          {
            "data": "m"
          }
        ],
        "color": [
          {
            "data": "black"
          }
        ],
        "price": [
          {
            "data": [
              {
                "amount": "29.95",
                "currency": "EUR"
              }
            ]
          }
        ],
        "quantity": [
          {
            "data": 10
          }
        ],
        "manufacturer": [
          {
            "data": "guess"
          }
        ],
        "manufacturer_product_number": [
          {
            "data": "G1234"
          }
        ]
      },
      "created": "2025-01-01T10:00:00+01:00",
      "enabled": true,
      "updated": "2025-06-15T14:30:00+02:00",
      "categories": [
        "120"
      ],
      "identifier": "wsnl-SKU123-m"
    }
  ]
}
Response examples (200)
{
  "_links": {
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    }
  },
  "current_page": 42,
  "_embedded": {
    "items": [
      {
        "_links": {
          "self": {
            "href": "string"
          }
        },
        "uuid": "string",
        "identifier": "string",
        "parent": "string",
        "enabled": true,
        "categories": [
          "string"
        ],
        "values": {
          "attributeCode": [
            {
              "locale": "string",
              "data": {}
            }
          ]
        },
        "created": "string",
        "updated": "string"
      }
    ]
  }
}
Response examples (401)
401
Authentication is required
Response examples (401)
{
  "code": 42,
  "message": "string"
}
Response examples (403)
403
Access forbidden. You are not allowed to list products.
Response examples (403)
{
  "code": 42,
  "message": "string"
}