FranPOS Help Center

Introduction

All methods requires for API Key that you can generate from my.franpos.com/GetAPI. The Token is required at the end of each URL query as additional parameter "&Token=APIKey".
Be attentive: it doesn't allow to do one api call for several companies.
API allows to do api calls for multiple locations of company, in this case you should send "Token" of main location (multilocation feature doesn't allowed with non-main store api token). Depending on the method (see particular method documentation) one, several or all locations in company will be handled. For specific methods it allows to select which specific locations should be handled. In this case you should send comma separated string with all desired location ids of one company as parameter restrictByLocations. Not all methods allows multi location behavior (check method documentation). In case there no info about multi location - it works with all company locations according to input data. Any date/time parameters have standard format: YYYY-MM-DDThh:mm:ss (symbol 'T' should be as is). It allows to miss time, in this case it will be default 00:00
The live URL to access API is https://publicapi.franpos.com/. Please contact us at support@franpos.com for any questions.

Class

API	Description
GET api/classes/getAll	Get All Class info
GET api/classes/get?classId={classId}	Get Class info

Reports

API	Description
POST api/report/tickets	Get CSV file for Sage ERP. Allows to get tickets from company locations. You can use restrictByLocations for restrict list of desired locations.
POST api/report/v1/tickets	Get Tickets Details for Sage ERP in JSON format. Allows to get tickets from company locations. You can use restrictByLocations for restrict list of desired locations.
POST api/report/v2/tickets	Get Tickets Details for Sage ERP in JSON format. Allows to get tickets from company locations. You can use restrictByLocations for restrict list of desired locations. Discounts are assigned to order items
POST api/report/timeClocks	Get TimeClocks. Allows to get tickets from company locations. You can use restrictByLocations for restrict list of desired locations.
GET api/report/timeClocks?startDate={startDate}&endDate={endDate}&pageIndex={pageIndex}&pageSize={pageSize}&returnDeleted={returnDeleted}&skipTimeZoneConvertion={skipTimeZoneConvertion}	No documentation available.
POST api/report/cashRegisters	No documentation available.

Shared

API	Description
POST api/shared/twilio/CustomerReply	No documentation available.

Company

API	Description
POST api/company/location	Add new location. Required fields: FirstName, LastName, CompanyName, Email, Password. Is not allowing multi location.
POST api/company/update	Update Company. Required fields: LocationId. Is not allowing multi location.
GET api/company/getLoyaltyProgram?locationId={locationId}	No documentation available.
GET api/company/GetChildLocation	No documentation available.

DataDump

API	Description
GET api/datadump/orders/{days}/{type}/{fromDate}	Orders Export. You can receive not more than last 30 days (in case fromDate is null) or not more than 30 days after fromDate. Is not allowing multi location. This method is deprecated, please use new one (url v1/orders/)
GET api/datadump/customers/{days}/{type}/{fromDate}	Customers Export. You can receive not more than last 30 days (in case fromDate is null) or not more than 30 days after fromDate. It returns Customers and Employees was created or modification in selected date/time period. Is not allowing multi location. This method is deprecated, please use new one (url v1/customers/)
GET api/datadump/orderitems/{days}/{type}/{fromDate}	Order details export. You can receive not more than last 30 days (in case fromDate is null) or not more than 30 days after fromDate. Is not allowing multi location. This method is deprecated, please use new one (url v1/orderitems/)
GET api/datadump/v1/orders/{days}/{page}/{fromDate}/{locationId}?pageSize={pageSize}	Orders Export. You can receive not more than last 30 days (in case fromDate is null) or not more than 30 days after fromDate. Is not allowing multi location.
GET api/datadump/v1/orderPayments/{days}/{page}/{fromDate}/{locationId}?pageSize={pageSize}	Order payments Export. You can receive not more than last 30 days (in case fromDate is null) or not more than 30 days after fromDate. Is not allowing multi location.
GET api/datadump/v2/orderPayments/{days}/{page}/{fromDate}/{locationId}?pageSize={pageSize}	Order payments Export. You can receive not more than last 30 days (in case fromDate is null) or not more than 30 days after fromDate. Is not allowing multi location.
GET api/datadump/v1/orderTaxes/{days}/{page}/{fromDate}/{locationId}?pageSize={pageSize}	Order taxes Export. You can receive not more than last 30 days (in case fromDate is null) or not more than 30 days after fromDate. Is not allowing multi location.
GET api/datadump/v1/customers/{days}/{page}/{fromDate}/{locationId}?pageSize={pageSize}	Customers Export. You can receive not more than last 30 days (in case fromDate is null) or not more than 30 days after fromDate. It returns Customers and Employees was created or modification in selected date/time period. Is not allowing multi location.
GET api/datadump/v1/orderitems/{days}/{page}/{fromDate}/{locationId}?pageSize={pageSize}	Order details export. You can receive not more than last 30 days. (in case fromDate is null) or not more than 30 days after fromDate. Is not allowing multi location.
GET api/datadump/v2/orderitems/{days}/{page}/{fromDate}/{locationId}?pageSize={pageSize}	Order details export (Include refund details). You can receive not more than last 30 days. (in case fromDate is null) or not more than 30 days after fromDate. Is not allowing multi location.
GET api/datadump/v1/orderdiscounts/{days}/{page}/{fromDate}/{locationId}?pageSize={pageSize}	Order details export (Include refund details). You can receive not more than last 30 days. (in case fromDate is null) or not more than 30 days after fromDate. Is not allowing multi location.

PurchaseOrder

API	Description
POST api/po/create	Create PO
POST api/po/delete?id={id}	Delete PO
GET api/po/all?statusIds[0]={statusIds[0]}&statusIds[1]={statusIds[1]}&startDate={startDate}&endDate={endDate}&pageIndex={pageIndex}&pageSize={pageSize}	Get paged purchase orders.
GET api/po/{id}	Get purchase order by id

Employee

API	Description
POST api/employee/importschedules	Import employee schedules. Required fields: EmployeeCode (or EmployeeId), LocationId, StartTime, EndTime
POST api/employee/create	Create Employee. Required fields: EmployeeCode, LocationId, Email, Password. EmployeeId is not using
POST api/employee/update	Update Employee. Required fields: EmployeeCode or EmployeeId, LocationId. You can update EmployeeCode if EmployeeId is not null (in this case employee searching will be by EmployeeId)
POST api/employee/createservice	Create service. Required fields: CustomerId, LocationId, ProductServiceId
POST api/employee/updateservices	Services update

Common

API	Description
GET api/dictionary/{entityName}	Get Dictionary by entity name.
POST api/inquiryPayPalPayflowInfo	No documentation available.
POST api/updateOrderNumbers	Update orders with Custom Order Numbers.
GET api/getOrderIdAndAuthNo?start={start}&end={end}	Get Order Ids and Auth Numbers
GET api/getCategory/{name}/{locationId}	Get Category by Name
GET api/getCategoriesByCompany/{page}?version={version}&getDeleted={getDeleted}&orderByVersion={orderByVersion}&includeImage={includeImage}	Get Company Categories
GET api/getVendor/{id}?locationId={locationId}	Get Vendor by Id
GET api/getLocationsInfo?version={version}&getNopSettings={getNopSettings}	Get location info
GET api/getVendorsByCompany/{page}?version={version}&locationId={locationId}&getDeleted={getDeleted}&orderByVersion={orderByVersion}	Get Company Vendors
GET api/getBrandsByCompany/{page}?version={version}&locationId={locationId}&getDeleted={getDeleted}&orderByVersion={orderByVersion}	Get Location Brands
GET api/getTaxesByCompany/{page}?version={version}&locationId={locationId}&getDeleted={getDeleted}&orderByVersion={orderByVersion}&taxType={taxType}&percentageOnly={percentageOnly}	Pull taxes for location
GET api/getTaxCategoriesByCompany/{page}?version={version}&locationId={locationId}&getDeleted={getDeleted}&orderByVersion={orderByVersion}	Pull tax categories for location
GET api/getProductServiceBySku/{sku}/{locationId}	Get Product/service by SKU
GET api/getProductService/{id}?locationId={locationId}	Get Product Service by Id
GET api/getOrder/{id}?locationId={locationId}	Get Order by Id
GET api/v1/getProductService/{id}?locationId={locationId}&includeAttributes={includeAttributes}&includeImage={includeImage}	Get Product Service by Id
GET api/getProductServicesByCompany/{page}?version={version}&type={type}&sellOnline={sellOnline}&locationId={locationId}&includeAttributes={includeAttributes}&getDeleted={getDeleted}&orderByVersion={orderByVersion}&includeImage={includeImage}&getOnlyStock={getOnlyStock}&pageSize={pageSize}	Get Company Products / Services
GET api/getRelatedProducts/{page}?version={version}&sellOnline={sellOnline}&locationId={locationId}&getDeleted={getDeleted}&orderByVersion={orderByVersion}	No documentation available.
GET api/getDiscountsByCompany/{page}?version={version}&locationId={locationId}&orderByVersion={orderByVersion}&types={types}&discountOperation={discountOperation}&status={status}	Get Company Discounts
GET api/getProductsImages/{page}?version={version}&locationId={locationId}	Get Product Service by Id. Getting images from token location only
GET api/getProductImage/{id}?large={large}&locationId={locationId}	Get Product Service by Id. Getting image from any company location
GET api/getStockByProductSKU/{sku}/{locationId}	Get Stock By Product SKU
GET api/getStockByProductSKU/{sku}?locationId={locationId}	Get Stock By Product SKU from main location
GET api/getMatrixAttributes?locationId={locationId}	Location Id by default is main location
GET api/getDiscountByCode/{locationId}/{code}	Get Discount by location and code
GET api/generateApiKey/{locationCode}	Generate api key for locations selected by code
GET api/checkUsageLimit	No documentation available.
GET api/pullLocationsAccessType	Dictionary with all locations available by token with flag: if it have unlim addon enabled
GET api/teesheet/products/search?query={query}&skip={skip}&take={take}	Searching for product from EZTee eligible categories

WalkIn

API	Description
GET api/walkin/queue?restrictByLocationCodes={restrictByLocationCodes}	No documentation available.
POST api/walkin/{companyId}/checkIn	No documentation available.
POST api/walkin/{companyId}/isCheckedIn	No documentation available.
POST api/walkin/{companyId}/secondaryContacts/{customerId}	No documentation available.
POST api/walkin/{companyId}/serviceProviders	No documentation available.
GET api/walkin/{companyId}/settings	No documentation available.
POST api/walkin/{companyId}/simpleServices	No documentation available.
POST api/walkin/{companyId}/services	No documentation available.
GET api/walkin/company/workinghours?companyId={companyId}	No documentation available.
GET api/walkin/booking/appointments?companyId={companyId}&dateStr={dateStr}	No documentation available.
GET api/walkin/employee/schedules?companyId={companyId}&employeeId={employeeId}&dateStr={dateStr}	No documentation available.

Customer

API	Description
GET api/Customers/{id}?locationId={locationId}	Get Customer by Id
GET api/Customers/ByCompany/{page}?startDate={startDate}&endDate={endDate}&skipTimeZoneConvertion={skipTimeZoneConvertion}	Get all Company Customers
POST api/CustomerAnalysisReport	Get New/Returning Company Customers
POST api/CustomerAnalysisSummary	Get New/Returning Company Customers
GET api/customer/search?query={query}&filterType={filterType}	Search customer by filter type and keyword
GET api/customer/search?customerCode={customerCode}&email={email}&cellPhone={cellPhone}&workPhone={workPhone}&firstName={firstName}&lastName={lastName}&zip={zip}&returnOtherContacts={returnOtherContacts}	Search customer by first name
GET api/customer/searchByCellPhoneOrEmail?query={query}&ignoreSubcontacts={ignoreSubcontacts}&ignoreIfExternalIdSet={ignoreIfExternalIdSet}&locationId={locationId}	No documentation available.
POST api/customer/getOrCreateCustomer?updateOldDetails={updateOldDetails}&locationId={locationId}	No documentation available.
GET api/customers/history/{id}/{type}	Get Chronological Customer Report. Is not allowing multi location.
POST api/putCustomer	Put Customer(s). Is not allowing multi location. This method is deprecated, please use new one (url customers/). State and Country defined by code or name, note type defined by name. Dob format: yyyy-mm-dd. You can setup (by default - false) which field should be required (do not allow to add customer when can't resolve these fields by names or they was not set), by these properties: RequireCountry, RequireState, RequireDob, RequireNote (if note type was not set or can't be resolved - do not add customer), RequireGender (if gender was not set correctly - do not add customer, otherwise use default Unknown gender).
POST api/customers	Add or update Customer(s). Search customer by Email or Customer Code or Cell Phone and update if found, otherwise add new. State and Country defined by code or name, note type defined by name. Dob format: yyyy-mm-dd. For adding only (not for update): you can setup (by default - false) which field should be required (do not allow to add customer when can't resolve these fields by names or they was not set), by these properties: RequireCountry, RequireState, RequireDob, RequireNote (if note type was not set or can't be resolved - do not add customer), RequireGender (if gender was not set correctly - do not add customer, otherwise use default Unknown gender).
POST api/houseaccount/create	Create a Prepaid account record along with new customer (cell phone based). Is not allowing multi location.
POST api/customer/sendAuthCode?locationId={locationId}	No documentation available.
GET api/customers/waivers?start={start}&end={end}&appliedTo={appliedTo}&locationId={locationId}	No documentation available.

Import

API	Description
POST api/updateStockByProductSKU?sku={sku}&stock={stock}&addToStock={addToStock}	Update Stock By Product SKU
POST api/updateProductStock?addToStock={addToStock}&employeeId={employeeId}	Update Stock By Product SKU
POST api/putProductService	Put Product Service(s)
POST api/putMatrixAttributes	No documentation available.
POST api/putMatrixCombination	No documentation available.
POST api/putCategory	Put Category(s)
POST api/putVendor	Put Vendor(s)
POST api/deleteProductService	Delete Product Service(s)
POST api/putOrder	Put Order(s). Required fields: TemporaryOrderId, SalesPerson, ShippingOptionId, LocationId, PaymentStatusID, PaymentMethodID
POST api/v2/putOrder	Put Order(s). Required fields: TemporaryOrderId, SalesPerson, ShippingOptionId, LocationId, PaymentStatusID, PaymentMethodID
POST api/cancelOrder	Cancel orders: delete order, return stock back, refund franpos gift cards
POST api/importProducts?employeeId={employeeId}&updateCost={updateCost}&updateDescription={updateDescription}&updateStock={updateStock}&updatePrice={updatePrice}	Import Products in the same way as Web Importing.
POST api/importProductMatrix?employeeId={employeeId}	Import Product Matrix in the same way as Web Importing.

Booking

API	Description
POST api/booking/create	Create Appointment
GET api/booking/getstatus?bookingId={bookingId}&locationId={locationId}	Get Appointment status
GET api/booking/getservices?locationId={locationId}	Online booking. Get all services. Is not allowing multi location
GET api/booking/getserviceproviders/{serviceId}?locationId={locationId}	Online booking. Get all service providers. Is not allowing multi location
GET api/booking/searchservicetime/{date}/{serviceId}/{serviceProviderId}?locationId={locationId}	Online booking. Search Service Times. Is not allowing multi location
GET api/booking/bookingtime?dateTime={dateTime}&serviceId={serviceId}&serviceProviderId={serviceProviderId}&email={email}&firstName={firstName}&lastName={lastName}&locationId={locationId}	Online booking. Booking Service By Time. Is not allowing multi location

Pos

API	Description
POST api/pos/giftcard	Do gift card operations
POST api/pos/loyaltyProgram	Do loyalty rewards operations
POST api/pos/prepaidItem/discounted/list	No documentation available.
POST api/pos/prepaidItem/operation	No documentation available.