Sub-resources of stores

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

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


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


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


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

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