Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R17.0.0


Excerpt

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:

Include Page
V4:product_family_identifier
V4:product_family_identifier

name

(optional)

String

The product family name

alternative_

code

{

(optional)

StringThe product family
alternative
code
parent

description

(optional)

StringThe product family description

parent

namedescription

(optional)

String
Identifier

The product

family description

parent family identifier. The allowed product parent family fields are the following:

Include Page
V4:product_family_identifier
V4:product_family_identifier

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

Include Page
V4:product_family_complete
V4:product_family_complete

Examples

Expand
titleExample 1

HTTP Method: POST

 


Request

Body

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
	"token":"{{token}}",
	"family_identifier": {
		"id": "8281723CD948413385390244A22C6A6E"
	},
	"parent": {
		"name": "Family A"
	}
} 

Response

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
    "data": {
        "parent": {
            "code": "PF001",
            "name": "Family A",
            "description": "Sample Category A - Updated",
            "id": "8B8395DC263C4210B0B3D39583DE140C"
        },
        "code": "PF004",
        "name": "Family D",
        "description": "Updated Sample Family D",
        "id": "8281723CD948413385390244A22C6A6E"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}