Caterer Schema Reference
Objects
Address
An address record. Can be for users, caterers, brands, etc.
Field Name | Description |
| The name of the city where the address is located. |
| Specific instructions provided for the delivery, such as parking details or particular points of entry. |
| The name associated with the address, which could be a business name or a contact person. |
| The two-letter abbreviation for the state in which the address is located (e.g., MA for Massachusetts). |
| The full name of the state corresponding to the address (e.g., Massachusetts). |
| The primary street address or street line 1. |
| The secondary street address or street line 2, used for additional address components such as apartment or suite numbers. |
| An additional address field for further granularity, often used for large complexes or extended addresses. |
| The postal code for the address location. |
Example
{
"city": "Boston",
"deliveryInstructions": null,
"name": "",
"state": "MA",
"stateName": "Massachusetts",
"street": "12345 Restaurant Avenue",
"street2": null,
"street3": null,
"zip": "54321"
}
Caterer
Return type of Caterer, representing a specific location providing catering.
Field Name | Description |
| The physical location or mailing address of a store or entity, which can include various subfields such as street, city, state, and zip code |
| Indicates whether an the caterer location is currently active, or operational. |
| The name associated with the caterer location. |
| A unique identifier assigned to each store. It is used to differentiate between different stores in a chain or franchise. |
|
|
Example
{
"address": Address,
"live": true,
"name": "My Caterer Name",
"storeNumber": "00001",
"uuid": "ezcater-caterer-id"
}
Scalars
Boolean
The Boolean scalar type represents true or false.
ID
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
UUID
Universally unique identifier as defined by RFC 4122