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
  ]
}
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.

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.

Address

The address information for the store.

JSON representation 
{
  "streetAddress": string,
  "city": string,
  "state": string,
  "country": string,
  "postalCode": string,
  "latitude": number,
  "longitude": number,
  "googleMapsUrl": string
}
Fields
streetAddress

string

Optional. The street address of the store.
city

string

Optional. The city of the store.
state

string

Optional. The state of the store.
country

string

Optional. The country of the store.
postalCode

string

Optional. The postal code of the store.
latitude

number

Optional. The latitude of the store.
longitude

number

Optional. The longitude of the store.
googleMapsUrl

string

Optional. The Google Maps URL for the store.

StoreHours

The operating hours of the store.

JSON representation 
{
  "fulfillmentMethod": enum (FulfillmentMethod),
  "schedules": [
    {
      object (Schedule)
    }
  ]
}
Fields
fulfillmentMethod

enum (FulfillmentMethod)

Optional. The fulfillment method of the store hours, for instance "PICKUP", "DELIVERY", etc. If unspecified, the store hours are assumed to be applicable to all fulfillment methods.
schedules[]

object (Schedule)

Optional. The operating hours for the store for the specified fulfillmentMethod.

Daypart

A daypart for the store.

JSON representation 
{
  "id": string,
  "schedules": [
    {
      object (Schedule)
    }
  ],
  "displayName": string
}
Fields
id

string

Optional. The day part id, for instance "BREAKFAST", "LUNCH", etc.
schedules[]

object (Schedule)

Optional. Daypart active hours.
displayName

string

Optional. Specifies an optional display name for this daypart.

Methods

batchDelete

 Batch deletes 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.