Product brands

You can manage all different Product types and their properties, define product brands and classify Products into product groups in the CareCloud platform. You get the list of product brands and it's properties in this resource.

Available methods

All available methods for resource product-brands.

HTTP method Endpoint Description
[badge-blue GET] /product-brands List of product-brands
[badge-blue GET] /product-brands/{product_brand_id} Detail of a specific product-brand

Get all product brands

Get a list of all product brands
[badge-blue GET] /product-brands

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.		 No
offset integer The number of records from a collection to skip.
Default value is 0.		 No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.		 No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC		 No
name string Name or a part of the name of a product brand No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
product_brands ProductBrand[] List of all product brands
total_items integer Count of all found product brands

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/product-brands?name=test2
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVcmZhY2U6YmVlZDA2ZjBmYhTEyUwOWIzNzk2ZjMODEEyZTIxNmVkMM5NDE5Zj2NzMwZmRj2w

Example response

HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 15:15:28 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "product_brands": [
      {
        "product_brand_id": "83d1d11ea3884a5d33253fe214",
        "name": "The best brand",
        "external_id": "a5d332"
      },
      {
        "product_brand_id": "87d706e4864d02af7ce9201c58",
        "name": "The nice brand",
        "external_id": "864d02"
      },
      {
        "product_brand_id": "81dee640727c45e3a7da28299e",
        "name": "The cool brand",
        "external_id": "7c45"
      }
    ],
    "total_items": 3
  }
}

Get information about a specific product brand

Get information about a specific product brand
[badge-blue GET] /product-brands/{product_brand_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
product_brand_id string The unique id for the product brand Yes

Response

Status code: 200 OK
Output structure : ProductBrand

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/product-brands/83d1d11ea3884a5d33253fe214
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVcmZhY2U6YmVlZDA2ZjBmYhTEyUwOWIzNzk2ZjMODEEyZTIxNmVkMM5NDE5Zj2NzMwZmRj2w

Example response

HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 15:17:00 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "product_brand_id": "83d1d11ea3884a5d33253fe214",
    "name": "The best brand",
    "external_id": "a5d332"
  }
}