Jump to Content
API Documentation
API Documentation
API Documentation
----- Delivery -----
JUMP TO
Ordering Api
Welcome to our Ordering API
----- Getting Started -----
API Summary
Ordering API SDK
Special data types
Errors
Including attributes
Filtering
Sorting Data
Pagination
Versioning
Testing instructions
Extra attributes (Metafields)
Timestamp parameter
----- Users -----
----- Users -----
Users Authentication
Users Authentication
Authorize User Login
post
Social Login
post
User Logout
post
User Verify
post
SMS login
post
SMS Twilio Verify
post
SMS Twilio Auth
post
Users
Users Model
Users special parameters requests
Get Users List
get
Find User
get
Create User
post
Edit User
post
Delete User
del
Users Forgot Password
post
Users Reset Password
post
Users Check Password
post
Get User Reviews
get
User addresses
Model
Add User address
post
Get User addresses
get
Find user address
get
Edit User Address
put
Delete user address
del
Address Metafields
Get Address Metafields
get
Find Address Metafield
get
Create Address Metafield
post
Edit Address Metafield
put
Delete Address Metafield
del
Users Notification Tokens
Notification Tokens Model
Get Notification Tokens
get
Create Notification Token
post
Delete Notification token
del
User API Key
Users API Key
Users API Key Model
Get API keys
get
Create API Key
post
Delete API key
del
User Metafields
Get User Metafields
get
Find User Metafield
get
Create User Metafield
post
Update User Metafield
put
Delete User Metafield
del
----- Businesses -----
----- Businesses -----
Seach Business
Advance Search Model
Get Advance Search List
get
Get Suggestions for search
get
Business
Business Model
Business special requests
Get Businesses List
get
Find Business
get
Create Business
post
Copy Business
post
Edit Business
post
Delete Business
del
Business Order Types
Business Order Type Model
Update Business Order Type
put
Business Metafields
Get Business Metafields
get
Find Business Metafield
get
Create Business Metafield
post
Edit Business Metafield
put
Delete Business Metafield
del
Business Delivery zones
Business Delivery Zones Model
Get Business Delivery Zones
get
Find Business Delivery Zone
get
Create Business Delivery Zone
post
Edit Business Delivery Zone
put
Delete Business Delivery Zone
del
Business Gallery
Business Gallery Model
Business Gallery special params request
Get Business Gallery Items
get
Find Business Gallery Item
get
Create Business Gallery Item
post
Delete Business Gallery Item
del
Business Paymethods
Business Paymethods Model
Business Paymethod special params request
Get Business Payment Options
get
Find Business Payment Option
get
Create Business Payment Option
post
Edit Business Payment Option
put
Delete Business Payment Option
del
Business Reviews
Business Reviews Model
Reviews special request
Get Business Reviews
get
Find Business Review
get
Create Business Review
post
Edit Business Review
put
Delete Business Review
del
Business Offers:Discounts
Business Offers Model
Business Offers special request
Get Business Offers
get
Find Business Offer
get
Create Business Offer
post
Edit Business Offer
put
Delete Business Offer
del
Business Offers Metafields
Get Business Offer Metafields
get
Find Business Offer Metafield
get
Create Business Offer Metafield
post
Edit Business Offer Metafield
put
Delete Business Offer Metafield
del
Business Menus:Catalogs
Business Menus Model
Business Menus special request
Get Business Menus
get
Find Business Menu
get
Create Business Menu
post
Edit Business Menu
put
Delete Business Menu
del
Business TYpes
Get Business Types List
get
Find Business Type
get
Create Business Types
post
Edit Business Types
post
Delete Business Types
del
Menu Metafields
Get Menu Metafields
get
Find Menu Metafield
get
Create Menu Metafield
post
Edit Menu Metafield
put
Delete Menu Metafield
del
Menus Shared
Shares Menus Feature
Update Menu Shared
put
Delete Menu Shared
del
Update Menu Shared Product
put
Get Menus Shared extra
get
Get Menus shared options
get
Get Menus shared suboptions
get
Business Categories
Business Categories Model
Business Category special request
Get Business Categories
get
Find Business Category
get
Create Business Category
post
Edit Business Category
post
Delete Business Category
del
Categories Metafields
Get Categories Metafields
get
Find Categories Metafields
get
Create Category Metafield
post
Update Category Metafield
put
Delete Category Metafield
del
Business Products
Business Products Model
Get Business Products
get
Find Business Product
get
Create Business Product
post
Edit Business Product
post
Delete Business Product
del
Bulk Create Products
post
Bulk Edit Products
put
Bulk Delete Products
del
Get All Business Products
get
Business:Place Groups
Business Place Groups Model
Get Business Place Groups
get
Get a Business Place Group
get
Create a Business Place Group
post
Update a Business Place Group
put
Delete a Business Place Group
del
Product Metafields
Get Product Metafields
get
Find Product Metafield
get
Create Product Metafield
post
Edit Product Metafield
put
Delete Product Metafield
del
Product Gallery
Product Gallery Model
Get Product Gallery Items
get
Find Product Gallery Item
get
Create Product Gallery Item
post
Edit Product Gallery Item
post
Delete Product Gallery Item
del
Product Ingredients
Product Ingredients Model
Get Product Ingredients
get
Find Product Ingredient
get
Create Product Ingredient
post
Edit Product Ingredient
post
Delete Product Ingredient
del
Product Extras
Product Extras Model
Product Extras special request
Get Product Extras
get
Find Product Extra
get
Create Product Extra
post
Edit Product Extra
put
Delete Product Extra
del
Product Extra Metafields
Get Product Extra Metafields
get
Find Product Extra Metafield
get
Create Product Extra Metafield
post
Edit Product Extra Metafield
put
Delete Product Extra Metafield
del
Extras Options
Extras Options Model
Extras Options special request
Get Extras Options
get
Find Extras Option
get
Create Extras Option
post
Edit Extras Option
put
Delete Extras Option
del
Extra Option Metafields
Get Extra Option Metafields
get
Find Extra Option Metafield
get
Create Extra Option Metafield
post
Edit Extra Option Metafield
put
Delete Extra Option Metafield
del
Extras SubOptions
Extras SubOptions Model
Extras SubOptions special request
Get Extras SubOptions
get
Find Extras SubOption
get
Create Extras SubOption
post
Edit Extras SubOption
put
Delete Extras SubOption
del
Extras Suboptions Metafields
Get Extra SubOption Metafields
get
Find Extra SubOption Metafields
get
Create Extra SubOption Metafields
post
Edit Extra SubOption Metafields
put
Delete Extra SubOption Metafields
del
----- Orders -----
----- Orders -----
Orders
Orders Model
Orders special params request
Get Orders
get
Find Order
get
Create Order
post
Edit Order
put
Delete Order
del
Orders Dashboard
get
Export Orders
get
Create Custom Order
post
Refund Order
post
Cart (new feature)
Cart model
Get Order Options
get
Update Order Options
put
Get Carts
get
Add Product to cart
post
Remove products to cart
post
Update product cart
post
Clear Cart
post
Apply coupon to a cart
post
Change driver tip
post
Find cart
get
Placer order with cart
post
Confirm Cart
post
Add offer to cart
post
Create Cart Metafield
post
Edit Cart Metafield
put
Get Carts Businesses
get
Edit Cart
put
Add wallet
post
Remove wallet
del
Event Rules
Event Rules Model
Get All Event Rules
get
Find Event Rule
get
Create Event Rule
post
Edit Event Rule
put
Delete Event Rule
del
Get All Channels of Event Rule
get
Find Channel of Event Rule
get
Create Channel on Event Rule
post
Edit Channel on Event Rule
put
Delete Channel Event Rule
del
Order Metafields
Get Order Metafields
get
Find Order Metafield
get
Create Order Metafield
post
Edit Order Metafield
put
Delete Order Metafield
del
Order attachments
Order Attachments Model
Get Order Attachments
get
Create Order Attachment
post
Delete Order Attachment
del
----- Delivery -----
----- Delivery -----
Delivery Options
Delivery Options Model
Get all Delivery Options
get
Get Delivery Option
get
Create Delivery Option
post
Edit Delivery Option
put
Delete Delivery Option
del
Driver locations
Driver Locations Model
Get Driver Locations
get
Create Driver Locations
post
Delete Driver Locations
del
Driver groups
Driver Groups Model
Get Driver Groups
get
Find Driver Group
get
Create Driver Group
post
Edit Driver Group
put
Delete Driver Group
del
Drivergroups Metafields
Get Drivergroup Metafields
get
Find Drivergroup Metafields
get
Create Drivergroup Metafields
post
Edit Drivergroup Metafields
put
Delete Drivergroup Metafields
del
Driver Companies
Driver Companies Model
Get Driver Companies
get
Find Driver Company
get
Create Driver Company
post
Update Driver Company
post
----- Settings -----
----- Settings -----
Languages
Languages Model
Get Languages
get
Find Language
get
Create Language
post
Edit Language
put
Delete Language
del
Translations
Translations Model
Get Translations
get
Find Translation
get
Create Translation
post
Edit Translation
put
Delete Translation
del
Bulk Create translations
post
Bulk Edit Translations
put
Bulk Delete Translations
put
Countries
Countries Model
Get Countries
get
Find Country
get
Create Country
post
Edit Country
put
Delete Country
del
Cities
Cities Model
Cities special request
Get Cities
get
Find City
get
Create City
post
Edit City
put
Delete City
del
Dropdown Options:Zones
Dropdown Options Model
Dropdown Options special request
Get Dropdown Options
get
Find Dropdown Option
get
Create Dropdown Option
post
Edit Dropdown Option
put
Delete Dropdown Option
del
Checkout fields
Checkout Fields Model
Get Checkout Fields
get
Find Checkout Field
get
Create Checkout Field
post
Edit Checkout Field
put
Delete Checkout Field
del
Configurations
Configurations Model
Get Configurations
get
Find Configuration
get
Create Configuration
post
Edit Configuration
put
Delete Configuration
del
Config Categories
Configuration Categories model
Get Configurations
get
Find Configuration Category
get
Create Config Category
post
Edit Config Category
put
Delete Config Category
del
Paymethods
Paymethod Model
Get Paymethods
get
Find Paymethod
get
Create Paymethod
post
Edit Paymethod
put
Delete Paymethod
del
----- External Integrations -----
----- External Integrations -----
GPRS Printers
GPRS Printers Model
Get GPRS Printers
get
Find GPRS Printer
get
Create GPRS Printer
post
Edit GPRS Printer
put
Delete GPRS Printer
del
Get GPRS Printers Queue
get
Confirm GPRS Printer Queue by GET
get
Webhooks
What are Webhooks?
Webhooks list
Webhooks Model
Get Webhooks
get
Create Webhook
post
Edit Webhook
put
Delete Webhook
del
Business webhooks
Business Webhooks Model
Get Business Webhooks
get
Create Business Webhook
post
Edit Business Webhook
put
Delete Business Webhook
del
SEO
SEO endpoints
Get SEO business
get
Get SEO category
get
Get SEO product
get
Get SEO sites
get
----- New Functionality -----
----- New Functionality -----
Plugins
Introduction
Hooks list
Prehooks
Plugins Model
Get Plugins
get
Create Plugin
post
Edit Plugin
post
Delete Plugin
del
Payment
Payment How does it work
Payment Cards
Get Payment Cards
get
Add Payment Card
post
Set Default Payment card
post
Delete Payment card
get
Zapier
Zapier
Sockets
Sockets
Placing Order
Placing order
Order Message
Order message model
Get Order messages
get
Create Order messages
post
Read Order messages
get
Pages
Pages model
Get Pages
get
Find Page
get
Create page
post
Update page
put
Delete Page
del
Reports
Reports General Params
Top Selling
get
Top categories
get
Orders status
get
Orders accept spend
get
Customer satisfaction
get
Sales
get
Orders
get
Users
get
Driver reports
Driver Reports General Params
Top Selling
get
Top categories
get
Orders status
get
Sales
get
Orders
get
Orders accept spend
get
Orders Arrived Pickup spend
get
Orders Pickup spend
get
Orders delivery spend
get
Orders complete spend
get
Orders spend times
get
Orders available times
get
Orders busy times
get
POS Integration
Business relation
Product relation
Suboptions relation
Order relations
Alerts
Business Maximums Rules
Business Maximums Model
Update Business Maximum Rule
put
Create Business Maximum Rule
post
Codes
Codes Model
Generate Code
post
Verify Code
get
Verify Code
post
Product Reviews
Product review Model
Create Product review
post
Create Multiple Product review
post
Get Product Reviews
get
Manual Dispatch
Manual Dispatch Model
Create Manual Dispatch
post
Offers
Offers Model
Update Offer
post
Remove Offer
post
Change paymethod to cart
post
Importers
Importer Model
Create importer
post
Delete importer
del
Create importer job
post
Create importer job slug
post
Franchises
Franchises Model
Create Franchises
post
Get All franchises
get
Update Franchise
post
Get a Franchise
get
Delete a franchise
del
Controls
Controls Model
Get Orders
get
Get Order
get
Products
Products Model
Get Products
get
Get Business by products
get
Get Business by products Model
Users Review
Users Review Model
Create User Review
post
Get All User review
get
Get User Review
get
Sites
Sites Model
Get Sites List
get
Find Site
get
Create Site
post
Edit Site
post
Delete Site
del
Wallet
Wallet Model
Get All Wallets List
get
Find Wallet
get
Get Wallets List by user
get
Find Wallet by user
get
Update Wallet
put
Update Wallet by user
put
Wallet Event
Wallet Event Model
Get All Events List
get
Find Event
get
Get Event List by user
get
Find Event by user
get
Create Event
post
Create Event by user
post
Loyalty plans
Loyalty Plan Model
Get All Loyalty Plans List
get
Find Loyalty Plan
get
Create Loyalty Plan
post
Update Loyalty Plan
post
Delete Loyalty Plan
del
Business Loyalty Plans
Business Loyalty Plans Model
Get All Business Loyalty Plans List
get
Find Business Loyalty Plans
get
Create Business Loyalty Plan
post
Update Business Loyalty Plan
post
Delete Business Loyalty Plan
del
Loyalty levels
Loyalty Levels Model
Get All Loyalty Levels List
get
Find Loyalty Level
get
Create Loyalty Level
post
Update Loyalty Level
post
Delete Loyalty Level
del
Powered by
----- Delivery -----
Updated over 1 year ago
Delete Order Attachment
Delivery Options Model
Updated over 1 year ago
Delete Order Attachment
Delivery Options Model
