Get all product groups

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/product-groups

Get a list of all product groups.

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction

string

Direction of sorting the response list.

name

string

Search record by name or a part of the name.

store_id

string

The unique ID of the store in CareCloud.

code

string

Code of the product group.

external_id

string

The ID from other system than CareCloud. It is usually used for the synchronization or identification of the record in between CareCloud and other system. The ID doesn't need to be necessary unique. Usage of other parameter could be required to return more specific results.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

product_groups

array of objects

List of all product groups.

product_groups

object

product_group_id

string

The unique ID of the product group.

name

string

required

Name of the product group.

parent_product_group_id

string

The unique ID of the parent product group. If parent_external_id is also set, both parameters have to represent the same product group.

parent_external_id

string

The unique external ID of the parent product group. If parent_product_group_id is also set, both parameters have to represent the same product group.

code

string

Code of the product group.

external_id

string

required

The external unique ID of the product group.

store_id

string

The unique ID of the store where the product group is valid. The product group is global if this value is not set.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the product group.
Possible values are: 0 - deleted / 1 - active

1 2

total_items

integer

The number of all found product groups.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/product-groups?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
18
 
1
{
2
  "data": {
3
    "product_groups": [
4
      {
5
        "product_group_id": "8fd73167342d06899c4c015320",
6
        "name": "Accessories",
7
        "parent_product_group_id": "83d1d11ea3884a5d33253fe214",
8
        "parent_external_id": "678",
9
        "code": "567829",
10
        "external_id": "953",
11
        "store_id": "83d1d11ea3884a5d33253fe214",
12
        "last_change": "2021-04-16 15:55:44.33538",
13
        "state": 1
14
      }
15
    ],
16
    "total_items": 1
17
  }
18
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.