Versions Compared

Old Version 24

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

compared with

New Version 25

changes.mady.by.user Joseph Ioannou (Unlicensed)

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 is used to synchronise products information in CRM.COM with products information that exists in a 3rd party system, within a single Web API method call. Note that the maximum number of products to be synchronised is 1000

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

synchronisation_definition_identifier

(mandatory)

String

The identifier of the products synchronisation process run definition. The available products synchronisation process run definition identifier fields are the following:

Include Page
V4:process_run_definition_identifier
V4:process_run_definition_identifier

products_set

(mandatory)

Set of Product ObjectsThe set of products that will be synchronised through the Web API method.customer events that will be created by this Web API method. Note that the maximum number of products that can be specified within a single Web API call is 1000

fields_set

(optional)

List of Strings, comma separatedA 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.

...

Expand
titlebulk products parameter object data


Name

Type

Description

code

(mandatory)

StringThe code of the product

alternative_code

(optional)

StringThe alternative code of the product

description

(optional)

StringThe description of the 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)

Product Type 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)

Product Brand Identifier

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

Include Page
V4:product_brand_identifier
V4:product_brand_identifier

family_identifier

(optional)

Product Family Identifier

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

Include Page
V4:product_family_identifier
V4:product_family_identifier

category_identifier

(optional)

Product Category Identifier

The product category of the product

Include Page
V4:product_category_identifier
V4:product_category_identifier

Tip

Deprecated from CRM.COM R14.8.0, R15.2.0, R16.0.0


vat_rate_identifier

(optional)

VAT Rate Identifier

The VAT Rate identifier of the product The allowed VAT Rate identifier fields are the following:

Include Page
V4:vat_rate_identifier
V4:vat_rate_identifier

Tip

Deprecated from CRM.COM R17.0.0


tax_rate_identifier

(optional)

Tax Rate Identifier

The Tax Rate identifier of the product The allowed Tax Rate identifier fields are the following:

Include Page
V4:tax_rate_identifier
V4:tax_rate_identifier

Tip

Deprecated from CRM.COM R17.0.0


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


product_validity_from

(optional)

DateThe date from which the product will be valid

product_validity_to

(optional)

DateThe date until which the product will be valid

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

metadata_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


categories_set

(optional)

Set of Category Objects

The product category of the product

Tip

Available from CRM.COM R14.8.0, R15.2.0, R16.0.0


Anchor
product create referred objects
product create referred objects
Referred Parameter Objects Data

Include Page
V4:global_rate_parameters
V4:global_rate_parameters

Include Page
V4:metadata_attribute_value_parameters
V4:metadata_attribute_value_parameters

Include Page
V4:product_categories_parameters
V4:product_categories_parameters

...

Expand
titleExample 1

HTTP Method: POST 


Request:


Body

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
    "token" :   "{{token}}",
    "synchronisation_definition_identifier" :  { "alternative_code" : "SBI1" },
	"products_set":
    [
        {
			"code" : "0001A" ,
            "description":"Product created through Products Synchronization",
            "type_identifier" :  { "alternative_code" : "AO" }
        },
        {
			"code" : "0002A" ,
            "description":"Product created through Products Synchronization",
            "type_identifier" :  { "alternative_code" : "Main Packages" },
            "family_identifier" :  { "code" : "P" }
        },
        {
			"code" : "0003A" ,
            "description":"Product created through Products Synchronization",
            "type_identifier" :  { "alternative_code" : "Main Packages" },
            "product_validity_from" : "2017-08-01T00:00:00"
        }
    ]      
}


Response

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 {
    "data": {
        "unprocessed_products_set": [
            {
                "error_description": "Error:Product Synchronisation is Not Allowed Based on the Product Synchronisation Definition. - Description:Product synchronisation cannot be performed.",
                "error_code": "CannotSynchronizeProductException",
                "request_code": "0001A"
            }
        ],
        "processed_products_set": [
            {
                "code": "0002A",
                "request_code": "0002A",
                "id": "4AC27B639C0642F1BDEF2F57A4BBDFCD"
            },
            {
                "code": "0003A",
                "request_code": "0003A",
                "id": "DC2C874B90594438A86096E73C1D3148"
            }
        ]
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}


...