API

Name

URI Template

Description

Get Menu by Menu ID

v1/Menus/{siteId}/{menuId}?promiseTime={promiseTime}&includeInvisible={includeInvisible}&orderMode={orderMode}

Retrieve menu by Id

Get Kiosk Menu

v1/Menus/{siteId}/Kiosk/{kioskId}?promiseTime={promiseTime}&includeInvisible={includeInvisible}

Retrieve menus by site id and kiosk id

Get Master Menu

v1/Menus/Master/{designId}

Retrieve master menus by design id

Get Menu By Site

v1/Menus/{siteId}?promiseTime={promiseTime}&includeInvisible={includeInvisible}&orderMode={orderMode}

Retrieve menus by site Id

Get Price Overrides

v1/Menus/SiteOverrides/{designId}?offset={offset}&limit={limit}

Gets overrides and memberships for all sites. Result is paged.

Get Exclusions

v1/Menus/SiteExclusions/{designId}?offset={offset}&limit={limit}

Retrieve site exclusions by designId

Update Exclusions by Site

v1/Menus/Exclusions

Menu exclusions to activate or deactivate items (SubMenu, MenuItem, SalesItem, ModifierGroup and Modifier) for each site. Menu changes will take effect after 5 mins due to menu caching.


Company

API

Name

URI Template

Description

Retrieve Supported Order Modes

v1/Company/SupportedOrderModes

Retrieves a list of supported order modes for the company.

Retrieve base URI for company

v1/Company/BaseUri

Retrieves base URI handling the company.


Delivery

API

Name

URI Template

Description

OBSOLETE: Generate Quotes

v1/Delivery/Quotes

OBSOLETE ENDPOINT
Please use v1/Delivery/Quotes/{siteId} endpoint

Generate Quotes

v1/Delivery/Quotes/{siteId}

Get quotes for delivery.

Get Delivery Availability

v1/Delivery/Sites/{latitude}/{longitude}?offset={offset}&limit={limit}&includeAllSites={includeAllSites}

Retrieves nearby sites available for delivery within a given radius (a Company Setting)


L10NStrings

API

Name

URI Template

Description

Get Strings

v1/L10NStrings?lastModifiedTime={lastModifiedTime}&clientType={clientType}&cultureType={cultureType}&companyCode={companyCode}

Retrieves all strings for a given client type and culture


Device

API

Name

URI Template

Description

Set Devices

v1/Devices

Add or update a customer 'Push Notification' device

Get Devices

v1/Devices/{customerId}

Gets the customer's 'Remember Me' devices

Delete Devices

v1/Devices/{customerId}/{deviceId}

Deletes a customer's 'Remember Me' device


StoredValueCard

API

Name

URI Template

Description

Add Stored Value

v1/StoredValueCards/AddValue/Loyalty

Purchase value to add to Aloha Loyalty StoredValue Card. The site must have UseTakeoutPrice set to true. The site must have EnableATODeposits set to true. The company setting StoredValueApiSettings must be configured with JSON that contains positive non-zero values for: MenuId, MenuItemId, SalesItemId, SiteId, DesignId, and AEStoreId. This call is dependent on the Company being configured and setup with an Aloha Loyalty StoredValue account. This includes the company settings: AECompanyID, AEUserName, AEPassword. In addition the appSettings.config must also contain AEWebServiceUserName and AEWebServicePassword.


Logs

API

Name

URI Template

Description

Create Log Entry

v1/Logs

Creates new log entry


Customer

API

Name

URI Template

Description

Get Customer Info

v1/Customers/{id}

Retrieves a customer with the given customer id

Request Customer profile

v1/Customers/{id}/EmailProfile

Request customer profile send to customer email

Update Customer Info

v1/Customers/{id}

Updates the customer's information

Update Customer Login

v1/Customers/LoginUpdate

Updates customer's login information

Get Recent Orders

v1/Customers/{customerId}/Order/Recent?offset={offset}&limit={limit}&VerifyOrderDesignIdBySite={VerifyOrderDesignIdBySite}

Returns recent orders for given customer

Get Recent Sites

v1/Customers/{customerId}/Site/Recent?offset={offset}&limit={limit}

Retrieves the last N sites the customer ordered from

Get Saved Orders

v1/Customers/{customerId}/Order/Saved?offset={offset}&limit={limit}&VerifyOrderDesignIdBySite={VerifyOrderDesignIdBySite}

Loads user's saved (favorite) orders

Remove Saved Order

v1/Customers/{customerId}/Order/Saved/{savedOrderId}

Deletes user's saved (favorite) order

Create Customer

v1/Customers?verbose={verbose}&accountCreationEmailOption={accountCreationEmailOption}&enableLoyaltyAccountLinking={enableLoyaltyAccountLinking}

Create a new customer

Create Customer by Alternate Account

v1/Customers/AlternateAccount?accountCreationEmailOption={accountCreationEmailOption}&enableLoyaltyAccountLinking={enableLoyaltyAccountLinking}

Create new customer using alternate account e.g. Facebook, Google and Twitter account...

Merge Alternate Account

v1/Customers/{customerId}/AlternateAccount

Merge social account to existing customer

Reverse Merge Alternate Account

v1/Customers/ReverseAlternateAccount

Merge social only account to a "merged" account to enable email only login

Reset Password

v1/Customers/PasswordReset

Reset customer password

Send Email with Reset Password Link

v1/Customers/PasswordReset/Email/Link

Send Email with Reset Password Link

Reset Password by Email

v1/Customers/PasswordReset/Email?isSecurityAnswerRequired={isSecurityAnswerRequired}

Reset customer password

Get Redis Values for Authorization

v1/Customers/GetCustomerLoginInfo?authKey={authKey}

Get Redis Values by Key - Uses GUID value provided in the email link sent from 'Send Email with Reset Password Link' call

Create Loyalty Account

v1/Customers/{customerId}/AddLoyalty

Add a Loyalty account for an existing customer

Add Favorite Items

v1/Customers/{customerId}/FavoriteItems

Add Favorite Item for a customer

Get Favorite Items

v1/Customers/{customerId}/FavoriteItems?siteId={siteId}&menuId={menuId}&promiseTime={promiseTime}

Retrieves the favorite items for a customer

Remove Favorite Item

v1/Customers/{customerId}/FavoriteItems/{favoriteId}

Delete favorite item for a customer

Send Verification Email

v1/Customers/SendVerificationEmail/{customerId}

Send email verification email to the customer

Send Push Message

v1/Customers/{customerId}/PushMessage

Send a push message to an AO Customer

Send Push Message to Loyalty Customer

v1/Customers/{loyaltyNumber}/PushMessage

Send a push message to a Loyalty Customer

Withdraw customer consent

v1/Customers/{customerId}/Consent

Withdraws the customer consent

Get Loyalty Rewards for Customer

v1/Customers/{customerId}/LoyaltyRewards/{siteId}?orderId={orderId}

Retrieves loyalty rewards for customer with the given customer id


Time

API

Name

URI Template

Description

Get Times

v1/Times/{siteId}/{orderMode}/{orderSource}/{menuId}?daysFromToday={daysFromToday}&numberOfDays={numberOfDays}&noCache={noCache}

Retrieves all the available times for a given number of days

Get Next Available Time

v1/Times/{siteId}/{orderMode}?noCache={noCache}

Retrieves next available time for a given site


CurbsideZone

API

Name

URI Template

Description

Get Curbside Zones

v1/CurbsideZones/{siteId}

Returns a list of the curb zones for the given site


Order

API

Name

URI Template

Description

Get Order

v1/Orders/{siteId}/{orderId}?includeMetadata={includeMetadata}

Retrieves an order so that you can see the state of the order

Get Order Status

v1/Orders/{siteId}/{orderId}/Status?pollPaymentStatus={pollPaymentStatus}&maxPollingWaitTimeSec={maxPollingWaitTimeSec}

Retrieves a payment status of the order

Get Delivery Order Status

v1/Orders/{siteId}/{orderId}/DeliveryStatus

Retrieves a delivery status of the order

Check-in Order

v1/Orders/{siteId}/{orderId}/CheckIn

Check in order

Submit Order

v1/Orders/{siteId}/{orderId}?forceATODeposit={forceATODeposit}

(NOTE: This endpoint will be deprecated and replaced by POST /v2/Orders/{siteId}/{orderId}/Submit in the future). Submit an order to the site that has been previously registered with Aloha Online Ordering (PUT Order).

Apply rewards to Order

v1/Orders/{siteId}/{orderId}/ApplyRewards

Apply loyalty rewards to existing order

Calculate Tax and Total

v1/Orders/{siteId}?verbose={verbose}

(NOTE: This endpoint will be deprecated and replaced by PUT /v2/Orders/{siteId}/{orderId} and POST /v2/Orders/{siteId} in the future). Creates an order on the server and sends it down to the site to calculate the tax and total for the given order. If Loyalty is turned on for a given company and a loyalty number is provided with the order, merit will be accrued for the transaction, and an attempt to redeem rewards will be made. The result of the loyalty redemption process will be reflected through the LoyaltyResultCode field. The order check out will happen whether or not Loyalty Redemption succeeds.

Cancel Order

v1/Orders/{siteId}/{orderId}/Cancel

Cancels an order after CTT (Post).

Update Status

v1/Orders/UpdateStatus/{siteId}/{orderId}

Updates the pos order status of an order

Get Order Receipt

v1/Orders/{siteId}/{orderId}/Receipt?receiptTemplateType={receiptTemplateType}

Get the receipt of a submitted order.

Create Favorite Order

v1/Orders/{siteId}/{orderId}/Favorite

Creates a favorite order from order history

Get Delivery Order Status

v1/Orders/DeliveryStatusNotify?sendEmail={sendEmail}

Notify when the delivery status of the order changes


Settings

API

Name

URI Template

Description

Get Settings

v1/Settings/{siteId}/{menuId}

Retrieves the company, site, and menu settings

Get Company Settings

v1/Settings/Company

Retrieves the company settings

Get Site Settings

v1/Settings/{siteId}

Retrieves site settings


Polygon

API

Name

URI Template

Description

Get Delivery Zones

v1/Polygons?siteId[0]={siteId[0]}&siteId[1]={siteId[1]}

Returns polygons for given list of sites


Payment

API

Name

URI Template

Description

Get Saved Payments

v1/Customers/{customerId}/Payments

Retrieves the customers saved payments

Get Saved Token Payments

v1/Customers/{customerId}/PaymentTokens

Retrieves the customers saved token payments

Add Payment Token

v1/Customers/Payment/Token

Adds new payment token for a customer, currently only Connected Payments and Credit Call are supported. Company has to support either of them to work. Otherwise use POST v1/Customers/{customerId}/Payments call

Remove Saved Payments

v1/Customers/{customerId}/Payments/{tokenId}

Removes the customers payment info

Generates one time token for the customer

v1/Customers/Braintree/OneTimeToken

Generates a one time braintree auth token

Replace Saved Payment

v1/Customers/{customerId}/Payments

Replace payment methods from a customer profile

Get Saved Payments Info

v1/Customers/{customerId}/Payments/Info

Retrieves the customers saved payments including some CPS information.


Authenticate

API

Name

URI Template

Description

Authenticate Customer

v1/Authenticate

Authenticates a user

Authenticate Customer

v1/Authenticate/2FA?sendEmail={sendEmail}

Authentication with optional two factor flow.

Verify Code

v1/Authenticate/2FA?email={email}&code={code}&rememberMe={rememberMe}&nickname={nickname}

Verifies code for a customer's login operation

Refresh Access Token

v1/Authenticate/2FA/Refresh

Provides a new access token given the refresh token

Get Apple Access Token

v1/Authenticate/GetAppleAccessToken?authCode={authCode}

Exchange an authorization code with Apple's authentication servers for an access token. This provides a six month token for accessing the Online Ordering application using Apple's "Sign In with Apple" authorization flow.


EntityMembership

API

Name

URI Template

Description

Update Membership by Site

v1/EntityMemberships/UpdateMembershipBySite

Update SiteEntityMembership to activate or deactivate items for each site. Menu changes will take effect after 5 mins due to menu caching.

Update Membership by Item

v1/EntityMemberships/UpdateMembershipByItem

Update SiteEntityMembership to choose sites to activate or deactivate each item. Menu changes will take effect after 5 mins due to menu caching.


Site

API

Name

URI Template

Description

Get Site

v1/Sites/{siteId}?includeAttributes={includeAttributes}

Retrieves a site with the given internal id

Get Site by External Id

v1/Sites?externalId={externalId}

Retrieves a site with the given external id

Get Sites by Search Term

v1/Sites/Search/{searchTerm}?offset={offset}&limit={limit}&lastTimeRetrieved={lastTimeRetrieved}

Retrieves all of the sites matching the search term and divides the results based on the page size.

Get Full Sites by Search Term

v1/Sites/SearchFullSiteObjects/{searchTerm}?offset={offset}&limit={limit}&lastTimeRetrieved={lastTimeRetrieved}&includeAttributes={includeAttributes}&includeMenu={includeMenu}&includeSiteSettings={includeSiteSettings}

Retrieves all of the sites matching the search term and divides the results based on the page size.

Get Kiosks by Site

v1/Sites/{siteId}/Kiosks

Retrieves all the kiosks for a particular site


Content

API

Name

URI Template

Description

Retrieve Contents

v1/Content/{designId}?useCdn={useCdn}

Retrieve a subset of content files

Retrieve Privacy Agreement Content

v1/Content/PrivacyAgreement?revision={revision}

Get privacy agreement content


Discount

API

Name

URI Template

Description

Apply Discount

v1/Discounts/{siteId}/{orderId}

Apply discount to order. On a successful call, you will get the order object back and a null CouponRejectionReason. If there is a problem applying the discount, you'll get a CouponRejectionReason and a null order back, since the order was unaffected.

Get All Comps

v1/Discounts/{designId}/GetAllComps?compIds[0]={compIds[0]}&compIds[1]={compIds[1]}

Get All comps or get one or more comps within a specific designId


Feedback

API

Name

URI Template

Description

Send Feedback

v1/Feedback/{siteId}/{orderId}?canContact={canContact}

Send feedback about the ordering experience


NearbySite

API

Name

URI Template

Description

Get Nearby Sites by Search Term

v1/NearbySites/{searchTerm}?getNearbySitesForFirstGeocodeResult={getNearbySitesForFirstGeocodeResult}&includeAllSites={includeAllSites}&offset={offset}&limit={limit}

Does a Google Geocode search for all the sites

Get Nearby Sites by Coordinates

v1/NearbySites/{latitude}/{longitude}?orderMode={orderMode}&offset={offset}&limit={limit}&includeAllSites={includeAllSites}&companyCode={companyCode}

Retrieves all the nearby sites within a given radius (a Company Setting


SecurityQuestion

API

Name

URI Template

Description

Get Security Question

v1/SecurityQuestions?Email={Email}

Get the security question for a user with the given email address


Instructions

API

Name

URI Template

Description

Get Instructions

v1/Instructions?siteId={siteId}&destinationType={destinationType}&offset={offset}&limit={limit}

Retrieves Instructions for a site and an order mode


Upsells

API

Name

URI Template

Description

Get Upsells

v1/Upsells/{siteId}?menuId={menuId}&salesItemIds[0]={salesItemIds[0]}&salesItemIds[1]={salesItemIds[1]}

Returns upsells for given items according to definition in web admin


Combo

API

Name

URI Template

Description

Get Quick Combo

v1/Promos/Combos/{siteId}/{menuId}?promiseTime={promiseTime}&orderMode={orderMode}

This call retrieves quick combo item information.

Get New Quick Combo

v1/QuickCombos/{siteId}/{menuId}?promiseTime={promiseTime}&promoIds={promoIds}&orderMode={orderMode}

This call retrieves quick combos defined in menu.


Loyalty

This section describes the api calls that you will need to conduct loyalty transactions for a customer's order in the cloud. These calls follow a PUT Order call (to calculate local tax and total), and proceed a POST Order call (to finally submit the order). Consult the documentation for each call to get specific information about how to use it.

API

Name

URI Template

Description

No Documentation Available

v1/Loyalty/AvailableRewards/{siteId}/{orderId}

This call retrieves available loyalty rewards for an order.

No Documentation Available

v1/Loyalty/AvailableRewards

This call retrieves available loyalty rewards for an order.

Void Loyalty Rewards

v1/Loyalty/VoidRewards/{siteId}/{orderId}

This call voids any previously registered loyalty rewards for an order.


}

Standard Error response

Standard error object is returned for all unsuccesful requests.

Supported cultures

List of all supported cultures with culture specific details.