JUMP TOOrdering ApiWelcome to our Ordering API----- Getting Started -----API SummaryOrdering API SDKSpecial data typesErrorsIncluding attributesFilteringSorting DataPaginationVersioningTesting instructionsExtra attributes (Metafields)Timestamp parameter----- Users ---------- Users -----Users AuthenticationUsers AuthenticationAuthorize User LoginpostSocial LoginpostUser LogoutpostUser VerifypostSMS loginpostSMS Twilio VerifypostSMS Twilio AuthpostUsersUsers ModelUsers special parameters requestsGet Users ListgetFind UsergetCreate UserpostEdit UserpostDelete UserdeleteUsers Forgot PasswordpostUsers Reset PasswordpostUsers Check PasswordpostGet User ReviewsgetUser addressesModelAdd User addresspostGet User addressesgetFind user addressgetEdit User AddressputDelete user addressdeleteAddress MetafieldsGet Address MetafieldsgetFind Address MetafieldgetCreate Address MetafieldpostEdit Address MetafieldputDelete Address MetafielddeleteUsers Notification TokensNotification Tokens ModelGet Notification TokensgetCreate Notification TokenpostDelete Notification tokendeleteUser API KeyUsers API KeyUsers API Key ModelGet API keysgetCreate API KeypostDelete API keydeleteUser MetafieldsGet User MetafieldsgetFind User MetafieldgetCreate User MetafieldpostUpdate User MetafieldputDelete User Metafielddelete----- Businesses ---------- Businesses -----Seach BusinessAdvance Search ModelGet Advance Search ListgetGet Suggestions for searchgetBusinessBusiness ModelBusiness special requestsGet Businesses ListgetFind BusinessgetCreate BusinesspostCopy BusinesspostEdit BusinesspostDelete BusinessdeleteBusiness Order TypesBusiness Order Type ModelUpdate Business Order TypeputBusiness MetafieldsGet Business MetafieldsgetFind Business MetafieldgetCreate Business MetafieldpostEdit Business MetafieldputDelete Business MetafielddeleteBusiness Delivery zonesBusiness Delivery Zones ModelGet Business Delivery ZonesgetFind Business Delivery ZonegetCreate Business Delivery ZonepostEdit Business Delivery ZoneputDelete Business Delivery ZonedeleteBusiness GalleryBusiness Gallery ModelBusiness Gallery special params requestGet Business Gallery ItemsgetFind Business Gallery ItemgetCreate Business Gallery ItempostDelete Business Gallery ItemdeleteBusiness PaymethodsBusiness Paymethods ModelBusiness Paymethod special params requestGet Business Payment OptionsgetFind Business Payment OptiongetCreate Business Payment OptionpostEdit Business Payment OptionputDelete Business Payment OptiondeleteBusiness ReviewsBusiness Reviews ModelReviews special requestGet Business ReviewsgetFind Business ReviewgetCreate Business ReviewpostEdit Business ReviewputDelete Business ReviewdeleteBusiness Offers/DiscountsBusiness Offers ModelBusiness Offers special requestGet Business OffersgetFind Business OffergetCreate Business OfferpostEdit Business OfferputDelete Business OfferdeleteBusiness Offers MetafieldsGet Business Offer MetafieldsgetFind Business Offer MetafieldgetCreate Business Offer MetafieldpostEdit Business Offer MetafieldputDelete Business Offer MetafielddeleteBusiness Menus/CatalogsBusiness Menus ModelBusiness Menus special requestGet Business MenusgetFind Business MenugetCreate Business MenupostEdit Business MenuputDelete Business MenudeleteBusiness TYpesGet Business Types ListgetFind Business TypegetCreate Business TypespostEdit Business TypespostDelete Business TypesdeleteMenu MetafieldsGet Menu MetafieldsgetFind Menu MetafieldgetCreate Menu MetafieldpostEdit Menu MetafieldputDelete Menu MetafielddeleteMenus SharedShares Menus FeatureUpdate Menu SharedputDelete Menu ShareddeleteUpdate Menu Shared ProductputGet Menus Shared extragetGet Menus shared optionsgetGet Menus shared suboptionsgetBusiness CategoriesBusiness Categories ModelBusiness Category special requestGet Business CategoriesgetFind Business CategorygetCreate Business CategorypostEdit Business CategorypostDelete Business CategorydeleteCategories MetafieldsGet Categories MetafieldsgetFind Categories MetafieldsgetCreate Category MetafieldpostUpdate Category MetafieldputDelete Category MetafielddeleteBusiness ProductsBusiness Products ModelGet Business ProductsgetFind Business ProductgetCreate Business ProductpostEdit Business ProductpostDelete Business ProductdeleteBulk Create ProductspostBulk Edit ProductsputBulk Delete ProductsdeleteGet All Business ProductsgetBusiness/Place GroupsBusiness Place Groups ModelGet Business Place GroupsgetGet a Business Place GroupgetCreate a Business Place GrouppostUpdate a Business Place GroupputDelete a Business Place GroupdeleteProduct MetafieldsGet Product MetafieldsgetFind Product MetafieldgetCreate Product MetafieldpostEdit Product MetafieldputDelete Product MetafielddeleteProduct GalleryProduct Gallery ModelGet Product Gallery ItemsgetFind Product Gallery ItemgetCreate Product Gallery ItempostEdit Product Gallery ItempostDelete Product Gallery ItemdeleteProduct IngredientsProduct Ingredients ModelGet Product IngredientsgetFind Product IngredientgetCreate Product IngredientpostEdit Product IngredientpostDelete Product IngredientdeleteProduct ExtrasProduct Extras ModelProduct Extras special requestGet Product ExtrasgetFind Product ExtragetCreate Product ExtrapostEdit Product ExtraputDelete Product ExtradeleteProduct Extra MetafieldsGet Product Extra MetafieldsgetFind Product Extra MetafieldgetCreate Product Extra MetafieldpostEdit Product Extra MetafieldputDelete Product Extra MetafielddeleteExtras OptionsExtras Options ModelExtras Options special requestGet Extras OptionsgetFind Extras OptiongetCreate Extras OptionpostEdit Extras OptionputDelete Extras OptiondeleteExtra Option MetafieldsGet Extra Option MetafieldsgetFind Extra Option MetafieldgetCreate Extra Option MetafieldpostEdit Extra Option MetafieldputDelete Extra Option MetafielddeleteExtras SubOptionsExtras SubOptions ModelExtras SubOptions special requestGet Extras SubOptionsgetFind Extras SubOptiongetCreate Extras SubOptionpostEdit Extras SubOptionputDelete Extras SubOptiondeleteExtras Suboptions MetafieldsGet Extra SubOption MetafieldsgetFind Extra SubOption MetafieldsgetCreate Extra SubOption MetafieldspostEdit Extra SubOption MetafieldsputDelete Extra SubOption Metafieldsdelete----- Orders ---------- Orders -----OrdersOrders ModelOrders special params requestGet OrdersgetFind OrdergetCreate OrderpostEdit OrderputDelete OrderdeleteOrders DashboardgetExport OrdersgetCreate Custom OrderpostRefund OrderpostCart (new feature)Cart modelGet Order OptionsgetUpdate Order OptionsputGet CartsgetAdd Product to cartpostRemove products to cartpostUpdate product cartpostClear CartpostApply coupon to a cartpostChange driver tippostFind cartgetPlacer order with cartpostConfirm CartpostAdd offer to cartpostCreate Cart MetafieldpostEdit Cart MetafieldputGet Carts BusinessesgetEdit CartputAdd walletpostRemove walletdeleteEvent RulesEvent Rules ModelGet All Event RulesgetFind Event RulegetCreate Event RulepostEdit Event RuleputDelete Event RuledeleteGet All Channels of Event RulegetFind Channel of Event RulegetCreate Channel on Event RulepostEdit Channel on Event RuleputDelete Channel Event RuledeleteOrder MetafieldsGet Order MetafieldsgetFind Order MetafieldgetCreate Order MetafieldpostEdit Order MetafieldputDelete Order MetafielddeleteOrder attachmentsOrder Attachments ModelGet Order AttachmentsgetCreate Order AttachmentpostDelete Order Attachmentdelete----- Delivery ---------- Delivery -----Delivery OptionsDelivery Options ModelGet all Delivery OptionsgetGet Delivery OptiongetCreate Delivery OptionpostEdit Delivery OptionputDelete Delivery OptiondeleteDriver locationsDriver Locations ModelGet Driver LocationsgetCreate Driver LocationspostDelete Driver LocationsdeleteDriver groupsDriver Groups ModelGet Driver GroupsgetFind Driver GroupgetCreate Driver GrouppostEdit Driver GroupputDelete Driver GroupdeleteDrivergroups MetafieldsGet Drivergroup MetafieldsgetFind Drivergroup MetafieldsgetCreate Drivergroup MetafieldspostEdit Drivergroup MetafieldsputDelete Drivergroup MetafieldsdeleteDriver CompaniesDriver Companies ModelGet Driver CompaniesgetFind Driver CompanygetCreate Driver CompanypostUpdate Driver Companypost----- Settings ---------- Settings -----LanguagesLanguages ModelGet LanguagesgetFind LanguagegetCreate LanguagepostEdit LanguageputDelete LanguagedeleteTranslationsTranslations ModelGet TranslationsgetFind TranslationgetCreate TranslationpostEdit TranslationputDelete TranslationdeleteBulk Create translationspostBulk Edit TranslationsputBulk Delete TranslationsputCountriesCountries ModelGet CountriesgetFind CountrygetCreate CountrypostEdit CountryputDelete CountrydeleteCitiesCities ModelCities special requestGet CitiesgetFind CitygetCreate CitypostEdit CityputDelete CitydeleteDropdown Options/ZonesDropdown Options ModelDropdown Options special requestGet Dropdown OptionsgetFind Dropdown OptiongetCreate Dropdown OptionpostEdit Dropdown OptionputDelete Dropdown OptiondeleteCheckout fieldsCheckout Fields ModelGet Checkout FieldsgetFind Checkout FieldgetCreate Checkout FieldpostEdit Checkout FieldputDelete Checkout FielddeleteConfigurationsConfigurations ModelGet ConfigurationsgetFind ConfigurationgetCreate ConfigurationpostEdit ConfigurationputDelete ConfigurationdeleteConfig CategoriesConfiguration Categories modelGet ConfigurationsgetFind Configuration CategorygetCreate Config CategorypostEdit Config CategoryputDelete Config CategorydeletePaymethodsPaymethod ModelGet PaymethodsgetFind PaymethodgetCreate PaymethodpostEdit PaymethodputDelete Paymethoddelete----- External Integrations ---------- External Integrations -----GPRS PrintersGPRS Printers ModelGet GPRS PrintersgetFind GPRS PrintergetCreate GPRS PrinterpostEdit GPRS PrinterputDelete GPRS PrinterdeleteGet GPRS Printers QueuegetConfirm GPRS Printer Queue by GETgetWebhooksWhat are Webhooks?Webhooks listWebhooks ModelGet WebhooksgetCreate WebhookpostEdit WebhookputDelete WebhookdeleteBusiness webhooksBusiness Webhooks ModelGet Business WebhooksgetCreate Business WebhookpostEdit Business WebhookputDelete Business WebhookdeleteSEOSEO endpointsGet SEO businessgetGet SEO categorygetGet SEO productgetGet SEO sitesget----- New Functionality ---------- New Functionality -----PluginsIntroductionHooks listPrehooksPlugins ModelGet PluginsgetCreate PluginpostEdit PluginpostDelete PlugindeletePaymentPayment How does it workPayment CardsGet Payment CardsgetAdd Payment CardpostSet Default Payment cardpostDelete Payment cardgetZapierZapierSocketsSocketsPlacing OrderPlacing orderOrder MessageOrder message modelGet Order messagesgetCreate Order messagespostRead Order messagesgetPagesPages modelGet PagesgetFind PagegetCreate pagepostUpdate pageputDelete PagedeleteReportsReports General ParamsTop SellinggetTop categoriesgetOrders statusgetOrders accept spendgetCustomer satisfactiongetSalesgetOrdersgetUsersgetDriver reportsDriver Reports General ParamsTop SellinggetTop categoriesgetOrders statusgetSalesgetOrdersgetOrders accept spendgetOrders Arrived Pickup spendgetOrders Pickup spendgetOrders delivery spendgetOrders complete spendgetOrders spend timesgetOrders available timesgetOrders busy timesgetPOS IntegrationBusiness relationProduct relationSuboptions relationOrder relationsAlertsBusiness Maximums RulesBusiness Maximums ModelUpdate Business Maximum RuleputCreate Business Maximum RulepostCodesCodes ModelGenerate CodepostVerify CodegetVerify CodepostProduct ReviewsProduct review ModelCreate Product reviewpostCreate Multiple Product reviewpostGet Product ReviewsgetManual DispatchManual Dispatch ModelCreate Manual DispatchpostOffersOffers ModelUpdate OfferpostRemove OfferpostChange paymethod to cartpostImportersImporter ModelCreate importerpostDelete importerdeleteCreate importer jobpostCreate importer job slugpostFranchisesFranchises ModelCreate FranchisespostGet All franchisesgetUpdate FranchisepostGet a FranchisegetDelete a franchisedeleteControlsControls ModelGet OrdersgetGet OrdergetProductsProducts ModelGet ProductsgetGet Business by productsgetGet Business by products ModelUsers ReviewUsers Review ModelCreate User ReviewpostGet All User reviewgetGet User ReviewgetSitesSites ModelGet Sites ListgetFind SitegetCreate SitepostEdit SitepostDelete SitedeleteWalletWallet ModelGet All Wallets ListgetFind WalletgetGet Wallets List by usergetFind Wallet by usergetUpdate WalletputUpdate Wallet by userputWallet EventWallet Event ModelGet All Events ListgetFind EventgetGet Event List by usergetFind Event by usergetCreate EventpostCreate Event by userpostLoyalty plansLoyalty Plan ModelGet All Loyalty Plans ListgetFind Loyalty PlangetCreate Loyalty PlanpostUpdate Loyalty PlanpostDelete Loyalty PlandeleteBusiness Loyalty PlansBusiness Loyalty Plans ModelGet All Business Loyalty Plans ListgetFind Business Loyalty PlansgetCreate Business Loyalty PlanpostUpdate Business Loyalty PlanpostDelete Business Loyalty PlandeleteLoyalty levelsLoyalty Levels ModelGet All Loyalty Levels ListgetFind Loyalty LevelgetCreate Loyalty LevelpostUpdate Loyalty LevelpostDelete Loyalty LeveldeletePowered by Add Payment Cardpost https://apiv4.ordering.co/{api_version}/{language}/{project}/payments/{gateway}/cards
