Franpos DevelopersDevelopment

Scopes

A scope names a kind of access. Each credential is granted a set of scopes, and a token can carry that set or any smaller part of it. An endpoint answers 403 insufficient_scope when the token lacks a scope it needs.

ScopeAllowsOperations
company:readRead company and location details, settings and loyalty programscheckUsageLimit companyFormfields companyGetAccessibleCompanyIds companyGetChildLocation companyGetLoyaltyProgram getLocationsInfo and 1 more
customers:readSearch and read customers and their historycustomerSearch customerSearchByCellPhoneOrEmail customers customersByCompany customersHistory
customers:writeCreate and update customerscustomerGetOrCreateCustomer customersPost
catalog:readRead products, categories, vendors, brands, taxes, discounts and stockdictionary getBrandsByCompany getCategoriesByCompany getCategory getDiscountsByCompany getProductImage and 11 more
catalog:writeCreate, update and delete products, categories and vendors, and adjust stockdeleteProductService putCategory putProductService putVendor updateProductStock updateStockByProductSKU
orders:readRead ordersgetOrder
orders:writeCreate, update and cancel orderscancelOrder putOrder putOrderV2 updateOrderNumbers
employees:writeCreate employees and import schedulesemployeeCreate employeeImportSchedules
bookings:readRead booking services, providers and availabilitybookingBookingtime bookingGetserviceproviders bookingGetservices bookingGetstatus bookingSearchservicetime
bookings:writeCreate bookingsbookingCreate
purchase_orders:readRead purchase orderspo poAll
purchase_orders:writeCreate and delete purchase orderspoCreate poDelete
reports:readRun reportscustomerAnalysisReport reportCashRegisters reportTicketsV1 reportTicketsV2 reportTimeClocks reportTimeClocksGet
datadump:readBulk data dumps of orders, payments, taxes, items, discounts and customersdatadumpCustomersV1 datadumpCustomersV1FromDate datadumpCustomersV1FromDateForLocation datadumpOrderDiscountsV1 datadumpOrderDiscountsV1FromDate datadumpOrderDiscountsV1FromDateForLocation and 20 more
imports:writeBulk product importsimportProducts importProductsV2
messaging:readRead SMS logsgetSmsLogs
walkin:readRead the walk-in queue, services, providers and scheduleswalkinBookingAppointments walkinCompanyWorkinghours walkinEmployeeSchedules walkinQueue walkinSecondaryContacts walkinServiceProviders and 3 more