Production tokens are issued after sandbox integration is verified. Contact Retagly to receive your production token.
How authentication works
Each store location has a unique Bearer token. Include it in every API request as an Authorization header. The token identifies which store the request comes from — no additional store ID needed. For chains with multiple locations, each store gets its own token.
API Overview
Everything you need to integrate your POS system with Retagly.
How it works
Your POS
Retagly API
Store Displays
Your POS sends product data to the Retagly API. Retagly stores the products and automatically updates the pricing displays in the store. Each store location has its own Bearer token — no store IDs needed in the request body.
Endpoints at a glance
POST/add
Add new products to a store. Each product must include a barcode, name, and price. If a product with the same barcode already exists, it will be updated. After saving, Retagly automatically updates any display bound to that barcode.
POST/productUpdate
Update existing products. Same as /add but the product name is optional — if omitted, the existing name is kept. Use this for price changes, stock updates, or sale toggles without resending the full product record.
Session-based Batch Import
For large-scale updates (hundreds or thousands of products), use the session-based batch flow. This gives you a single session ID to track the entire import, no matter how many products you send.
1
POST/batch/start
Start a new session. Returns a sessionId and a 30-minute expiry window.
2
POST/batch/push× repeat
Send up to 1,000 products per push. Call as many times as needed. For 5,000 products, push 5 times.
3
POST/batch/complete
Signal that all products have been sent. This triggers server-side processing.
4
GET/batch/{sessionId}/status× poll
Poll every 5–10 seconds until completed. Tracks progress through saving, syncing, and verification.
|||
When to use what
Scenario
Recommended endpoint
Adding a few new products
/add
Quick price or stock update
/productUpdate
Daily full inventory sync (100+ products)
/batch/start → /push → /complete
Large-scale import (thousands of products)
/batch/start → /push × N → /complete
Batch processing phases
After you call /batch/complete, Retagly processes your products through three phases. The /batch/{sessionId}/status endpoint reports which phase is active and the overall progress (0–100%).
0 – 30%
Phase 1: Saving
Each product is validated and saved. Existing products (matched by barcode) are updated; new ones are created.
30 – 80%
Phase 2: Display sync
Products are synced to in-store displays in chunks of 1,000. Each bound display receives the updated product data and is triggered to refresh.
80 – 100%
Phase 3: Verification
Retagly confirms that each display actually refreshed. Displays are checked every 30 seconds for up to 6 minutes. The tagsConfirmed / tagsTotal fields in the status response track this.
