Ordering - Developers Hub

      Ordering Developer Hub

      Welcome to the Ordering developer hub. You'll find comprehensive guides and documentation to help you start working with Ordering as quickly as possible, as well as support if you get stuck. Let's jump right in!

      v400HomeUser GuideRecipesAPI DocumentationReferenceChangelogCommunity QuestionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
        HomeUser GuideAPI Documentation
      discard

      WELCOME

      • Getting Started
      • Need Help? Here is the HOW!
      • Requirements to create Apps
      • Flow of Apps Creation
      • Downloads · Business & Delivery Apps

      On boarding

      • Ordering Workflow (One Order with all the apps)
      • My store
      • Orders Manager & Delivery Dashboard
      • Reports
      • More - Settings

      Recent Changes

      • Changelog

      My Builder

      • Ordering Web Settings
      • Business App
      • Ordering App
      • Delivery App
      • Enable / Disable Extensions
      • Appearance
      • Pages & Footer
      • Developers
      • Third Party Integrations
      • Build Product
      • Open Source

      My Stores

      • My Stores
      • Create a Business
      • Categorizing Products
      • Products
      • Product Options
      • Business Information
      • Business Schedule
      • Business Menu
      • Delivery Zones
      • Business Notifications
      • Payment Methods
      • Ordering Channels
      • Webhooks
      • More
      • Multi-Business Owners · Perfect for franchises

      Orders Manager

      • Orders View
      • Delivery Dashboard

      Ordering Editor

      • Quick Guide For Ordering Editor
      • General Settings
      • Payment Gateways
      • Countries and Cities
      • Languages
      • Users
      • Delivery Manager
      • Reports
      • POS - Create Order
      • Plugins
      • Reviews Manager
      • Invoice Manager
      • Static Pages Manager CMS
      • Sign up as Business
      • Drivers Reports
      • Additional Order Information
      • Advanced Reports · Heatmap

      Ordering Features

      • Quick Guide For Ordering Web
      • Quick Guide For Ordering App
      • Multi Language
      • Featured Business
      • Featured Products
      • Facebook Login
      • Guest Checkout
      • Drivers Tracking
      • Google Analytics
      • Pre-Order
      • Stock Management / Inventory
      • Social Network Share
      • Advanced Map Search
      • Product Search Bar.
      • Cart enhancements
      • Product Details
      • Business enhancements
      • Reviews
      • Messages
      • Ordering App Messages
      • Saved Places
      • Upselling
      • Driver close to the customer (Push Notification)
      • Bulk Images Upload
      • Download Several Images for bulk upload
      • Hard Clear Cache
      • Reorder
      • Contactless Delivery - Module (Pickup & Delivery)

      Features for Business App

      • Quick Guide for Business App
      • Driver Tracking for Business App
      • Edit Products for Business App
      • Assign Driver on Business App
      • White Label Option
      • Change Sound Notification
      • Business App Messages

      Features for Delivery App

      • Quick Guide for Delivery App
      • Multi Language Delivery App
      • Support email
      • Order Photos
      • Order Signatures
      • Order Notes
      • Delivery App Messages

      Tips, Advices & Support

      • Custom Domain
      • Zapier
      • Inline / iFrame my Ordering Website on Any Site
      • Test my App before Uploading
      • Test My Apps In My iOS Device
      • Submit Your URL To Search Engines
      • Add "Download from the store" buttons for your apps in your Homepage
      • Share Your site URL with a custom image and description
      • Download your apps from your builder
      • Remove "We get what you love" Title
      • Clear cache all the time to see changes
      • Upload My Apps to Stores
      • Add us as Administrator
      • VIP Management Service

      Security at Ordering

      • PSD2 and Strong Customer Authentication

      Common Issues

      • Google Maps API Key
      • Push Notifications Services
      • Business or Products Not Showing
      • 404 Redirect
      • Rename several images for bulk upload

      Development examples

      • Use our API to create your own front-end apps.

      Templates Customization

      • introduction & requirements
      • Adding & overwriting
      • Web Templates
        • Folder's structure
        • Pagination model--
        • Texts in the views
        • Editor - Orders - Order Details
        • Editor - Orders - Order list
        • Editor - Settings - Includes - Channels
        • Editor - Settings - Includes - Drivers
        • Editor - Settings - Includes - General
        • Editor - Settings - Includes - Integration
        • Editor - Settings - Includes - Languages
        • Editor - Settings - Includes - Places
        • Editor - Settings - Includes - Plugins
        • Editor - Settings - Includes - Users
        • Editor - Settings - Includes - webhooks
        • Editor - Settings - Checkoutfields
        • Editor - Settings - City Settings
        • Editor - Settings - Drivergroup Settings
        • Editor - Settings - Drivertype settings
        • Editor - Settings - Languages
        • Editor - Settings - Main
        • Editor - Settings - Modal integration
        • Editor - Settings - Neighborhood settings
        • Editor - Settings - Users
        • Editor - business info
        • Editor - Business menu settings
        • Editor - Business menu
        • Editor - Business
        • Editor - Channels
        • Editor - Create business
        • Editor - Delivery zone settings
        • Editor - Delivery zone
        • Editor - Extensions
        • Editor - Listing business
        • Editor - More coupon setting
        • Editor - More payments methods
        • Editor - More product option settings
        • Editor - more product settings
        • Editor - Notifications
        • Editor - Payments methods
        • Editor - Schedule
        • Editor - Schedule lapse
        • Editor - Webhooks
        • Layouts - Footer
        • Layouts - Main
        • 404
        • Advanced search popup
        • business more info popup
        • Card stripe popup
        • Forgot password
        • Home screen 2
        • Image popup
        • My account profile
        • My order detail
        • No connection
        • Order checkout popup
        • Order confirm popup
        • Order rest menu
        • Order rest search
        • Order review popup
        • Payment choose stripe
        • Preorder popup
        • Reset password
        • Sign in
        • Sign up
        • Stripe redirect popup
        • Editor - Settings - Checkoutfields

      WELCOME

      • Getting Started
      • Need Help? Here is the HOW!
      • Requirements to create Apps
      • Flow of Apps Creation
      • Downloads · Business & Delivery Apps

      On boarding

      • Ordering Workflow (One Order with all the apps)
      • My store
      • Orders Manager & Delivery Dashboard
      • Reports
      • More - Settings

      Recent Changes

      • Changelog

      My Builder

      • Ordering Web Settings
      • Business App
      • Ordering App
      • Delivery App
      • Enable / Disable Extensions
      • Appearance
      • Pages & Footer
      • Developers
      • Third Party Integrations
      • Build Product
      • Open Source

      My Stores

      • My Stores
      • Create a Business
      • Categorizing Products
      • Products
      • Product Options
      • Business Information
      • Business Schedule
      • Business Menu
      • Delivery Zones
      • Business Notifications
      • Payment Methods
      • Ordering Channels
      • Webhooks
      • More
      • Multi-Business Owners · Perfect for franchises

      Orders Manager

      • Orders View
      • Delivery Dashboard

      Ordering Editor

      • Quick Guide For Ordering Editor
      • General Settings
      • Payment Gateways
      • Countries and Cities
      • Languages
      • Users
      • Delivery Manager
      • Reports
      • POS - Create Order
      • Plugins
      • Reviews Manager
      • Invoice Manager
      • Static Pages Manager CMS
      • Sign up as Business
      • Drivers Reports
      • Additional Order Information
      • Advanced Reports · Heatmap

      Ordering Features

      • Quick Guide For Ordering Web
      • Quick Guide For Ordering App
      • Multi Language
      • Featured Business
      • Featured Products
      • Facebook Login
      • Guest Checkout
      • Drivers Tracking
      • Google Analytics
      • Pre-Order
      • Stock Management / Inventory
      • Social Network Share
      • Advanced Map Search
      • Product Search Bar.
      • Cart enhancements
      • Product Details
      • Business enhancements
      • Reviews
      • Messages
      • Ordering App Messages
      • Saved Places
      • Upselling
      • Driver close to the customer (Push Notification)
      • Bulk Images Upload
      • Download Several Images for bulk upload
      • Hard Clear Cache
      • Reorder
      • Contactless Delivery - Module (Pickup & Delivery)

      Features for Business App

      • Quick Guide for Business App
      • Driver Tracking for Business App
      • Edit Products for Business App
      • Assign Driver on Business App
      • White Label Option
      • Change Sound Notification
      • Business App Messages

      Features for Delivery App

      • Quick Guide for Delivery App
      • Multi Language Delivery App
      • Support email
      • Order Photos
      • Order Signatures
      • Order Notes
      • Delivery App Messages

      Tips, Advices & Support

      • Custom Domain
      • Zapier
      • Inline / iFrame my Ordering Website on Any Site
      • Test my App before Uploading
      • Test My Apps In My iOS Device
      • Submit Your URL To Search Engines
      • Add "Download from the store" buttons for your apps in your Homepage
      • Share Your site URL with a custom image and description
      • Download your apps from your builder
      • Remove "We get what you love" Title
      • Clear cache all the time to see changes
      • Upload My Apps to Stores
      • Add us as Administrator
      • VIP Management Service

      Security at Ordering

      • PSD2 and Strong Customer Authentication

      Common Issues

      • Google Maps API Key
      • Push Notifications Services
      • Business or Products Not Showing
      • 404 Redirect
      • Rename several images for bulk upload

      Development examples

      • Use our API to create your own front-end apps.

      Templates Customization

      • introduction & requirements
      • Adding & overwriting
      • Web Templates
        • Folder's structure
        • Pagination model--
        • Texts in the views
        • Editor - Orders - Order Details
        • Editor - Orders - Order list
        • Editor - Settings - Includes - Channels
        • Editor - Settings - Includes - Drivers
        • Editor - Settings - Includes - General
        • Editor - Settings - Includes - Integration
        • Editor - Settings - Includes - Languages
        • Editor - Settings - Includes - Places
        • Editor - Settings - Includes - Plugins
        • Editor - Settings - Includes - Users
        • Editor - Settings - Includes - webhooks
        • Editor - Settings - Checkoutfields
        • Editor - Settings - City Settings
        • Editor - Settings - Drivergroup Settings
        • Editor - Settings - Drivertype settings
        • Editor - Settings - Languages
        • Editor - Settings - Main
        • Editor - Settings - Modal integration
        • Editor - Settings - Neighborhood settings
        • Editor - Settings - Users
        • Editor - business info
        • Editor - Business menu settings
        • Editor - Business menu
        • Editor - Business
        • Editor - Channels
        • Editor - Create business
        • Editor - Delivery zone settings
        • Editor - Delivery zone
        • Editor - Extensions
        • Editor - Listing business
        • Editor - More coupon setting
        • Editor - More payments methods
        • Editor - More product option settings
        • Editor - more product settings
        • Editor - Notifications
        • Editor - Payments methods
        • Editor - Schedule
        • Editor - Schedule lapse
        • Editor - Webhooks
        • Layouts - Footer
        • Layouts - Main
        • 404
        • Advanced search popup
        • business more info popup
        • Card stripe popup
        • Forgot password
        • Home screen 2
        • Image popup
        • My account profile
        • My order detail
        • No connection
        • Order checkout popup
        • Order confirm popup
        • Order rest menu
        • Order rest search
        • Order review popup
        • Payment choose stripe
        • Preorder popup
        • Reset password
        • Sign in
        • Sign up
        • Stripe redirect popup
        • Editor - Settings - Checkoutfields

      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
      • post
        Authorize User Login
      • post
        Social Login
      • post
        User Logout
      • post
        SMS login

      Users

      • Users Model
      • Users special parameters requests
      • get
        Get Users List
      • get
        Find User
      • post
        Create User
      • post
        Edit User
      • delete
        Delete User
      • post
        Users Forgot Password
      • post
        Users Reset Password
      • get
        Get User Reviews

      User addresses

      • Model
      • post
        Add User address
      • get
        Get User addresses
      • get
        Find user address
      • put
        Edit User Address
      • delete
        Delete user address

      Address Metafields

      • get
        Get Address Metafields
      • get
        Find Address Metafield
      • post
        Create Address Metafield
      • put
        Edit Address Metafield
      • delete
        Delete Address Metafield

      Users Notification Tokens

      • Notification Tokens Model
      • get
        Get Notification Tokens
      • post
        Create Notification Token
      • delete
        Delete Notification token

      User API Key

      • Users API Key
      • Users API Key Model
      • get
        Get API keys
      • post
        Create API Key
      • delete
        Delete API key

      User Metafields

      • get
        Get User Metafields
      • get
        Find User Metafield
      • post
        Create User Metafield
      • put
        Update User Metafield
      • delete
        Delete User Metafield

      ----- Businesses -----

      • ----- Businesses -----

      Business

      • Business Model
      • Business special requests
      • get
        Get Businesses List
      • get
        Find Business
      • post
        Create Business
      • post
        Copy Business
      • post
        Edit Business
      • delete
        Delete Business

      Business Metafields

      • get
        Get Business Metafields
      • get
        Find Business Metafield
      • post
        Create Business Metafield
      • put
        Edit Business Metafield
      • delete
        Delete Business Metafield

      Business Delivery zones

      • Business Delivery Zones Model
      • get
        Get Business Delivery Zones
      • get
        Find Business Delivery Zone
      • post
        Create Business Delivery Zone
      • put
        Edit Business Delivery Zone
      • delete
        Delete Business Delivery Zone

      Business Gallery

      • Business Gallery Model
      • Business Gallery special params request
      • get
        Get Business Gallery Items
      • get
        Find Business Gallery Item
      • post
        Create Business Gallery Item
      • delete
        Delete Business Gallery Item

      Business Paymethods

      • Business Paymethods Model
      • Business Paymethod special params request
      • get
        Get Business Payment Options
      • get
        Find Business Payment Option
      • post
        Create Business Payment Option
      • put
        Edit Business Payment Option
      • delete
        Delete Business Payment Option

      Business Reviews

      • Business Reviews Model
      • Reviews special request
      • get
        Get Business Reviews
      • get
        Find Business Review
      • post
        Create Business Review
      • put
        Edit Business Review
      • delete
        Delete Business Review

      Business Offers/Discounts

      • Business Offers Model
      • Business Offers special request
      • get
        Get Business Offers
      • get
        Find Business Offer
      • post
        Create Business Offer
      • put
        Edit Business Offer
      • delete
        Delete Business Offer

      Business Offers Metafields

      • get
        Get Business Offer Metafields
      • get
        Find Business Offer Metafield
      • post
        Create Business Offer Metafield
      • put
        Edit Business Offer Metafield
      • delete
        Delete Business Offer Metafield

      Business Menus/Catalogs

      • Business Menus Model
      • Business Menus special request
      • get
        Get Business Menus
      • get
        Find Business Menu
      • post
        Create Business Menu
      • put
        Edit Business Menu
      • delete
        Delete Business Menu

      Menu Metafields

      • get
        Get Menu Metafields
      • get
        Find Menu Metafield
      • post
        Create Menu Metafield
      • put
        Edit Menu Metafield
      • delete
        Delete Menu Metafield

      Business Categories

      • Business Categories Model
      • Business Category special request
      • get
        Get Business Categories
      • get
        Find Business Category
      • post
        Create Business Category
      • post
        Edit Business Category
      • delete
        Delete Business Category

      Categories Metafields

      • get
        Get Categories Metafields
      • get
        Find Categories Metafields
      • post
        Create Category Metafield
      • put
        Update Category Metafield
      • delete
        Delete Category Metafield

      Business Products

      • Business Products Model
      • get
        Get Business Products
      • get
        Find Business Product
      • post
        Create Business Product
      • post
        Edit Business Product
      • delete
        Delete Business Product
      • post
        Bulk Create Products
      • put
        Bulk Edit Products
      • put
        Bulk Delete Products
      • get
        Get All Business Products

      Product Metafields

      • get
        Get Product Metafields
      • get
        Find Product Metafield
      • post
        Create Product Metafield
      • put
        Edit Product Metafield
      • delete
        Delete Product Metafield

      Product Gallery

      • Product Gallery Model
      • get
        Get Product Gallery Items
      • get
        Find Product Gallery Item
      • post
        Create Product Gallery Item
      • post
        Edit Product Gallery Item
      • delete
        Delete Product Gallery Item

      Product Ingredients

      • Product Ingredients Model
      • get
        Get Product Ingredients
      • get
        Find Product Ingredient
      • post
        Create Product Ingredient
      • post
        Edit Product Ingredient
      • delete
        Delete Product Ingredient

      Product Extras

      • Product Extras Model
      • Product Extras special request
      • get
        Get Product Extras
      • get
        Find Product Extra
      • post
        Create Product Extra
      • put
        Edit Product Extra
      • delete
        Delete Product Extra

      Product Extra Metafields

      • get
        Get Product Extra Metafields
      • get
        Find Product Extra Metafield
      • post
        Create Product Extra Metafield
      • put
        Edit Product Extra Metafield
      • delete
        Delete Product Extra Metafield

      Extras Options

      • Extras Options Model
      • Extras Options special request
      • get
        Get Extras Options
      • get
        Find Extras Option
      • post
        Create Extras Option
      • put
        Edit Extras Option
      • delete
        Delete Extras Option

      Extra Option Metafields

      • get
        Get Extra Option Metafields
      • get
        Find Extra Option Metafield
      • post
        Create Extra Option Metafield
      • put
        Edit Extra Option Metafield
      • delete
        Delete Extra Option Metafield

      Extras SubOptions

      • Extras SubOptions Model
      • Extras SubOptions special request
      • get
        Get Extras SubOptions
      • get
        Find Extras SubOption
      • post
        Create Extras SubOption
      • put
        Edit Extras SubOption
      • delete
        Delete Extras SubOption

      Extras Suboptions Metafields

      • get
        Get Extra SubOption Metafields
      • get
        Find Extra SubOption Metafields
      • post
        Create Extra SubOption Metafields
      • put
        Edit Extra SubOption Metafields
      • delete
        Delete Extra SubOption Metafields

      ----- Orders -----

      • ----- Orders -----

      Orders

      • Orders Model
      • Orders special params request
      • get
        Get Orders
      • get
        Find Order
      • post
        Create Order
      • put
        Edit Order
      • delete
        Delete Order
      • get
        Orders Dashboard
      • get
        Export Orders

      Order Metafields

      • get
        Get Order Metafields
      • get
        Find Order Metafield
      • post
        Create Order Metafield
      • put
        Edit Order Metafield
      • delete
        Delete Order Metafield

      Order attachments

      • Order Attachments Model
      • get
        Get Order Attachments
      • post
        Create Order Attachment
      • delete
        Delete Order Attachment

      ----- Delivery -----

      • ----- Delivery -----

      Driver locations

      • Driver Locations Model
      • get
        Get Driver Locations
      • post
        Create Driver Locations
      • delete
        Delete Driver Locations

      Driver groups

      • Driver Groups Model
      • get
        Get Driver Groups
      • get
        Find Driver Group
      • post
        Create Driver Group
      • put
        Edit Driver Group
      • delete
        Delete Driver Group

      Drivergroups Metafields

      • get
        Get Drivergroup Metafields
      • get
        Find Drivergroup Metafields
      • post
        Create Drivergroup Metafields
      • put
        Edit Drivergroup Metafields
      • delete
        Delete Drivergroup Metafields

      ----- Settings -----

      • ----- Settings -----

      Languages

      • Languages Model
      • get
        Get Languages
      • get
        Find Language
      • post
        Create Language
      • put
        Edit Language
      • delete
        Delete Language

      Translations

      • Translations Model
      • get
        Get Translations
      • get
        Find Translation
      • post
        Create Translation
      • put
        Edit Translation
      • delete
        Delete Translation
      • post
        Bulk Create translations
      • put
        Bulk Edit Translations
      • put
        Bulk Delete Translations

      Countries

      • Countries Model
      • get
        Get Countries
      • get
        Find Country
      • post
        Create Country
      • put
        Edit Country
      • delete
        Delete Country

      Cities

      • Cities Model
      • Cities special request
      • get
        Get Cities
      • get
        Find City
      • post
        Create City
      • put
        Edit City
      • delete
        Delete City

      Dropdown Options/Zones

      • Dropdown Options Model
      • Dropdown Options special request
      • get
        Get Dropdown Options
      • get
        Find Dropdown Option
      • post
        Create Dropdown Option
      • put
        Edit Dropdown Option
      • delete
        Delete Dropdown Option

      Checkout fields

      • Checkout Fields Model
      • get
        Get Checkout Fields
      • get
        Find Checkout Field
      • post
        Create Checkout Field
      • put
        Edit Checkout Field
      • delete
        Delete Checkout Field

      Configurations

      • Configurations Model
      • get
        Get Configurations
      • get
        Find Configuration
      • post
        Create Configuration
      • put
        Edit Configuration
      • delete
        Delete Configuration

      Paymethods

      • Paymethod Model
      • get
        Get Paymethods
      • get
        Find Paymethod
      • post
        Create Paymethod
      • put
        Edit Paymethod
      • delete
        Delete Paymethod

      ----- External Integrations -----

      • ----- External Integrations -----

      GPRS Printers

      • GPRS Printers Model
      • get
        Get GPRS Printers
      • get
        Find GPRS Printer
      • post
        Create GPRS Printer
      • put
        Edit GPRS Printer
      • delete
        Delete GPRS Printer
      • get
        Get GPRS Printers Queue
      • get
        Confirm GPRS Printer Queue by GET

      Webhooks

      • What are Webhooks?
      • Webhooks list
      • Webhooks Model
      • get
        Get Webhooks
      • post
        Create Webhook
      • put
        Edit Webhook
      • delete
        Delete Webhook

      Business webhooks

      • Business Webhooks Model
      • get
        Get Business Webhooks
      • post
        Create Business Webhook
      • put
        Edit Business Webhook
      • delete
        Delete Business Webhook

      SEO

      • SEO endpoints
      • get
        Get SEO business
      • get
        Get SEO category
      • get
        Get SEO product

      ----- New Functionality -----

      • ----- New Functionality -----

      Plugins

      • Introduction
      • Hooks list
      • Plugins Model
      • get
        Get Plugins
      • post
        Create Plugin
      • post
        Edit Plugin
      • delete
        Delete Plugin

      Payment

      • Payment How does it work

      Payment Cards

      • get
        Get Payment Cards
      • post
        Add Payment Card
      • post
        Set Default Payment card
      • get
        Delete Payment card

      Zapier

      • Zapier

      Sockets

      • Sockets

      Placing Order

      • Placing order

      Order Message

      • Order message model
      • get
        Get Order messages
      • post
        Create Order messages
      • get
        Read Order messages

      Pages

      • Pages model
      • get
        Get Pages
      • get
        Find Page
      • post
        Create page
      • put
        Update page
      • delete
        Delete Page

      Reports

      • Reports General Params
      • get
        Top Selling
      • get
        Top categories
      • get
        Orders status
      • get
        Orders accept spend
      • get
        Customer satisfaction
      • get
        Sales
      • get
        Orders
      • get
        Users

      Driver reports

      • Driver Reports General Params
      • get
        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

      POS Integration

      • Business relation
      • Product relation
      • Suboptions relation
      • Order relations
      • Alerts
      Powered by