{ "openapi": "3.1.0", "info": { "title": "Menubarcode API", "version": "v1", "description": "Auto-generated from the live router. Human docs: https://menubarcode.com/developers" }, "servers": [ { "url": "https://menubarcode.com/api/v1" } ], "components": { "securitySchemes": { "ApiToken": { "type": "http", "scheme": "bearer", "description": "Owner/reseller personal token." }, "StorefrontToken": { "type": "apiKey", "in": "header", "name": "X-Storefront-Token" }, "Passport": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://menubarcode.com/oauth/authorize", "tokenUrl": "https://menubarcode.com/oauth/token", "scopes": {} } } } } }, "paths": { "/api/v1/customer/addresses": { "get": { "operationId": "api.v1.customer.addresses.get", "summary": "Get /api/v1/customer/addresses", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] }, "post": { "operationId": "api.v1.customer.addresses.store.post", "summary": "Post /api/v1/customer/addresses", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/customer/addresses/{id}": { "delete": { "operationId": "api.v1.customer.addresses.destroy.delete", "summary": "Delete /api/v1/customer/addresses/{id}", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "operationId": "api.v1.customer.addresses.update.put", "summary": "Put /api/v1/customer/addresses/{id}", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/customer/gift-cards": { "get": { "operationId": "api.v1.customer.gift-cards.get", "summary": "Get /api/v1/customer/gift-cards", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/customer/logout": { "post": { "operationId": "api.v1.customer.logout.post", "summary": "Post /api/v1/customer/logout", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/customer/me": { "get": { "operationId": "api.v1.customer.me.get", "summary": "Get /api/v1/customer/me", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] }, "put": { "operationId": "api.v1.customer.me.update.put", "summary": "Put /api/v1/customer/me", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/customer/orders": { "get": { "operationId": "api.v1.customer.orders.get", "summary": "Get /api/v1/customer/orders", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] }, "post": { "operationId": "api.v1.customer.orders.place.post", "summary": "Post /api/v1/customer/orders", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/customer/store-credit": { "get": { "operationId": "api.v1.customer.store-credit.get", "summary": "Get /api/v1/customer/store-credit", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/available": { "get": { "operationId": "api.v1.driver.available.get", "summary": "Get /api/v1/driver/available", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/deliveries": { "get": { "operationId": "api.v1.driver.deliveries.get", "summary": "Get /api/v1/driver/deliveries", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/deliveries/{orderId}/claim": { "post": { "operationId": "api.v1.driver.deliveries.claim.post", "summary": "Post /api/v1/driver/deliveries/{orderId}/claim", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/driver/deliveries/{orderId}/pod-otp": { "post": { "operationId": "api.v1.driver.deliveries.podOtp.post", "summary": "Post /api/v1/driver/deliveries/{orderId}/pod-otp", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/driver/deliveries/{orderId}/pod-photo": { "post": { "operationId": "api.v1.driver.deliveries.podPhoto.post", "summary": "Post /api/v1/driver/deliveries/{orderId}/pod-photo", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/driver/deliveries/{orderId}/status": { "put": { "operationId": "api.v1.driver.deliveries.status.put", "summary": "Put /api/v1/driver/deliveries/{orderId}/status", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/driver/earnings": { "get": { "operationId": "api.v1.driver.earnings.get", "summary": "Get /api/v1/driver/earnings", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/location": { "put": { "operationId": "api.v1.driver.location.put", "summary": "Put /api/v1/driver/location", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/login/request": { "post": { "operationId": "api.v1.driver.login.request.post", "summary": "Post /api/v1/driver/login/request", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/login/verify": { "post": { "operationId": "api.v1.driver.login.verify.post", "summary": "Post /api/v1/driver/login/verify", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/me": { "get": { "operationId": "api.v1.driver.me.get", "summary": "Get /api/v1/driver/me", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/offers": { "get": { "operationId": "api.v1.driver.offers.get", "summary": "Get /api/v1/driver/offers", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/offers/{offerId}/accept": { "post": { "operationId": "api.v1.driver.offers.accept.post", "summary": "Post /api/v1/driver/offers/{offerId}/accept", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "offerId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/driver/offers/{offerId}/reject": { "post": { "operationId": "api.v1.driver.offers.reject.post", "summary": "Post /api/v1/driver/offers/{offerId}/reject", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "offerId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/driver/push/register-device": { "post": { "operationId": "api.v1.driver.push.register.post", "summary": "Post /api/v1/driver/push/register-device", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/push/unregister-device": { "post": { "operationId": "api.v1.driver.push.unregister.post", "summary": "Post /api/v1/driver/push/unregister-device", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/driver/shift": { "post": { "operationId": "api.v1.driver.shift.post", "summary": "Post /api/v1/driver/shift", "tags": [ "driver" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/drivers": { "get": { "operationId": "api.v1.drivers.index.get", "summary": "Get /api/v1/drivers", "tags": [ "drivers" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] }, "post": { "operationId": "api.v1.drivers.store.post", "summary": "Post /api/v1/drivers", "tags": [ "drivers" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/drivers/{id}": { "delete": { "operationId": "api.v1.drivers.destroy.delete", "summary": "Delete /api/v1/drivers/{id}", "tags": [ "drivers" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "operationId": "api.v1.drivers.update.put", "summary": "Put /api/v1/drivers/{id}", "tags": [ "drivers" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/drivers/{id}/rotate-token": { "post": { "operationId": "api.v1.drivers.rotate.post", "summary": "Post /api/v1/drivers/{id}/rotate-token", "tags": [ "drivers" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/me": { "get": { "operationId": "api.v1.me.get", "summary": "Get /api/v1/me", "tags": [ "me" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/menu/{restaurantId}": { "get": { "operationId": "api.v1.public.menu.get", "summary": "Get /api/v1/menu/{restaurantId}", "tags": [ "public" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "restaurantId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/reseller/customers": { "get": { "operationId": "api.v1.reseller.customers.get", "summary": "Get /api/v1/reseller/customers", "tags": [ "reseller" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/reseller/invoices": { "get": { "operationId": "api.v1.reseller.invoices.get", "summary": "Get /api/v1/reseller/invoices", "tags": [ "reseller" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/reseller/plans": { "post": { "operationId": "api.v1.reseller.plans.store.post", "summary": "Post /api/v1/reseller/plans", "tags": [ "reseller" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/reseller/stats": { "get": { "operationId": "api.v1.reseller.stats.get", "summary": "Get /api/v1/reseller/stats", "tags": [ "reseller" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/reseller/tier": { "get": { "operationId": "api.v1.reseller.tier.get", "summary": "Get /api/v1/reseller/tier", "tags": [ "reseller" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/restaurants": { "get": { "operationId": "api.v1.restaurants.index.get", "summary": "Get /api/v1/restaurants", "tags": [ "restaurants" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/restaurants/{id}": { "get": { "operationId": "api.v1.restaurants.show.get", "summary": "Get /api/v1/restaurants/{id}", "tags": [ "restaurants" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/analytics": { "get": { "operationId": "api.v1.analytics.summary.get", "summary": "Get /api/v1/restaurants/{id}/analytics", "tags": [ "analytics" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/customer/login": { "post": { "operationId": "api.v1.customer.login.post", "summary": "Post /api/v1/restaurants/{id}/customer/login", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/customer/otp/request": { "post": { "operationId": "api.v1.customer.otp.request.post", "summary": "Post /api/v1/restaurants/{id}/customer/otp/request", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/customer/otp/verify": { "post": { "operationId": "api.v1.customer.otp.verify.post", "summary": "Post /api/v1/restaurants/{id}/customer/otp/verify", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/customer/register": { "post": { "operationId": "api.v1.customer.register.post", "summary": "Post /api/v1/restaurants/{id}/customer/register", "tags": [ "customer" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/customers": { "get": { "operationId": "api.v1.customers.index.get", "summary": "Get /api/v1/restaurants/{id}/customers", "tags": [ "customers" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "operationId": "api.v1.customers.store.post", "summary": "Post /api/v1/restaurants/{id}/customers", "tags": [ "customers" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/deliveries": { "get": { "operationId": "api.v1.deliveries.index.get", "summary": "Get /api/v1/restaurants/{id}/deliveries", "tags": [ "deliveries" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/guests": { "get": { "operationId": "api.v1.guests.index.get", "summary": "Get /api/v1/restaurants/{id}/guests", "tags": [ "guests" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/guests/segments": { "get": { "operationId": "api.v1.guests.segments.get", "summary": "Get /api/v1/restaurants/{id}/guests/segments", "tags": [ "guests" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/menu": { "get": { "operationId": "api.v1.restaurants.menu.get", "summary": "Get /api/v1/restaurants/{id}/menu", "tags": [ "restaurants" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/menu/categories": { "post": { "operationId": "api.v1.menu.categories.store.post", "summary": "Post /api/v1/restaurants/{id}/menu/categories", "tags": [ "menu" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/menu/categories/{categoryId}": { "delete": { "operationId": "api.v1.menu.categories.delete.delete", "summary": "Delete /api/v1/restaurants/{id}/menu/categories/{categoryId}", "tags": [ "menu" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "operationId": "api.v1.menu.categories.update.put", "summary": "Put /api/v1/restaurants/{id}/menu/categories/{categoryId}", "tags": [ "menu" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/menu/items": { "post": { "operationId": "api.v1.menu.items.store.post", "summary": "Post /api/v1/restaurants/{id}/menu/items", "tags": [ "menu" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/menu/items/{itemId}": { "delete": { "operationId": "api.v1.menu.items.delete.delete", "summary": "Delete /api/v1/restaurants/{id}/menu/items/{itemId}", "tags": [ "menu" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "operationId": "api.v1.menu.items.update.put", "summary": "Put /api/v1/restaurants/{id}/menu/items/{itemId}", "tags": [ "menu" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/menu/items/{itemId}/sold-out": { "patch": { "operationId": "api.v1.menu.items.soldout.patch", "summary": "Patch /api/v1/restaurants/{id}/menu/items/{itemId}/sold-out", "tags": [ "menu" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/orders": { "post": { "operationId": "api.v1.orders.store.post", "summary": "Post /api/v1/restaurants/{id}/orders", "tags": [ "orders" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "operationId": "api.v1.restaurants.orders.get", "summary": "Get /api/v1/restaurants/{id}/orders", "tags": [ "restaurants" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/orders/{orderId}": { "get": { "operationId": "api.v1.orders.show.get", "summary": "Get /api/v1/restaurants/{id}/orders/{orderId}", "tags": [ "orders" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/orders/{orderId}/assign": { "post": { "operationId": "api.v1.orders.assign.post", "summary": "Post /api/v1/restaurants/{id}/orders/{orderId}/assign", "tags": [ "orders" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/orders/{orderId}/delivery-status": { "put": { "operationId": "api.v1.orders.delivery.put", "summary": "Put /api/v1/restaurants/{id}/orders/{orderId}/delivery-status", "tags": [ "orders" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/orders/{orderId}/status": { "put": { "operationId": "api.v1.restaurants.orders.status.put", "summary": "Put /api/v1/restaurants/{id}/orders/{orderId}/status", "tags": [ "restaurants" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/reservations": { "get": { "operationId": "api.v1.restaurants.reservations.get", "summary": "Get /api/v1/restaurants/{id}/reservations", "tags": [ "restaurants" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/staff/login": { "post": { "operationId": "api.v1.staff.login.post", "summary": "Post /api/v1/restaurants/{id}/staff/login", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/restaurants/{id}/staff/pin": { "post": { "operationId": "api.v1.staff.pin.post", "summary": "Post /api/v1/restaurants/{id}/staff/pin", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/staff/2fa/confirm": { "post": { "operationId": "api.v1.staff.2fa.confirm.post", "summary": "Post /api/v1/staff/2fa/confirm", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/2fa/setup": { "post": { "operationId": "api.v1.staff.2fa.setup.post", "summary": "Post /api/v1/staff/2fa/setup", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/analytics": { "get": { "operationId": "api.v1.staff.analytics.get", "summary": "Get /api/v1/staff/analytics", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/deliverect/busy": { "post": { "operationId": "api.v1.staff.deliverect.busy.post", "summary": "Post /api/v1/staff/deliverect/busy", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/deliverect/snooze": { "post": { "operationId": "api.v1.staff.deliverect.snooze.post", "summary": "Post /api/v1/staff/deliverect/snooze", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/deliverect/status": { "get": { "operationId": "api.v1.staff.deliverect.status.get", "summary": "Get /api/v1/staff/deliverect/status", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/kds": { "get": { "operationId": "api.v1.staff.kds.get", "summary": "Get /api/v1/staff/kds", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/kds/items/{itemId}/bump": { "put": { "operationId": "api.v1.staff.kds.bump.put", "summary": "Put /api/v1/staff/kds/items/{itemId}/bump", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/staff/kds/items/{itemId}/recall": { "put": { "operationId": "api.v1.staff.kds.recall.put", "summary": "Put /api/v1/staff/kds/items/{itemId}/recall", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/staff/logout": { "post": { "operationId": "api.v1.staff.logout.post", "summary": "Post /api/v1/staff/logout", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/me": { "get": { "operationId": "api.v1.staff.me.get", "summary": "Get /api/v1/staff/me", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/menu/categories": { "post": { "operationId": "api.v1.staff.menu.categories.store.post", "summary": "Post /api/v1/staff/menu/categories", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/menu/items": { "post": { "operationId": "api.v1.staff.menu.items.store.post", "summary": "Post /api/v1/staff/menu/items", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/menu/items/{itemId}": { "delete": { "operationId": "api.v1.staff.menu.items.delete.delete", "summary": "Delete /api/v1/staff/menu/items/{itemId}", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "operationId": "api.v1.staff.menu.items.update.put", "summary": "Put /api/v1/staff/menu/items/{itemId}", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/staff/menu/items/{itemId}/sold-out": { "patch": { "operationId": "api.v1.staff.menu.items.soldout.patch", "summary": "Patch /api/v1/staff/menu/items/{itemId}/sold-out", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/staff/orders": { "get": { "operationId": "api.v1.staff.orders.get", "summary": "Get /api/v1/staff/orders", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/orders/{orderId}/status": { "put": { "operationId": "api.v1.staff.orders.status.put", "summary": "Put /api/v1/staff/orders/{orderId}/status", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/staff/push/register-device": { "post": { "operationId": "api.v1.staff.push.register.post", "summary": "Post /api/v1/staff/push/register-device", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/staff/push/unregister-device": { "post": { "operationId": "api.v1.staff.push.unregister.post", "summary": "Post /api/v1/staff/push/unregister-device", "tags": [ "staff" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/storefront/menu": { "get": { "operationId": "api.v1.storefront.menu.get", "summary": "Get /api/v1/storefront/menu", "tags": [ "storefront" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/storefront/orders": { "post": { "operationId": "api.v1.storefront.orders.create.post", "summary": "Post /api/v1/storefront/orders", "tags": [ "storefront" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/storefront/restaurant": { "get": { "operationId": "api.v1.storefront.restaurant.get", "summary": "Get /api/v1/storefront/restaurant", "tags": [ "storefront" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/track/{token}": { "get": { "operationId": "api.v1.track.get", "summary": "Get /api/v1/track/{token}", "tags": [ "track" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/webhook-endpoints": { "get": { "operationId": "api.v1.webhooks.index.get", "summary": "Get /api/v1/webhook-endpoints", "tags": [ "webhooks" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] }, "post": { "operationId": "api.v1.webhooks.store.post", "summary": "Post /api/v1/webhook-endpoints", "tags": [ "webhooks" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ] } }, "/api/v1/webhook-endpoints/{id}": { "delete": { "operationId": "api.v1.webhooks.destroy.delete", "summary": "Delete /api/v1/webhook-endpoints/{id}", "tags": [ "webhooks" ], "responses": { "200": { "description": "OK" }, "4XX": { "description": "Client error (see the standard error envelope on /developers)." } }, "security": [ { "ApiToken": [] }, { "StorefrontToken": [] }, { "Passport": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } } } }