Ship integrations faster
Prebuilt Franpos methods speed embedded feature delivery.
Franpos Connector
Embed customer-facing integrations that sync orders, customers, products, inventory, bookings and reports between your SaaS product and Franpos POS for multi-location franchise operations. Build workflows, run imports/exports and surface data inside your app.
Multi-tenant credentialing
Map location tokens per customer and isolate access.
Reusable orchestration
Share and version workflows across customers and teams.
Embedded experience
Deliver customer-facing workflows natively inside your SaaS product.
CONNECTOR OVERVIEW
Overview
Use the Franpos connector to sync orders, customers, products, inventory, bookings and reports between Franpos and your SaaS application. Cyclr lets product teams build and ship embedded integrations, orchestrate multi-step workflows and map Franpos objects into tenant-specific automation for end users. (devpublicapi.franpos.com)
PRODUCT USE CASES
Use cases
Quickly build embedded integrations and automations for franchise customers — from order sync and inventory updates to scheduled exports and appointment creation — then publish via Cyclr’s white-labelled marketplace for your users.
Real-time order and payment sync
Create or update orders and order payments in Franpos from eCommerce checkouts using POST /v2/putOrder and payment endpoints. (publicapi.franpos.com)
Customer creation and lookups
Search, get and create customer records so SaaS user actions produce Franpos customer profiles. (devpublicapi.franpos.com)
Bulk product imports and inventory updates
Push product catalogs or import products and update stock via importProducts and updateStock endpoints. (devpublicapi.franpos.com)
ORCHESTRATION
How Franpos works with Cyclr
Cyclr sits between your SaaS product and Franpos to handle authentication, govern access and orchestrate every API call per customer, at scale.
- 1
Your SaaS product
Your app requests an action for a specific customer.
- 2
Cyclr orchestration
Cyclr authenticates, applies policies and routes the request.
- 3
Franpos
Franpos processes the request and returns a response to your app.
Customer-specific authentication · Governed data movement · Centralized visibility and audit
CONNECTOR COVERAGE
Available connector capabilities
Explore Franpos methods you can orchestrate through Cyclr.
Customers3
List New Customers
ActionGet all the customers since last run.
Get Customer by ID
ActionGet customer by ID.
List Customers
ActionGet all the customers.
Orders3
List New Orders
ActionGet all orders since last run.
Get Order by ID
ActionGet order by ID.
List Orders
ActionGet all orders within set time frame.
TECHNICAL DETAILS
Franpos integration and API details
Review the sourced authentication and API behaviour used when configuring customer-facing Franpos integrations in Cyclr.
API and authentication
- API host
https://publicapi.franpos.com- Authentication
- API key
- Credentials
API Key; choose main-location token; optional restrictByLocations for multi-location methods. (devpublicapi.franpos.com)
- Method categories
Read; Create/Update; Import/Export; Reporting; Order and customer operations
Pagination and rate limits
Pagination
Pagination commonly uses path/page segments and a pageSize query parameter for datadump and export endpoints. (devpublicapi.franpos.com)
Rate limits
Refer to the vendor API documentation for current limits.
IMPLEMENTATION
Authentication at a glance
Franpos documents an API Key passed as the Token query parameter to publicapi.franpos.com; confirm Cyclr installation option in Console. (devpublicapi.franpos.com)
- Authentication method
- API key
- Credential required
API Key; choose main-location token; optional restrictByLocations for multi-location methods. (devpublicapi.franpos.com)
Before you begin:
View setup guideRequires location-level API Token; use main-location Token for multi-location calls. (devpublicapi.franpos.com)
COMMON QUESTIONS
Frequently asked questions
It syncs orders, customers, products, inventory, bookings, gift cards and exports for reporting. Franpos exposes read and write endpoints for orders, customers and data exports that Cyclr workflows can orchestrate. (devpublicapi.franpos.com)
Franpos uses an API Key passed as the Token query parameter on each request; keys are generated in Franpos Franpos documentation. Verify the Cyclr installation field you’ll supply in Console. (devpublicapi.franpos.com)
Yes. Franpos supports location-level tokens and a restrictByLocations parameter for multi-location behavior; Cyclr maps tenant credentials and isolates access per customer. Confirm token strategy per customer in Console. (devpublicapi.franpos.com)
Yes. Cyclr can expose approved read and write actions from the connector as governed MCP tools, letting product teams control which methods tenants can invoke and track usage.
KEEP EXPLORING
Related resources and connectors
Documentation
Teaming up your POS and eCommerce Integrations
Read more →ProductHow to develop an API – Best Practices to Follow from Cyclr Developers
Read more →ProductMCP PaaS
Read more →Related connectorLightspeed Retail (X-Series)
Related ecommerce connector for customer-facing integration workflows.
Related connectorNeto
Related ecommerce connector for customer-facing integration workflows.
Related connectorOpSuite
Related ecommerce connector for customer-facing integration workflows.