Orderer API

The CaterCow Orderer API provides endpoints supporting all functionalities available in the orderer dashboard, enabling users to manage addresses, orders, payments, teams, memberships, saved searches, and more. All requests to these endpoints must be authenticated.

A key aspect of the API is the CC-As-Team header, which specifies the team context for the current request. This is especially important for users with access to multiple organizations, ensuring that actions and data retrieval are performed within the correct team environment.

V1

The Orderer V1 API documentation can be found here.

Addresses

• Manage delivery addresses by retrieving a list of all addresses for an order, creating new ones, and getting or updating a specific address.
• Verify if a specific address is within the caterer's delivery range.

Award Redemptions

• View all award redemptions for the current user and get a list of orders that are eligible for redemption.
• Redeem awards for a set of orders and mark them as redeemed.

Batched Deliveries

• Retrieve lists of batched deliveries, which can be filtered by various criteria like brand or date.

Coupons

• Check if a coupon code is valid and can be applied to a specific order.

Credit Cards

• Manage payment methods by getting a list of saved credit cards, adding new cards, and updating or deleting existing cards.

Favorites

• Mark or unmark catering brands and packages as favorites for easy access later.

Invoices

• Fetch a list of all invoices for a user or retrieve a specific invoice by its code or associated order ID.

Orders

• Full order lifecycle management from the customer's perspective.
• Create a new order from a catering package, or preview what an order would look like.
• View all orders or a single order's details.
• Modify, submit, and cancel orders.
• Check the validity of an order's details and reorder from a past submitted order.
• Pin or unpin orders for organizational purposes. This saves (and unsaves) an order for later

Order Polls

• Manage group ordering through polls.
• View all polls for the user, create a new poll for an order, or preview a poll.
• Apply the selections from a poll to finalize an order.

Poll Selections

• View the meal selections made within a poll.
• Add, change, or delete a meal selection for a user in a poll.

Package Items

• Get a list of all items included in a specific catering package or for a specific order.

Package Item Options

• Create new custom combo options within a package for a specific order or for the package in general.

Payments

• Retrieve the details of a specific payment made by the user.

Reviews

• Manage feedback on past orders.
• View all reviews left by the orderer or a specific review.
• Leave a new review or update an existing one for an order.
• Option to skip leaving a review for an order.

V2

The Orderer V2 API documentation can be found here.

Coupons

• View a list of all unused, active, and non-expired coupons that are uniquelly available to the current user.

Draft Orders

• Retrieve a list of draft orders, which can be filtered by various parameters like user, team, or date.
• Create a new draft order with details such as date, time, headcount, and brand or package information.
• Fetch, update, or delete a single draft order.
• Convert a draft order into a real order that can be processed.

Memberships

• Manage team members by retrieving a list of all memberships for a specific team.
• Invite new members to a team by creating a new membership with their name, email, and role.
• Fetch, update the role of, or remove a single team member.
• Resend an invitation to a person who has not yet claimed their team membership.

Order Templates

• Create, view, update, and delete reusable templates for frequent orders. These templates can store details like start time, headcount, budget, and special instructions to streamline the ordering process.

Saved Searches

• Manage saved search queries for finding catering packages.
• Create a new saved search with a name and various filter criteria like price range.
• Retrieve a list of all saved searches for the current user.
• Fetch, update, or delete a specific saved search.

Team Contacts

• Maintain a list of contacts for a team, including backup contacts or individuals who should receive invoices.
• Actions include creating a new contact, retrieving the full list, and fetching, updating, or deleting a specific contact.

Teams

• Manage teams for group ordering and administration.
• Retrieve a list of teams for the current user or create a new team.
• Fetch, update, or delete a specific team's details.