Quick Start

Make a successful IMS Business API request in a few minutes using the base URL, company ID and API key issued to your integration.

1. Required values

Value	Example	Notes
Base URL	`https://api.example.com`	Use the HTTPS base URL supplied for the IMS environment.
Company ID	`1`	The company must be assigned to your API client.
API key	`ims_live_...`	Send it in `X-IMS-API-Key`. Treat it as a secret.

2. First request: Stores

curl "https://api.example.com/api/v1/companies/1/stores"   -H "X-IMS-API-Key: YOUR_API_KEY"   -H "Accept: application/json"

A successful response returns HTTP 200 with company metadata, a count and the store/warehouse data array.

3. Date-based request: Sales

curl "https://api.example.com/api/v1/companies/1/sales?fromDate=2026-09-01&toDate=2026-09-30&page=1&pageSize=100"   -H "X-IMS-API-Key: YOUR_API_KEY"   -H "Accept: application/json"

4. Typical paged response

{
  "companyId": 1,
  "companyCode": "COMPANY",
  "companyName": "Company Name",
  "page": 1,
  "pageSize": 100,
  "count": 100,
  "totalCount": 1250,
  "totalPages": 13,
  "data": [ ... ]
}

Next stepSee Endpoint Reference for available resources and filters, and Data Semantics before aggregating financial/inventory values.

Ready-to-run request file

Download IMS_API_v1.http for Visual Studio/VS Code HTTP Client examples covering every API v1 endpoint. Replace the three variables at the top and run the requests directly.