Location

Location

Represents a location in the system

Kind: Object

Fields

Field Type Description
cashEnabled Boolean! Whether cash payments are enabled for this location
city String City
companyId ID! The company this location belongs to
createdAt DateTime! Timestamp when the location was created
externalId String External system identifier for the location
id ID! Unique identifier for the location
interiorEnabled Boolean! Whether the interior cleaning queue is enabled for this location
isVirtual Boolean! Whether this is a virtual location
name String! Display name of the location
shortName String Short display name of the location
state USStateCode State or province
street String Street address
stripeAccountId String! The Stripe account ID used by this location
stripeTerminalLocationId String Stripe terminal location ID
taxEnabled Boolean! Whether tax calculation is enabled for this location
timezone String! Location timezone
tipsEnabled Boolean! Whether tips are enabled for this location
updatedAt DateTime! Timestamp when the location was last updated
zip USPostalCode ZIP or postal code

Definition

"""Represents a location in the system"""
type Location {
  """Whether cash payments are enabled for this location"""
  cashEnabled: Boolean!
  """City"""
  city: String
  """The company this location belongs to"""
  companyId: ID!
  """Timestamp when the location was created"""
  createdAt: DateTime!
  """External system identifier for the location"""
  externalId: String
  """Unique identifier for the location"""
  id: ID!
  """Whether the interior cleaning queue is enabled for this location"""
  interiorEnabled: Boolean!
  """Whether this is a virtual location"""
  isVirtual: Boolean!
  """Display name of the location"""
  name: String!
  """Short display name of the location"""
  shortName: String
  """State or province"""
  state: USStateCode
  """Street address"""
  street: String
  """The Stripe account ID used by this location"""
  stripeAccountId: String!
  """Stripe terminal location ID"""
  stripeTerminalLocationId: String
  """Whether tax calculation is enabled for this location"""
  taxEnabled: Boolean!
  """Location timezone"""
  timezone: String!
  """Whether tips are enabled for this location"""
  tipsEnabled: Boolean!
  """Timestamp when the location was last updated"""
  updatedAt: DateTime!
  """ZIP or postal code"""
  zip: USPostalCode
}