flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

GetOnlineStatus

Uri template /application/onlinestatus

OnInit
./lib/actions/GetOnlineStatus.js
OnStartup
-
OnClose
-

Attributes

-

GetVersionAndStatus

Uri template /application/{applicationId}/versionstatus/{versionId}

OnInit
./lib/actions/GetVersionAndStatus.js
OnStartup
-
OnClose
-

Attributes

-

GetApplicationVersion

Uri template /application/{applicationId}/versionupdate/{versionId}

OnInit
./lib/actions/GetApplicationVersion.js
OnStartup
-
OnClose
-

Attributes

-

CreateBasket

Uri template /baskets

OnInit
./lib/actions/CreateBasket.js
OnStartup
-
OnClose
-

Attributes

-

GetBasket

Uri template /baskets/{basketId}

OnInit
./lib/actions/GetBasket.js
OnStartup
-
OnClose
-

Attributes

-

SetOrderContactDetails

Uri template /baskets/{basketId}/contactdetails/

OnInit
./lib/actions/SetOrderContactDetails.js
OnStartup
-
OnClose
-

Attributes

-

SetRequestedFulfilmentTime

Uri template /baskets/{basketId}/fulfilmenttime?time={time}&asap={asap}

OnInit
./lib/actions/SetRequestedFulfilmentTime.js
OnStartup
-
OnClose
-

Attributes

-

GetFulfilmentTimeslots

Uri template /baskets/{basketId}/fulfilmenttimeslots/

OnInit
./lib/actions/GetFulfilmentTimeslots.js
OnStartup
-
OnClose
-

Attributes

-

SetOrderNotes

Uri template /baskets/{basketId}/notes

OnInit
./lib/actions/SetOrderNotes.js
OnStartup
-
OnClose
-

Attributes

-

AddProductToBasket

Uri template /baskets/{basketId}/orderitems

OnInit
./lib/actions/AddProductToBasket.js
OnStartup
-
OnClose
-

Attributes

-

RemoveProductFromBasket

Uri template /baskets/{basketId}/orderitems/{orderItemId}

OnInit
./lib/actions/RemoveProductFromBasket.js
OnStartup
-
OnClose
-

Attributes

-

UpdateProductsMealParts

Uri template /baskets/{basketId}/orderitems/{orderItemId}/mealparts

OnInit
./lib/actions/UpdateProductsMealParts.js
OnStartup
-
OnClose
-

Attributes

-

UpdateProductsOptionalAccessories

Uri template /baskets/{basketId}/orderitems/{orderItemId}/optionalaccessories

OnInit
./lib/actions/UpdateProductsOptionalAccessories.js
OnStartup
-
OnClose
-

Attributes

-

UpdateProductsRequiredAccessories

Uri template /baskets/{basketId}/orderitems/{orderItemId}/requiredaccessories

OnInit
./lib/actions/UpdateProductsRequiredAccessories.js
OnStartup
-
OnClose
-

Attributes

-

get_baskets__basketId__paymentoptions

Uri template /baskets/{basketId}/paymentoptions?applePay={applePay}&androidPay={androidPay}&googlePay={googlePay}&platform={platform}&voucherCode={voucherCode}

OnInit
./lib/actions/get_baskets__basketId__paymentoptions.js
OnStartup
-
OnClose
-

Attributes

-

UpdateBasketServiceOptions

Uri template /baskets/{basketId}/serviceoptions

OnInit
./lib/actions/UpdateBasketServiceOptions.js
OnStartup
-
OnClose
-

Attributes

-

UpdateBasket

Uri template /baskets/{basketId}/user

OnInit
./lib/actions/UpdateBasket.js
OnStartup
-
OnClose
-

Attributes

-

UpdateZipCode

Uri template /baskets/{basketId}/zipcode

OnInit
./lib/actions/UpdateZipCode.js
OnStartup
-
OnClose
-

Attributes

-

GetConsumerDetails

Uri template /consumer

OnInit
./lib/actions/GetConsumerDetails.js
OnStartup
-
OnClose
-

Attributes

-

UpdateConsumer

Uri template /consumer

OnInit
./lib/actions/UpdateConsumer.js
OnStartup
-
OnClose
-

Attributes

-

CreateConsumer

Uri template /consumer

OnInit
./lib/actions/CreateConsumer.js
OnStartup
-
OnClose
-

Attributes

-

GetConsumerAddresses

Uri template /consumer/addresses

OnInit
./lib/actions/GetConsumerAddresses.js
OnStartup
-
OnClose
-

Attributes

-

DeActivateDeviceToken

Uri template /consumer/devicetokens

OnInit
./lib/actions/DeActivateDeviceToken.js
OnStartup
-
OnClose
-

Attributes

-

ActivateDeviceToken

Uri template /consumer/devicetokens

OnInit
./lib/actions/ActivateDeviceToken.js
OnStartup
-
OnClose
-

Attributes

-

GetInFlightOrderStatuses

Uri template /consumer/inflight-order-status

