HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
API Documentation
  1. Loyalty API
  2. Loyalty Partner - Overview
  3. Webhooks
  4. Loyalty Orders

Loyalty Order Notification

post
https://yourwebhook.com/loyalty/order

Purpose

This webhook event is triggered when an order is made. Deliverect sends the order details to the configured endpoint, enabling the loyalty provider to perform relevant loyalty operations, such as awarding points and deducting redeemed points.

Order Schema

For a full list of all order attributes and their definition, see the link below;

▶ Loyalty Order Model
Body Params

This schema defines the comprehensive structure of an order used for loyalty operations (such as program validation or redemption).

string
required

The unique identifier for the merchant account.

string
deprecated

(DEPRECATED) Use accountId instead.

string
required

The unique identifier linking the channel to the account/location.

string
required

The unique identifier for the specific location/store where the order was placed.

string
deprecated

(DEPRECATED) Use locationId instead.

integer
enum
required

The type of delivery.

Allowed:
number
required

The final amount paid by the customer.

customer
object
required

Details about the customer who placed the order.

date-time | null

Timestamp of when the order was created. May be null in some initial API calls (e.g., get programs).

string | null

The order ID displayed to the customer on the channel.

string | null

The system's unique identifier for the order.

items
array of objects
required

A list of all items included in the order.

items*
number | null

The total price of all items before taxes and discounts.

number | null

The total tax applied to the order.

number | null

The total value of all discounts applied to the order.

discounts
array of objects

A list of all applied discounts.

discounts
number
required
Defaults to 2

The number of decimal places used for currency precision. Default is 2.

number | null

Any service fee applied to the order.

number | null

The cost of delivery.

number | null

Any fee applied for packaging or bags.

number | null

The customer-provided tip.

number | null

The tip specifically allocated for the driver.

number | null

Any fee applied for not meeting a minimum order threshold.

Headers
string
Defaults to Deliverect/{version}
string
Defaults to {signature}
Responses

Updated 5 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago

Did this page help you?