Sales Track Live API Docs

Get Stores

Retrieve all stores for the authenticated admin.

GET/api/integrations/crm/stores

How to Integrate at Your Website

Step-by-step guide to integrate store management data into your CRM or website

1. Get Your API Keys

Contact us to get your API key and secret key for accessing store data

2. Use Our Pre-built Components

Download our ready-to-use UI components from the UI Components page - just copy and paste!

3. Connect to Your System

Add the API integration code to your website or CRM system using the examples in the right sidebar

4. Display Data

Your website will now show live store data from our system automatically

What You Get

  • Complete store information with location and contact details
  • Store categorization and type classification
  • Store capacity and layout information (shelf space, number of shelves)
  • Customer traffic data and rush hour timings
  • POSM (Point of Sale Materials) availability and space
  • Store performance ratings and compliance information
  • Visit scheduling and frequency management
  • Geographic coordinates for mapping and navigation
  • Ready-to-use UI components and code examples

Code Examples

GET /api/integrations/crm/stores
const apiKey = 'your_api_key_here';
const secretKey = 'your_secret_key_here';

async function getStores() {
  const response = await fetch('/api/integrations/crm/stores?limit=20&category=supermarket', {
    method: 'GET',
    headers: {
      'X-API-Key': apiKey,
      'X-Secret-Key': secretKey,
      'Content-Type': 'application/json'
    }
  });

  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }

  const data = await response.json();
  console.log(data.data.stores);
}

getStores().catch(console.error);

Response Examples

{
  "success": true,
  "data": {
    "stores": [
      {
        "id": "123",
        "name": "SuperMart Store",
        "address": "123 Main Street, Downtown",
        "city": "Mumbai",
        "state": "Maharashtra",
        "postalcode": "400001",
        "contactperson": "John Manager",
        "contactnumber": "+91-9876543210",
        "email": "store@supermart.com",
        "category": "supermarket",
        "storetype": "chain",
        "storesize": "large",
        "shelfspace": "500 sq ft",
        "numberofshelves": 20,
        "customersperday": 500,
        "rushhourtimestart": "18:00",
        "rushhourtimeend": "20:00",
        "hasposm": true,
        "availableposmspace": "50 sq ft",
        "pricingcompliance": "high",
        "competitorpresence": "moderate",
        "visitday": "monday",
        "visitfrequency": "weekly",
        "preferredvisittime": "10:00",
        "potentialrating": 8.5,
        "accessibilityrating": 9.0,
        "hasvisitpermission": true,
        "hasmerchandisingpermission": true,
        "status": "active",
        "lastvisited": "2024-12-15T10:30:00Z",
        "longitude": 72.8777,
        "latitude": 19.0760,
        "store_gst": "27ABCDE1234F1Z5",
        "createdat": "2024-01-15T08:00:00Z",
        "updatedat": "2024-12-15T10:30:00Z"
      }
    ],
    "pagination": {
      "total": 45,
      "limit": 20,
      "offset": 0,
      "has_more": true
    }
  }
}

Need Help?