Versions Compared

Old Version 39

changes.mady.by.user p_demou

Saved on

compared with

New Version 40

changes.mady.by.user p_demou

Saved on

Key

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


Tip

Available from CRM.COM R14.0.0


Excerpt

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

...

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)

StringThe code of the product

alternative_code

(optional)

StringThe alternative code of the product

description

(optional)

StringThe description of the product

short_description

(optional)

String

A short description of the product

Tip

Available from CRM.COM R16.2.0 and onwards


long_description

(optional)

String

A long description of the product


priority_level

(optional)

Integer

The priority level of the product

non_stockableBoolean

The flag shoes shows if the retrieved product is non-stockable. Applicable only for products of classification physical goods

Tip

Available from CRM.COM R18.0.0


type_identifier

(optional)

Identifier

The product type identifier of the 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 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 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

global_rate

(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


validity_set

(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
languagejavascript
themeConfluence
linenumberstrue
"set": [
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]


categories_set

(optional)

Set of Product Category Objects

The product category of the 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
languagejavascript
themeConfluence
linenumberstrue
"set": [
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]


tax_rate_set

(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
languagejavascript
themeConfluence
linenumberstrue
"set": [
			{
            	"action": "add",
            	...........
			}
		]


vat_rate_set

(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
languagejavascript
themeConfluence
linenumberstrue
"set": [
			{
            	"action": "add",
            	...........
			}
		]


Tip

Deprecated from CRM.COM R17.0.0


components_set

(mandatory on conditions)

Set of Components Objects

The bundle components of the 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
languagejavascript
themeConfluence
linenumberstrue
"set": [
			{
            	"action": "remove",
            	...........
			},
			{
            	"action": "add",
            	...........
			}
		]


bundle_restrictions

(optional)

Bundle Restrictions Object

The bundle restrictions of the product

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

upsells_set

(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.0.0


metadata_attribute_value_set

(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_attributes_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

...