Franchise Integrations

This guide covers building integrations for franchise locations on All About Pawz: how a location's data is scoped, what a location inherits from the franchisor and what it controls itself, how money readiness works per location, and what franchisor-side and location-side tooling each build. The offer and sale of a franchise are governed by the Franchise Disclosure Document and the franchise program documents in Brands and Franchises; this guide covers integration mechanics only, makes no representation about earnings, and promises nothing about whether or when a location opens.

The scoping rule

Every franchise location operates as its own account scope on the Platform, under the same API rules as every other account (Getting Started)

1. A location's key reaches that location's data. Products, orders, customers, and settings a call returns are the calling location's. There is no parameter that widens a call into another location's records; an identifier from another location does not resolve under your key.
2. Authenticate as the location you are acting for. Tooling that serves several locations holds each location's authorization separately, uses the one belonging to the location being acted on, and shows the operator which location is active before any write. Acting on the wrong location is a data incident, not a display defect.
3. Never mix locations' data on your side either. Do not cache one location's records into another's views, exports, or reports. Scoping is enforced by the Platform on every call; your systems must preserve it after the response arrives.
4. Franchisor-level access is its own authorization. Aggregate reporting across locations (below) is granted to the franchisor role explicitly; it is not something a location key can be stretched into, and location staff never receive it by accident of a shared login.

Credential handling follows Authentication and Authorization without exception; the custody rules are in Security and Compliance.

What a location inherits, and what it owns

• The franchisor provides the brand and its assets, the service and product catalog, pricing guidance and templates, operating procedures, and the shared platform services: payments, marketing tools, analytics.
• The location provides its premises, staff, customers, and local execution, and owns its local operating data: its appointments, its customers' records at that location, its local settings.
• Data flows down by design. The franchisor publishes a service, a price template, or a promotion; locations inherit it, and may override locally only within the bands the program allows. A local price override inside the band is legitimate; removing a core service the brand promises is not.
• Data does not flow up in detail. The franchisor sees aggregate performance across its locations: the reporting below: not a location's individual customer records. A location's customer data stays that location's.

When your integration syncs catalog or pricing for a location, preserve this shape: inherited values arrive as the franchisor published them, local overrides are recorded as overrides, and a later franchisor update never silently erases a permitted local override: or quietly permits a forbidden one. Pricing mechanics are in Pricing.

Money per location

Each location settles its own money

1. Payout setup is completed per location in the Seller Center: the location's own payout account, verified under the location's own business details. Until setup is complete, the location cannot receive payouts, whatever its sales.
2. Gate your tooling on readiness as the API reports it through Payments Endpoints: charges and payouts enabled: not on whether a profile form looks filled in. The states and what each permits are defined there and in Data Types and Enums.
3. The money flow itself: collection on the seller's behalf, deductions, payout timing, reversals: is the model in Payments, applied per location. A franchisor dashboard reads each location's payment state separately; locations never share a payout balance.

Provisioning a new location

1. The applicant completes the franchise application and review under the franchise program documents (Brands and Franchises). Nothing in the integration flow is a promise of approval or of an opening date.
2. On approval, the location's account is provisioned: its scope, its users, the inherited catalog, the location record, its default settings, and its payout onboarding.
3. Provisioning is safe to repeat: re-running it for an existing location leaves the location as it was rather than duplicating accounts, users, or catalog records. Anything your integration creates during setup should carry the same property: writes with idempotency keys, matched on stable identifiers.
4. Post-approval setup is the location's own checklist: staff, hours, services offered, local overrides: completed by the location in its tooling. Your integration's job is to make the checklist completable and its state visible, not to complete it silently with defaults the location never chose. A location that opens with wrong hours because a system assumed them blames the platform for its first bad review.

Operating across locations

• Franchisor view: aggregate reporting: revenue by location, service mix, customer satisfaction, brand-standard compliance: read through Analytics Endpoints under the franchisor authorization, computed across exactly the locations that authorization covers.
• Location switching in operational tools is explicit: the active location is chosen deliberately, shown continuously, and attached to every write. If an operator cannot tell which location they are acting on, the tool is not safe to ship.
• Shared services are consumed, not rebuilt. Booking, payments, and marketing run once at the platform level and serve every location; a franchise integration uses them per location rather than reimplementing them per location.

What to build

• Franchisor tooling: provisioning oversight, inherited catalog and pricing publication with override bands, aggregate reporting across entitled locations, brand-standard checks.
• Location tooling: location-scoped customers, appointments, staff, and inventory, with the active location always visible and every action taken under that location's authorization.
• Franchisor finance: per-location payout readiness and per-location reporting (Analytics), kept separate per location in your records as the Platform keeps them.

Questions about a franchise integration: support@aapawz.com.