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
DeliverectDeliverect
HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page
Deliverect
API Documentation
HomeGuidesAPI DocumentationAPI UpdatesAsk a QuestionStatus Page

Access Token

  • Get Access Token

Commerce API

  • Overview
  • Endpoints
    • Stores
      • Get Storesget
      • Get Storeget
    • Menu
      • Get Root Menu(s)get
      • Get Store Menu(s)get
    • Basket
      • Create Basketpost
      • Validate Basketpost
      • Get Basketget
      • Recreate Basketpost
      • Update Basket - Fulfillment Detailspatch
      • Update Basket - Storepatch
      • Update Basket - Item(s)patch
      • Update Basket - Customerpatch
      • Update Basket - Group Customerspatch
      • Update Basket - Policiespatch
      • Update Basket - Tippatch
      • Update Basket - Donationspatch
      • Update Basket - Discount(s)patch
      • Update Basket - Chargespatch
    • Checkout
      • Complete Checkoutpost
      • Get Checkoutget
  • Webhooks
    • Checkout Updatepost

CHANNEL API

  • Overview
  • Endpoints
    • Stores
      • Update Store Statuspost
      • Tables and Floorsget
    • Menus
      • Menu Update (Async)post
      • GET Allergens & Tags
    • Orders
      • Create / Cancel Orderpost
      • Update Courier / Guest Statuspost
      • Dispatch Availabilitypost
      • Dispatch Detailsget
      • Order Rating Updatepost
  • Webhooks
    • Onboarding
      • Channel Registrationpost
    • Menu Updatepost
    • Busy modepost
    • Snooze / Unsnooze Productspost
    • Order Updates
      • Payment Updatepost
      • Preparation Time Updatepost
      • Order Status Updatepost
      • Courier Updatepost

Upsell API

  • Overview
  • Endpoints
    • Get Upsell Itemspost

Dispatch API

  • Dispatch Overview
  • Endpoints
    • Update Delivery Jobpost
    • Cancel Delivery Jobpost
  • Webhooks
    • Validate Delivery Jobpost
    • Create Delivery Jobpost
    • Update Delivery Jobpost
    • Cancel Delivery Jobpost

Loyalty API

  • Loyalty Channel - Overview
    • Endpoints
      • Get Loyalty Configurationget
      • Get Loyalty Customerget
      • Create Loyalty Customerpost
      • Get Loyalty Customer Walletget
      • Get Loyalty Tiersget
      • Get Loyalty Programspost
      • Validate Loyalty Programspost
      • Validate Compensation Cardspost
  • Loyalty Partner - Overview
    • Webhooks
      • Onboarding
        • Register Loyalty Partnerpost
      • User Authentication
        • Loyalty Single Sign On (SSO)
          • Loyalty SSO - OAuth token exchangepost
          • Loyalty SSO - redirect to ordering channelget
      • Loyalty Customers
        • Get Loyalty Customerget
        • Create Loyalty Customerpost
      • Loyalty Tiers
        • Get Loyalty Tiersget
      • Loyalty Wallet
        • Get Loyalty Customer Walletget
      • Loyalty Programs
        • Get Loyalty Programspost
        • Validate Programspost
        • Loyalty Discounts Schema
      • Loyalty Orders
        • Loyalty Order Notificationpost
        • Cancel Loyalty Orderpost

Gift Cards

  • Overview
  • Endpoints
    • Get Profile Linksget
    • Apply Gift Cardpost
    • Get Balancepost
    • Reverse Redemptionpost
    • Redeem Gift Cardspost
    • Validate Gift Card post
  • Webhooks
    • Register Gift Card Providerpost
    • Redeem gift cardspost
    • Reverse Redemptionpost

Coupons API

  • Overview
  • Endpoints
    • Get Couponsget
    • Validate Couponspost

CRM API

  • Overview
  • Endpoints
    • Create Customerpost
    • Lookup Customer by Email/Phonepost
    • Lookup Customer (many)post
    • Retrieve Customer Profileget
    • Update Customer Profilepatch
    • Update Customer Delivery Addressespatch
    • Update Customer Vehiclespatch
    • Update Customer Favoritespatch
    • Customer Order Historyget
    • CRM Orderget
    • Customer Favorite Ordersget

Pay API

  • Overview
  • Endpoints
    • Get Payment Gatewaysget
    • Create Tokenpost
    • Delete Tokendel
    • Get Customer Tokensget
    • Request Paymentpost
    • Request Payment Re-authorizationpost
    • Get Paymentget
    • Refund Paymentpost
  • Webhooks
    • Payment Update post

Payment Platform API

  • Overview
  • Endpoints
    • Payment Eventspost
  • Webhooks
    • Register Profilepost
    • Refund Paymentpost
    • Request Paymentpost
    • Unregister Profile Eventpost
Powered by 
  1. Commerce API
  2. Endpoints

Checkout

Glossary

EndpointTypeFunction
Complete CheckoutPOSTCompletes the checkout process
Get CheckoutGETRetrieves checkout information

Updated 9 days ago


Update Basket - Charges
Complete Checkout
Did this page help you?

Updated 9 days ago


Update Basket - Charges
Complete Checkout
Did this page help you?
    • Glossary