XExentral
Product

List product properties

Changed on

Returns a list of given Products' Properties

get/api/v1/products/{id}/properties

Request

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'name' | 'value' | 'unit'
dir'asc' | 'desc'
includeTranslationsboolean

When true, each property additionally exposes its translations array.

Response

Success

Example response

{
  "data": [
    {
      "id": "17",
      "property": {
        "id": "2",
        "name": "Test123",
        "project": {
          "id": "17"
        }
      },
      "value": "100.00",
      "unit": "kg",
      "translations": [
        {
          "language": {
            "iso2": "EN"
          },
          "salesChannel": {
            "id": "17"
          },
          "name": "Colour",
          "value": "RedEN"
        }
      ]
    }
  ],
  "extra": {
    "page": {
      "number": 1,
      "size": 10
    }
  }
}

Changes

  • ebe5ba2a4ed8Revision changes
    • info

      added the new optional query request parameter includeTranslations

    • info

      added the optional property // to the response with the status

    • info

      added the required property /// to the response with the status