Location

Location represents an outlet/ store/ address to associate the “expected” location of the equipment to be tracked/ monitored​.

Parameters

Parameter	Type	Required	Description
Code	String	Yes	Unique code for the location
Name	String	Yes	Unique Location name - Supports unicode
ExternalLocationCode	String	No	External reference code in integration system
Street	String	No	Street addres
Street2	String	No	Street Address Line 2
Street3	String	No	Street Address Line 3
City	String	No	City Name
PostalCode	String	No	Postal/ Zip Code
SateId	int	No	State Id
CountryId	int	No	Country Id
MarketId	int	No	Market Id
StoreOwner	String	No	Store owner name
LocationSalesRep	String	No	Sales Rep name. Only use this field if not using user accounts for Sales Reps
PrimaryPhone	String	No	Location Phone#
IsActive	Boolean	No	Whether location is active or not
TimeZoneId	int	No	Defaults to TimeZone of the tenant
LocationRoute	String	No	Route identifier. Do not use this field if using pre-defined routing system
CustomerId	int	No	Customer. See customer section for more details
DistributorId	int	No	Distributor. See customer section for more details
PreSellerRouteId	int	No	Pre-Seller Route. See route section for more details
RouteId	int	No	Distribution/ General Route. See route section for more details
TDLinx	String	No	If customer has TDLinx number
Latitude	decimal	No	Latitude of the store
Longitude	decimal	No	Longitude of the store
BuyerGTIN	string	No	GTIN# for the Buyer
OutletGTIN	string	No	GTIN# for the Outlet

Note

• Many attributes have been excluded for brevity.

Note

• Based on your integration needs, additional attributes may be shared with you.
• You can use MarketName, Channel, LocationType, StateName, CountryName, CustomerName, DistributorName instead of MarketId, ChannelId, LocationTypeId, StateId, CountryId, CustomerId, DistributorId respectively

Example to save/ update a record based on External Location code:

POST /controllers/Location.ashx?action=save&Code=524&Name=Test Location&ExternalLocationCode=Test-01

One to Many Related Information - Optional

Details of the following API are not available in this documentation tool at the moment. If you have any query for the specific area, reach out to support@coolrgroup.com and we'll update the section on priority basis/ provide the appropriate Postman collection.

1. Sales Reps: Reps handling the outlet
2. Sales Rep Routes: If the routing information differs from week to week
3. Visit Hitory: Tracking of visit history at the outlet
4. Business Hours: To track off hours to avoid unnecessary alerts
5. Addresses: If there are additional addresses to be stored apart from location address itself
6. Contacts: Any additional contacts apart from Store Owner
7. Location Images: Images of the store itself. These can be useful to find an outlet or different promotions
8. Notes: Notes associated with the outlet
9. Promotios: List of promotional material at the location
10. Products: If the ordering is restricted on a per outlet basis or the pricing is differnt on per outlet basis
11. Location Action: Actions planned/ executed at the location

Related Entities - Optional Attributes

Location has multiple related entities that define various attributes. These are used primarily for segmenting the operational and analytical aspects.

1. Market:
2. Classification
3. Channel
4. Distributor
5. Customer
6. Route
7. Pre-Seller Route

🧩 Location List API (Response)

GET /Controllers/Location.ashx?action=list&start=0&limit=50&asArray=0

Provides comprehensive details about each location, including geographic coordinates, contact information, classification, market association, ownership, routing, and operational metadata for use in sales, logistics, and monitoring systems

Property	Type	Description
LocationId	Integer	Unique ID for the location
LocationTypeId	Integer	Type ID of the location
Name	String	Name of the location
Latitude	Float	Latitude coordinate
Longitude	Float	Longitude coordinate
StateId	Integer	Identifier for the state
PostalCode	String	Postal or ZIP code
Street2	String	Secondary street address
Street3	String	Tertiary street address
LocationType	String	Location type description
IsKeyLocation	Boolean	Whether the location is a key location
SalesRepId	Integer	Primary sales rep ID
PrimarySalesRep	String	Email of the primary sales rep
Code	String	Internal location code
PrimaryContactId	Integer	Primary contact ID
TimeZone	String	Time zone name
CellPhone	String	Cell number of contact
CorporateEmailAddress	String	Corporate email address
WorkPhone	String	Work contact number
FirstName	String	Contact’s first name
LastName	String	Contact’s last name
LocationText	String	Additional location text
MarketId	Integer	Associated market ID
MarketName	String	Market or regional name
PrimaryPhone	String	Main phone number for the location
OwnerId	Integer	Owner identifier
ContactPersonName	String	Name of contact person
ContactPersonPhone	String	Phone of contact person
StoreOwner	String	Store owner email
OwnerName	String	Name of the owner
LocationSalesRep	String	Sales rep email for the location
Classification	String	Classification type
ClassificationId	Integer	ID for classification
IsSmart	Boolean	Whether location is smart-enabled
IsSurveyed	Boolean	Indicates if location is surveyed
IsVision	Boolean	Whether vision module is enabled
TimeZoneId	Integer	Identifier for the timezone
AlertCount	Integer	Number of active alerts
LastPing	String	Last ping time (nullable)
LastDoorClose	String	Timestamp of last door close
LastHealth	String	Last health check time
AllEMailAddress	String	All associated emails
RestockScheduleDays	Integer	Days between restocks
LastRestock	String	Timestamp of last restock
OutletNumber	String	Number identifying outlet
DistributorId	Integer	Distributor ID
DistributorName	String	Name of distributor
TDLinx	String	TDLink value
SurveyCount	Integer	Total survey records for the location
AddressChecksum	Integer	Internal address validation checksum
LatLongIdentifiedFor	String	Reference point for location ID check
ASNToSalesRep	Boolean	ASN flag for sales rep
IsUseSalesRepRouteToOrder	Boolean	Use sales rep route for order
IsSkipOrder	Boolean	If orders should be skipped
SalesModelId	Integer	Sales model identifier
SalesModel	String	Name of the sales model
InfieldContactPersonId	Integer	Contact person ID in field
InfieldContactPerson	String	Name of field contact
KeyAccountId	Integer	Key account identifier
KeyAccount	String	Name of the key account
BuyerGTIN	String	Global trade item number for buyer
OutletGTIN	String	GTIN of the outlet
ExternalLocationCode	String	External system location code
LocationRoute	String	Routing identifier for the location
PreSellerRoute	String	Pre-seller route reference
CustomerId	Integer	ID of the customer entity
CustomerName	String	Customer name
FullAddress	String	Combined address string
IsCreditHold	Boolean	Indicates if location is on credit hold
DeliveryNotes	String	Additional delivery instructions
LastDeliveryDate	String	Timestamp of last delivery
SecondarySalesRepEmail	String	Email of secondary sales rep
DistributorGTIN	String	GTIN of the distributor
InfieldContactPersonEmail	String	Email of field contact person
OutletStatusId	Integer	Status ID of the outlet
OutletStatus	String	Human-readable status of the outlet
OutletTypeId	Integer	ID of the outlet type
OutletType	String	Outlet type name
Channel	String	Channel name (nullable)
ChannelId	Integer	ID of the channel
ClassificationName	String	Name of the classification
SalesRepEmail	String	Email of the sales rep