Accept-Version:1 StatusNames:
['AwaitingPayment' or 'Processing' or 'Completed' or 'Canceled' or 'Declined' or 'Accepted' or 'OnItsWay' or 'DueDateChanged']

Accept-Version:2 StatusNames:
['DueDateDelayed']

Accept-Version:3 StatusNames:
['OrderReady']

Accept-Version:4 StatusNames:
['PreOrderPending']

OnInit
./lib/actions/GetInFlightOrderStatuses.js
OnStartup
-
OnClose
-

Attributes

-

GetOrderHistory

Uri template /consumer/order-history?page={page}&pageSize={pageSize}

OnInit
./lib/actions/GetOrderHistory.js
OnStartup
-
OnClose
-

Attributes

-

UpdateConsumerPassword

Uri template /consumer/password

OnInit
./lib/actions/UpdateConsumerPassword.js
OnStartup
-
OnClose
-

Attributes

-

GetConsumerPreferences

Uri template /consumer/preferences

OnInit
./lib/actions/GetConsumerPreferences.js
OnStartup
-
OnClose
-

Attributes

-

SetConsumerPreferences

Uri template /consumer/preferences

OnInit
./lib/actions/SetConsumerPreferences.js
OnStartup
-
OnClose
-

Attributes

-

get_consumer_serviceable_addresses_restaurant__restaurantId_

Uri template /consumer/serviceable-addresses/restaurant/{restaurantId}

OnInit
./lib/actions/get_consumer_serviceable_addresses_restaurant__restaurantId_.js
OnStartup
-
OnClose
-

Attributes

-

get_consumer_serviceable_addresses_restaurant__restaurantId___maxAmount_

Uri template /consumer/serviceable-addresses/restaurant/{restaurantId}/{maxAmount}

OnInit
./lib/actions/get_consumer_serviceable_addresses_restaurant__restaurantId___maxAmount_.js
OnStartup
-
OnClose
-

Attributes

-

GetCustomisation

Uri template /consumerhelp/customisation?orderid={orderid}&requestcontext={requestcontext}

OnInit
./lib/actions/GetCustomisation.js
OnStartup
-
OnClose
-

Attributes

-

GetFlowStep1

Uri template /consumerhelp/flows/{flow}/{orderId}/{action}

OnInit
./lib/actions/GetFlowStep1.js
OnStartup
-
OnClose
-

Attributes

-

PostFlowStep1

Uri template /consumerhelp/flows/{flow}/{orderId}/{action}

OnInit
./lib/actions/PostFlowStep1.js
OnStartup
-
OnClose
-

Attributes

-

GetFlowStep2

Uri template /consumerhelp/flows/{flow}/{orderId}/{action}/{subaction}

OnInit
./lib/actions/GetFlowStep2.js
OnStartup
-
OnClose
-

Attributes

-

PostFlowStep2

Uri template /consumerhelp/flows/{flow}/{orderId}/{action}/{subaction}

OnInit
./lib/actions/PostFlowStep2.js
OnStartup
-
OnClose
-

Attributes

-

GetCountries

Uri template /countries

OnInit
./lib/actions/GetCountries.js
OnStartup
-
OnClose
-

Attributes

-

GetActiveExperiments

Uri template /experiments/active

OnInit
./lib/actions/GetActiveExperiments.js
OnStartup
-
OnClose
-

Attributes

-

get_health_check

Uri template /health/check

OnInit
./lib/actions/get_health_check.js
OnStartup
-
OnClose
-

Attributes

-

get_health_validate

Uri template /health/validate

OnInit
./lib/actions/get_health_validate.js
OnStartup
-
OnClose
-

Attributes

-

Put

Uri template /internal/for-testing/{basketId}/contactdetails/

OnInit
./lib/actions/Put.js
OnStartup
-
OnClose
-

Attributes

-

GetHealth

Uri template /internal/health/all

OnInit
./lib/actions/GetHealth.js
OnStartup
-
OnClose
-

Attributes

-

CreateLoginToken

Uri template /logins

OnInit
./lib/actions/CreateLoginToken.js
OnStartup
-
OnClose
-

Attributes

-

GetDeliveryAreas

Uri template /menus/{menuId}/deliveryareas

OnInit
./lib/actions/GetDeliveryAreas.js
OnStartup
-
OnClose
-

Attributes

-

GetCategoriesForMenu

Uri template /menus/{menuId}/productcategories

OnInit
./lib/actions/GetCategoriesForMenu.js
OnStartup
-
OnClose
-

Attributes

-

GetProducts

Uri template /menus/{menuId}/productcategories/{categoryId}/products

OnInit
./lib/actions/GetProducts.js
OnStartup
-
OnClose
-

Attributes

-

CreateOrderFromBasket

SuccessState values are: Unknown = 0, Successful, InvalidBasket, BasketNotOrderable, PotentialDuplicate, BasketDoesNotExist, BasketTooBig, InvalidContactDetails, GuestAccountCannotBeCreated, InvalidAuthToken

OnInit
./lib/actions/CreateOrderFromBasket.js
OnStartup
-
OnClose
-

