Shop Data Model

Data Model Overview

🏗️ Primary Entities

Shops: Physical service locations with address, contact, and operational details

Tenants: Parent organizations that own and manage shops

Integrations: External shop management system mappings

Communication Settings: Text and email sending configuration

🔗 Key Relationships

Many-to-One: Shop → Tenant (each shop belongs to one tenant)

Field Specifications

Shop Identification

Core identification fields for shop records with internal, external, and tenant system mapping.

Tip

Primary Key: STEER_SHOP_ID is the primary key for this table. Each row represents one unique shop location.

Field Name	Data Type	Description	Required
STEER_TENANT_ID	String (UUID)	Unique tenant identifier (parent organization)	Yes
STEER_TENANT_NAME	String	Tenant organization display name	Yes
STEER_SHOP_ID	String (UUID)	Unique shop location identifier (primary key)	Yes
STEER_SHOP_NAME	String	Shop location display name	Yes
EXTERNAL_SHOP_ID	String	Shop identifier in the external management system (e.g., Tekmetric shop ID)	No
SHOP_MANAGEMENT_SYSTEM	String	External shop management system name	No
SHOP_PHONE	String	Shop phone number (e.g., +1 (715) 676-2914)	No
SHOP_WEBSITE	String	Shop website URL	No
SHOP_LOCATION_NUMBER	String	Location number within a multi-location tenant	No
SHOP_TIMEZONE	String	Shop timezone in IANA format (e.g., US/Central, US/Eastern). Use this to convert UTC timestamps to local time	Yes
SHOP_STATUS	String	Current operational status of the shop	Yes

Shop Address

Physical location details for the shop with optional geolocation.

Field Name	Data Type	Description	Required
SHOP_ADDRESS_ONE	String	Primary street address	No
SHOP_ADDRESS_TWO	String	Secondary address line (suite, unit, etc.)	No
SHOP_CITY	String	City name	No
SHOP_STATE	String	State or province (format varies: may be abbreviation like WI, CA or full name like Oklahoma)	No
SHOP_COUNTRY	String	Country name or code (format varies: may be full name like United States or code like US, CA)	No
SHOP_ZIPCODE	String	Postal/ZIP code	No
SHOP_LATITUDE	Number	Shop address latitude coordinate	No
SHOP_LONGITUDE	Number	Shop address longitude coordinate	No

Text/SMS Communication Settings

Configuration for SMS/text message sending from this shop.

Field Name	Data Type	Description	Required
TEXT_SETTING_PHONE_NUMBER	String	Phone number used for sending text messages	No
TEXT_CAMPAIGN_RULE_ENABLED	Boolean	Whether text campaign sending rules are active	No
TEXT_CAMPAIGN_RULE_MAX_COMMUNICATIONS_PER_DAY	Number	Maximum text messages a customer can receive per day	No
TEXT_CAMPAIGN_RULE_UNIQUE_COMMUNICATION_FOR_DAYS	Number	Minimum days between repeated text messages to the same customer	No
TEXT_SENDING_HOURS_LIMIT_ALLOWED_FROM	String	Earliest allowed time to send texts (e.g., 08:00:00)	No
TEXT_SENDING_HOURS_LIMIT_ALLOWED_TO	String	Latest allowed time to send texts (e.g., 21:00:00)	No
TEXT_SENDING_HOURS_LIMIT_DEFAULT_TIME	String	Default send time if outside allowed window (e.g., 10:00:00)	No

Email Communication Settings

Configuration for email sending from this shop.

