Page Comparison

...

Available from CRM.COM R14.0.0

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

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Identifier

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

...

code

(optional)

...

alternative_code

(optional)

...

description

(optional)

...

(optional)

...

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

...

(optional)

...

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

...

(optional)

...

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

...

udf_string_1

(optional)

...

User Defined Field of type String

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

User Defined Field of type String

...

udf_string_9

(optional)

...

User Defined Field of type String

...

udf_string_10

(optional)

...

User Defined Field of type String

...

udf_string_11

(optional)

...

User Defined Field of type String

...

udf_string_12

(optional)

...

User Defined Field of type String

...

udf_string_13

(optional)

...

User Defined Field of type String

...

udf_string_14

(optional)

...

User Defined Field of type String

...

udf_string_15

(optional)

...

User Defined Field of type String

...

udf_string_16

(optional)

...

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

...

validity_set

(optional)

...

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:

...

theme	Confluence
language	javascript
linenumbers	true

...

Tip
Available from CRM.COM R14.0.0

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

Resource URL

Parameters

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 product

alternative_code

(optional)

String

The alternative code of the product

description

(optional)

String

The description of the product

short_description

(optional)

String

A short description of the product

Tip
Available from CRM.COM R16.3.0 and onwards

long_description

(optional)

String

A long description of the product

priority_level

(optional)

Integer

The priority level of the product

non_stockable

Boolean

The flag 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

language	javascript
theme	Confluence
linenumbers	true

"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

language	javascript
theme	Confluence
linenumbers	true

"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

language	javascript
theme	Confluence
linenumbers	true

"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

language	javascript
theme	Confluence
linenumbers	true

"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

language	javascript
theme	Confluence
linenumbers	true

"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

Anchor

	product create referred objects
	product create referred objects

Referred Parameter Objects Data

Include Page

	V4:product_validity_updating_parameters
	V4:product_validity_updating_parameters

Include Page

	V4:product_categories_updating_parameters
	V4:product_categories_updating_parameters

Include Page

	V4:product_rate_updating_parameters
	V4:product_rate_updating_parameters

Include Page

	V4:product_bundle_components_updating_parameters
	V4:product_bundle_components_updating_parameters

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.

Response Data

Include Page

	V4:product_complete
	V4:product_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
	"token":"{{token}}",
	"product_identifier": {
		"id": "C27AC0553F2E4CD6BC80FFD1315ECA57"
	},
	"description": "Updated Product for services",
	"family_identifier": {
		"code": "ED1"
	},
	"validity_set": [
		{
			"action": "add",
			"valid_from": "2021-10-01T00:00:00",
			"valid_to": "2021-10-31T11:59:00"
		}
	],
	"categories_set": [
		{
			"action": "remove",
			"category_identifier": {
				"code": "EC1"
			}
		},
		{
			"action": "add",
			"category_identifier": {
				"code": "TSC"
			}
		}
	],
	"vat_rate_set": [
		{
			"action": "add",
			"rate_identifier": {
				"name": "Standard"
			}
		}
	]
}

Response

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
    "data": {
        "code": "Service Product A",
        "alternative_code": "SPA",
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2017-08-24T11:52:57",
            "updated_date": "2017-08-24T12:15:16",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            }
        },
        "components_set": [],
        "price_plans_set": [],
        "description": "Updated Product for services",
        "udf_date_2": null,
        "type": {
            "service_type": "TERMED",
            "used_for_provisioning": false,
            "alternative_code": "FSB_1",
            "udr_type": null,
            "composition_method": "FIXEDBUNDLE",
            "name": "Fixed Service Bundles",
            "description": null,
            "id": "B6B89600B6B141E9A01F47FD547CB740",
            "classification": "SERVICES",
            "physical_good_type": null
        },
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": "2017-08-25T08:30:00",
        "udf_float_3": null,
        "udf_float_4": null,
        "udf_string_15": null,
        "categories_set": [
            {
                "id": "A5CB88DEDC474CAFB0F5296C12949B68",
                "category": {
                    "code": "TSC",
                    "name": "Term Service Category",
                    "description": null,
                    "id": "A462D6C0C9304287BE73BBDC44E7CF2F"
                }
            }
        ],
        "udf_string_16": null,
        "udf_string_13": null,
        "validity_set": [
            {
                "valid_to": "2021-10-31T11:59:00",
                "valid_from": "2021-10-01T00:00:00",
                "id": "4FF5916674A94CA2879D6B9BBC27671E"
            },
            {
                "valid_to": "2017-09-30T11:59:59",
                "valid_from": "2017-09-01T00:00:00",
                "id": "B2F96A7F7ECE4868966FD71B678562A2"
            }
        ],
        "udf_string_14": null,
        "udf_string_11": null,
        "udf_string_12": null,
        "bundle_restrictions": [
            {
                "number_of_product_families_restriction": 15,
                "number_of_product_types_restriction": 20
            }
        ],
        "id": "C27AC0553F2E4CD6BC80FFD1315ECA57",
        "udf_string_10": null,
        "udf_float_1": null,
        "udf_float_2": 10.5,
        "brand": {
            "alternative_code": "BT",
            "name": "brand test",
            "description": null,
            "id": "CA43B8302B0D43A49A934099D039656B"
        },
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": "Service Product",
        "udf_string_6": null,
        "family": {
            "code": "ED1",
            "name": "Expense Decoder",
            "description": null,
            "id": "24AA760239FE414A95DBEB884D64B1BA"
        },
        "udf_string_7": null,
        "udf_string_8": null,
        "usage_service_catalogs_set": [],
        "tax_rate_set": [
            {
                "alternative_code": "TT",
                "name": "Telephony Tax",
                "description": null,
                "id": "DA6DD47A53DC4CBB8D0EEF698B08E94A"
            },
            {
                "alternative_code": "T",
                "name": "Test",
                "description": null,
                "id": "2A8517D6169C4CB3B703E2C49D5AD1EB"
            }
        ],
        "vat_rate_set": [
            {
                "alternative_code": "S",
                "name": "Standard",
                "description": null,
                "id": "0DB74F47A6E54DF2AB8CCE28124C1957"
            },
            {
                "alternative_code": "U",
                "name": "Usage",
                "description": null,
                "id": "E92C70E2952C41E0B86EB5DE1510DB3F"
            }
        ],
        "udf_string_9": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Expand

