FranPOS Mobile API Help Center

Introduction

Please contact us at support@franpos.com for any questions.

BookingGroup

API	Description
GET booking/groups?page={page}&version={version}	Authorized only.
GET employee/groups?page={page}&version={version}	Authorized only.

Employee

API	Description
GET employees?page={page}&version={version}	Authorized only.
POST employees	Authorized only.
POST employee/login	Login employee. Required fields: Email, Password Authorized only.
POST delivery/login	Login as delivery employee. Required fields: Email, Password Authorized only.
POST employee/validate	Validate employee credentials. Required fields: Email, Password Authorized only.
POST session/validate	Authorized only.
POST store/login	Authorized only.
POST store/switch	Allow you to switch store. OBSOLETE. Use session/switch instead Authorized only.
POST session/switch	Allows to change store or employee associated with current session Authorized only.
GET employee/locations?page={page}&version={version}	Authorized only.
GET employee/timeclocks?page={page}&version={version}	Authorized only.
GET employee/timeclockSettings?page={page}&version={version}	Authorized only.
POST employee/timeclocks	Authorized only.
GET employee/timeclocktypes?page={page}&version={version}	Authorized only.
GET employee/schedules?startDate={startDate}&endDate={endDate}&page={page}&version={version}	Authorized only.
GET employee/services?page={page}&version={version}	Authorized only.
GET employee/accessPermissionRules?page={page}&version={version}	Authorized only.
GET employee/accessPermissionRulesMaps?page={page}&version={version}	Authorized only.
POST employee/accessPermissionRulesMaps/specific?page={page}	Authorized only.
GET employee/goals?page={page}&version={version}	Authorized only.

Company

API	Description
GET locations?page={page}&version={version}	Authorized only.
POST locations	Authorized only.
POST location/refundDetails	Authorized only.
GET location/partners?page={page}&version={version}	Authorized only.
GET location/creditcardprovider	Authorized only.
GET location/pickuplocations?page={page}&version={version}	Authorized only.
GET location/selfcheckouts?page={page}&version={version}	Authorized only.
GET location/selfcheckout/devices?page={page}&version={version}	Authorized only.
GET location/poledisplays?page={page}&version={version}	Authorized only.
GET location/kitchendisplays?page={page}&version={version}	Authorized only.
GET location/hours?page={page}&version={version}	Authorized only.
POST location/hours?page={page}&version={version}	Authorized only.
GET location/payments/custom?page={page}&version={version}	Authorized only.
POST locations/payments/settings?page={page}&version={version}	Authorized only.
GET locations/receiptdesigner/settings?page={page}&version={version}	Get Receipt designer settings. Possible StatType for field: IsVisible=0, SalesPerson=1, FontSize=2 Authorized only.
GET locations/formcustomization/settings?page={page}&version={version}	Get Form Customization settings. Authorized only.
GET location/waivers?page={page}&version={version}	Authorized only.
GET location/waiver/terms?page={page}&version={version}	Authorized only.
GET location/advertisements?page={page}&version={version}	Authorized only.
GET location/advertisement/categorymaps?page={page}&version={version}	Authorized only.
GET location/tipSettings?page={page}&version={version}	Authorized only.
GET location/holidays?page={page}&version={version}	Authorized only.
GET location/serviceAvailability?page={page}&version={version}	Authorized only.
GET messageTemplates?page={page}&version={version}	Authorized only.
GET location/returnDispositions?page={page}&version={version}	Authorized only.
GET location/returnReasons?page={page}&version={version}	Authorized only.
GET location/refundDetails?version={version}	Authorized only.

Cache

API	Description
GET cache/refreshcache.axd?token={token}&type={type}&id={id}	No documentation available.

Booking

