Product properties

Product properties are list of available properties for products resource.

Available methods

All available methods for resource product properties.

HTTP method Endpoint Description
[badge-blue GET] /product-properties Get information about all product properties
[badge-blue GET] /product-properties/{product_property_id} Get information about a product property


Get all product properties

Get information about product properties
[badge-blue GET] /product-properties

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.		 No
offset integer The number of records from a collection to skip.
Default value is 0.		 No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.		 No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC		 No
name string Name of the property No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
product_properties Property[] List of all product properties
total_items integer Count of all found product properties

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/product-properties?name=test
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVcmZhY2U6YmVlZDA2ZjBmYhTEyUwOWIzNzk2ZjMODEEyZTIxNmVkMM5NDE5Zj2NzMwZmRj2w

Example response

HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 15:22:16 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "product_properties": [
      {
        "property_id": "test",
        "name": "test",
        "description": "test",
        "data_type": "int",
        "items": null,
        "is_required": false,
        "is_unique": false,
        "last_change": "2019-06-20 14:48:09.951997",
        "state": 1
      }
    ],
    "total_items": 1
  }
}


Get a product property

Get information about a specific product property
[badge-blue GET] /product-properties/{product_property_id}

Path parameters

Parameter name Type Description
product_property_id string The unique id for the product property

Response

Status code: 200 OK
Output structure : Property

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/product-properties/test
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVcmZhY2U6YmVlZDA2ZjBmYhTEyUwOWIzNzk2ZjMODEEyZTIxNmVkMM5NDE5Zj2NzMwZmRj2w

Example response

HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 15:23:19 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "property_id": "test",
    "name": "test",
    "description": "test",
    "data_type": "int",
    "items": null,
    "is_required": false,
    "is_unique": false,
    "last_change": "2019-06-20 14:48:09.951997",
    "state": 1
  }
}