Master data
Stores, Items & Suppliers
Store/warehouse attributes, merchandise master data and supplier identity used by business transactions.
Business API v1
Read-only external API for approved IMS business data across authorized companies. It is designed for integrations, analytics and data consumers that need a stable HTTPS contract without direct database access.
Start hereIf you received an API key and company ID, open Quick Start. It contains copy/paste calls and the minimum information required to make a successful request.
What the API exposes
Transactions
Sales & Purchases
Sales/returns, COGS, salesperson/customer references, purchases/returns, local and landed cost.
Inventory
Balances & Movements
On-hand stock, stock value, movement history, transfers, adjustments and depreciation.
Commercial
Markdowns & Promotions
Markdown policies, promotion definitions/relations and discount-coupon event metadata.
Security model
Every business request is authenticated with the X-IMS-API-Key header. Access is limited by the client record, assigned companies and assigned scopes. API keys can be expired, rotated or revoked by an IMS Global administrator.
API v1 scopes
| Scope | Purpose |
|---|---|
stores.read | Store and warehouse information. |
items.read | Item and merchandise master information. |
sales.read | Sales/returns, salesperson references, customer/loyalty references, discounts and COGS. |
inventory.read | Inventory balances/valuation and inventory movement history. |
purchases.read | Suppliers, purchases/returns, local cost, landed cost and purchase expenses. |
transfers.read | Store-to-store transfer documents and movements. |
adjustments.read | Stock adjustments and stock depreciation. |
promotions.read | Markdowns, promotions, promotion relations and discount-coupon events. |
Developer path
01
Quick StartBase URL, API key header and first working calls.
02
Authentication & AccessCompany authorization, scopes, key lifecycle and client validity.
03
Requests & ResponsesDates, pagination, response envelopes, null values and filtering conventions.
04
Endpoint ReferenceAll Business API v1 resources, routes, filters and important response fields.
05
Data SemanticsSigned returns, COGS, landed cost, movement types, discount meaning and promotion rules.
06
Errors & Rate Limits400/401/403/404/429 behavior and retry guidance.
07
Examples & Downloadscurl, PowerShell, C# and ready-to-run HTTP/Postman collections.
Versioning
The /api/v1 route is the stable v1 contract. Compatible additions may be introduced within v1. Changes that remove/rename existing fields or change established business semantics require a new API version.