Page Comparison

...

Step 1 - Synchronize Products

No

Description

Web API Example

POS Conceptual Examples

1

Product synchronization on a POS system can implemented as a batch process that is performed on a repeated basis (i.e. every day at 2 am), where product information is sent to CRM.COM

Submitting a product synchronization request in CRM.COM should be performed using the POST products/synchronise method, and capture the following information

The product synchronization definition that describes how the products information from the POS system will be handled by CRM.COM (synchronisation_definition_identifier)
The POS products and their related attributes (code, description, family, brand, categories, etc) per each product (products_set)

Note
The maximum number of products that can be synchronized per call is 1,000

Code Block

title	POST Request

https://hostname/crmapi/rest/v2/products/synchronise

Code Block

title	Body
linenumbers	true
collapse	true

{
	"token": "{{token}}",
	"synchronisation_definition_identifier":{
		"alternative_code": "Product_Sync"
	},

	"products_set":[
		{
			"code" : "Orange Cookie",
			"alternative_code" : "10021",
			"description":"Cookie with orange cream",
		},
		{
			"code" : "Iced Caramel Latte",
			"alternative_code" : "20071",
			"description":"Latte with caramel syrup",
			"family_identifier" :{
				"code" : "Iced Coffee"
			}
		}
	],

	"fields_set":"unprocessed_products_set,processed_products_set"
}

Not Applicable

2

Once the product synchronization request is submitted and upon completion processing from the CRM.COM, the following information is returned (and handled accordingly by the POS system)

The products that were not processed by CRM.COM due to an error was thrown (unprocessed_products_set)
The products that were processed successfully by CRM.COM (unprocessed_products_set)

Code Block

title	Response
linenumbers	true
collapse	true

{
	"data": {
		"unprocessed_products_set": [
			{
				"error_description": "Error:Product Family (Iced Coffee) Not Found. - Description:The specified API value was not found.",
				"error_code": "NotFoundAPIValueException",
				"request_code": "Iced Caramel Latte"
			}
		],
		"processed_products_set": [
			{
				"code": "Orange Cookie",
				"request_code": "Orange Cookie",
				"id": "E15E0F60F5D147B28C8FD50ADE4E0116"
			}
		]
	},
	"status":{
		"message": null,
		"description": null,
		"code": "OK"
	}
}

Not Applicable

Versions Compared

Old Version 2

New Version 3

Key

Step 1 - Synchronize Products