Page Comparison

...

Available from CRM.COM R14.0.0

Excerpt
This method creates a product. A single product is created by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

code

(mandatory)

...

alternative_code

(mandatory)

...

description

(mandatory)

...

long_description

(optional)

...

A long description of the retrieved product

...

priority_level

(optional)

...

The priority level of the product

...

(mandatory)

...

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:

...

e

Tip
Available from CRM.COM R14.0.0

Excerpt
This method creates a product. A single product is created by each call

Resource URL

Parameters

...

Name

Type

Description

token

String

The token retrieved from the login method

code

(mandatory)

String

The code of the new product

alternative_code

(mandatory)

String

The alternative code of the new product

description

(mandatory)

String

The description of the new product

short_description

(optional)

String

A short description of the new product

Tip
Available from CRM.COM R16.3.0 and onwards

long_description

(optional)

String

A long description of the new 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

priority_level

(optional)

Integer

The priority level of the product

type_identifier

(mandatory)

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_

2

13

(optional)

String

User Defined Field of type String

udf_string_

3

14

(optional)

String

User Defined Field of type String

udf_string_

4

15

(optional)

String

User Defined Field of type String

udf_string_

5

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_

string

float_

6

4

(optional)

String

Float

User Defined Field of type

String

Float

udf_

string

date_

7

1

(optional)

String

Date	User Defined Field of type

String

Date

udf_

string

date_

8

2

(optional)

String

Date	User Defined Field of type

String

Date

udf_

string

date_

9

3

(optional)

String

Date	User Defined Field of type

String

Date

udf_

string

date_

10

4

(optional)

String

Date	User Defined Field of type

String

Date

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12udf_string_13

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

categories_set

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

Set of Product Category Objects

The product category of the new product

tax_rate_set

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

Set of Tax Rate Objects

The Tax rates of the current period that will be applied on the new product

vat_rate_set

(optional)

String

User Defined Field of type String

udf_float_2

Set of Vat Rate Objects

The Vat rates of the current period that will be applied on the new product

Tip
Deprecated from CRM.COM R17.0.0

components_set

(applicable and mandatory on conditions)

Set of Bundle Components Objects

The components of the new product

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

bundle_restrictions

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

Bundle Restrictions Object

The bundle restrictions of the new product

This parameter is applicable only if the product is classified as a flexible bundle

upsells_set

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

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)

Float

User Defined Field of type Float

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

validity

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)

Date

User Defined Field of type Date

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

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

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

classification SERVICE with type EXPENSE or TERMED

categories_set

(optional)

Set of Product Category Objects

The product category of the new product

tax_rate

the following product classification

Traceable Physical Good

Tip
Available from CRM.COM R15.0.0

You can only add existing metadata attributes.

fields_set

(optional)

Set of Tax Rate ObjectsThe Tax rates of the current period that will be applied on the new product

vat_rate_set

(optional)

Set of Vat Rate ObjectsThe Vat rates of the current period that will be applied on the new product

components_set

(applicable and mandatory on conditions)

Set of Bundle Components Objects

The components of the new product

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

bundle_restrictions

(optional)

Bundle Restrictions Object

The bundle restrictions of the new product

This parameter is applicable only if the product is classified as a 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

...

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_parameters
	V4:product_validity_parameters

Include Page

	V4:product_categories_parameters
	V4:product_categories_parameters

Include Page

	V4:product_rate_parameters
	V4:product_rate_parameters

Include Page

	V4:product_bundle_components_parameters
	V4:product_bundle_components_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:product_categoriesupsells_parameters
	V4:product_categoriesupsells_parameters

Include Page

	V4:productcross_ratesells_parameters
	V4:productcross_ratesells_parameters

Include Page

	V4:productmetadata_bundleattribute_componentsvalue_parameters
	V4:productmetadata_bundleattribute_componentsvalue_parameters

Include Page

	V4:productallowed_bundlemetadata_restrictionsattribute_parameters
	V4:productallowed_bundlemetadata_restrictionsattribute_parameters

Restrictions

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

...

Expand

title	Example 1

HTTP Method: POST

Request