title	Example 2

HTTP Method: POST

Request

Body

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
	"token":"{{token}}",
	"product_identifier": {
		"code": "Service Product B"
	},
	"code": "Updated Service Product B",
	"alternative_code": "USPB",
	"description": "Updated product for services",
	"validity_set": [
		{
			"action": "remove",
			"validity_identifier": {
				"id": "2F2F5FFF38E74EE58C8C6DA3DA74B06F"
			}
		},
		{
			"action": "add",
			"valid_from": "2021-10-01T12:00:00",
			"valid_to": "2021-11-01T12:59:00"
		}
	]
}

Response

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
    "data": {
        "code": "Updated Service Product B",
        "alternative_code": "USPB",
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2017-08-24T12:03:52",
            "updated_date": "2017-08-24T12:27:02",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            }
        },
        "components_set": [],
        "price_plans_set": [],
        "description": "Updated product for services",
        "udf_date_2": null,
        "type": {
            "service_type": null,
            "used_for_provisioning": false,
            "alternative_code": "B",
            "udr_type": null,
            "composition_method": "FIXEDBUNDLE",
            "name": "Bundle",
            "description": null,
            "id": "EE0AA3102B414622A57926EDD0D624FF",
            "classification": "PHYSICALGOODS",
            "physical_good_type": "TRACEABLE"
        },
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "udf_string_15": null,
        "categories_set": [],
        "udf_string_16": null,
        "udf_string_13": null,
        "validity_set": [
            {

...

               "valid_to":

...

"2021-11-01T12:59:00",

...

categories_set

(optional)

...

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:

...

theme	Confluence
language	javascript
linenumbers	true

...

    "valid_from": "2021-10-01T12:00:00",
                "id": "2818778965CA4BBD902764DE3AE7F48B"
            }
        ],
        "udf_string_14": null,
        "udf_string_11": null,

...

udf_string_12":

...

null,
        "bundle_restrictions": [
            {

...

"number_of_product_families_restriction":

...

null,

...

tax_vat_rates_set

(optional)

...

The tax/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". Different actions can be used within the same set. For example:

...

theme	Confluence
language	javascript
linenumbers	true

...

     "number_of_product_types_restriction": null
            }
        ],
        "id": "4AEDA92F9A9C49D1AAB24DD9B603B51A",
        "udf_string_10": null,

...

    "udf_float_1":

...

null,
        "udf_float_2": null,
        "brand": null,
        "udf_string_2":

...

components_set

(mandatory on conditions)

...

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:

...

theme	Confluence
language	javascript
linenumbers	true

...

null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "udf_string_6": null,
        "family": null,

...

 "udf_string_7":

...

null,
        "udf_string_8": null,
        "usage_service_catalogs_set": [],

...

"tax_rate_set": [
            {

...

bundle_restrictions

(optional)

...

The bundle restrictions of the new product

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

...

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

...

Examples

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response

Code Block

theme	Confluence
language	javascript
linenumbers	true

Expand

title	Example 2

HTTP Method: POST

Request

Body

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response

Code Block

theme	Confluence
language	javascript
linenumbers	true

...

      "alternative_code": "TT",
                "name": "Telephony Tax",
                "description": null,
                "id": "DA6DD47A53DC4CBB8D0EEF698B08E94A"
            }
        ],
        "vat_rate_set": [
            {
                "alternative_code": "U",
                "name": "Usage",
                "description": null,
                "id": "E92C70E2952C41E0B86EB5DE1510DB3F"
            }
        ],
        "udf_string_9": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 29

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Response Data

Examples

Response Data

Examples