Store properties

Store properties are list of available properties for store resource.

Available methods

All available methods for resource store properties.

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


Get all store properties

Get information about store properties
[badge-blue GET] /store-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 for the property No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
store_properties Property[] List of all store properties
total_items integer Count of all found store properties

Example Request

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

Example response

HTTP/1.1 200 OK
Date: Wed, 09 Dec 2020 14:13:26 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "store_properties": [
      {
        "property_id": "provided_services",
        "name": "Store services",
        "description": "List of services provided in store",
        "data_type": "multiselect",
        "items": [
          {
            "id": "81eaeea13b8984a169c490a325",
            "name": "sudexo tickets",
            "state": 1
          },
          {
            "id": "86e05affc7a7abefcd513ab400",
            "name": "tickets",
            "state": 1
          },
          {
            "id": "8fd73167342d06899c4c015320",
            "name": "Click and collect",
            "state": 1
          },
          {
            "id": "8bd48117006496e0b1788109b8",
            "name": "Accept payment cards",
            "state": 1
          }
        ],
        "is_required": false,
        "is_unique": false,
        "last_change": null,
        "state": 1
      },
      {
        "property_id": "count",
        "name": "Count",
        "description": "",
        "data_type": "int",
        "items": null,
        "is_required": false,
        "is_unique": false,
        "last_change": null,
        "state": 1
      },
      {
        "property_id": "opening_date",
        "name": "Opening date",
        "description": "",
        "data_type": "date",
        "items": null,
        "is_required": false,
        "is_unique": false,
        "last_change": null,
        "state": 1
      },
      {
        "property_id": "extra_description",
        "name": "extra_description",
        "description": "",
        "data_type": "string",
        "items": null,
        "is_required": false,
        "is_unique": false,
        "last_change": null,
        "state": 1
      },
      {
        "property_id": "google_review_place_id",
        "name": "Google Review - Place ID",
        "description": "Place id for google review",
        "data_type": "string",
        "items": null,
        "is_required": false,
        "is_unique": false,
        "last_change": null,
        "state": 1
      },
      {
        "property_id": "self_checkout",
        "name": "Self checkout",
        "description": "",
        "data_type": "enum",
        "items": [
          {
            "id": "86e05affc7a7abefcd513ab400",
            "name": "yes",
            "state": 1
          },
          {
            "id": "8bed991c68a470e7aaeffbf048",
            "name": "no",
            "state": 1
          }
        ],
        "is_required": false,
        "is_unique": false,
        "last_change": null,
        "state": 1
      }
    ],
    "total_items": 6
  }
}


Get a store property

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

Path parameters

Parameter name Type Description
store_property_id string The unique id for the store property

Response

Status code: 200 OK
Output structure : Property

Example Request

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

Example response

HTTP/1.1 200 OK
Date: Wed, 09 Dec 2020 14:14:03 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
"store_properties": [
      {
        "property_id": "provided_services",
        "name": "Store services",
        "description": "List of services provided in store",
        "data_type": "multiselect",
        "items": [
          {
            "id": "81eaeea13b8984a169c490a325",
            "name": "sudexo tickets",
            "state": 1
          },
          {
            "id": "86e05affc7a7abefcd513ab400",
            "name": "tickets",
            "state": 1
          },
          {
            "id": "8fd73167342d06899c4c015320",
            "name": "Click and collect",
            "state": 1
          },
          {
            "id": "8bd48117006496e0b1788109b8",
            "name": "Accept payment cards",
            "state": 1
          }
        ],
        "is_required": false,
        "is_unique": false,
        "last_change": null,
        "state": 1
      }
    }