Public API for Catering Partne...
Caterers API
Caterer Schema Reference
8 min
caterer schema reference objects address an address record can be for users, caterers, brands, etc field name description city docid\ u2uigsyo0gfpxj 5tuif0 the name of the city where the address is located deliveryinstructions docid\ u2uigsyo0gfpxj 5tuif0 specific instructions provided for the delivery, such as parking details or particular points of entry name docid\ u2uigsyo0gfpxj 5tuif0 the name associated with the address, which could be a business name or a contact person state docid\ u2uigsyo0gfpxj 5tuif0 the two letter abbreviation for the state in which the address is located (e g , ma for massachusetts) statename docid\ u2uigsyo0gfpxj 5tuif0 the full name of the state corresponding to the address (e g , massachusetts) street docid\ u2uigsyo0gfpxj 5tuif0 the primary street address or street line 1 street2 docid\ u2uigsyo0gfpxj 5tuif0 the secondary street address or street line 2, used for additional address components such as apartment or suite numbers street3 docid\ u2uigsyo0gfpxj 5tuif0 an additional address field for further granularity, often used for large complexes or extended addresses zip docid\ u2uigsyo0gfpxj 5tuif0 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 address docid\ u2uigsyo0gfpxj 5tuif0 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 docid\ u2uigsyo0gfpxj 5tuif0 indicates whether an the caterer location is currently active, or operational name docid\ u2uigsyo0gfpxj 5tuif0 the name associated with the caterer location storenumber docid\ u2uigsyo0gfpxj 5tuif0 a unique identifier assigned to each store it is used to differentiate between different stores in a chain or franchise uuid docid\ u2uigsyo0gfpxj 5tuif0 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 { "endpoint" "https //app archbee com/api/graphql", "query" "{\n status,\n people\n}" }