For AI agents: visit https://developers.deliverect.com/v3.0-ordering-experience/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Home
Guides
API Documentation
API Updates
Ask a Question
Status Page
Deliverect API
Restaurants
Retail
Ordering Experience
API Documentation
Search
Ask AI
Ordering Experience
Home
Guides
API Documentation
API Updates
Ask a Question
Status Page
/loyalty/{channelLinkId}/programs/retrieve-1
Access Token
Get Access Token
Commerce API
Overview
Endpoints
Stores
Get Stores
get
Get Store
get
Menu
Get Root Menu(s)
get
Get Store Menu(s)
get
Basket
Create Basket
post
Validate Basket
post
Reconcile Basket
post
Get Basket
get
Recreate Basket
post
Update Basket - Fulfillment Details
patch
Update Basket - Store
patch
Update Basket - Item(s)
patch
Update Basket - Customer
patch
Update Basket - Group Customers
patch
Update Basket - Group Order Policies
patch
Update Basket - Tip
patch
Update Basket - Donations
patch
Update Basket - Discount(s)
patch
Update Basket - Charges
patch
Checkout
Complete Checkout
post
Get Checkout
get
Webhooks
CHANNEL API
Overview
Endpoints
Stores
Update Store Status
post
Tables and Floors
get
Menus
Menu Update (Async)
post
GET Allergens & Tags
Orders
Create / Cancel Order
post
Update Courier / Guest Status
post
Dispatch Availability
post
Dispatch Details
get
Order Rating Update
post
Webhooks
Onboarding
Channel Registration
post
Menu Update
post
Busy mode
post
Snooze / Unsnooze Products
post
Order Updates
Payment Update
post
Preparation Time Update
post
Order Status Update
post
Courier Update
post
Upsell API
Overview
Endpoints
Get Upsell Items
post
Dispatch API
Dispatch Overview
Endpoints
Update Delivery Job
post
Cancel Delivery Job
post
Webhooks
Validate Delivery Job
post
Create Delivery Job
post
Job Update
post
Cancel Delivery Job
post
Loyalty API
Loyalty Channel - Overview
Endpoints
Get Loyalty Configuration
get
Get Loyalty Customer
get
Create Loyalty Customer
post
Get Loyalty Customer Wallet
get
Get Loyalty Tiers
get
Get Loyalty Programs
post
Validate Loyalty Programs
post
Validate Compensation Cards
post
Loyalty Partner - Overview
Webhooks
Onboarding
Register Loyalty Partner
post
User Authentication
Loyalty Single Sign On (SSO)
Loyalty SSO - OAuth token exchange
post
Loyalty Customers
Get Loyalty Customer
get
Create Loyalty Customer
post
Loyalty Tiers
Get Loyalty Tiers
get
Loyalty Wallet
Get Loyalty Customer Wallet
get
Loyalty Programs
Get Loyalty Programs
post
Validate Programs
post
Loyalty Discounts Schema
Loyalty Orders
Loyalty Order Notification
post
Cancel Loyalty Order
post
Endpoints
Loyalty SSO - redirect to ordering channel
get
Gift Cards
Overview
Endpoints
Get Profile Links
get
Apply Gift Card
post
Get Balance
post
Reverse Redemption
post
Redeem Gift Cards
post
Validate Gift Card
post
Webhooks
Register Gift Card Provider
post
Retrieve Balance
post
Redeem Gift Cards
post
Reverse Redemption
post
Coupons API
Overview
Endpoints
Get Coupons
get
Validate Coupons
post
CRM API
Overview
Endpoints
Create Customer
post
Lookup Customer by Email/Phone
post
Lookup Customer (many)
post
Retrieve Customer Profile
get
Update Customer Profile
patch
Update Customer Delivery Addresses
patch
Update Customer Vehicles
patch
Update Customer Favorites
patch
Customer Order History
get
CRM Order
get
Customer Favorite Orders
get
Pay API
Overview
Endpoints
Get Payment Gateways
get
Create Token
post
Delete Token
del
Get Customer Tokens
get
Request Payment
post
Request Payment Re-authorization
post
Get Payment
get
Refund Payment
post
Webhooks
Payment Update
post
Payment Platform API
Overview
Endpoints
Payment Events
post
Webhooks
Register Profile
post
Refund Payment
post
Request Payment
post
Unregister Profile Event
post
Channel Webhooks
/channel/busy_mode
Busy mode
post
/channel/courier_update
Courier Update
post
/channel/menu_update/
Menu Update
post
/channel/oauth/authorize?client_id={integration_id}&state={state_id}&redirect_uri={redirect_uri}&response_type={response_type}&metadata={metadata}
Oauth flow
post
/channel/order_status
Order Status Update
post
/channel/payment_update
Payment Update
post
/channel/prep_time
Preparation Time Update
post
/channel/register
Channel Registration
post
/channel/snooze
Snooze / Unsnooze Products
post
Powered by
/loyalty/{channelLinkId}/programs/retrieve-1
Updated 11 days ago
Overview
Did this page help you?
Yes
No
Updated 11 days ago
Overview
Did this page help you?
Yes
No
Copy Page
