Request to GetMenu.
| Field | Type | Label | Description |
| name | string | The ID of the menu resource to retrieve. |
A store resource.
| Field | Type | Label | Description |
| id | int64 | A unique id. |
|
| description | string | A description of the menu |
Get information about store menus.
| Method Name | Request Type | Response Type | Description |
| GetMenu | GetMenuRequest | Menu | Returns a menu for a specific store. |
| Method Name | Method | Pattern | Body |
| GetMenu | GET | /v1/menus/{name=store} |
An address.
| Field | Type | Label | Description |
| street | string | Street address |
|
| city | string | City |
|
| state | string | State |
|
| zip_code | int32 | Zip code |
|
| region_code | string | Country |
|
| county | string | County |
A bounding box in terrestrial coordinates.
| Field | Type | Label | Description |
| max | Location | Maximum coordinate values. |
|
| min | Location | Minimum coordinate values. |
Request to FindStores.
| Field | Type | Label | Description |
| bounds | BoundingBox | Bounding box of the request. |
|
| limit | int32 | Maximum number of results to return. |
Response from FindStores.
| Field | Type | Label | Description |
| count | int32 | Number of matching stores. |
|
| stores | Store | repeated | Matching stores. |
Request to GetStore.
| Field | Type | Label | Description |
| name | string | The ID of the store resource to retrieve. |
Request to ListStores.
| Field | Type | Label | Description |
| page_size | int32 | Page size. |
|
| page_token | string | Pagination token. |
Response from ListStores.
| Field | Type | Label | Description |
| stores | Store | repeated | List of stores. |
| next_page_token | string | Token of next page. |
A location in terrestrial coordinates.
| Field | Type | Label | Description |
| latitude | float | Latitude of the location. |
|
| longitude | float | Longitude of the location. |
A store.
| Field | Type | Label | Description |
| name | string | A unique id (e.g. store number) |
|
| type | string | An identifier indicating the type of store |
|
| title | string | Store name (human-readable) |
|
| location | Location | Store location |
|
| address | Address | Store address |
|
| store_hours | string | Store hours |
Get stores and related information.
| Method Name | Request Type | Response Type | Description |
| ListStores | ListStoresRequest | ListStoresResponse | List all stores. |
| FindStores | FindStoresRequest | FindStoresResponse | Returns a list of all stores in a specified region. |
| GetStore | GetStoreRequest | Store | Returns a specific store. |
| Method Name | Method | Pattern | Body |
| ListStores | GET | /v1/stores | |
| FindStores | GET | /v1/stores:find | |
| GetStore | GET | /v1/stores/{name=store} |
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |