Sub-resources of stores

All available methods for the sub-resources of the resource store.

Add a property to a store

Add a new specific store property record to a store
[badge-green POST] /store/{store_id}/property-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
store_id string The unique id of the Store Yes

Request

Parameter name Type Description Mandatory (Yes/No)
property_record PropertyRecord Store property record Yes

Response

Status code: 201 Created
Output structure : object

Parameter name Type Description
property_record_id string The unique id of the property record

Example Request

POST https://<projectURL>/rest-api/enterprise-interface/v1.0/stores/8ed5d767e2b288973a858419c/property-records
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6ZjFjZDJhMyMjllODA2NDg0MzA2ODkxZTZlY2U3OTlkYjQzZDQyNzEwZDUwYTNhMjVmYTJjYzcyYzEwOTU4Mg==

{
  "property_record" : {
    "property_id" : "long_description",
    "property_value" : "long description"
  }
}

Example response

HTTP/1.1 201 Created
Date: Wed, 09 Dec 2020 13:55:42 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "property_record_id": "long_description:8ed5d767e2ba288973a858419c"
  }
}


Get a collection of properties

Get information about all property records on a store account
[badge-blue GET] /stores/{store_id}/property-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
store_id string The unique id of the Store Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
property_records PropertyRecord[] List of property records
total_items integer Count of all found store property records

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/stores/8ed5d767e2ba28897a858419c/property-records/long_description:8ed5d767e2ba288973a858419c
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6ZjFjZDMyMjllODA2NDg0MzA2ODkxZTZlY2U3OTlkYjQzZDQyNzEwZDUwYTNhMjVmYTJjYzcyYzEwOTU4Mg==

Example response

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

{
  "data": {
    "property_records": [
      {
        "property_record_id": "long_description:8ed5d767e2ba288973a858419c",
        "property_id": "long_description",
        "property_name": "Long description",
        "property_value": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Duis risus. Fusce consectetuer risus a nunc. Mauris tincidunt sem sed arcu. Duis pulvinar. Curabitur bibendum justo non orci. Morbi imperdiet, mauris ac auctor dictum, nisl ligula egestas nulla, et sollicitudin sem purus in lacus. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.",
        "last_change": "2020-12-09 14:56:49"
      }
    ],
    "total_items": 1
  }
}


Get a collection of store group records

Get information about all store group records on a store account
[badge-blue GET] /stores/{store_id}/store-group-records

Path parameters

Parameter name Type Description Mandatory (Yes/No)
store_id string The unique id of the Store Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
store_group_records StoreGroupRecord[] List of store group records
total_items integer Count of all found store group records

Example Request

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

Example response

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

{
  "data": {
    "store_group_records": [],
    "total_items": 0
  }
}


Update a property record of the store

Update a specific store property record of the store
[badge-grey PUT] /stores/{store_id}/property-records/{property_record_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
store_id string The unique id of the Store Yes
property_record_id string The unique id of the property record Yes

Request

Parameter name Type Description Mandatory (Yes/No)
property_record PropertyRecord Store property record Yes

Response

Status code: 204 No Content

Example Request

PUT https://<projectURL>/rest-api/enterprise-interface/v1.0/stores/8ed5d767e2ba28973a858419c/property-records
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6ZjFjZDJhZTMyMjllkxZTZlY2U3OTlkYjQzZDQyNzEwZDUwYTNhMjVmYTJjYzcyYzEwOTU4Mg==

{
  "property_record" : {
    "property_id" : "long_description",
    "property_value" : "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Duis risus. Fusce consectetuer risus a nunc. Mauris tincidunt sem sed arcu. Duis pulvinar. Curabitur bibendum justo non orci. Morbi imperdiet, mauris ac auctor dictum, nisl ligula egestas nulla, et sollicitudin sem purus in lacus. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo."
  }
}

Example response

HTTP/1.1 204 No Content
Date: Wed, 09 Dec 2020 13:56:49 GMT
Content-Type: application/json; charset=utf-8


Delete a property record of the store

Delete a specific store property record of a store
[badge-red DELETE] /stores/{store_id}/property-records/{property_record_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
store_id string The unique id of the Store Yes
property_record_id string The unique id of the property record Yes

Response

Status code: 204 No Content

Example Request

DELETE https://<projectURL>/rest-api/enterprise-interface/v1.0/stores/8ed5d767e2ba288973a858419c/property-records/long_description:8ed5d767e2ba288973a858419c
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6ZjFjZDJhDA2NDg0MzA2ODkxZTZlY2U3OTlkYjQzZDQyNzEwZDUwYTNhMjVmYTJjYzcyYzEwOTU4Mg==

Example response

HTTP/1.1 204 No Content
Date: Wed, 09 Dec 2020 13:59:10 GMT
Content-Type: application/json; charset=utf-8