Products / Families
Create Product Family
This endpoint allows you to create a Product Family based on JSON input.
You will only be able to create a 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 BODY
| Attribute | Type | Description |
|---|---|---|
| branchRestriction | Boolean | 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 |
| idParent | Integer | Unique identifier of the parent Product Family, for Product Families hierarchy purposes |
| notAvailable | Boolean | If true, the Product Family is not available |
RESPONSE
Returns a JSON with information about the Product Family just created.
| Attribute | Type |
|---|---|
| Id | Id assigned to the new Product Family |
| Message | The operation status |
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 |
post/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
Request body
Response
Create Product Family
Changes
No recorded changes to this operation across all 1 revision of this API.