How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bevz Integrator Service

The Bevz Integrator Service is a partner REST API that lets POS vendors and third-party integrators provision and manage stores on the Bevz platform programmatically. It covers store creation, provisioning and deprovisioning; menu upload in CSV or JSON with configurable column mapping and asynchronous status tracking; menu synchronization out to the connected delivery services; product catalog maintenance with per-service pricing and availability; the full order lifecycle from receipt through acceptance, out-for-delivery, completion, rejection and cancellation; post-acceptance order adjustments; and delivery-service onboarding for DoorDash and Grubhub via a single call plus a dedicated three-step OAuth handshake for Uber Eats. Three outbound webhooks push order events, menu upload status and store settings changes. Authentication is a bearer JWT with a 30-day lifetime, minted from Bevz-issued integrator credentials.

This API exposes 30 operations across 24 paths, organized into 8 resource areas, and defines 12 schemas. It is described by OpenAPI 3.0.3, at version 1.12.0.

Requests are made against 2 base URLs: https://api.bevz.com/integrator-service, https://sandbox-api.bevz.com/integrator-service.

30 operations 24 paths 12 schemas 1 DELETE10 GET5 PATCH13 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.12.0
Base URL
https://api.bevz.com/integrator-service
Resource Areas
8

Paths & Operations 30

Across 24 paths, the API surfaces 30 operations — 1 DELETE, 10 GET, 5 PATCH, 13 POST, 1 PUT. They span 8 resource areas: Integrators, Stores, integrator_users, Store Products, Lotto Scratcher Games, Order, Pick a Delivery Service for Onboarding API, Uber Eats Onboarding API Workflow. Each is listed below with its method, path, parameters, and response codes.

Integrators 2
PATCH
/integrators/{integrator_id}
Setup Order Notification Webhook
patchOrder 2 params body → 200400401403404
PATCH
/integrators/{integrator_id}ㅤ
Setup Menu Upload Notification
patchMenuUpload 2 params body → 200400401403404
Stores 11
GET
/integrators/{integrator_id}/stores
Retrieve All Provisioned Stores
getStores 2 params → 200400401403
POST
/integrators/{integrator_id}/stores
Create a New Store
createStore 2 params body → 200400401403
GET
/integrators/{integrator_id}/stores/{store_id}
Get Store by storeid
getIntegratorStore 3 params → 200400401403
PATCH
/integrators/{integrator_id}/stores/{store_id}
Update Store Details
patchStore 3 params body → 200400401403
POST
/integrators/{integrator_id}/stores/provision
Provision Existing Store
postStore 2 params body → 200400404401403
POST
/integrators/{integrator_id}/stores/{store_id}/deprovision
Deprovision store
removeStore 3 params → 200400401403
POST
/integrators/{integrator_id}/stores/{store_id}/menu
Menu Upload
postMenu 3 params body → 200400401403
GET
/integrators/{integrator_id}/stores/{store_id}/menu/{menu_id}
Retrieve the menu upload status
getMenu 4 params → 200400401403404
POST
/integrators/{integrator_id}/stores/{store_id}/menu-sync
Menu Sync
menuSync 3 params body → 200400401403
GET
/integrators/{integrator_id}/stores/{store_id}/generate-checkout-link
Generate Checkout Link
generateCheckoutLink 3 params → 200400401403
POST
/integrators/{integrator_id}/stores/{store_id}/subscription-link
Get Subscription Link
getSubscriptionLink 3 params body → 200400401403404
integrator_users 4

The Integrator Users API allows you to manage user accounts and access permissions for your integrator account.

GET
/integrators/{integrator_id}/users
Retrieve All Integrator User Access
getUser 2 params → 200400401403404
POST
/integrators/{integrator_id}/users
Create Integrator User
postUser 2 params body → 200400401403
PUT
/integrators/{integrator_id}/users/{user_id}
Update Integrator User Access
putUser 3 params body → 200400401403404
POST
/integrators/{integrator_id}/users/{user_id}/change-password
Change Integrator User Password
changePassword 3 params body → 200400401403
Store Products 3

