Available from CRM.COM R14.0.0

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:

Name

Type

Description

(semi-optional)

String

The ID of the process run definition

name

(semi-optional)

String

The name of the process run definition

alternative_code

(semi-optional)

String

The alternative code of the process run definition

products_set

(mandatory)

Set of Product Objects

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

Referred Parameter Objects Data

bulk products parameter object data

Name

Type

Description

code

(mandatory)

String

The code of the product

alternative_code

(optional)

String

The alternative code of the product

description

(optional)

String

The 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

Deprecated from CRM.COM R17.0.0

type_identifier

(optional)

Product Type Identifier

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

Name

Type

Description

(semi-optional)

String

The ID of the product type

name

(semi-optional)

String

The name of the product type

alternative_code

(semi-optional)

String

The alternative code of a product type

brand_identifier

(optional)

Product Brand Identifier

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

Name

Type

Description

(semi-optional)

String

The ID of the product brand

name

(semi-optional)

String

The name of the product brand

alternative_code

(semi-optional)

String

The alternative code of a product brand

family_identifier

(optional)

Product Family Identifier

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

Name

Type

Description

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of a product family

category_identifier

(optional)

Product Category Identifier

The product category of the product

Name

Type

Description

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of a product category

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:

Name

Type

Description

(semi-optional)

String

The ID of the VAT rate

name

(semi-optional)

String

The name of the VAT rate

alternative_code

(semi-optional)

String

The alternative code of the VAT rate

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:

Name

Type

Description

(semi-optional)

String

The ID of the Tax rate

name

(semi-optional)

String

The name of the Tax rate

alternative_code

(semi-optional)

String

The alternative code of the Tax rate

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

Available from CRM.COM R15.0.0

Deprecated from CRM.COM R17.0.0

product_validity_from

(optional)

Date

The date from which the product will be valid

product_validity_to

(optional)

Date

The date until which the product will be valid

udf_string_1

(optional)

String

Browser not supported