Public API
The CaterCow Public API provides endpoints primarily for fetching public resources such as packages, brands, menus, business hours, delivery areas, reviews, and more. These endpoints are designed to be mostly read-only and do not typically require authentication, making them accessible for general browsing and discovery. This allows users and applications to retrieve information about available catering options, menu items, and other public data without needing to log in. Some endpoints may be deprecated or have limited write capabilities, but the majority focus on providing open access to public-facing data.
V1
The Public V1 API documentation can be found here.
Business Hours
- Get the business hours for a specific caterer.
Caterers [deprecated]
- Get a list of all active caterers, with options to filter by place or search by name.
- Retrieve information about a particular brand.
Cause Updates [deprecated]
- Fetch all global and featured updates for charitable causes, with options to filter by featured status, search by name, or filter by cause ID.
- Get all updates associated with a single charitable cause.
Charitable Causes [deprecated]
- Retrieve a list of all active charitable causes, which can be filtered by campaign type or location.
- Get the details of a specific charitable cause by its slug.
Delivery Areas
- Get all delivery areas and their details for a specific caterer.
Donations [deprecated]
- View all donations for a specific charitable cause.
- Make a new donation to a cause, which charges and captures the provided credit card for the specified amount.
Home [deprecated]
- Fetch the data needed to populate the home page, including popular packages, new packages, and featured collections.
Managed Leads
- Create a managed lead record, which then notifies system administrators.
Poll Selections
- Retrieve an existing poll selection for a given group order poll.
- Make or update a meal selection within a group order poll.
- Update non-essential fields on a poll selection, such as a special request or credit card information.
Packages
- Search for catering packages using a wide array of filters such as price, location, lead time, and dietary options.
- Retrieve the complete details for a single, specific package.
Reviews
- Fetch all public reviews for a specific caterer, with various filtering options.
- Get all public reviews for a specific package.
Subscribers
- Subscribe an email address to a mailing list.
- Unsubscribe an email address for a user.
Users
- Fetch or create/update a user's acquisition response, which tracks how they heard about the service.
V2
The Public V2 API documentation can be found here.
Brands
- List and search for caterer brands using a wide variety of filters. You can filter by name, location, package categories, and attributes like "sustainable" or "pickup allowed". You can also sort results by order frequency or last submission date.
- The search functionality allows for finding brands that are available for a specific date, time, and address.
- Retrieve the detailed information for a single, specific brand by its ID.
Coupons
- Get a list of publicly available coupons. This list can be filtered by the associated brand, kitchen, or by a partial match of the coupon code. You can also filter for coupons offered directly by CaterCow.
Kitchens
- Retrieve a list of kitchens, which can be filtered by brand, geographical place, or cuisine type.
- Fetch the complete details for a specific kitchen, including its address, business hours, and delivery price information.
- Load the parent brand information for a specific kitchen.
Menu Items
- Get a list of menu items with various filtering options. You can filter by brand, menu, order, kitchen, or location, as well as by status like "deleted," "hidden," or "pollable".
National Holidays
- Retrieve a list of all US national holidays affecting workplaces, which includes the name and date for each holiday.
Order Issues
- Fetch a list of all public order issues for a specific brand.
- Retrieve a single, specific order issue by its ID.
Order Surveys
- Get a list of all public order surveys for a specific team, identified by a team code.
- Fetch a single, specific order survey by its unique code, which includes details about the order and menu items.
- Retrieve a list of all survey responses submitted by the current user.
- Set or view the current user's response for a specific survey.
Poll Selection Bills
- View a list of all poll selection bills for the current user, which can be filtered by the credit card used.
- Fetch the details of a specific poll selection bill by its ID.
Restaurant Applications
- Fetch or update a restaurant's application for the platform. This can be done either by using a specific prospect ID or by using the current user's session.
Restaurant Menus
- List all public restaurant menus, with options to filter by brand or kitchen.
- Fetch a single, specific restaurant menu by its ID.