Store Products refer to inventory items that are available in a specific store. These products can be managed, updated, and retrieved through the Store Products API.

GET
/integrators/{integrator_id}/stores/{store_id}/products
Get Store Products
getProducts 7 params → 200401403
PATCH
/integrators/{integrator_id}/stores/{store_id}/products/{product_id}
Update Store Product
patchProduct 4 params body → 200400401403
DELETE
/integrators/{integrator_id}/stores/{store_id}/products/{product_id}
Delete Store Product
deleteProduct 4 params → 200400401403
Lotto Scratcher Games 1

Lotto Scratcher Games Retrieve lottery scratch-off game data from supported state lotteries. This endpoint provides game catalogs that can be used to display lotto ticket informat…

GET
/integrators/{integrator_id}/lotto-scratcher-games
Get Lotto Scratcher Games
getLottoScratcherGames 7 params → 200400401
Order 5
POST
/integrators/{integrator_id}/stores/{store_id}/orders
Test Store Orders
testStoreOrders 2 params body → 200400401403
GET
/integrators/{integrator_id}/stores/{store_id}/orders
Get Store Orders
getStoreOrders 9 params → 200401403
GET
/integrators/{integrator_id}/stores/{store_id}/orders/{order_id}
Get Order by OrderId
getOrderId 4 params → 200400401403404
PATCH
/integrators/{integrator_id}/stores/{store_id}/orders/{order_id}
Patch Order Status
patchOrderStatus 4 params body → 200400401403
POST
/integrators/{integrator_id}/stores/{store_id}/orders/{order_id}/adjustments
Post Order Adjustment
postOrderAdjustment 4 params body → 200400401403404
Pick a Delivery Service for Onboarding API 1

This document outlines the integration flow for onboarding new DoorDash and Grubhub stores through the [Delivery Services Onboarding API](tag/Pick-a-Delivery-Service-for-Onboardin…

POST
/integrators/{integrator_id}/stores/{store_id}/onboard-delivery-services
Delivery Services Onboarding API
onboard 3 params body → 200400401403
Uber Eats Onboarding API Workflow 3

The Uber Eats API allows you to onboard your store to Uber Eats and manage related operations. Uber Eats onboarding is a three-step process: 1. Generate OAuth URL: Obtain an autho…

GET
/integrators/{integrator_id}/stores/{store_id}/onboard-delivery-services/ubereats/generate-oauth
Step 1. Generate OAuth URL for Uber Eats onboarding
generateOAuth 4 params → 200401403
POST
/integrators/{integrator_id}/stores/{store_id}/onboard-delivery-services/ubereats/exchange-authorization-code
Step 2. Exchange Authorization Code for Access Token
exchangeCode 3 params body → 200400401403
POST
/integrators/{integrator_id}/stores/{store_id}/onboard-delivery-services/ubereats/provision-store
Step 3. Provision Store on Uber Eats
provisionStore 3 params body → 200400401403

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are StoreProducts (17 properties), Order (15 properties), LottoScratcherGame (12 properties), Store (11 properties). Each schema is shown below with its type and property counts.

JWT
object
4 properties
Menu
object
7 properties
User
object
Represents an integrator user account on the Bevz platform. This object contains all essential information about the user, including identity, authentication c…
8 properties
Store
object
Represents a retail store managed on the Bevz platform. This object contains all essential information about the store, including its identity, contact details…
11 properties
IntegratorMenu
object
Represents a menu upload payload for an integrator on the Bevz platform. This schema allows integrators to upload or synchronize their store menu, with support…
5 properties 1 required
Order
object
Represents a customer order placed through the Bevz platform. This schema includes all relevant details about the order, such as products, delivery information…
15 properties
StoreProducts
object
Represents a product available for sale in a specific store on the Bevz platform. This schema includes product identity, categorization, inventory, pricing, an…
17 properties
LottoScratcherGame
object
12 properties
CreateStore
object
3 properties
DeliverySettings
object
1 property 1 required
DeliverySettingsGH
DeliverySettingsDD

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bevz-integrator-service-openapi.yaml Raw ↑
Where this information came from

This is an independent, third-party profile of Bevz Integrator Service, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.