API	Description
GET bookings?startDate={startDate}&endDate={endDate}&customerId={customerId}&type={type}&page={page}&version={version}	Authorized only.
POST bookings/specific	Authorized only.
POST bookings	Authorized only.
POST sendWaiverSms?bookingId={bookingId}	Authorized only.
POST bookings/addons	Authorized only.
GET bookings/addons?startDate={startDate}&endDate={endDate}&customerId={customerId}&type={type}&page={page}&version={version}	Authorized only.
POST bookings/specificAddons	Authorized only.
GET booking/status/colors?page={page}&version={version}	Authorized only.
GET bookings/last?employeeId={employeeId}&serviceId={serviceId}&customerId={customerId}	Authorized only.
GET bookings/services?customerId={customerId}&type={type}	Authorized only.
GET bookings/services/addons?serviceId={serviceId}	Authorized only.
POST bookings/available/days?year={year}&month={month}	Authorized only.
POST bookings/available/times?year={year}&month={month}&day={day}	Authorized only.
POST bookings/slotReservationUid?year={year}&month={month}&day={day}&hour={hour}&minute={minute}	Authorized only.
POST bookings/create	Authorized only.

Customer

API	Description
GET customers?page={page}&version={version}&maxResults={maxResults}	Authorized only.
POST customers/sync?page={page}&version={version}&maxResults={maxResults}	Authorized only.
POST customers/specific	Authorized only.
POST customers	Authorized only.
POST customers/external	Authorized only.
POST customer/sales	Authorized only.
GET customer/search?query={query}&filterType={filterType}&maxResults={maxResults}&offset={offset}&includeShared={includeShared}	Authorized only.
GET customer/search/exact?customerCode={customerCode}&cellPhone={cellPhone}&phone={phone}&email={email}&maxResults={maxResults}&offset={offset}	Authorized only.
POST customer/account/update	Authorized only.
GET customer/groups?page={page}&version={version}	Authorized only.
GET customer/customertypes?page={page}&version={version}	Authorized only.
GET customer/onholdtickets?page={page}&version={version}	Authorized only.
POST customer/notes	Authorized only.
GET customer/notes/all?id={id}&parentId={parentId}	Authorized only.
GET customer/notes/family?parentId={parentId}	Authorized only.
POST customer/notes/latest?quantityPerCustomer={quantityPerCustomer}&isAlert={isAlert}&isPosAlert={isPosAlert}	Authorized only.
POST customer/notes/specific	Authorized only.
GET customer/notetypes?page={page}&version={version}	Authorized only.
GET giftcards?page={page}&version={version}	Authorized only.
POST giftcards/specific	Authorized only.
POST giftcards	Authorized only.
GET customers/questions?page={page}&version={version}	Return questions for particular company. Type could be: 0 - Dropdown, 1 - Yes/No, 2 - Text. Authorized only.
GET customers/questionAnswers?page={page}&version={version}	Authorized only.
GET customers/customerAnswers?page={page}&version={version}	Authorized only.
POST customers/customerAnswers/specific	Authorized only.
POST customers/customerAnswers	Authorized only.
GET customers/balance?customerId={customerId}	Authorized only.
POST customer/allSignedWaivers?page={page}&version={version}	Authorized only.
POST customer/signedWaivers?customerId={customerId}	Authorized only.
POST customer/signWaivers	Authorized only.
POST customer/sendWaiver	Authorized only.
POST customer/signedWaiverTerms	Authorized only.
POST customer/findmypet/register	Authorized only.
GET customer/dashboard?customerId={customerId}&days={days}	Authorized only.
POST memberships/sync?page={page}&version={version}	Authorized only.
POST memberships/cancel	Authorized only.

Restaurant

API	Description
GET catalog/menus?page={page}&version={version}&includeEcommerceImages={includeEcommerceImages}	Authorized only.
GET catalog/menu/products?page={page}&version={version}	Authorized only.
GET catalog/menu/product/related?page={page}&version={version}	Authorized only.
GET catalog/menu/product/impulseBuy?page={page}&version={version}	Authorized only.
GET catalog/menu/modifiers?page={page}&version={version}	Authorized only.
GET catalog/menu/modifier/sets?page={page}&version={version}	Authorized only.
GET catalog/menu/modifier/setMaps?page={page}&version={version}	Authorized only.
GET catalog/menu/modifier/productMaps?page={page}&version={version}	Authorized only.
GET catalog/menu/modifier/ingredientMaps?page={page}&version={version}	Authorized only.
GET catalog/menu/ingredients?page={page}&version={version}	Authorized only.
GET catalog/menu/modifier/mealItems?page={page}&version={version}	Authorized only.
GET catalog/menu/meal/menus?page={page}&version={version}	Authorized only.
GET catalog/menu/item/modifier/maps?page={page}&version={version}	Authorized only.
GET catalog/menu/modifier/categoryMaps?page={page}&version={version}	Authorized only.
GET catalog/menu/modifier/options?page={page}&version={version}	Authorized only.
GET catalog/restaurant/table/getTable?page={page}&version={version}	Authorized only.
POST catalog/restaurant/table	Authorized only.
GET catalog/restaurant/table/getSection?page={page}&version={version}	Authorized only.
POST catalog/restaurant/section	Authorized only.
GET catalog/restaurant/table/getRoom?page={page}&version={version}	Authorized only.
POST catalog/restaurant/room	Authorized only.
GET catalog/productionItems?page={page}&version={version}	Authorized only.
GET catalog/productionItems/productionItemProductMaps?page={page}&version={version}	Authorized only.
GET catalog/productionItems/productionItemModifierMaps?page={page}&version={version}	Authorized only.