Field Name	Data Type	Description	Required
EMAIL_SETTING_FROM_EMAIL	String	Email address used as the “from” address (e.g., shop slug)	No
EMAIL_SETTING_FROM_EMAIL_NAME	String	Display name used in email “from” field	No
EMAIL_CAMPAIGN_RULE_ENABLED	Boolean	Whether email campaign sending rules are active	No
EMAIL_CAMPAIGN_RULE_MAX_COMMUNICATIONS_PER_DAY	Number	Maximum emails a customer can receive per day	No
EMAIL_CAMPAIGN_RULE_UNIQUE_COMMUNICATION_FOR_DAYS	Number	Minimum days between repeated emails to the same customer	No
EMAIL_SENDING_HOURS_LIMIT_ALLOWED_FROM	String	Earliest allowed time to send emails (e.g., 00:00:00)	No
EMAIL_SENDING_HOURS_LIMIT_ALLOWED_TO	String	Latest allowed time to send emails (e.g., 1.00:00:00 for end of day)	No
EMAIL_SENDING_HOURS_LIMIT_DEFAULT_TIME	String	Default send time if outside allowed window (e.g., 09:00:00)	No

Integration

External shop management system synchronization details.

Field Name	Data Type	Description	Required
INTEGRATION_INITIAL_SYNC_STATUS	String	Status of the initial data synchronization from the management system	No
INTEGRATION_LAST_FETCH_DATETIME	Timestamp	When data was last fetched from the management system	No
INTEGRATION_LAST_SYNC_DATETIME	Timestamp	When data was last synchronized with the management system	No

System Metadata

Field Name	Data Type	Description	Required
SHOP_UPDATED_AT	Timestamp	Last modification timestamp for this shop record (UTC)	Yes

Field Enum Values

Shop Status

• Active: Shop is currently operational and accepting customers
• Inactive: Shop is no longer operational or has been deactivated

Shop Country

Country values vary in format across shops:

• US or United States: United States
• CA or Canada: Canada

Note

Country format is not normalized — some shops use two-letter codes while others use full names. Data consumers should handle both formats.

Integration Type

• Tekmetric: Tekmetric shop management platform
• ShopWare: ShopWare management system
• Protractor: Protractor shop management software
• MitchellOne: Mitchell1 shop management platform
• FullThrottle: FullThrottle management system
• Vast: Vast integration platform

Note

This list is not exhaustive. Additional management systems may be integrated over time.

Timestamp Handling

Caution

Timezone: The SHOP_UPDATED_AT, INTEGRATION_LAST_FETCH_DATETIME, and INTEGRATION_LAST_SYNC_DATETIME fields are stored in UTC. Use the SHOP_TIMEZONE field to convert to the shop’s local time when needed.

Data Quality Notes

Null Values

Note

Expected Null Values

• Address fields (SHOP_ADDRESS_ONE, SHOP_ADDRESS_TWO, SHOP_CITY, SHOP_STATE, SHOP_ZIPCODE) may be null if address information has not been provided
• SHOP_ADDRESS_TWO is commonly null when no secondary address line exists
• SHOP_LATITUDE and SHOP_LONGITUDE may be null if address geocoding has not been performed
• SHOP_WEBSITE and SHOP_LOCATION_NUMBER may be null based on shop configuration
• EXTERNAL_SHOP_ID and SHOP_MANAGEMENT_SYSTEM may be null if the shop has not been connected to a shop management system
• Integration sync fields may be null if no management system is connected
• TEXT_SETTING_PHONE_NUMBER may be null if text messaging has not been configured

Data Format Variations

Note

State and Country Formats

• SHOP_STATE: May contain either abbreviated (WI, CA, OH) or full state/province names (Oklahoma, New York). Format is not normalized
• SHOP_COUNTRY: May contain either codes (US, CA) or full names (United States, Canada). Data consumers should handle both formats

Sample Record

Complete API response example with a shop record:

{
  "data": [
    [
      "f2e3d4c5-b6a7-8901-2345-6789abcdef01",
      "Premier Auto - Corporate",
      "c3d4e5f6-a7b8-9012-3456-789abcdef012",
      "Premier Auto - Downtown",
      "12345",
      "Tekmetric",
      "+1 (212) 555-0123",
      null,
      null,
      "US/Eastern",
      "Active",
      "123 Main St",
      "Suite 4B",
      "New York",
      "NY",
      "United States",
      "10001",
      40.712776,
      -74.005974,
      null,
      true,
      2,
      7,
      "08:00:00",
      "21:00:00",
      "10:00:00",
      "premier-auto-downtown",
      "Premier Auto - Downtown",
      true,
      3,
      7,
      "00:00:00",
      "1.00:00:00",
      "09:00:00",
      null,
      null,
      null,
      "2026-03-10T05:00:01.701Z"
    ]
  ],
  "metadata": {
    "rowType": [
      {"name": "STEER_TENANT_ID", "type": "text"},
      {"name": "STEER_TENANT_NAME", "type": "text"},
      {"name": "STEER_SHOP_ID", "type": "text"},
      {"name": "STEER_SHOP_NAME", "type": "text"},
      {"name": "EXTERNAL_SHOP_ID", "type": "text"},
      {"name": "SHOP_MANAGEMENT_SYSTEM", "type": "text"},
      {"name": "SHOP_PHONE", "type": "text"},
      {"name": "SHOP_WEBSITE", "type": "text"},
      {"name": "SHOP_LOCATION_NUMBER", "type": "text"},
      {"name": "SHOP_TIMEZONE", "type": "text"},
      {"name": "SHOP_STATUS", "type": "text"},
      {"name": "SHOP_ADDRESS_ONE", "type": "text"},
      {"name": "SHOP_ADDRESS_TWO", "type": "text"},
      {"name": "SHOP_CITY", "type": "text"},
      {"name": "SHOP_STATE", "type": "text"},
      {"name": "SHOP_COUNTRY", "type": "text"},
      {"name": "SHOP_ZIPCODE", "type": "text"},
      {"name": "SHOP_LATITUDE", "type": "real"},
      {"name": "SHOP_LONGITUDE", "type": "real"},
      {"name": "TEXT_SETTING_PHONE_NUMBER", "type": "text"},
      {"name": "TEXT_CAMPAIGN_RULE_ENABLED", "type": "boolean"},
      {"name": "TEXT_CAMPAIGN_RULE_MAX_COMMUNICATIONS_PER_DAY", "type": "fixed"},
      {"name": "TEXT_CAMPAIGN_RULE_UNIQUE_COMMUNICATION_FOR_DAYS", "type": "fixed"},
      {"name": "TEXT_SENDING_HOURS_LIMIT_ALLOWED_FROM", "type": "text"},
      {"name": "TEXT_SENDING_HOURS_LIMIT_ALLOWED_TO", "type": "text"},
      {"name": "TEXT_SENDING_HOURS_LIMIT_DEFAULT_TIME", "type": "text"},
      {"name": "EMAIL_SETTING_FROM_EMAIL", "type": "text"},
      {"name": "EMAIL_SETTING_FROM_EMAIL_NAME", "type": "text"},
      {"name": "EMAIL_CAMPAIGN_RULE_ENABLED", "type": "boolean"},
      {"name": "EMAIL_CAMPAIGN_RULE_MAX_COMMUNICATIONS_PER_DAY", "type": "fixed"},
      {"name": "EMAIL_CAMPAIGN_RULE_UNIQUE_COMMUNICATION_FOR_DAYS", "type": "fixed"},
      {"name": "EMAIL_SENDING_HOURS_LIMIT_ALLOWED_FROM", "type": "text"},
      {"name": "EMAIL_SENDING_HOURS_LIMIT_ALLOWED_TO", "type": "text"},
      {"name": "EMAIL_SENDING_HOURS_LIMIT_DEFAULT_TIME", "type": "text"},
      {"name": "INTEGRATION_INITIAL_SYNC_STATUS", "type": "text"},
      {"name": "INTEGRATION_LAST_FETCH_DATETIME", "type": "timestamp_ntz"},
      {"name": "INTEGRATION_LAST_SYNC_DATETIME", "type": "timestamp_ntz"},
      {"name": "SHOP_UPDATED_AT", "type": "timestamp_ntz"}
    ]
  }
}