You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 17
Next »
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 |
|---|
id (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 |
| 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 |
|---|
id (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 |
|---|
id (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 |
|---|
id (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 Object | The product category of the product Name | Type | Description |
|---|
id (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 |
|
vat_rate (optional) | VAT Rate Object | The VAT Rate identifier of the product The allowed VAT Rate identifier fields are the following: Name | Type | Description |
|---|
id (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 |
|
tax_rate (optional) | Tax Rate Object | The Tax Rate identifier of the product The allowed Tax Rate identifier fields are the following: Name | Type | Description |
|---|
id (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 |
|
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 | 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 |
Response Data
Name | Type | Description |
|---|
processed_products_set | Set of Processed Products Objects | A set that contains the ID and the code of the products that were synchronised
|
| unprocessed_products_set | Set of Unprocessed Products Objects | A set that contains the products that failed to be synchronised in CRM.COM. Each row includes the code of the product, as provided by the caller, along with an error code and error description.
|
Referred Objects Response Data
processed products object response data
Name | Type | Description |
|---|
| request_code | String | The product code as provided by the caller, in order to identify the successful results. |
id | String | The ID of the product in CRM.COM which was synchronised |
| code | String | The number of the product in CRM.COM which was synchronised |
| message | String | The description of the processed product (including any combination of an attribute and the reason why such attribute information was not updated) |
unprocessed products object response data
Name | Type | Description |
|---|
| request_code | String | The product code as provided by the caller, in order to identify the failed results. |
| error_code | String | The code of the error that was raised |
| error_description | String | The description of the error that was raised |
Examples
Example 1
HTTP Method: POST
Request:
Body:
{
"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:
{
"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": ""
}
}