Collection of available products

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

Get information about all available products.

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.

code

string

Code of the product.

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.

external_type_code

string

Every product can have more than one external ID depends of the business requirements. This parameter allows to pick from witch list of external IDs you want to choose. For the list of external type codes please contact you account manager. If the parameter is not set, API uses as a default value GLOBAL.

tag_ids

array of strings

Parameter filters values by a list of tag IDs. Logic OR is used between values.

In case you want to filter multiple options use array syntax : tag_ids[]=8bc8ca16f9c5039951021700a2&tag_ids[]=82c06812c0756528660784fef

tag_ids

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

products

array of objects

List of CareCloud products.

products

object

product_id

string

The unique ID of the product.

name

string

Name of the product.

code

string

Code of the product.

external_id

string

deprecated

The external unique ID of the product. This parameter is deprecated. Please use parameter plu_ids.

plu_ids

array of objects

An array of all available pluIds from the particular product lists (default is Product ID from Global product list (consist cleaned data - unique ID of every product across all POS systems)).

plu_ids

object

list_code

string

required

Code of the particular product list (basic is code of Global product list (consist cleaned data - unique ID of every product across all POS systems)). For example, “GLOBAL”, “SKU”, “PLU”, etc.

code

string

required

Code of product from the product list (basic is Product ID from Global product list (consist cleaned data - unique ID of every product across all POS systems)).

product_group_id

string

The unique ID of the product group.

product_brand_id

string

The unique ID of the product brand.

prices

array of objects

prices

object

currency_id

string

required

The unique ID of the currency.

value

float

required

Price of the product

additional_properties

array of objects

List of additional properties.

additional_properties

object

property_record_id

string

The unique ID of the property record.

property_id

string

required

The unique ID of the property.

property_name

string

Name of the property.

property_value

Value of the property.

last_change

string

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

image_urls

array of strings

A list of an image URLs.

image_urls

last_change

string

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

state

integer

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

1 2

tags

object

tag_id

string

The unique ID of the tag.

name

string

Name of the tag in language from the HTTP header.

text_id

string

Text ID of the tag.

state

integer

State of the tag.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

last_change

string

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

total_items

integer

The number of all found products.

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/products?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
49
}
1
{
2
  "data": {
3
    "products": [
4
      {
5
        "product_id": "85d6598db0bf3f62afd5db8507",
6
        "name": "Google phone 1",
7
        "code": "649",
8
        "plu_ids": [
9
          {
10
            "list_code": "GLOBAL",
11
            "code": "abc"
12
          }
13
        ],
14
        "product_group_id": "82de12eb8b138791e678fd11c3",
15
        "product_brand_id": "82db62087b0f79a6e14e5747e7",
16
        "prices": [
17
          {
18
            "currency_id": "86e05affc7a7abefcd513ab400",
19
            "value": 650
20
          }
21
        ],
22
        "additional_properties": [
23
          {
24
            "property_record_id": "docasna_blokace_darce_do:8ea2591121e636086a4a9c0992",
25
            "property_id": "docasna_blokace_darce_do",

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.