Versions Compared

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 within a single Web API method call. Note that the maximum number of products to be synchronised is 1000

...

Name

Type

Description

token

String

The token retrieved from the login method

products_setSet 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

Expand
titlebulk products parameter object data

Name

Type

Description

code

(mandatory)

StringThe code of the product

description

(optional)

StringThe description 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

(optional)

Product Category Object

The product category of the product

Include Page
V4:product_category_identifier
V4:product_category_identifier

vat_rate

(optional)

VAT Rate Object

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

tax_rate

(optional)

Tax Rate Object

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

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

...

(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

...

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

Include Page
V4:product_synchronisation_complete
V4:product_synchronisation_complete

...