Skip to main content
GET
/
client_categories
All Client Categories
curl --request GET \
  --url https://api.valuechecker.net/client_categories \
  --header 'Authorization: <api-key>'
[
  {
    "client_category_id": 30893,
    "client_category": "Undefined",
    "parent_client_category_id": 0,
    "is_group_category": false,
    "cid": 0,
    "category": "Undefined",
    "api_sort_order": 0,
    "has_depreciation": false,
    "has_replacement": false,
    "acv_disabled": true,
    "show_closest_matches": true
  },
  {
    "client_category_id": 2740,
    "client_category": "Mobile Phones",
    "parent_client_category_id": 0,
    "is_group_category": false,
    "cid": 4364,
    "category": "Cell Phones",
    "api_sort_order": 1,
    "has_depreciation": true,
    "has_replacement": true,
    "acv_disabled": false,
    "show_closest_matches": true
  }
]

Authorizations

​
Authorization
string
header
required

Note! Prefix your with apiKey. Note the space after "apiKey ".

Query Parameters

​
client_id
integer

The client ID for the request. It's required if you have access to multiple clients with your API key. Otherwise, it's optional.

​
session-id
string

Optional session identifier of the user.

Response

OK

​
client_category_id
integer

This is an identifier used to help group and categorize the millions of consumer products in our database. It will be used as a request parameter in several of our API calls.

​
client_category
string

This is the display name for each product category.

​
parent_client_category_id
integer
​
is_group_category
boolean
​
cid
integer

The cid is the identifier that matches the client_category_id to ValueChecker’s internal product categories. This value is for reference only and can be ignored.

​
category
string
​
api_sort_order
integer
​
has_depreciation
boolean
​
has_replacement
boolean

Shows whether the client_category_id is considered a “Replacement category” by ValueChecker. “Replacement Categories” represent product groupings that ValueChecker has defined Like-Kind-and-Quality replacement logic for -- which means a comprehensive search to find relevant Replacement Products based on objective specification values can be completed for products in these categories. All client_category_id’s where has_replacement = True are considered “Replacement Categories”. Where has_replacement = False, ValueChecker is still able to search for the product and find real-time pricing information; however, there is no ability to search for Replacement Products within these categories.

​
acv_disabled
boolean

Informs as to whether the category has depreciation calculations associated with it. Depreciation can be applied in the Calculate ACV call.

​
show_closest_matches
boolean