Metadata associated with an outlet for use by a third party remote order provider.
Required
outletID :
string (GUID)
The unique identifier for this outlet
Required
revisionID :
number (int)
An identifier for the configuration revision of this outlet. This value will change whenever any referenced fields change.
There is no relationship between the values and how "current" the revision is (treat it as you would a hash code)
This can be used by providers to compare outlets (with the same OutletID) across multiple requests.
Nullable
MaxLength(64)
outletName :
string
Descriptive name of this outlet. Can be null/empty
Nullable
addressLines :
string
[]
The address lines where this outlet can be found. Each line is 64 chars max. Can be null / empty
Nullable
MaxLength(64)
emailAddress :
string
The email address shown on receipts for this outlet. Can be null / empty
Nullable
MaxLength(64)
phoneNumber :
string
The phone number shown on receipts for this outlet. Can be null / empty
Nullable
MaxLength(64)
websiteUri :
string
The website shown on receipts for this outlet. Can be null / empty
Nullable
MaxLength(64)
taxBusinessNumber :
string
The identifier for this outlet as defined by their local tax agency that is shown on receipts. Can be null / empty
Nullable
latitude :
number (decimal)
WGS:84 / EPSG:4326 Latitude of the location of this particular outlet (if registered). Only valid if Longitude is also defined. Ranges from -90 to 90
Nullable
longitude :
number (decimal)
WGS:84 / EPSG:4326 Longitude of the location of this particular outlet (if registered). Only valid if Latitude is also defined. Ranges from -180 to 180
Nullable
MaxLength(64)
timeZoneName :
string
The name of the timezone that this outlet operates under. The name will be a valid "tz database" name
Example for Perth, Australia: Australia/Perth
Example for London, UK: Europe/London
See https://www.iana.org/time-zones
See https://en.wikipedia.org/wiki/Tz_database
Example
{
"outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"revisionID": 321,
"outletName": "string value",
"addressLines": ["string value"],
"emailAddress": "string value",
"phoneNumber": "string value",
"websiteUri": "string value",
"taxBusinessNumber": "string value",
"latitude": 1.23,
"longitude": 1.23,
"timeZoneName": "string value"
}