POS Ingest API

The POS Ingest API lets partners and their POS vendors in every country push store, product, transaction and daily-close data to HQ through one vendor-neutral interface.

How it works

• Push model — your system calls the API; HQ never pulls from your POS.
• Asynchronous writes — once a request passes validation, the API stores it and returns 202 Accepted. Merging, de-duplication and reconciliation happen at HQ afterwards.
• Daily batches — data is sent once per business day after the store closes. This is not a real-time streaming API.
• Reconciliation — after sending a day's transactions you send a daily-close message with control totals, then query the reconciliation result.

flowchart LR
  A[Partner / POS vendor] -- "HTTPS + API key" --> B[POS Ingest API]
  B -- "202 Accepted" --> A
  B --> C[HQ data platform]
  C -- "Reconciliation result" --> B

Base URLs

Environment	Base URL
Test (dev)	https://func-posingest-dev.azurewebsites.net/pos/v1
Production	TBA

Endpoints at a glance

Method	Path	Purpose	Role
GET	/health	Health check	none
GET	/reference/transaction-types	HQ standard transaction types	API key
GET	/reference/{code_type}	Other standard codes	API key
PUT	/mappings/transaction-types	Upload your transaction-type mapping	API key
GET	/mappings/transaction-types	Read your current mapping	API key
PUT	/stores	Upsert store master data	API key
PUT	/products	Upsert product master data	API key
POST	/trade-records	Push transactions	API key
POST	/daily-close	Daily-close signal with control totals	API key
GET	/daily-close/{store_id}/{business_date}	Reconciliation result	API key

Where to start

1. Read the Glossary and the Integration Flow.
2. Request test credentials — see Test Environment.
3. Get your API key from HQ — see Authentication.
4. Follow the data rules in Conventions.
5. Use the Sample Client as a starting point.