Attributes

-

GetOrderDetails

Uri template /orders/{orderId}

OnInit
./lib/actions/GetOrderDetails.js
OnStartup
-
OnClose
-

Attributes

-

GetOrderGivenAway

Uri template /orders/{orderId}/campaigncontent

OnInit
./lib/actions/GetOrderGivenAway.js
OnStartup
-
OnClose
-

Attributes

-

post_orders__orderId__pay_accountcredit

Uri template /orders/{orderId}/pay/accountcredit

OnInit
./lib/actions/post_orders__orderId__pay_accountcredit.js
OnStartup
-
OnClose
-

Attributes

-

MakePaymentUsingAndroidPay

Uri template /orders/{orderId}/pay/android/

OnInit
./lib/actions/MakePaymentUsingAndroidPay.js
OnStartup
-
OnClose
-

Attributes

-

MakePaymentUsingApplePay

Uri template /orders/{orderId}/pay/apple/

OnInit
./lib/actions/MakePaymentUsingApplePay.js
OnStartup
-
OnClose
-

Attributes

-

post_orders__orderId__pay_cash

Uri template /orders/{orderId}/pay/cash

OnInit
./lib/actions/post_orders__orderId__pay_cash.js
OnStartup
-
OnClose
-

Attributes

-

MakePaymentUsingGooglePay

Uri template /orders/{orderId}/pay/google/

OnInit
./lib/actions/MakePaymentUsingGooglePay.js
OnStartup
-
OnClose
-

Attributes

-

post_orders__orderId__pay_savedcard

Uri template /orders/{orderId}/pay/savedcard

OnInit
./lib/actions/post_orders__orderId__pay_savedcard.js
OnStartup
-
OnClose
-

Attributes

-

GetOrderPaymentStatus

Uri template /orders/{orderId}/payment/status/

OnInit
./lib/actions/GetOrderPaymentStatus.js
OnStartup
-
OnClose
-

Attributes

-

get_orders__orderId__paymentoptions

Uri template /orders/{orderId}/paymentoptions?applePay={applePay}&androidPay={androidPay}&googlePay={googlePay}&platform={platform}&voucherCode={voucherCode}

OnInit
./lib/actions/get_orders__orderId__paymentoptions.js
OnStartup
-
OnClose
-

Attributes

-

CreateBasketFromOrder

Uri template /orders/{orderId}/reorder

OnInit
./lib/actions/CreateBasketFromOrder.js
OnStartup
-
OnClose
-

Attributes

-

PostReview

Uri template /ratings

OnInit
./lib/actions/PostReview.js
OnStartup
-
OnClose
-

Attributes

-

CreateResetToken

Uri template /reset-password-tokens

OnInit
./lib/actions/CreateResetToken.js
OnStartup
-
OnClose
-

Attributes

-

GetRestaurantsByFreeText

Uri template /restaurants?freetext={freeText}&cuisine={cuisine}&name={restaurantName}

OnInit
./lib/actions/GetRestaurantsByFreeText.js
OnStartup
-
OnClose
-

Attributes

-

GetAvailableBadges

Uri template restaurants/available_badges

OnInit
./lib/actions/GetAvailableBadges.js
OnStartup
-
OnClose
-

Attributes

-

SearchVersion3

Uri template /restaurants/v3?q={postCode}&c={cuisine}&name={restaurantName}

OnInit
./lib/actions/SearchVersion3.js
OnStartup
-
OnClose
-

Attributes

-

GetRestaurantDetails

Uri template /restaurants/{restaurantId}/details

OnInit
./lib/actions/GetRestaurantDetails.js
OnStartup
-
OnClose
-

Attributes

-

GetMenus

Uri template /restaurants/{restaurantId}/menus?delivery={delivery}¤t={current}&postcode={postcode}

OnInit
./lib/actions/GetMenus.js
OnStartup
-
OnClose
-

Attributes

-

GetAvailableMenus

Uri template /restaurants/{restaurantId}/menus/available?time={utcTime}

OnInit
./lib/actions/GetAvailableMenus.js
OnStartup
-
OnClose
-

Attributes

-

GetProductCategories

Uri template /restaurants/{restaurantId}/productcategories?type={serviceType}&time={utcTime}&zipcode={zipcode}

OnInit
./lib/actions/GetProductCategories.js
OnStartup
-
OnClose
-

Attributes

-

GetRestaurantReviews

Uri template /restaurants/{restaurantId}/reviews?p={pageNumber}&s={pageSize}

OnInit
./lib/actions/GetRestaurantReviews.js
OnStartup
-
OnClose
-

Attributes

-

GetLatestTermsAndConditions

Uri template /terms

OnInit
./lib/actions/GetLatestTermsAndConditions.js
OnStartup
-
OnClose
-

Attributes

-

GetZipCodeAutoCompleteSuggestions

Uri template /zipcodeautocomplete?term={term}&resultsCount={resultsCount}

OnInit
./lib/actions/GetZipCodeAutoCompleteSuggestions.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment