POSSUM API Documentation Portal

This portal groups the POSSUM.Api endpoints into focused modules so that product teams, integrators and support agents can quickly find the capabilities they need. Each module page contains endpoint level details including verbs, request contracts, response formats and cross-cutting notes.

How to use these docs

Start with the module that matches your use case. Each module page is organised by controller and highlights key flows, payload expectations and implementation tips. Use the navigation bar to jump directly to the module you need.

Quick-Start Integration

Follow the step-by-step playbook used by POSSUM.SyncService to orchestrate API authentication, data imports and outbound uploads.

Authentication & Access

Provision POS users, authenticate from mobile devices and validate SMS codes.

Customer & Engagement

Synchronise customer masters, manage loyalty discounts, subscriptions and deposits.

Orders & Payments

Open and settle orders, post cash drawer events and process Swish online payments.

Products & Inventory

Distribute product catalogues, manage inventory counts and category structures.

Administration & Operations

Maintain system settings, terminals and perform tenant onboarding or file retrieval.

Utilities & Diagnostics

Use helper callbacks and sample endpoints for monitoring and developer testing.

Cross-cutting conventions

Authentication
API controllers inheriting from BaseAPIController expect a valid bearer token issued by the POS back office. The token determines the database connection that is used for the request.
Date filters
Synchronisation endpoints commonly accept either Dates or DatesApi query parameters. These contain a From/To range (or LastExecutedDate/CurrentDate) and optional paging information so that clients can fetch only deltas.
Response envelopes
Unless otherwise noted, endpoints return plain JSON collections or view models. Error scenarios log to EWOLogManager and respond with HTTP 500 or 417.