Body

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
	"token":"{{token}}",
	"code": "Service Product A",
	"alternative_code": "SPA",
	"description": "Product for services",
	"type_identifier": {
		"name": "Fixed Service Bundles"
	},
	"brand_identifier": {
		"alternative_code": "BT"
	},
	"family_identifier": {
		"code": "PKF"
	},
	"udf_string_1": "Service Product",
	"udf_float_2": 10.5,
	"udf_date_3": "2017-08-25T08:30:00",
	"validity_set": [
		{
			"valid_from": "2017-09-01T00:00:00",
			"valid_to": "2017-09-30T11:59:59"
		}
	],
	"categories_set": [
		{
			"category_identifier": {
				"code": "EC1"
			}
		}
	],
	"tax_rate_set": [
		{
			"rate_identifier": {
				"id": "2A8517D6169C4CB3B703E2C49D5AD1EB"
			}
		},
		{
			"rate_identifier": {
				"name": "Telephony Tax"
			}
		}
	],
	"vat_rate_set": [
		{
			"rate_identifier": {
				"id": "E92C70E2952C41E0B86EB5DE1510DB3F"
			}
		}
	],
	"components_set": [
		{
			"action": "add",
			"product": {
				"id": "30D6D1C4F7CD4CFBAFC77CBF107EEAD2"
			},
			"quantity": 10,
			"minimum_quantity": 1,
			"maximum_quantity": 100
		}
	],
	"bundle_restrictions": {
		"number_of_product_types_restriction": 20,
		"number_of_product_families_restriction": 15
	},
	"fields_set": ""
}

Response

Code Block

language	javascript
theme	Confluence	language	javascript
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-24T11:52:58",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            }
        },
        "components_set": [
            {
                "product": {
                    "code": "PPT_A",
                    "product_type": {
                        "service_type": "TERMED",
                        "used_for_provisioning": true,
                        "alternative_code": "AO",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Add-ons",
                        "description": "Additional products",
                        "id": "E2324486B2454B56B054ED8129E3A9C0",
                        "classification": "SERVICES",
                        "physical_good_type": null
                    },
                    "alternative_code": "P",
                    "description": "PPT_A",
                    "id": "30D6D1C4F7CD4CFBAFC77CBF107EEAD2"
                },
                "quantity": 10,
                "max_quantity": 100,
                "min_quantity": 1,
                "id": "586AC0C800C047B9827FC385085A6EA9"
            }
        ],
        "price_plans_set": [],
        "description": "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": "B30B2F6F77B440F9AACC828F832FEA36",
                "category": {
                    "code": "EC1",
                    "name": "Expense Category",
                    "description": null,
                    "id": "8320A513FBF34B75AD250E844B509009"
                }
            }
        ],
        "udf_string_16": null,
        "udf_string_13": null,
        "validity_set": [
            {
                "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": "PKF",
            "name": "PK_Family",
            "description": null,
            "id": "3E91CC57B69240FBB367C1BD534BF190"
        },
        "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": "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	language	javascript
linenumbers	true

 {
	"token":"{{token}}",
	"code": "Service Product B",
	"alternative_code": "SPB",
	"description": "Another product for services",
	"type_identifier": {
		"id": "EE0AA3102B414622A57926EDD0D624FF"
	},
	"validity_set": [
		{
			"valid_from": "2017-08-01T00:00:00"
		}
	],
	"tax_rate_set": [
		{
			"rate_identifier": {
				"name": "Telephony Tax"
			}
		}
	],
	"vat_rate_set": [
		{
			"rate_identifier": {
				"id": "E92C70E2952C41E0B86EB5DE1510DB3F"
			}
		}
	],
	"fields_set": "id,code,alternative_code,log_information,tax_rate_set,vat_rate_set,validity_set"
}

Response

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
    "data": {
        "code": "Service Product B",
        "alternative_code": "SPB",
        "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:03:52",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            }
        },
        "validity_set": [
            {
                "valid_to": null,
                "valid_from": "2017-08-01T00:00:00",
                "id": "2F2F5FFF38E74EE58C8C6DA3DA74B06F"
            }
        ],
        "id": "4AEDA92F9A9C49D1AAB24DD9B603B51A",
        "tax_rate_set": [
            {
                "alternative_code": "TT",
                "name": "Telephony Tax",
                "description": null,
                "id": "DA6DD47A53DC4CBB8D0EEF698B08E94A"
            }
        ],
        "vat_rate_set": [
            {
                "alternative_code": "U",
                "name": "Usage",
                "description": null,
                "id": "E92C70E2952C41E0B86EB5DE1510DB3F"
            }
        ]
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

...

Versions Compared

Old Version 41

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters