Product Update Callback (async)

webhook

https://yourwebhook.com/product_sync_callback

Purpose

A webhook event can be delivered to a specified endpoint to confirm the success of an asynchronous product update with a summary of products synced.

Format

By default, the Insert Products response is synchronous and a 200 Accepted is returned with a summary of products updated.

For POS handling products updates across a large number of locations, this process is best handled asynchronously, where the initial response will be a 202 and a webhook event will be delivered to confirm the success of the operation.

Payload

Sent by Deliverect as a JSON payload.

operationReportId

string

Unique identifier of the product update operation.

products

object

Summary of products synced.

modifiers

object

Summary of modifiers synced.

modifierGroups

object

Summary of modifier groups synced.

bundles

object

Summary of bundles synced.

priceLevels

integer

Number of price levels synced.

warnings

integer

Number of warnings raised during the update.

errors

integer

Number of errors raised during the update.

Headers

User-Agent

string

required

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

X-Server-Authorization-HMAC-SHA256

string

required

Signature of the raw request body using your shared secret; recompute it on receipt to verify the request came from Deliverect (see HMAC authentication guide).

Response

200

Return a 2xx status to acknowledge receipt.