Versions Compared

Old Version 20

changes.mady.by.user Christina Georgiou (Unlicensed)

Saved on

compared with

New Version Current

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.

Anchor
product referred objects
product referred objects
Referred Parameter Objects Data

...

type
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
code
description of the product

long_description

(optional)

String

A long description of the retrieved product

alternative


priority_

code

level

(optional)

String
Integer

The

alternative code

priority level of the product

description

Tip

Deprecated from CRM.COM R17.0.0


type_identifier

(optional)

String
Product Type Identifier

The

description of the productlong_description

priority_level

(optional)

Integer

The priority level of the product

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)

String

A long description of the retrieved product

 

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
Type
Family Identifier

The product

type

family identifier of the product. The allowed product

type

family identifier fields are the following:

Include Page
V4:product_

type

family_identifier
V4:product_

type

family_identifier

brand
category_identifier

(optional)

Product
Brand
Category Identifier

The product

brand identifier

category of the product

. The allowed product brand identifier fields are the following:

Include Page
V4:product_

brand

category_identifier
V4:product_

brand

category_identifier

family

Tip

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


vat_rate_identifier

(optional)

Product Family
VAT Rate Identifier

The

product family

VAT Rate identifier of

the product.

the product The allowed

product family

VAT Rate identifier fields are the following:

Include Page
V4:

product

vat_

family

rate_identifier
V4:

product

vat_

family

rate_identifier

category

Tip

Deprecated from CRM.COM R17.0.0


tax_rate_identifier

(optional)

Product Category
Tax Rate Identifier

The

product category of the product

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

Include Page
V4:

product

tax_

category

rate_identifier
V4:

product

tax_

category

rate_identifier

vat

Tip

Deprecated from CRM.COM R17.0.0


global_rate

_identifier

(optional)

VAT
 Global Rate
Identifier
object

The

VAT Rate identifier of the product The allowed VAT Rate identifier fields are the following: Include PageV4:vat_rate_identifierV4:vat_rate_identifiertax_rate_identifier

rate (price) that the product will have in the Global Price Plan

Tip

Available from CRM.COM R15.0.0

Deprecated from CRM.COM R17.0.0


product_validity_from

(optional)

Tax Rate Identifier
DateThe
Tax Rate identifier of the product The allowed Tax Rate identifier fields are the following: Include PageV4:tax_rate_identifierV4:tax_rate_identifier

global_rate

date from which the product will be valid

product_validity_to

(optional)

 Global Rate object
DateThe
rate (price) that the product will have in the Global Price Plan
Tip

Available from CRM.COM R15.0.0

product_validity_fromproduct_validity_to
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)

DateThe date from which the product will be validThe date until which the product will be valid

String

User Defined Field of type String

udf_string_4

(optional)

Date

String

User Defined Field of type String

udf_string_

1

5

(optional)

String

User Defined Field of type String

udf_string_

2

6

(optional)

String

User Defined Field of type String

udf_string_

3

7

(optional)

String

User Defined Field of type String

udf_string_

4

8

(optional)

String

User Defined Field of type String

udf_string_

5

9

(optional)

String

User Defined Field of type String

udf_string_

6

10

(optional)

String

User Defined Field of type String

udf_string_

7

11

(optional)

String

User Defined Field of type String

udf_string_

8

12

(optional)

String

User Defined Field of type String

udf_string_

9

13

(optional)

String

User Defined Field of type String

udf_string_

10

14

(optional)

String

User Defined Field of type String

udf_string_

11

15

(optional)

String

User Defined Field of type String

udf_string_

12

16

(optional)

String

User Defined Field of type String

udf_

string

float_

13

1

(optional)

String

Float

User Defined Field of type

String

Float

udf_

string

float_

14

2

(optional)

String

Float

User Defined Field of type

String

Float

udf_

string

float_

15

3

(optional)

String

Float

User Defined Field of type

String

Float

udf_

string

float_

16

4

(optional)

String

Float

User Defined Field of type

String

Float

udf_

float

date_1

(optional)

Float

Date

User Defined Field of type

Float

Date

udf_

float

date_2

(optional)

Float

Date

User Defined Field of type

Float

Date

udf_

float

date_3

(optional)

Float

Date

User Defined Field of type

Float

Date

udf_

float

date_4

(optional)

Float

Date

User Defined Field

of type Floatudf_date_1

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)

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

Anchorproduct create referred objectsproduct create referred objectsReferred Parameter Objects Data

 

Include PageV4:global_rate_parametersV4:global_rate
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

Response Data

Include Page
V4:product_synchronisation_complete
V4:product_synchronisation_complete

...

Expand
titleExample 1

HTTP Method: POST POST


Request:


Body:

Code Block
language
languagejavascript
themeConfluence
javascriptlinenumberstrue
 {
    "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
themeConfluence
languagejavascript
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": ""
    }
}

 

...