Retail Pro API
Retail Pro is a specialty-retail POS and retail management platform built on the modular Retail Pro Prism server, deployed per-customer with its own REST API framework. An unofficial API lets you programmatically pull transactions, inventory, customers, employees, and store data—and push updates like sales receipts, item changes, price adjustments, and customer records—across each Prism deployment without partner-license gating or per-server credentials slowing you down.
What is Retail Pro?
Retail Pro is a point-of-sale and retail management platform built for specialty retail, unifying transactions, inventory, pricing, and customer data across stores and channels. Its flagship product, Retail Pro Prism, is a natively modular platform that runs as a per-customer server—on Oracle or MySQL, across Windows, iOS, and Android—giving retailers central control over multi-store operations while exposing a REST API framework for customizations and integrations.
Core product areas include:
- Point of Sale (transactions, receipts, returns, multi-device POS on tablet, touchscreen, and all-in-one hardware)
- Inventory and Replenishment (real-time stock, transfers, purchasing, and store-to-store communication)
- Pricing and Promotions (price lists, markdowns, and promotion rules across locations)
- Customer and Employee Management (loyalty, marketing, and store staff records)
- Reporting and Analytics (KPIs, performance reporting, and planning add-ons)
- Add-ons and App Market (RFID, loyalty/marketing, ERP, and third-party plugins)
Common data entities:
- Documents (sales receipts, transactions, line items, tenders)
- Inventory Items, SKUs, Styles, Price Lists, Quantities
- Purchase Orders, Vouchers, Transfers, Adjustments
- Customers, Loyalty Records, Marketing Segments
- Employees, Stores, Subsidiaries, Preferences
The Retail Pro Integration Challenge
Retailers run their daily operations on Retail Pro Prism, but its self-hosted, per-customer architecture makes API-driven automation harder than a typical cloud SaaS:
- Self-hosted per-customer servers: Each deployment is its own Prism server (cloud-hosted or on-prem), so there is no single tenant URL—integrations must target each retailer's own server, credentials, and network
- Development Partner License gating: The Prism SDK, code samples, and partner resources require a Retail Pro Development Partner License before you can build against the API
- Per-server API Explorer and metadata: API documentation lives at each server's /api-explorer and /api-documentation, and resource attributes are discovered through /meta/—so the effective schema varies by version and deployment
- Modular configuration drift: Prism is natively modular and customizable per retailer, so which services and resources are exposed differs from one installation to the next
- Multi-store, multi-subsidiary scope: Documents, inventory, and price lists are scoped by store and subsidiary, requiring careful handling of IDs and central-versus-local preferences
- Database and version variability: Servers run on Oracle or MySQL across different Prism versions, and v1/rest resource shapes shift as the platform evolves
How Supergood Creates Retail Pro APIs
Supergood reverse-engineers the authenticated Prism REST surface—its v1/rest resources, metadata, and API Explorer—to deliver a resilient, normalized API layer against each retailer's own Retail Pro Prism server, without requiring you to manage a partner license or per-server credential sprawl.
- Authenticates against each Prism server with its own username/password and session handling
- Discovers exposed services and resource attributes via /meta/ so the adapter matches each deployment's configuration
- Normalizes documents, inventory, customers, and employee data into consistent objects across stores and subsidiaries
- Adapts to Prism version and database differences (Oracle or MySQL) and modular configuration drift automatically
Use Retail Pro with AI agents: Retail Pro MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your Prism version, deployment model, modules, and authentication setup.
- Supergood Generates and Validates Your API
We deliver a production-ready Retail Pro adapter tailored to your Prism server's exposed resources and configuration.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adaptation as your Prism deployment evolves.
API Endpoints
Authentication
/authenticateAuthenticate against a retailer's Retail Pro Prism server with username/password and obtain a session for downstream REST calls.
Sales
/documentsList sales documents (receipts, transactions) with filters for store, subsidiary, date range, and status.
Sales
/documentsCreate a sales document such as a receipt or return with line items, tenders, and customer association.
Inventory
/inventoryRetrieve inventory items, SKUs, styles, quantities, and price-list assignments across stores.
Inventory
/inventoryUpdate item attributes, prices, or quantities for an inventory resource on the Prism server.
Customers
/customersPull customer and loyalty records with marketing and contact attributes scoped by subsidiary.
Use Cases
Sync sales and transactions to your data warehouse
- Pull sales documents, line items, and tenders from each Prism server into a central warehouse - Stream receipt and return events to downstream BI, finance, and reconciliation tools - Unify multi-store and multi-subsidiary sales into a single normalized view
Keep inventory and pricing in sync across systems
- Read item, SKU, and quantity data to feed ecommerce, OMS, and replenishment systems - Push price-list and markdown changes back into Prism without manual entry - Reconcile transfers, purchase orders, and adjustments across locations
Power loyalty and customer experience
- Sync customer and loyalty records into CRM and marketing platforms - Trigger marketing segments and offers based on in-store purchase history - Maintain a unified customer 360 across stores and channels
Automate store and employee operations
- Pull store, subsidiary, and preference configuration for centralized reporting - Sync employee records and sales attribution to payroll and incentive tools - Monitor KPIs and store performance without manual exports
Technical Specifications
Authentication
Per-server username/password against each retailer's Retail Pro Prism deployment, handled in a managed session
Connectivity
Prism v1/rest REST API surface, including the API Explorer and /api-documentation exposed by each server
Response format
Normalized JSON across documents, inventory, customer, employee, and store objects
Rate limits
Adaptive throttling tuned to each self-hosted Prism server to avoid overloading the retailer's database
Session management
Automatic session refresh, credential rotation, and per-server connection handling
Data freshness
Near real-time reads for sales, inventory, and customer data with optional scheduled batch syncs
Security
Encrypted credential vault, scoped access, SOC 2-aligned controls, and audit logging
Webhooks
Event-style callbacks for new sales documents, inventory changes, and customer updates
Latency
Sub-second reads on cached resources; multi-second writes when posting documents and inventory updates
Throughput
Horizontally scaled workers sized to multi-store, multi-subsidiary transaction volume
Reliability
Retry, backoff, and idempotency keys for document creation and inventory adjustments
Adaptation
Continuous monitoring of Prism version changes, modular configuration drift, and Oracle/MySQL differences across deployments
Frequently asked questions
No. Supergood works against your authenticated Retail Pro Prism server directly, so you do not need to obtain a Development Partner License or manage the Prism SDK yourself to get an API.
Each retailer runs its own Prism server, whether cloud-hosted or on-prem. Supergood connects to that specific server with its own credentials and network configuration, then exposes a single normalized API across all of your locations.
Yes. Prism servers run on either Oracle or MySQL across different versions. Supergood targets the Prism REST surface rather than the database directly, so it adapts to either deployment without schema-level changes on your side.
Yes. The API reads documents, inventory, customers, employees, and store data, and can create or update resources such as sales receipts, item and price changes, and customer records through the Prism v1/rest endpoints.
Prism is natively modular, so exposed services and resource attributes vary by installation. Supergood discovers each server's resources and metadata via /meta/ and tailors the adapter to your specific configuration.