Customer account signup/login and other CRUD operations.
Bite API (v2)
Overview
Bite exposes online ordering functionality through a REST API which third party developers can use to create applications on top of the Bite platform.
A Bite "Customer" represents a full end-user account created on Bite's platform. Customers can be created with a Bite password or can be authenticated against a Single Sign-On provider such as Paytronix or Punchh. Bite Customers have the following features:
- A single set of credentials could be used to create completely different accounts under different brands that Bite works with.
- Storing credit cards on file so that they could be used for future purchases.
- Access to the customer's favorite ordered items and recent order history.
- Storing delivery addresses on file for future purchases.
After creating or authenticating a Bite Customer through the API, a unique authentication token will be returned which can be used to refer to that user from that moment on without the need to store their password in your application.
A dedicated sandbox environment will be provisioned for each new third-party developer. All development and testing must be carried out through that environment. It will include both an API sandbox as well as Admin Portal sandbox so that test locations could be modified by the developers for the purposes of testing their integration with Bite. The Sandbox environment runs the same code as production. https://YOUR_SANDBOX_SUB_DOMAIN.getbite.com/api
The production environment endpoint is: [REDACTED]
All communication must be encrypted over TLS 1.2
https://<environment_domain>/<API_version>/<resource>?[params]
- Bite API expects both the request and the response bodies to encoded with JSON, so both the HTTP Accept and Content-Type headers should be set to application/json.
- HTTP Status Codes will be returned as follows:
- 200 OK - The requested operation completed successfully!
- 400 Bad Request - An error occurred on the Bite side or on the POS side. Please reference the response body's "code" value in the Bite Error Codes documentation.
- 403 Forbidden - Invalid API credentials or insufficient access to a resource or operation.
- 500 Server Error - An unexpected error occurred. Please verify that your request is correctly formatted.
- Every API call must include the following headers:Header
Description Example x-md-api-version Must be set to 4 x-md-api-version: 4 x-bite-org-id Must be set to the brand id that you are working with. This value will be provided along with the sandbox environment. x-bite-org-id: 5fa31dc97acd2f0031e023eb x-customer-app-scope Must be set to the brand's account scope. This value will be provided along with the sandbox environment. x-customer-app-scope: my-brand-scope Authorization Must be set to Bearer: API_TOKEN. The API_TOKEN will be provided along with the sandbox environment. Authorization: Bearer 2979c798-c901-4ceb-8478-3b26c24a998d User-Agent Unique user agent value that identifies the app. Please send this formatted as application_name/version. User-Agent: SomeApp/v1.2.3 X-Device-Id Unique hardware identifier for the device. X-Device-Id: 993e0082-5bfd-4bbc-98ec-d13b50bbd54a
A success response structure will look as follows:
{
success: true;
data?: {...};
}An error response structure will look as follows:
{
success: false;
code: number;
message?: string;
data?: {...};
}Any error response will contain an error code:
| Code | Meaning | Suggested Action |
|---|---|---|
| 60 | Customer Password Already Used: The customer is trying to use a password they have previously used. | |
| 61 | Customer Token Invalid: The token has been malformed or has expired. | Maybe the customer needs to log out and log in again because they've changed their password. |
| 62 | Customer Account Not Verified: The customer resource being accessed requires a verified customer account. | |
| 63 | Customer Account Disabled: The specified customer account has been disabled by one of the brand admins. | |
| 64 | Customer Account Deleted: The specified customer account has been deleted by one of the brand admins. |
Please treat all IDs in the API as strings.
We will not remove properties from the current API version, but we do add new properties to return objects from time to time.
There is no guaranteed ordering of properties. We request that properties are accessed by name and not by index.
Please do not rely on error messages for logic. Error text may change periodically. Rather rely on error codes, which are guaranteed to not change.
Some API endpoints are protected through the use of rate limiting. The base rate limit can be found in the description of the API endpoint.
Information about the current usage can be found in the headers of the response:
- Ratelimit-Limit: The amount of requests permitted
- Ratelimit-Remaining: How many requests can be made in the interval
- Ratelimit-Reset: How long, in seconds, until the rate-limit interval ends and the remaining amount of requests resets
The rate limit maximum is adjusted by the number of locations associated with the token. For example, if an API has a base rate limit of 50 requests per minute, then an organization with 10 locations may use the API endpoint 500 times per minute.
2026-02-24
- Updated definitions of openingHoursByFulfillmentMethod
2025-07-23
- Updated security for Bite API Token based requests
2024-08-29
- Added
consentedToMarketingfield to order
2024-01-22
- Added section to ordered item schema
2024-01-03
- More details regarding rate limiting
2023-11-07
- Deprecated:
POST /api/v2/reporting/orders/day - New Endpoint:
GET /api/v2/reporting/orders/day/:date
2022-12-19
- Updated rate limits of API calls
- Reversed order of change log
2022-10-25
- New endpoints:
- POST /api/v2/reporting/orders/day
- GET /api/v2/locations
- Rate Limiting
2021-10-19
- First Draft
Download OpenAPI description
Languages
Servers
Mock server
https://documentation.getbite.com/_mock/openapi/v2/bite-api-v2
Sandbox
https://{sandboxApiSubDomain}.getbite.com/api
Request
Returns a report with detailed information about the orders of a given day at a specified location. Requires an API token with the "Reporting" scope. The base rate limit of an organization with one location is 75 requests per 10 minutes.
Security
BearerAuthApiTokenSecurityScheme
- Mock serverhttps://documentation.getbite.com/_mock/openapi/v2/bite-api-v2/v2/reporting/orders/day/{date}
- Sandboxhttps://YOUR_SANDBOX_SUB_DOMAIN.getbite.com/api/v2/reporting/orders/day/{date}
- curl
- Node.js
- JavaScript
curl -i -X GET \
'https://documentation.getbite.com/_mock/openapi/v2/bite-api-v2/v2/reporting/orders/day/2023-07-21?newerThan=654b3c2d537fd6b2dab2a2cc' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'x-bite-location-id: string' \
-H 'x-md-api-version: 4'Success!
The ID of the location (in the specified org) at which the customer placed the order.
Denotes the ordering channel through which orders are placed:
catering- Catering Websiteflash- Contactless (QR-code)kiosk- Kiosklinebuster- Linebusterweb- Online Ordering Website
Enum"catering""flash""kiosk""linebuster""web"
The name of the dining option with which the customer placed the order.
Whether the order was made from a kiosk, mobile, or desktop browser.
The IDs of the check from POS integrations.
The IDs of the loyalty check from loyalty integrations (if any). Absent if loyalty doesn't exist or order was not checked into loyalty.
Items of the order.
A special request that the guest added for this menu item. The max length of this field depends on the specific POS.
The name of the vendor from which the item originated. If location is single-vendor or does not have a POS, defaults to "Default Vendor".
Value of the barcode that was scanned at the kiosk to add this menu item to the order.
ID of the item on the POS. Absent if item does not come from a POS.
Name of the menu item as it appeared on the menu.
Final price of the item (in cents) that accounts for quantity but not including any priced modifiers.
Quantity of the menu item ordered.
Price of a single unit of the menu item in cents (given the ordered price option).
Sale unit:
0- single unit2- pounds3- ounces
A short description of how the item was added to the cart.
The section of the menu from which the item originated.
Mod groups of the item.
ID of the mod group on the POS. Absent if mod group does not come from a POS.
Name of the mod group as it appears on the menu.
The amount of tax collected on the order in cents.
The amount discounted from the order sub total in cents.
The total amount that the guest paid in cents. This number includes the tip.
Transactions of the order.
The type of the card used by the transaction. ex: Visa, Gift Card
The type of the transaction.
Enum"sale""refund"
Last four digits of card used in transaction. Absent if a card was not used, such as by paying in cash.
The gateway used to process the transaction. ex: Stripe, Worldpay
The time the customer is expected to pickup an order, in ISO with timezone offset. Only available if the order is a future-order.
The name of the outpost. Only available if the dining option is an Outpost dining option.
The delivery address for this order. This value is required if this is a delivery address.
Number of the table or table tent that the order is associated with.
The sum of all the service charges added to the order in cents.
A list of all the service charges added to the order. If this property is available, then serviceChargeTotal is definitely available on the order. However, this property may not be available even if there is a serviceChargeTotal because not every POS will provide a breakdown of the service charges.
Whether or not the guest redeemed a loyalty reward for the order.
Info about the guest who placed the order.
Name of the guest. Only available if the Guest Name identifier was used.
Email of the guest. Only available if the guest requested the receipt to be emailed after placing their order or if it was provided during payment.
Phone Number of the guest. Only available if the Guest Vehicle identifier was used.
Info about the guest's vehicle. Only available if the Guest Vehicle identifier was used.
How satisfied the guest was with their experience. Only available if the guest completed the survey.
The maximum possible satisfaction score for the survey. Only available if the guest completed the survey.
An approximate age range of the guest. Only available if the guest used facial recognition. ex: 22 - 28
A calculated guess as to the gender of the guest. Only available if the guest used facial recognition.
Enum"M""F"
The language the guest selected for their order. Only available if the guest selected a language.
The IDs of the guest's loyalty account. If the array is empty, then the guest did not connect a loyalty account. There may be multiple entries if the guest used multiple methods of connecting to their account.
How the information connecting a guest to their loyalty account was collected.
Enum"barcode-scanned""card-number-manually-entered""email-manually-entered""email-and-password-manually-entered""email-and-phone-number-manually-entered""email-and-phone-number-provided-externally""phone-number-manually-entered""phone-number-provided-externally""redemption-code-manually-entered""unknown-manually-entered"
Response
application/json
{ "success": true, "data": { "orders": [ … ], "next": "/api/v2/reporting/orders/day/2023-07-21?newerThan=654b3c2d537fd6b2dab2a2cc" } }
Request
This API endpoint is deprecated and will be removed in a future release. Returns a report with detailed information about the orders of a given day at a specified location. Requires an API token with the "Reporting" scope. The base rate limit of an organization with one location is 75 requests per 10 minutes.
Security
BearerAuthApiTokenSecurityScheme
- Mock serverhttps://documentation.getbite.com/_mock/openapi/v2/bite-api-v2/v2/reporting/orders/day
- Sandboxhttps://YOUR_SANDBOX_SUB_DOMAIN.getbite.com/api/v2/reporting/orders/day
- curl
- Node.js
- JavaScript
curl -i -X POST \
https://documentation.getbite.com/_mock/openapi/v2/bite-api-v2/v2/reporting/orders/day \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'x-md-api-version: 4' \
-d '{
"locationId": "0123456789abcdef01234567",
"date": "2023-07-21",
"page": 1,
"limit": 25
}'Success!
The ID of the location (in the specified org) at which the customer placed the order.
Denotes the ordering channel through which orders are placed:
catering- Catering Websiteflash- Contactless (QR-code)kiosk- Kiosklinebuster- Linebusterweb- Online Ordering Website
Enum"catering""flash""kiosk""linebuster""web"
The name of the dining option with which the customer placed the order.
The IDs of the check from POS integrations.
The IDs of the loyalty check from loyalty integrations (if any). Absent if loyalty doesn't exist or order was not checked into loyalty.
Items of the order.
A special request that the guest added for this menu item. The max length of this field depends on the specific POS.
The name of the vendor from which the item originated. If location is single-vendor or does not have a POS, defaults to "Default Vendor".
Value of the barcode that was scanned at the kiosk to add this menu item to the order.
Name of the menu item as it appeared on the menu.
Final price of the item (in cents) that accounts for quantity but not including any priced modifiers.
Quantity of the menu item ordered.
Price of a single unit of the menu item in cents (given the ordered price option).
Sale unit:
0- single unit2- pounds3- ounces
A short description of how the item was added to the cart.
The section of the menu from which the item originated.
Mod groups of the item.
ID of the mod group on the POS. Absent if mod group does not come from a POS.
Name of the mod group as it appears on the menu.
Ordered mods of the mod group.
ID of the mod on the POS. Absent if mod does not come from a POS.
Name of the modifier as it appears on the menu.
Final price of the item (in cents) that accounts for quantity but not including any priced modifiers.
data[].items[].modGroups[].mods[].quantityinteger(int32)(OrderedPriceOptionQuantity)>= 1required
Quantity of the menu item ordered.
Price of a single unit of the menu item in cents (given the ordered price option).
Sale unit:
0- single unit2- pounds3- ounces
A short description of how the mod was added to the cart. Only available if mod was selected through recommendations.
The amount discounted from the order sub total in cents.
The total amount that the guest paid in cents. This number includes the tip.
Transactions of the order.
The type of the card used by the transaction. ex: Visa, Gift Card
The type of the transaction.
Enum"sale""refund"
Last four digits of card used in transaction. Absent if a card was not used, such as by paying in cash.
The gateway used to process the transaction. ex: Stripe, Worldpay
The time the customer is expected to pickup an order, in ISO with timezone offset. Only available if the order is a future-order.
The name of the outpost. Only available if the dining option is an Outpost dining option.
The delivery address for this order. This value is required if this is a delivery address.
Number of the table or table tent that the order is associated with.
The sum of all the service charges added to the order in cents.
A list of all the service charges added to the order. If this property is available, then serviceChargeTotal is definitely available on the order. However, this property may not be available even if there is a serviceChargeTotal because not every POS will provide a breakdown of the service charges.
Whether or not the guest redeemed a loyalty reward for the order.
Info about the guest who placed the order.
Email of the guest. Only available if the guest requested the receipt to be emailed after placing their order or if it was provided during payment.
Phone Number of the guest. Only available if the Guest Vehicle identifier was used.
Info about the guest's vehicle. Only available if the Guest Vehicle identifier was used.
How satisfied the guest was with their experience. Only available if the guest completed the survey.
The maximum possible satisfaction score for the survey. Only available if the guest completed the survey.
An approximate age range of the guest. Only available if the guest used facial recognition. ex: 22 - 28
A calculated guess as to the gender of the guest. Only available if the guest used facial recognition.
Enum"M""F"
The language the guest selected for their order. Only available if the guest selected a language.
The IDs of the guest's loyalty account. If the array is empty, then the guest did not connect a loyalty account. There may be multiple entries if the guest used multiple methods of connecting to their account.
How the information connecting a guest to their loyalty account was collected.
Enum"barcode-scanned""card-number-manually-entered""email-manually-entered""email-and-password-manually-entered""email-and-phone-number-manually-entered""email-and-phone-number-provided-externally""phone-number-manually-entered""phone-number-provided-externally""redemption-code-manually-entered""unknown-manually-entered"
Response
application/json
{ "success": true, "data": [ { … } ] }