GET Products

This will be called when the user initiates a product sync from Deliverect. This should be responded to by calling the Insert/update products categories endpoint

Depending on your setup, there are two ways of responding to this GET request, either a-sync or sync

MethodDescription
a-syncYour response to this request you can respond with an empty array and HTTP 200. You can then a-sync send us the products to the Insert/update products categories. *
syncYou can choose to respond to the request with the products.

📘

Product Sync URL Format

As this URL will receive a simple GET request, you would need to provide a parameter within the URL to identify the location in the POS e.g. https://www.poscloudurl.com?locationID=254754

To test this out, you can add the webhook URL in the Location settings of your staging environment within the 'Product Sync URL' field.

curl --location --request GET 'https://integrator.com/products' \
--header 'Accept: application/json'

Product sync preview and soft sync

It is possible to do products sync preview to see how many product will be created, update or deleted without actually applying any updates. To do this extra url parameter called previewSync set to true should added to the url i.e. <https://api.staging.deliverect.com/productAndCategories?previewSync=true>

There's also an opportunity to do a soft products sync. In this case all product sync requests that are about to remove more than 30% of existing items will be aborted. To do this extra url parameter called forceUpdate set to false should added to the url i.e. <https://api.staging.deliverect.com/productAndCategories?forceUpdate=false>

The GET Products webhook URL will be added a parameter at the end specifying which kind of update needs to be performed, e.g. https://www.poscloudurl.com?locationID=254754?forceUpdate=false.

If the intention is to perform a soft sync after receiving the GET products call, the posterior call to the insert/update endpoint should include ?forceUpdate=false.