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:
| ||||||||||||
(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
Response Data
Name | Type | Description |
|---|---|---|
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
Examples
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": ""
}
}