...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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)
...
(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:
...
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
...
(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
...
(optional)
...
The product category of the new product
...
(optional)
...
(applicable and 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
...
(optional)
...
The bundle restrictions of the new product
The "bundle_restrictions" 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
...
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 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request Body
Response
|
...
title | Example 2 |
---|
HTTP Method: POST
Request
Body
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Response
...
theme | Confluence |
---|---|
language | javascript |
linenumbers | true |
...
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
| ||||||
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
| ||||||
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:
| ||||||
brand_identifier (optional) | Identifier | The product brand identifier of the new product. The allowed product type identifier fields are the following:
| ||||||
family_identifier (optional) | Identifier | The product family identifier of the new product. The allowed product type identifier fields are the following:
| ||||||
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
| ||||||
(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 | ||||||
(optional) | Set of Product Category Objects | The product category of the new product | ||||||
(optional) | Set of Tax Rate Objects | The Tax rates of the current period that will be applied on the new product | ||||||
(optional) | Set of Vat Rate Objects | The Vat rates of the current period that will be applied on the new product
| ||||||
(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 | ||||||
(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 | ||||||
(optional) | Set of Upsell Products Object | The upsell products associated to the specific product
| ||||||
(optional) | Set of cross-sell Products Object | The cross-sell products associated to the specific product
| ||||||
(optional) | Set of Metadata Object | The set of metadata attributes and values associated to the specific product
| ||||||
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
You can only add existing metadata attributes. | ||||||
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 |
Referred Parameter Objects Data Anchor product create referred objects product create referred objects
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
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 | ||||
---|---|---|---|---|
|
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request Body
Response
|
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST Request Body
Response
|