Business Location
Status: Trusted Tester
Any entity that works with a provider company (two-way communication). These generally have a sustained relationship with the provider company. This may include a potential buyer, an existing client, or a past client that has churned.
AG-1234567Possible values: [businessLocations]
businessLocationsattributes object
A value assigned by the business partner to reference this business location. Customer ID is currently NOT enforced to be unique, and there may be negative side effects to having a duplicate and/or changing a customer ID, specifically around legacy SSO. Use caution when editing a customer ID.
The common name for this location.
Note: The pipe character (|) is not allowed.
Possible values: non-empty, Value must match regular expression ^[^|]+$
address object
The primary information. Typically a street address.
109 8th Street E.An additional line of information to add after the street address.
Suite 23Deprecated - This field has been replaced by regionCode. The two letter state code within the country
Possible values: >= 2 characters and <= 2 characters
CADeprecated - This field has been renamed postalCode
The zip code or postal code component of an address.
S7M 1R3The code for the top level subdivision within the country (state/province). For more info see the Addresses guide
Examples: CA-SK, US-FL, AG-08, AU-NSW
Possible values: >= 4 characters and <= 6 characters, Value must match regular expression ^[A-Z]{2}-[\w]{1,3}$
CA-SKThe two letter country code. For more info see the Addresses guide
Examples: CA, US, AU
Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$
CAThe standard phone numbers for the location. Formatting characters may be included.
Extensions
It is recommended that extensions are included at the end of the number after an appropriate separator: Pause: , Wait: ; Default: ext.
You may test the parsibility of a number using https://phonenumbers.temba.io/ All phone numbers are assumed to be in the same country as this business location.
Possible values: <= 3
When true the address will be used as the center of the area that this location services instead of being displayed.
geoCoordinate object
The point where the map pin for the location should be displayed.
The values will not be automatically updated when the address is updated. If not provided when creating the location they will be initialized based on the address.
It is expressed as a pair of numbers to represent degrees latitude and degrees longitude in accordance with the WGS84 standard (the one used by your GPS).
Possible values: >= -90 and <= 90
Possible values: >= -180 and <= 180
hours object[]nullable
The operating hours for the business location. Each entry in the array is a set of hours for a particular department or customer of the business. It is recommended to provide the general hours for all locations. Some locations may have additional definitions for other departments.
The category of hours that may apply to a specific department or service. Not all types are valid for all business categories.
The general hours for a location must be set before defining hours for other departments.
Currently only general is supported in the Vendasta platform. We intend to add others in the future.
Possible values: [general, delivery, kitchen, driveThrough, pickup, takeout]
regularHours object[]nullable
A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
You may specify multiple entries for the same date if you are open for multiple periods (Example lunch and supper).
Indicates the day of the week that this period starts on.
Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]
wednesdayIndicates the day of the week that this period ends on. It should be the same as openDay except when the period goes over midnight. The total period may not be more than 24 hours.
Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]
wednesdayValid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.
Possible values: Value must match regular expression ^\d{2}:\d{2}$
09:45Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.
Possible values: Value must match regular expression ^\d{2}:\d{2}$
09:45specialHours object[]nullable
Represents a set of time periods when a location's operational hours differ from its regular business hours. This may be a holiday or special event. These hours replace the regular hours for the day.
A special hour period must represent a range of less than 24 hours. The openTime and startDate must predate the closeTime and endDate.
The closeTime and endDate can extend to 11:59 a.m. on the day after the specified startDate.
Note: Most listing sites only support special hours for the general type.
Describes the different modes that apply to special hour periods. Currently only open and closed are supported in the Vendasta platform. Overlapping open and closed periods are not allowed. When status is open, for the given business it will be open for the mentioned time period for the selected date. When status is closed, for the given business it will be closed for the selected date.
Possible values: [open, closed]
The calendar date this special hour period starts on.
The calendar date this special hour period ends on. If endDate field is not set, default to the date specified in startDate. If set, this field must be equal to or at most 1 day after startDate.
Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.
Possible values: Value must match regular expression ^\d{2}:\d{2}$
09:45Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field.
Possible values: Value must match regular expression ^\d{2}:\d{2}$
09:45The time at which the business locations was last updated
The toll free number for the business.
A call tracking number is a phone number that gathers analytics for inbound calls. Call tracking is commonly used as a method of performance assessment for marketing campaigns.
Possible values: <= 6
Other names that your business is commonly called (Ex. Patty's Irish Pub referred to as Patty's or Patty's Pub).
Possible values: <= 3
The primary language in which this business operates, as a BCP 47 language tag (e.g. "en", "it", "fr-CA"). Mirrored from the salesAccounts record; set it there to change it. Returns "en" when unset.
enrelationships object
businessPartner object
A link to the organization that provides the platform to this business location.
data objectrequired
Possible values: [partners]
partnersABCbusinessCategories object
A list of the types of business this location should be compared against. The first item on the list will be considered as the primary category. If not set during creation it will default "other".
data object[]
Possible values: <= 3
Possible values: [businessCategories]
businessCategoriesbusinessCategoriesactive:diving:freediving{
"id": "AG-1234567",
"type": "businessLocations",
"attributes": {
"customerIdentifier": "string",
"name": "string",
"address": {
"line1": "109 8th Street E.",
"line2": "Suite 23",
"city": "string",
"postalCode": "S7M 1R3",
"regionCode": "CA-SK",
"countryCode": "CA"
},
"phoneNumbers": [
"string"
],
"serviceAreaBusiness": true,
"geoCoordinate": {
"latitude": 0,
"longitude": 0
},
"hours": [
{
"hoursTypeId": "general",
"regularHours": [
{
"openDay": "wednesday",
"closeDay": "wednesday",
"openTime": "09:45",
"closeTime": "09:45"
}
],
"specialHours": [
{
"startDate": "2024-07-29",
"endDate": "2024-07-29",
"startTime": "09:45",
"endTime": "09:45"
}
]
}
],
"updatedAt": "string",
"tollFreeNumber": "string",
"trackingNumbers": [
"string"
],
"commonNames": [
"string"
],
"primaryOperatingLanguage": "en"
},
"relationships": {
"businessPartner": {
"data": {
"type": "partners",
"id": "ABC"
}
},
"businessCategories": {
"data": [
{
"type": "businessCategories",
"id": "active:diving:freediving"
}
]
}
}
}