Common Schema

This document defines field groups that appear across multiple exports. Instead of repeating these fields in every schema, we reference them here to keep documentation concise and maintainable.

---

Client Information

Standard client identification fields present in all exports.

Column Name	Data Type	Description
ClientId	int	Client identifier
ClientName	varchar	Name of the client
ClientCode	varchar	Code of the client

---

Location Information

Standard location/outlet fields that appear in location-related exports.

Column Name	Data Type	Description
LocationId	int	Unique identifier for the location/outlet
Name	varchar	Location name
Code	varchar	Location code
ExternalLocationCode	varchar	External system location code
Street	varchar	Primary street address
Street2	varchar	Street address line 2
Street3	varchar	Street address line 3
City	varchar	City name
PostalCode	varchar	Postal/ZIP code
Latitude	decimal(18,2)	GPS latitude coordinate for mapping
Longitude	decimal(18,2)	GPS longitude coordinate for mapping
StateId	int	State/province identifier
State	varchar	State/province name
CountryId	int	Country identifier
Country	varchar	Country name
MarketId	int	Market identifier
MarketName	varchar	Market name
ChannelId	int	Location type/channel identifier
Channel	varchar	Location type/channel name (e.g., Retail, Wholesale)
ClassificationId	int	Location classification identifier
Classification	varchar	Location classification name
TimeZoneId	int	Timezone identifier
TimeZone	varchar	Timezone display name

---

Product Information

Standard product fields that appear in product-related exports.

Column Name	Data Type	Description
ProductId	int	Unique product identifier
Product	varchar	Product name
ShortName	varchar	Product short name
SKU	varchar	Stock Keeping Unit code
ExternalProductCode	varchar	External system product code
UPC	varchar	Universal Product Code (barcode)
ProductGTIN	varchar	Global Trade Item Number
BrandId	int	Brand identifier
Brand	varchar	Brand name
ProductCategoryId	int	Product category identifier
ProductCategory	varchar	Product category name
ProductCategory2Id	int	Secondary product category identifier
ProductCategory2	varchar	Secondary product category name
ProductTypeId	int	Product type identifier
ProductType	varchar	Product type name
IsKeyProduct	bit	Key product flag
IsForeignProduct	bit	Foreign/competitor product flag

---

Asset Information

Standard asset/cooler fields that appear in asset-related exports.

Column Name	Data Type	Description
AssetId	int	Unique asset identifier
AssetSerialNumber	varchar	Physical asset serial number printed on device
ExternalAssetCode	varchar	External system asset code
AssetTypeId	int	Asset type identifier
AssetType	varchar	Asset type name (e.g., Cooler, Refrigerator)
PlanogramId	int	Assigned planogram identifier
PlanogramName	varchar	Planogram name
ExternalPlanogramCode	varchar	External system planogram code

---

Smart Device Information

Standard smart device/sensor fields that appear in IoT-related exports.

Column Name	Data Type	Description
SmartDeviceId	int	Unique smart device identifier
SmartDeviceSerialNumber	varchar	Smart device serial number
SmartDeviceType	varchar	Smart device type name (e.g., Camera, Sensor)
MacAddress	varchar	Device MAC address
SmartDeviceMacAddress	varchar	Alternative field name for MAC address

---

Audit Fields

Standard audit/tracking fields that appear in most exports.

Column Name	Data Type	Description
IsDeleted	bit	Soft delete flag (0=Active, 1=Deleted)
CreatedOn	datetime	Timestamp when record was created
ModifiedOn	datetime	Timestamp when record was last modified ⭐ Critical for delta processing
CreatedBy	varchar	Username of user who created the record
ModifiedBy	varchar	Username of user who last modified the record
CreatedByUser	varchar	Alternative field name for creator username
ModifiedByUser	varchar	Alternative field name for modifier username

⭐ ModifiedOn is critical for delta processing - this field determines which records are included in incremental exports.

---

Geographic Information

Standard geographic/regional fields.

Column Name	Data Type	Description
StateId	int	State/province identifier
State	varchar	State/province name
CountryId	int	Country identifier
Country	varchar	Country name

---

Usage in Schema Documentation

When a schema document includes these common field groups, you'll see a reference like:

📋 Includes: Client Information, Location Information, Audit Fields

This indicates that all fields from those sections are present in the export, in addition to the export-specific fields documented in that schema.