Get Location

v1.0.0

Use this endpoint to return a Location object. A valid business location id is required. Find all location id's by using the GET /consumer/v1/locations endpoint.

IMPORTANT DEPRECATION NOTICE: The following online settings parameters were intended for internal use in our Portal application only. They will be deprecated on OCTOBER 15, 2022. These fields are currently part of the SETTINGS object in all location endpoints: businessId, enabled, familyMembersEnabled, serviceLabel, resourceLabel, resourceAnyLabel, resourceSelection, liveMode, formFlow, availabilityForm, showServiceGroups, showOnSchedLogo, showBusinessLogo, disableAuthorization, hideNavBar, hideLocationNav, hideServiceGroupsNav, hideServicesNav, hideContinueBooking, returnToService, returnToAvailability, hideBreadCrumbNav. If you are using these fields, please adjust your code to handle the deprecation or let us know by submitting a ticket to: [email protected] as we do not want to interrupt your existing workflows.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "address": {
      "type": "object",
      "properties": {
        "addressLine1": {
          "type": "string"
        },
        "addressLine2": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        },
        "state": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "adminEmail": {
      "type": "string"
    },
    "adminName": {
      "type": "string"
    },
    "appointmentReminders": {
      "type": "object",
      "properties": {
        "emailFirstReminder": {
          "type": "integer",
          "format": "int32"
        },
        "emailFirstReminderInterval": {
          "type": "integer",
          "format": "int32"
        },
        "emailSecondReminder": {
          "type": "integer",
          "format": "int32"
        },
        "emailSecondReminderInterval": {
          "type": "integer",
          "format": "int32"
        },
        "smsFirstReminder": {
          "type": "integer",
          "format": "int32"
        },
        "smsFirstReminderInterval": {
          "type": "integer",
          "format": "int32"
        },
        "smsSecondReminder": {
          "type": "integer",
          "format": "int32"
        },
        "smsSecondReminderInterval": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "businessHolidays": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "businessClosed": {
            "type": "boolean"
          },
          "holidayName": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "publicHolidayId": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      }
    },
    "businessHours": {
      "type": "object",
      "properties": {
        "fri": {
          "type": "object",
          "properties": {
            "endTime": {
              "type": "integer",
              "format": "int32"
            },
            "is24Hours": {
              "type": "boolean"
            },
            "isOpen": {
              "type": "boolean"
            },
            "startTime": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        },
        "mon": {
          "type": "object",
          "properties": {
            "endTime": {
              "type": "integer",
              "format": "int32"
            },
            "is24Hours": {
              "type": "boolean"
            },
            "isOpen": {
              "type": "boolean"
            },
            "startTime": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        },
        "sat": {
          "type": "object",
          "properties": {
            "endTime": {
              "type": "integer",
              "format": "int32"
            },
            "is24Hours": {
              "type": "boolean"
            },
            "isOpen": {
              "type": "boolean"
            },
            "startTime": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        },
        "sun": {
          "type": "object",
          "properties": {
            "endTime": {
              "type": "integer",
              "format": "int32"
            },
            "is24Hours": {
              "type": "boolean"
            },
            "isOpen": {
              "type": "boolean"
            },
            "startTime": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        },
        "thu": {
          "type": "object",
          "properties": {
            "endTime": {
              "type": "integer",
              "format": "int32"
            },
            "is24Hours": {
              "type": "boolean"
            },
            "isOpen": {
              "type": "boolean"
            },
            "startTime": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        },
        "tue": {
          "type": "object",
          "properties": {
            "endTime": {
              "type": "integer",
              "format": "int32"
            },
            "is24Hours": {
              "type": "boolean"
            },
            "isOpen": {
              "type": "boolean"
            },
            "startTime": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        },
        "wed": {
          "type": "object",
          "properties": {
            "endTime": {
              "type": "integer",
              "format": "int32"
            },
            "is24Hours": {
              "type": "boolean"
            },
            "isOpen": {
              "type": "boolean"
            },
            "startTime": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "companyId": {
      "type": "string"
    },
    "companyName": {
      "type": "string"
    },
    "defaults": {
      "type": "object",
      "properties": {
        "autoUpdateCustomer": {
          "type": "boolean"
        },
        "businessNotification": {
          "type": "boolean"
        },
        "customerCity": {
          "type": "boolean"
        },
        "customerState": {
          "type": "boolean"
        },
        "emailInfo": {
          "type": "boolean"
        },
        "enableUtcTimezone": {
          "type": "boolean"
        },
        "object": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "email": {
      "type": "string"
    },
    "fax": {
      "type": "string"
    },
    "friendlyId": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "imageUrl": {
      "type": "string"
    },
    "latitude": {
      "type": "number",
      "format": "double"
    },
    "logo": {
      "type": "string"
    },
    "longitude": {
      "type": "number",
      "format": "double"
    },
    "name": {
      "type": "string"
    },
    "object": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "primaryBusiness": {
      "type": "boolean"
    },
    "primaryCalendarId": {
      "type": "string"
    },
    "regionId": {
      "type": "string"
    },
    "services": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "object": {
            "type": "string"
          },
          "serviceId": {
            "type": "integer",
            "format": "int32"
          },
          "serviceName": {
            "type": "string"
          }
        },
        "additionalProperties": false
      }
    },
    "settings": {
      "type": "object",
      "properties": {
        "availabilityForm": {
          "type": "integer",
          "format": "int32"
        },
        "bookAheadUnit": {
          "type": "integer",
          "format": "int32"
        },
        "bookAheadValue": {
          "type": "integer",
          "format": "int32"
        },
        "bookInAdvance": {
          "type": "integer",
          "format": "int32"
        },
        "bookWithAccount": {
          "type": "boolean"
        },
        "bookingConfirmationMessage": {
          "type": "string"
        },
        "bookingMessage": {
          "type": "string"
        },
        "bookingPolicy": {
          "type": "string"
        },
        "bookingTimerMins": {
          "type": "integer",
          "format": "int32"
        },
        "businessId": {
          "type": "string"
        },
        "companyId": {
          "type": "string"
        },
        "customerBookingsPerDay": {
          "type": "integer",
          "format": "int32"
        },
        "customerVerification": {
          "type": "boolean"
        },
        "defaultService": {
          "type": "boolean"
        },
        "defaultToCustomerTimezone": {
          "type": "boolean"
        },
        "disableAuthorization": {
          "type": "boolean"
        },
        "enableWorldTimezones": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "familyMembersEnabled": {
          "type": "boolean"
        },
        "firstAvailable": {
          "type": "boolean"
        },
        "formFlow": {
          "type": "integer",
          "format": "int32"
        },
        "hideBreadCrumbNav": {
          "type": "boolean"
        },
        "hideContinueBooking": {
          "type": "boolean"
        },
        "hideLocationNav": {
          "type": "boolean"
        },
        "hideNavBar": {
          "type": "boolean"
        },
        "hideServiceGroupsNav": {
          "type": "boolean"
        },
        "hideServicesNav": {
          "type": "boolean"
        },
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "lateCancelAction": {
          "type": "integer",
          "format": "int32"
        },
        "lateCancelHours": {
          "type": "integer",
          "format": "int32"
        },
        "lateRescheduleAction": {
          "type": "integer",
          "format": "int32"
        },
        "lateRescheduleHours": {
          "type": "integer",
          "format": "int32"
        },
        "liveMode": {
          "type": "boolean"
        },
        "locationId": {
          "type": "string"
        },
        "object": {
          "type": "string"
        },
        "resourceAnyLabel": {
          "type": "string"
        },
        "resourceLabel": {
          "type": "string"
        },
        "resourceSelection": {
          "type": "boolean"
        },
        "returnToAvailability": {
          "type": "boolean"
        },
        "returnToService": {
          "type": "boolean"
        },
        "serviceLabel": {
          "type": "string"
        },
        "showBusinessLogo": {
          "type": "boolean"
        },
        "showOnSchedLogo": {
          "type": "boolean"
        },
        "showServiceGroups": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "timezoneIana": {
      "type": "string"
    },
    "timezoneId": {
      "type": "string"
    },
    "timezoneOffset": {
      "type": "integer",
      "format": "int32"
    },
    "travel": {
      "type": "object",
      "properties": {
        "distance": {
          "type": "string"
        },
        "proximity": {
          "type": "string"
        },
        "startAddress": {
          "type": "string"
        },
        "startLat": {
          "type": "string"
        },
        "startLon": {
          "type": "string"
        },
        "units": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "website": {
      "type": "string"
    }
  },
  "additionalProperties": false
}