WalkIn

API	Description
GET location/walkin?page={page}&version={version}	Authorized only.
GET location/walkin/customers?page={page}&version={version}	Authorized only.
POST location/walkin/customers/get	Authorized only.
POST location/walkin/customers	Authorized only.
POST location/walkin/updateEstimatedTime?estimatedTime={estimatedTime}	Authorized only.
POST location/walkin/updateEstimatedTime?estimatedTimeMinutes={estimatedTimeMinutes}	Authorized only.
POST location/walkin/updateNumberInQueue?numberInQueue={numberInQueue}	Authorized only.

Order

API	Description
GET order/get?id={id}&customer={customer}	Authorized only.
POST orders/get?page={page}&version={version}	Authorized only.
GET orders/search?shippingStatuses[0]={shippingStatuses[0]}&shippingStatuses[1]={shippingStatuses[1]}&ccLast4={ccLast4}&orderId={orderId}&customerId={customerId}&employeeId={employeeId}&transactionId={transactionId}&startDate={startDate}&endDate={endDate}&withBalance={withBalance}&futureOrders={futureOrders}&orderTypeId={orderTypeId}&maxResults={maxResults}&offset={offset}	Authorized only.
GET orders/delivery?page={page}&version={version}	Authorized only.
GET order/details?id={id}	Authorized only.
GET order/shipping?id={id}	Authorized only.
POST order/shipping	Authorized only.
POST order/cancel	Authorized only.
POST orders	Authorized only.
POST order/emails	Authorized only.
POST order/sms	Authorized only.
POST voids	Authorized only.
POST orders/full	Authorized only.

Taxes

API	Description
GET taxes?page={page}&version={version}	Authorized only.
GET taxcategories?page={page}&version={version}	Authorized only.

Payment

API	Description
POST payment/get	Authorized only.
POST payments/get?page={page}&version={version}	Authorized only.
POST payments	Authorized only.

ProductService

API	Description
GET catalog/products?page={page}&version={version}&includeEcommerceImages={includeEcommerceImages}	Authorized only.
POST catalog/products/specific	Authorized only.
POST catalog/product/search	Authorized only.
GET catalog/product/related?page={page}&version={version}	Authorized only.
GET catalog/product/addons?page={page}&version={version}	Authorized only.
GET catalog/product/taxes?page={page}&version={version}	Authorized only.
GET catalog/productattributes?page={page}&version={version}	Authorized only.
GET catalog/productattributemaps?page={page}&version={version}	Authorized only.
GET catalog/kitproductitems?page={page}&version={version}	Authorized only.
GET catalog/products/scan?sku={sku}	Authorized only.
POST catalog/products/massivescan?pageIndex={pageIndex}&pageSize={pageSize}&categoryId={categoryId}&vendorId={vendorId}&brandId={brandId}	Search and return product stock by sku or code. Authorized only.
POST catalog/product/update	Authorized only.
POST catalog/products/recieve?averageCost={averageCost}	Recieve products. Authorized only.
POST catalog/products/reconcile	Reconcile products. Authorized only.
GET catalog/reconcile/reasons?page={page}&version={version}	Authorized only.
GET catalog/purchaseOrders?startDate={startDate}&endDate={endDate}&statusId={statusId}&types[0]={types[0]}&types[1]={types[1]}&pageIndex={pageIndex}&pageSize={pageSize}	Get purchase orders. Authorized only.
GET catalog/purchaseorder/{purchaseOrderId}	Authorized only.
POST catalog/purchaseorder/receive	Authorized only.

