Products / Families
Get Product Family
This endpoint retrieves data of a specific Product Family based on JSON input. The API returns a single Product Family available to the user in the Value List, according to the unique ID provided. If the specified Family does not exist, the response will be a "bad request".
You will only receive the Product Family 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 |
REQUEST
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the Product Family |
RESPONSE
| 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 (Required) | 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 |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/productFamilies/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/productFamilies/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Product Family
Changes
No recorded changes to this operation across all 1 revision of this API.