FAQ

Are marketplace orders with a loyalty ID sent to our loyalty webhooks?

Yes. When a marketplace order is created with a loyalty identifier, Deliverect calls the GET Customer webhook. If a200 is returned with the loyalty profile, the order is sent to the Loyalty Order Notification webhook, and any later cancellation to Cancel Loyalty Order.

See the full sequence in the 3PD loyalty flow diagram.

Where does the customer's loyalty ID appear in the order?

In customer.loyaltyProviderCustomerId. This is the providerId you confirmed in the GET Customer response.

"customer": {
  "email": "",
  "phoneNumber": "",
  "name": "Jane Doe",
  "loyaltyProviderCustomerId": "123"
}

Can we tell which channel an order came from?

No, loyalty order is channel agnostic by design, since a Loyalty Platform only needs to update a customer's balance.

At which order status is the loyalty order sent?

The flow starts only once the order is accepted in the POS. The cancel webhook is sent for any cancellation, including POS rejections.

What is the retry policy for failed webhooks?

We retry on a connection timeout or connection refused. After the first failed attempt we retry 3 times, with exponential backoff of 5s, 10s and 20s, so retries finish around 35 seconds after the first failure, plus the time each attempt takes.

We don't retry on:

Any HTTP response, including non-2xx such as 429, 502, 503 and 504.
Read timeouts, where the connection succeeds but your endpoint doesn't respond in time. The default timeout is 30 seconds, with a maximum of 60 seconds.

How are monetary values formatted?

Amounts are sent as integers in the smallest currency unit 1250 is $12.50.

For how each amount field is populated, see the Loyalty Order Model and for discount model, see how to handle discounts.

Are item PLUs the same as in the Deliverect menu?

PLUs are sanitised before they're sent in loyalty orders, so any suffixes used for menu display are stripped out.

How do we verify that a webhook came from Deliverect?

Every webhook includes an X-Server-Authorization-HMAC-SHA256 header. During development we provide a unique HMAC secret: sign the raw request body with it and compare the result with the header. If they match, the request came from Deliverect. See HMAC Authentication.

Do we need to support the loyalty programs or wallet endpoints?

No. The marketplace flow doesn't use them.

Is the Create Customer webhook called for marketplace orders?

No, only GET Customer is called for marketplace orders. Create Customer is used by other Deliverect products, for example to send a guest-checkout user a sign-up link from your platform.

How can we test marketplace loyalty orders?

We can provide a Deliverect test store to trigger the loyalty webhooks. Marketplace test stores depend on the marketplace's own support, so availability is limited; we can share one temporarily, or the merchant can request one from the marketplace directly.

How do we become an integration partner?

Complete the partner application form.