Page Comparison

Versions Compared

Key

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

Tip
Tip
Available from CRM.COM R14.0.0

Excerpt
This method updates a product. A single product is updated by each call

...

.. }, { "action": "add", ........... } ]

The bundle restrictions of the new product

The "bundle_restrictions" parameter is applicable only if the product is classified as flexible bundle

Name

Type

Description

token

String

The token retrieved from the login method

product_identifier

(mandatory)

Identifier

The identifier of the product. The allowed product identifier fields are the following:

Include Page

	V4:product_identifier
	V4:product_identifier

code

(optional)

String

The code of the new product

alternative_code

(optional)

String

The alternative code of the new product

description

(optional)

String

The description of the new product

long_description

(optional)

String

A long description of the retrieved product

priority_level

(optional)

Integer

The priority level of the product

type_identifier

(optional)

Identifier

The product type identifier of the new product. The allowed product type identifier fields are the following:

Include Page

	V4:product_type_identifier
	V4:product_type_identifier

brand_identifier

(optional)

Identifier

The product brand identifier of the new product. The allowed product type identifier fields are the following:

Include Page

	V4:product_brand_identifier
	V4:product_brand_identifier

family_identifier

(optional)

Identifier

The product family identifier of the new product. The allowed product type identifier fields are the following:

Include Page

	V4:product_family_identifier
	V4:product_family_identifier

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

(optional)

Global Rate object

The rate (price) that the product will have in the Global Price Plan

Tip
Available from CRM.COM R15.0.0

(optional)

Set of Product Validity Objects

The time periods during which the product will be available to be used. If not specified then the product will be always be available

Applicable only for products of classification SERVICE with type EXPENSE or TERMED

If no records are specified in the set then nothing will be updated. To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

Code Block

theme	Confluence
language	javascript
linenumbers	true

"set": [
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

(optional)

Set of Product Category Objects

The product category of the new product

If no records are specified in the set then nothing will be updated. To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

Code Block

theme	Confluence
language	javascript
linenumbers	true

"set": [
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]

(optional)

Set of Tax Rate Objects

The Tax rates of the current period

If no records are specified in the set then nothing will be updated. To add a record use "action" : "add". For example:

Code Block

theme	Confluence
language	javascript
linenumbers	true

"set": [
			{
            	"action": "add",
            	...........
			}
		]

(optional)

Set of Vat Rate Objects

The Vat rates of the current period

If no records are specified in the set then nothing will be updated. To add a record use "action" : "add". For example:

Code Block

theme	Confluence
language	javascript
linenumbers	true

"set": [
			{
            	"action": "add",
            	...........
			}
		]

(mandatory on conditions)

Set of Components Objects

The bundle components of the new product

The "bundle_components" parameter is applicable and possibly mandatory only if the product is classified as a fixed or flexible bundle

If no records are specified in the set then nothing will be updated. To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example:

Code Block

theme	Confluence
language	javascript
linenumbers	true

"set": ["set": [
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "removeadd",
            	...........
			}
		]

bundle_restrictions

(optional)

Bundle Restrictions Object

The bundle restrictions of the new product

The "bundle_restrictions" parameter is applicable only if the product is classified as flexible bundle

(optional)

Set of Upsell Products Object

The upsell products associated to the specific product

Tip
Available from CRM.COM R15.0.0

cross_sells_set

(optional)

Set of cross-sell Products Object

The cross-sell products associated to the specific product

Tip
Available from CRM.COM R15.

bundle_restrictions

(optional)

Bundle Restrictions Object

0.0

(optional)

Set of Metadata Object

The set of metadata attributes and values associated to the specific product

Tip
Available from CRM.COM R15.0.0

allowed_metadata_set

(optional)

Set of Allowed Metadata Object

The set of allowed metadata attributes whose values will be set upon the creation of the installed items

Applicable only for products of the following product classification

Traceable Physical Good

Tip
Available from CRM.COM R15.0.0

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

...

Include Page

	V4:product_bundle_restrictions_parameters
	V4:product_bundle_restrictions_parameters

Include Page

	V4:global_rate_parameters
	V4:global_rate_parameters

Include Page

	V4:upsells_parameters
	V4:upsells_parameters

Include Page

	V4:cross_sells_parameters
	V4:cross_sells_parameters

Include Page

	V4:metadata_attribute_value_parameters
	V4:metadata_attribute_value_parameters

Include Page

	V4:allowed_metadata_attribute_parameters
	V4:allowed_metadata_attribute_parameters

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...