Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Locations in Omneo represent the brand’s physical or virtual store locations. They are referenced throughout the platform to provide context to transactions, profiles, and customer experiences.

​
Location fields

FieldDescription
external_idThe location’s ID in your POS or eCommerce system
nameStore display name
addressFull street address
cityCity or suburb
stateState or region
countryCountry
postcodePostcode
latLatitude (for geocoding and proximity features)
lngLongitude
phoneStore phone number
emailStore email address
opening_hoursStructured opening hours data
directionsVerbal directions or notes
image_urlStore image URL
is_virtualWhether this is an online/virtual location

​
How locations are used

​
Profile context

  • join_location_id — the store where a profile was created
  • preferred_location_id — the customer’s favourite store (user-defined)
  • most_transacted_location — the store where the customer most frequently shops (aggregation)

​
Transaction context

Every transaction includes a location_id linking it to the store where the purchase occurred. This drives store-level analytics and staff attribution.

​
Incentive context

Reactions and benefit definitions can filter or apply logic based on the transaction’s location. For example, a reaction can issue a benefit only when a transaction occurs at a specific location.

​
Click and collect

Locations are referenced as pickup points in order records for click and collect fulfilment.

​
Custom fields

Locations support custom fields — brand-defined key-value pairs for any additional location-specific data (e.g., manager name, floor number, mall name, parking information).

​
Sync and management

Locations are managed in CX Manager under Configuration. They can also be created and updated via the API or bulk imported from your POS system.