Caterer Schema Reference

8 min

Caterer Schema Reference

Objects

Address

An address record. Can be for users, caterers, brands, etc.

Field Name	Description
city: String!	The name of the city where the address is located.
deliveryInstructions: String	Specific instructions provided for the delivery, such as parking details or particular points of entry.
name: String	The name associated with the address, which could be a business name or a contact person.
state: String!	The two-letter abbreviation for the state in which the address is located (e.g., MA for Massachusetts).
stateName: String	The full name of the state corresponding to the address (e.g., Massachusetts).
street: String!	The primary street address or street line 1.
street2: String	The secondary street address or street line 2, used for additional address components such as apartment or suite numbers.
street3: String	An additional address field for further granularity, often used for large complexes or extended addresses.
zip: String	The postal code for the address location.

{
  "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
address: Address	The physical location or mailing address of a store or entity, which can include various subfields such as street, city, state, and zip code
live: Boolean!	Indicates whether an the caterer location is currently active, or operational.
name: String!	The name associated with the caterer location.
storeNumber: String	A unique identifier assigned to each store. It is used to differentiate between different stores in a chain or franchise.
uuid: UUID!

{
  "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

https://app.archbee.com/api/graphql

{
  status,
  people
}