HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
API Documentation

Sync Products

webhook
https://yourwebhook.com/sync_products

Purpose

A webhook event will be sent to a provided endpoint whenever a user initiates a product sync from Deliverect. This should be responded to by calling the Insert Products endpoint.

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

MethodDescription
a-syncResponding with an empty HTTP 204 allows products to be sent asynchronously
syncResponding synchronously to the request with the complete product data set

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.yourwebhook.com?locationID=254754.

Headers
string
required

Identifies Deliverect as the sender, in the format Deliverect/{version}.

string
required

Signature generated with your shared secret (GET requests have no body); recompute it on receipt to verify the request came from Deliverect (see HMAC authentication guide).

Responses
200

Synchronous: respond with the complete product data set.

204

Asynchronous: respond with an empty 204, then send products via Insert Products.

Updated 1 day ago

Did this page help you?
LoadingLoading…

Updated 1 day ago

Did this page help you?