Products / Families
List Product Families
Returns all Product Families available.
You will only receive the Product Families after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
RESPONSE
This endpoint returns all Product Families available for the value list.
List of the supported Product Families attributes:
| Attribute | Type | Description |
|---|---|---|
| branchRestriction | Integer | If true, the User has limited visibility in some branches |
| descriptionBR | String | Product Family name in Brasilian Portuguese |
| descriptionDE | String | Product Family name in German |
| descriptionDK | String | Product Family name in Dutch |
| descriptionEN | String | Product Family name in English |
| descriptionES | String | Product Family name in Spanish |
| descriptionFR | String | Product Family name in French |
| descriptionIT | String | Product Family name in Italian |
| descriptionPT | String | Product Family name in Portuguese |
| descriptionRU | String | Product Family name in Russian |
| descriptionUS | String | Product Family name in American English |
| id | Integer | Unique identifier of the Product Family in ForceManager |
| idParent | Integer | Unique identifier of the parent Product Family, for Product Families hierarchy purposes |
| notAvailable | Boolean | If true, the Product Family is not available |
| dateCreated | String | Date and time when the Product Family was created |
| dateDeleted | String | Date and time when the Product Family was deleted |
| dateUpdated | String | Date and time when the Product Family was last updated |
| deleted | Boolean | If true, the Product Family has been deleted and archived |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Product Family |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Product Family |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Product Family |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/productFamilies
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/productFamilies
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Countstring
Response
List Product Families
Changes
No recorded changes to this operation across all 1 revision of this API.