REST Resource: projects.locations.brands.stores

Resource: Store

An individual store for a brand.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "status": {
    object (StoreStatus)
  },
  "timeZone": {
    object (TimeZone)
  },
  "storeMetadata": {
    object (StoreMetadata)
  },
  "tags": [
    string
  ],
  "integrationAttributes": {
    object
  },
  "ownershipType": enum (OwnershipType)
}
Fields
name

string

Identifier. The store name. Format: projects/{project}/locations/{location}/brands/{brand}/stores/{store}
createTime

string (Timestamp format)

Output only. The time this store was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time this store was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
status

object (StoreStatus)

Required. The status of the store.
timeZone

object (TimeZone)

Required. The time zone of the store. This is used to determine which menu daypart to use for the store at a given time and for any time-based overrides.
storeMetadata

object (StoreMetadata)

Optional. Metadata for the store.
tags[]

string

Optional. Tags associated with the store.
integrationAttributes

object (Struct format)

Optional. Free-form key-value pairs for brand-specific integration attributes.
ownershipType

enum (OwnershipType)

Optional. The ownership type of the store.

StoreStatus

The status of the store.

JSON representation 
{
  "state": enum (State)
}
Fields
state

enum (State)

Optional. The state of the store.

State

The status of the store.

Enums
STATE_UNSPECIFIED The store is in an unspecified state.
ACTIVE The store is active.
DISABLED The store is disabled.

StoreMetadata

Metadata for the store.

JSON representation 
{
  "displayName": string,
  "contactEmail": string,
  "address": {
    object (Address)
  },
  "storeHours": [
    {
      object (StoreHours)
    }
  ],
  "dayparts": [
    {
      object (Daypart)
    }
  ],
  "phoneNumber": string
}
Fields
displayName

string

Optional. The display name of the store to be used in UI and customer-facing elements.
contactEmail

string

Optional. The email address of the store to be provided to customers.
address

object (Address)

Optional. The address information for the store.
storeHours[]

object (StoreHours)

Optional. The open hours of the store.
dayparts[]

object (Daypart)

Optional. Dayparts defined for the store.
phoneNumber

string

Optional. The main phone number of the store to take orders, ask for catering, make general inquiries, and make reservations.

OwnershipType

The ownership type of the store.

Enums
OWNERSHIP_TYPE_UNSPECIFIED Unspecified ownership type.
CORPORATE A company-owned corporate store.
FRANCHISE A franchisee-owned store.

Methods

batchDelete

 Batch deletes stores.

batchGet

 Batch gets stores.

batchUpdate

 Batch updates stores.

create

 Creates a store.

delete

 Deletes the specified store.

get

 Gets a store.

list

 Lists stores.

patch

 Update the specified store.