API guides
Browse 286 guides to Ordering API concepts and workflows. For request and response schemas, see the Open API Reference.
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 Authentication
- User authentication
- Authorize user login
- Social login
- User logout
- Verify a user
- SMS login with Facebook Account Kit (legacy)
- Request an SMS verification with Twilio
Users
- User model
- User Relation Expansion
- List users
- Get user
- Create a user
- Update a user
- Delete a user
- Request a password reset
- Check a user password
User addresses
- User Address Model
- Create User Address
- List User Addresses
- Find User Address
- Update User Address
- Delete User Address
Address Metafields
- List Address Metafields
- Find Address Metafield
- Create Address Metafield
- Update Address Metafield
- Delete Address Metafield
Users Notification Tokens
User API Key
Businesses
Seach Business
Business
- Business model
- Business special requests
- List businesses
- Find a business
- Create a business
- Copy a business
- Update a business
- Delete a business
Business Order Types
Business Metafields
Business Delivery zones
Business Gallery
Business Paymethods
- Business payment-method credential model
- Business payment-method relations
- Business payment-method setup history
Business Reviews
- Business Reviews Model
- Business Review Relation Expansion
- Create Business Review
- Update Business Review
- Delete Business Review
Business Offers:Discounts
Business Offers Metafields
- List Business Offer Metafields
- Find Business Offer Metafield
- Create Business Offer Metafield
- Update Business Offer Metafield
- Delete Business Offer Metafield
Business Menus:Catalogs
- Business Menus Model
- Business Menus special request
- Get Business Menus
- Find Business Menu
- Create Business Menu
- Edit Business Menu
Business TYpes
Menu Metafields
- List Menu Metafields
- Find Menu Metafield
- Create Menu Metafield
- Update Menu Metafield
- Delete Menu Metafield
Menus Shared
Business Categories
- Business category model
- Business category special request
- List business categories
- Find a business category
- Create a business category
- Update a business category
- Delete a business category
Categories Metafields
Business Products
- Business product model
- List business products
- Find a business product
- Create a business product
- Update a business product
- Delete a business product
- Bulk create products
- Bulk update products
- Bulk delete products
Business:Place Groups
Product Gallery
- Product Gallery Model
- Get Product Gallery Items
- Find Product Gallery Item
- Create Product Gallery Item
- Edit Product Gallery Item
- Delete Product Gallery Item
Product Ingredients
Product Extras
Extras Options
Extra Option Metafields
- List Extra Option Metafields
- Find Extra Option Metafield
- Create Extra Option Metafield
- Update Extra Metafield
- Delete Extra Option Metafield
Extras SubOptions
Extras Suboptions Metafields
- List extra suboption metafields
- Find an extra suboption metafield
- Create an extra suboption metafield
- Update an extra suboption metafield
- Delete an extra suboption metafield
Orders
- Orders
- Orders Model
- Order Relation Expansion
- List Orders
- Find Order
- Update Order
- Delete Order
- Orders dashboard
- Order Export History
- Custom Order Creation History
- Refund Order
Cart (new feature)
- Cart Model
- Update Order Options
- Remove Product from Cart
- Place Order from Cart
- Confirm Cart
- Create Cart Metafield
- Update Cart Metafield
Event Rules
Order Metafields
- List Order Metafields
- Find Order Metafield
- Create Order Metafield
- Update Order Metafield
- Delete Order Metafield
Order attachments
Delivery
Delivery Options
Driver locations
Driver groups
Driver Companies
Settings
Languages
Translations
- Translations Model
- List Translations
- Find Translation
- Create Translation
- Update Translation
- Delete Translation
- Bulk Create Translations
- Bulk Update Translations
- Bulk Delete Translations
Countries
Cities
Dropdown Options:Zones
Checkout fields
Configurations
- Configurations Model
- Get Configurations
- Find a configuration
- Create a configuration
- Update a configuration
- Delete a configuration
Config Categories
Paymethods
External Integrations
GPRS Printers
Webhooks
Business webhooks
SEO
New Functionality
Plugins
Payment
Zapier
Sockets
Placing Order
Order Message
Pages
Reports
Driver reports
POS Integration
- POS Business Mapping
- POS Product Mapping
- POS Suboption Mapping
- POS Order Mapping
- POS Integration Alerts
Business Maximums Rules
Codes
Product Reviews
Manual Dispatch
Offers
Importers
Franchises
Controls
Products
Users Review
Sites
Wallet
Wallet Event
- Wallet Event Model
- Wallet Event List History
- Wallet Event Detail History
- Wallet Event Creation History
- Create User Wallet Event
Loyalty plans
- Loyalty Plan Model
- List Loyalty Plans
- Find Loyalty Plan
- Create Loyalty Plan
- Update Loyalty Plan
- Delete Loyalty Plan
Business Loyalty Plans
- Business Loyalty Plans Model
- List Business Loyalty Plans
- Find Business Loyalty Plan
- Create Business Loyalty Plan
- Update Business Loyalty Plan
- Delete Business Loyalty Plan