Common

API	Description
GET common/countries?page={page}&version={version}	Authorized only.
GET common/stateProvinces?page={page}&version={version}	Authorized only.
GET common/currencies?page={page}&version={version}	Authorized only.
GET common/currency/denominations?page={page}&version={version}	Authorized only.
GET common/loyaltyprograms?page={page}&version={version}	Authorized only.
GET common/creditloanprograms?page={page}&version={version}	Authorized only.
GET common/orderTypes?page={page}&version={version}	Authorized only.
GET common/voidReasons?page={page}&version={version}	Authorized only.
GET common/videos?platform={platform}&page={page}&version={version}	Load tutorial videos Authorized only.
POST common/uploadFile	Authorized only.
GET common/file?id={id}	Authorized only.
POST common/deleteFile?id={id}	Authorized only.
POST common/device/validate	Authorized only.
POST common/device/register	Authorized only.
GET common/device/operations?deviceUniqueId={deviceUniqueId}&page={page}&version={version}	Authorized only.
POST common/device/operations	Authorized only.
GET common/externalMappings?page={page}&version={version}	Authorized only.
POST common/externalMappings/specific	Authorized only.
POST common/externalMappings	Authorized only.
POST common/auditlogs	Authorized only.
POST common/azurefunction	Authorized only.
GET common/version	Authorized only.
POST common/conversations	Authorized only.
POST common/messages	Authorized only.
POST common/sendmessage	Authorized only.

TeeSheet

API	Description
POST teesheet/checkin/details	Authorized only.
POST teesheet/checkin/void	Authorized only.
POST teesheet/checkin/update	Authorized only.

System

API	Description
GET system/heartbeat	No documentation available.

Astro

API	Description
POST astro/rewards	Authorized only.
POST astro/rewards/validate	Authorized only.
POST astro/rewards/redeem	Authorized only.
POST astro/offers/redeem	Authorized only.

Reports

API	Description
POST reports/xreport	Authorized only.
POST reports/shiftreport	Authorized only.
POST reports/tipoff	Authorized only.

Catalog

API	Description
GET catalog/categories?page={page}&version={version}	Authorized only.
GET catalog/brands?page={page}&version={version}	Authorized only.
GET catalog/vendors?page={page}&version={version}	Authorized only.

Pos

