Available from CRM.COM R14.0.0
This method updates an existing product family. A single product family can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
family_identifier (mandatory) | Product Family Identifier | The identifier of the product family. The allowed product family identifier fields are the following:
| ||||||||||||
name (optional) | String | The product family name | ||||||||||||
code (optional) | String | The product family code | ||||||||||||
description (optional) | String | The product family description | ||||||||||||
parent (optional on conditions) | Identifier | The product parent family identifier. The allowed product parent family fields are the following:
If this parameter is set, then the "remove_parent" parameter will not be able to be defined | ||||||||||||
remove_parent (optional on conditions) | Boolean | Defines if the parent will be removed from the current category If this parameter is set, then the "parent" parameter will not be able to be defined | ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified
Response Data
Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved product family |
| name | String | The Name of the retrieved product family |
| code | String | The code of the retrieved product family |
| description | String | The Description of the retrieved product family |
Product Family Object | The retrieved product families |
Referred Objects Response Data
Examples
HTTP Method: POST
Request
Body
Response