NCR Counterpoint API
NCR Counterpoint is a point-of-sale and retail management platform for specialty retailers, handling inventory, customers, purchasing, gift cards, and e-commerce across stores and online. A REST API lets you programmatically read customers, items, inventory by location, sales documents, and gift cards—and push new tickets, customer records, and inventory updates back into Counterpoint.
What is NCR Counterpoint?
NCR Counterpoint is a point-of-sale and retail management system for specialty retailers, owned by NCR Voyix. It manages inventory tracking, customer relationships and loyalty, vendor purchasing, e-commerce integration, and mobile-enabled operations so retailers can run across multiple physical and digital touchpoints from a single platform.
Common data entities:
- Customers, addresses, cards on file, notes, open AR items
- Items, categories, images, serial numbers, inventory by location
- Sales documents (tickets), line items, payments, contacts, notes
- Gift cards, tax codes, paycodes, and Secure Pay payment processing
- eCommerce category hierarchies and inventory sync
- Users, roles, API keys, companies, stores, stations, and workgroups
The NCR Counterpoint Integration Challenge
Counterpoint runs core retail operations daily, but its API is a self-hosted, on-premise server—turning it into reliable, modern automation is non-trivial:
- On-premise REST server: The API is a .NET server installed on the merchant's Windows machine, not a hosted cloud endpoint—reaching it requires network access into the store environment
- Layered licensing gates: Most endpoints require both a developer API license key and a paid registration.ini option before merchant functions are callable
- Multi-company, multi-version sprawl: A single server can host multiple companies and Counterpoint versions, each with its own database, IDs, and configuration
- Basic-auth on Counterpoint credentials: Calls authenticate with existing Counterpoint user logins, so credential and permission handling must mirror in-store roles
- Version-coupled endpoints: Endpoint coverage is tied to specific Counterpoint releases (for example, API v2.4 against v8.6.0.0), so behavior shifts across deployments
- Document and ticket complexity: Sales documents carry line items, payments, contacts, and notes that must be composed correctly to post a valid transaction
- Inventory-by-location nuance: Stock, serials, and eCommerce inventory live per location, requiring careful reconciliation to keep channels in sync
How Supergood Creates NCR Counterpoint APIs
Supergood wraps the self-hosted Counterpoint REST server—and the authenticated flows behind it—to deliver a resilient, normalized API layer for your Counterpoint deployment, regardless of company count or version.
- Handles API key licensing and basic-auth against Counterpoint user credentials securely
- Bridges on-premise connectivity into the store server without exposing raw infrastructure
- Normalizes responses across Customers, Items, Inventory, Documents, and Gift Cards so you integrate once across companies and versions
- Aligns with merchant-specific roles, registration options, and store/station configuration to ensure compliant access
Use NCR Counterpoint with AI agents: NCR Counterpoint MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your companies, Counterpoint version, registration options, and authentication model.
- Supergood Generates and Validates Your API
We deliver a production-ready Counterpoint adapter tailored to your deployment and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Counterpoint evolves.
API Endpoints
Authentication
/authenticateAuthenticate against a Counterpoint company using an API license key and Counterpoint user credentials to obtain a session for downstream calls.
Customers
/customersList customers with addresses, cards on file, notes, and open AR items, filtered by store, status, and modified date.
Customers
/create_customerCreate a new customer record with profile, address, and contact details in the target company.
Inventory
/itemsRetrieve item catalog data including categories, images, serial numbers, cost, and inventory by location.
Documents
/documentsPull sales documents (tickets) with line items, payments, contacts, and notes, filtered by store, station, and date range.
Documents
/create_documentPost a new sales document (ticket) with line items, tenders, and customer assignment into Counterpoint.
Gift Cards
/gift_cardsLook up gift card balances and status by card code across the merchant's companies.
Use Cases
Sync retail inventory and catalog across channels
- Pull item catalog, categories, images, and serial numbers into a single warehouse - Stream inventory-by-location levels to e-commerce and marketplace listings - Reconcile eCommerce inventory sync against in-store stock to prevent oversells
Centralize customer and loyalty data
- Sync customers, addresses, and cards on file into a downstream CRM or CDP - Surface open AR items and notes to collections and customer-service tools - Push new customer records captured online back into Counterpoint
Stream sales transactions to analytics and finance
- Pull sales documents (tickets), line items, and payments for BI and reporting - Reconcile tendered payments and tax codes against the general ledger - Post web and mobile orders into Counterpoint as native tickets
Automate gift card and payment workflows
- Look up gift card balances and status across companies in real time - Surface Secure Pay payment activity to reconciliation tools - Trigger downstream workflows when balances or document statuses change
Technical Specifications
Authentication
API license key plus basic auth against existing Counterpoint user credentials, handled in a managed session
Connectivity
Self-hosted Counterpoint REST server (.NET) reached over HTTP, supporting multi-company and multi-version deployments
Response format
Normalized JSON across Customers, Items, Inventory, Documents, and Gift Cards
Rate limits
Adaptive throttling tuned to the on-premise server to avoid overloading the store environment
Session management
Automatic session refresh, credential rotation, and registration-option handling
Data freshness
Near real-time pulls for customers, items, inventory, and tickets with optional scheduled batch syncs
Security
Encrypted credential vault, scoped access tokens, SOC 2-aligned controls, and audit logging
Webhooks
Event-style callbacks for new tickets, customer changes, inventory updates, and gift card activity
Latency
Sub-second reads on cached entities; multi-second writes when posting documents and payments
Throughput
Horizontally scaled workers sized to multi-company, multi-store transaction volume
Reliability
Retry, backoff, and idempotency keys for document posting and inventory adjustments
Adaptation
Continuous monitoring of Counterpoint version and API releases and merchant-specific configuration drift
Frequently asked questions
Most Counterpoint endpoints require both a free developer API license key and a paid registration.ini merchant option. Supergood works within your existing licensing and entitlements rather than bypassing them.
Yes. Supergood bridges connectivity into the store's self-hosted .NET REST server and operates against the same authenticated surfaces, with network configuration tuned to your environment.
Yes. A single Counterpoint server can host multiple companies and versions simultaneously. Supergood normalizes across them so you integrate once, even when companies run different Counterpoint releases.
Calls use basic auth against existing Counterpoint user credentials alongside the API license key. Supergood manages these securely in an encrypted vault and preserves the in-store roles and permissions tied to each user.
Yes. Beyond reads, the API supports creating sales documents with line items, tenders, and customer assignment, plus creating and updating customer and inventory records back into Counterpoint.