API	Description
GET pos/discounts?page={page}&version={version}	Authorized only.
GET pos/discount/products?page={page}&version={version}	Authorized only.
GET pos/discount/categories?page={page}&version={version}	Authorized only.
GET pos/discount/timeRanges?page={page}&version={version}	Authorized only.
POST pos/discount/validate	Authorized only.
POST pos/discounts/validate	Authorized only.
POST pos/discount/sales	Authorized only.
POST pos/payment/creditcard	Authorized only.
POST pos/payment/creditcard/status	Authorized only.
POST pos/payment/creditcard/capture	Authorized only.
POST pos/payment/creditcard/void	Authorized only.
POST pos/paypal/refreshaccesstoken	Authorized only.
POST pos/square/refreshaccesstoken?isMigration={isMigration}&isNewVersion={isNewVersion}	Authorized only.
GET pos/square/authtoken	Authorized only.
POST pos/payment/fragmenturl	Authorized only.
POST pos/payment/log	Authorized only.
POST pos/square/terminal/pair	Authorized only.
POST pos/square/terminal/pair/status	Authorized only.
POST pos/square/terminal/checkout	Authorized only.
POST pos/square/terminal/checkout/status	Authorized only.
POST pos/square/terminal/checkout/cancel	Authorized only.
POST pos/square/terminal/refund	Authorized only.
POST pos/square/terminal/refund/status	Authorized only.
POST pos/square/terminal/refund/cancel	Authorized only.
POST pos/square/terminal/handle	Authorized only.
POST pos/sumup/terminal/pair	Authorized only.
POST pos/loyalty/punchh/balance	Authorized only.
POST pos/loyalty/punchh/completeOrder	Authorized only.
POST pos/loyalty/punchh/redemption/void	Authorized only.
POST pos/loyalty/punchh/redemption	Authorized only.
POST pos/loyalty/punchh/apply_discounts	Authorized only.
POST pos/loyalty/punchh/redemption_v2	Authorized only.
POST pos/loyalty/punchh/redemption/void_v2	Authorized only.
GET pos/loyalty/synergy/balance?cardNumber={cardNumber}&numberType={numberType}	Authorized only.
POST pos/loyalty/sumup/balance	Authorized only.
POST pos/loyalty/sumup/transaction	Authorized only.
POST pos/loyalty/sumup/void	Authorized only.
GET pos/bonus/balance?customerId={customerId}&type={type}&cellPhone={cellPhone}	Authorized only.
POST pos/bonus/balance	Authorized only.
POST pos/payment/levelup/propose	Authorized only.
POST pos/payment/levelup/complete	Authorized only.
POST pos/payment/levelup/refund	Authorized only.
POST pos/payment/process	To setup AccountType for SynergyRewardPoints add param 'codeType' (allowable values can be found in documentation of loyalty/synergy/balance) Authorized only.
POST pos/payment/cancel	Authorized only.
POST pos/houseaccount	Authorized only.
POST pos/houseaccount/create	Authorized only.
POST pos/account	Authorized only.
POST pos/valutec/operation	Authorized only.
POST pos/svs/operation	Authorized only.
POST pos/giftcard	Authorized only.
GET pos/raincheck/generate	Authorized only.
GET pos/tokens?customerId={customerId}&creditCardProviderId={creditCardProviderId}	Authorized only.
POST pos/tokens	Authorized only.
POST pos/drawerentries	Authorized only.
POST pos/cashregisters	Authorized only.
GET pos/cashregister/get?page={page}&version={version}	Authorized only.
POST pos/cashregister/open	Authorized only.
GET pos/cashregister/info?cashRegisterId={cashRegisterId}	Authorized only.
POST pos/cashregister/close	Authorized only.
GET pos/pinpaddevices?page={page}&version={version}	Authorized only.
POST pos/pushpinpaddevices	Authorized only.
POST pos/cashmachine/transactions	Authorized only.
POST pos/cashmachine/cassette/replace	Authorized only.
POST pos/tasks	Authorized only.
POST pos/tax/avalara/get	Authorized only.
GET pos/packages?customerId={customerId}&parentCustomerId={parentCustomerId}	Authorized only.
POST pos/packages	Authorized only.
GET pos/membership/check?membershipId={membershipId}	Authorized only.
GET pos/memberships?customerId={customerId}	Authorized only.
POST pos/memberships	Authorized only.
POST pos/delivery/calculate/time	Authorized only.
POST pos/delivery/calculate/fee	Authorized only.
POST pos/delivery/validate	Authorized only.
POST pos/qrcode/validate	Authorized only.
POST pos/promotion/use	Authorized only.
POST pos/promotion/validate	Authorized only.

OrderItem

API	Description
POST orderitem/get	Authorized only.
POST orderitems/get?page={page}&version={version}	Authorized only.
POST orderitems	Authorized only.
POST orderitem/modifiers	Authorized only.
POST orderitem/modifier/get	Authorized only.
POST orderitem/modifiers/get?page={page}&version={version}	Authorized only.

Tip

API	Description
POST tip/get	Authorized only.
POST tips/get?page={page}&version={version}	Authorized only.
POST tips	Authorized only.

BookingCustomer

API	Description
GET booking/customers?startDate={startDate}&endDate={endDate}&customerId={customerId}&page={page}&version={version}	Authorized only.
POST booking/customers/specific	Authorized only.
POST booking/customers	Authorized only.

BookingHeader

API	Description
GET booking/headers?startDate={startDate}&endDate={endDate}&customerId={customerId}&page={page}&version={version}	Authorized only.
POST booking/headers	Authorized only.

BookingRetentionType

API	Description
GET booking/retentionTypes?page={page}&version={version}	Authorized only.

BookingRecource

API	Description
GET booking/resources?page={page}&version={version}	Authorized only.

OrderDiscount

API	Description
POST orderdiscount/get	Authorized only.
POST orderdiscounts	Authorized only.

OrderTax

API	Description
POST ordertax/get	Authorized only.
POST ordertaxes	Authorized only.