Edit this page on GitHub

REST API - Property group Resource

Introduction

In this part of the documentation, you can learn more about the API's property groups resource. With this resource, it's possible to retrieve and update any property group in your shop. We will also have a look at the associated data structures.

General Information

This resource supports the following operations:

Access URL GET GET (List) PUT PUT (Batch) POST DELETE DELETE (Batch)
/api/propertyGroups Yes Yes Yes No Yes Yes No

If you want to access this resource, simply query the following URL:

  • http://my-shop-url/api/propertyGroups

GET

You can retrieve a property group by using its id

  • http://my-shop-url/api/propertyGroups/id

Return Value

Field Type Original Object
id integer (primary key)
name string
position integer
comparable boolean
sortMode integer
options array Option
attribute array Attribute

Note the camel case notation for 'sortMode'.

GET (List)

To get more than one property group at once, simply remove the id parameter from the request URL.

  • http://my-shop-url/api/propertyGroups/

Since this returns a list, the following fields will be added to the array:

Field Type Comment
total integer The total number of cache resources
success boolean Indicates if the call was successful or not.

POST (create) and PUT (update)

You can post or put data by querying the following URL:

  • (POST or PUT) http://my-shop-url/api/propertyGroups/id
Field Type Original Object
id integer (primary key)
name string
position integer
comparable boolean
sortmode integer

Note the small case notation for 'sortmode' to go with POST or PUT as opposed for GET.

DELETE

To delete a property group, simply query this URL with a DELETE request:

  • http://my-shop-url/api/propertyGroups/id

Replace the id with the specific property group id.

Top