{"openapi":"3.1.0","info":{"title":"Fortune OS API","version":"v1","description":"The public API surfaces of Fortune OS: the versioned REST facade over every business procedure, the Model Context Protocol server for AI agents, and the report and document downloads. Every operation is generated from the Zod schema that validates it."},"servers":[{"url":"https://app.fortuneos.ai"}],"components":{"securitySchemes":{"session":{"type":"apiKey","in":"cookie","name":"better-auth.session_token"},"secureSession":{"type":"apiKey","in":"cookie","name":"__Secure-better-auth.session_token"},"sessionCookie":{"type":"apiKey","in":"cookie","name":"__Secure-better-auth.session_token","description":"The signed-in session BetterAuth issues on sign-in."},"apiKey":{"type":"http","scheme":"bearer","description":"A merchant-minted key from Settings → Profile → API keys, prefixed fos_. Read-only unless the key carries a write grant; every call is still bounded by the caller's live venue permissions."},"mcpOAuth":{"type":"oauth2","description":"The MCP connector sign-in flow; discovery lives at /.well-known/oauth-authorization-server. Tokens are read-only and authenticate the MCP mount alone.","flows":{"authorizationCode":{"authorizationUrl":"https://app.fortuneos.ai/api/auth/oauth2/authorize","tokenUrl":"https://app.fortuneos.ai/api/auth/oauth2/token","scopes":{}}}}}},"paths":{"/api/mcp/v1":{"post":{"operationId":"callMcp","summary":"Send one Model Context Protocol request","description":"JSON-RPC 2.0 over streamable HTTP, stateless per request: tools/list publishes the typed tool contract and tools/call invokes business_context, describe_business_data, query_sales, read_business_records, read_merchant_data, read_catalog or set_catalog_availability. Every call authorizes the credential, the live memberships and the named business scope again.","security":[{"apiKey":[]},{"mcpOAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"jsonrpc":{"type":"string","const":"2.0"},"id":{"anyOf":[{"type":"string"},{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}]},"method":{"type":"string"},"params":{"type":"object","properties":{"_meta":{"type":"object","properties":{"progressToken":{"anyOf":[{"type":"string"},{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}]},"io.modelcontextprotocol/related-task":{"type":"object","properties":{"taskId":{"type":"string"}},"required":["taskId"]}},"additionalProperties":{}}},"additionalProperties":{}}},"required":["jsonrpc","id","method"],"additionalProperties":false}}}},"responses":{"200":{"description":"The JSON-RPC result or error for the request id.","content":{"application/json":{"schema":{"oneOf":[{"anyOf":[{"type":"object","properties":{"jsonrpc":{"type":"string","const":"2.0"},"id":{"anyOf":[{"type":"string"},{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}]},"result":{"type":"object","properties":{"_meta":{"type":"object","properties":{"io.modelcontextprotocol/serverInfo":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"icons":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string"},"mimeType":{"type":"string"},"sizes":{"type":"array","items":{"type":"string"}},"theme":{"type":"string","enum":["light","dark"]}},"required":["src"]}},"version":{"type":"string"},"websiteUrl":{"type":"string"},"description":{"type":"string"}},"required":["name","version"]}},"additionalProperties":{}}},"additionalProperties":{}}},"required":["jsonrpc","id","result"],"additionalProperties":false},{"type":"object","properties":{"jsonrpc":{"type":"string","const":"2.0"},"id":{"anyOf":[{"type":"string"},{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}]},"error":{"type":"object","properties":{"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"message":{"type":"string"},"data":{}},"required":["code","message"]}},"required":["jsonrpc","error"],"additionalProperties":false}]},{"type":"object","properties":{"jsonrpc":{"type":"string","const":"2.0"},"id":{"anyOf":[{"type":"string"},{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}]},"error":{"type":"object","properties":{"code":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"message":{"type":"string"},"data":{}},"required":["code","message"]}},"required":["jsonrpc","error"],"additionalProperties":false}]}}}},"401":{"description":"Missing or invalid bearer; WWW-Authenticate names the protected-resource metadata.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"405":{"description":"Only POST is served; the server opens no SSE stream.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}},"/api/public/v1/remoteControl/challenge":{"post":{"operationId":"remoteControl.challenge","description":"Runs the remoteControl.challenge procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"},"publicKey":{"type":"string","minLength":88,"maxLength":88},"platform":{"enum":["android","ios","macos","windows","linux"],"type":"string"},"locationId":{"type":"string","minLength":1,"maxLength":128},"legacyInstallId":{"type":"string","minLength":1,"maxLength":128},"appVersion":{"type":"string","maxLength":128},"capabilities":{"type":"array","maxItems":32,"items":{"type":"string","minLength":1,"maxLength":128}}},"required":["instanceId","publicKey","platform","locationId","legacyInstallId","capabilities"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"challengeId":{"type":"string","format":"uuid"},"nonce":{"type":"string","minLength":1}},"required":["challengeId","nonce"]}}}}}}},"/api/public/v1/remoteControl/enroll":{"post":{"operationId":"remoteControl.enroll","description":"Runs the remoteControl.enroll procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"challengeId":{"type":"string","format":"uuid"},"signature":{"type":"string","minLength":8,"maxLength":128}},"required":["challengeId","signature"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"},"locationId":{"type":"string","minLength":1,"maxLength":128},"legacyInstallId":{"type":"string","minLength":1,"maxLength":128},"appVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"capabilities":{"type":"array","maxItems":32,"items":{"type":"string","minLength":1,"maxLength":128}},"bindingId":{"type":"string","format":"uuid"},"organizationId":{"type":"string","minLength":1}},"required":["instanceId","locationId","legacyInstallId","appVersion","capabilities","bindingId","organizationId"]}}}}}}},"/api/public/v1/remoteControl/current":{"post":{"operationId":"remoteControl.current","description":"Reads the remoteControl.current procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"},"locationId":{"type":"string","minLength":1,"maxLength":128},"legacyInstallId":{"type":"string","minLength":1,"maxLength":128},"appVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"capabilities":{"type":"array","maxItems":32,"items":{"type":"string","minLength":1,"maxLength":128}},"bindingId":{"type":"string","format":"uuid"},"organizationId":{"type":"string","minLength":1}},"required":["instanceId","locationId","legacyInstallId","appVersion","capabilities","bindingId","organizationId"]},{"type":"null"}]}}}}}}},"/api/public/v1/remoteControl/heartbeat":{"post":{"operationId":"remoteControl.heartbeat","summary":"Record that a device can run a command now","description":"Records the enrolled device's presence and answers the binding it checked, so a page needs no separate binding read on each tick. Refused with FORBIDDEN and refusal `otherLocation` when the given `locationId` is not the binding's location, and with FORBIDDEN or UNAUTHORIZED once the binding, its session or its venue permission is no longer current; a refused heartbeat records no presence. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bindingId":{"type":"string","format":"uuid"},"foreground":{"type":"boolean"},"locationId":{"type":"string","minLength":1,"maxLength":128}},"required":["bindingId","foreground"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"},"locationId":{"type":"string","minLength":1,"maxLength":128},"legacyInstallId":{"type":"string","minLength":1,"maxLength":128},"appVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"capabilities":{"type":"array","maxItems":32,"items":{"type":"string","minLength":1,"maxLength":128}},"bindingId":{"type":"string","format":"uuid"},"organizationId":{"type":"string","minLength":1},"lastSeenAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["instanceId","locationId","legacyInstallId","appVersion","capabilities","bindingId","organizationId","lastSeenAt"]}}}}}}},"/api/public/v1/remoteControl/acknowledge":{"post":{"operationId":"remoteControl.acknowledge","summary":"Acknowledge a diagnostic request on its device","description":"Records that the enrolled device received a diagnostic request or started running it; a received acknowledgement of a running request keeps it running. Refused with CONFLICT and refusal `alreadyRunning` when the request is already running, so only the first running acknowledgement starts it, and with FORBIDDEN or PRECONDITION_FAILED once the device binding or the request is no longer current. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"bindingId":{"type":"string","format":"uuid"},"status":{"enum":["received","running"],"type":"string"}},"required":["requestId","bindingId","status"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"accepted":{"const":true},"status":{"enum":["received","running"],"type":"string"}},"required":["accepted","status"]}}}}}}},"/api/public/v1/remoteControl/finishReload":{"post":{"operationId":"remoteControl.finishReload","summary":"Record a reload's outcome on its device","description":"Records that the enrolled device reloaded its page, or refused to with the reason its release safety gave. Only the first answer finishes the request; a later one, or one for a request that is no longer active, is refused with PRECONDITION_FAILED, and a binding that is no longer current with FORBIDDEN. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"bindingId":{"type":"string","format":"uuid"},"outcome":{"const":"completed"}},"required":["requestId","bindingId","outcome"]},{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"bindingId":{"type":"string","format":"uuid"},"outcome":{"const":"failed"},"failureReason":{"enum":["payment","printing","editing","mutation","in-use","hidden","unavailable"],"type":"string"}},"required":["requestId","bindingId","outcome","failureReason"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":["completed","failed"],"type":"string"}},"required":["status"]}}}}}}},"/api/public/v1/remoteControl/submitResult":{"post":{"operationId":"remoteControl.submitResult","description":"Runs the remoteControl.submitResult procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"bindingId":{"type":"string","format":"uuid"},"reportId":{"type":"string","format":"uuid"},"kind":{"enum":["network","application"],"type":"string"},"report":{},"outcome":{"enum":["completed","partial","failed"],"type":"string"},"failureReason":{"enum":["storage-failed","invalid-journal","storage-full","request-conflict","identity-unavailable","invalid-request","unsupported-platform","collection-failed","execution-interrupted"],"type":"string"}},"required":["bindingId","reportId","kind","outcome"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","format":"uuid"},"requestId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"outcome":{"enum":["completed","partial","failed"],"type":"string"},"sentryStatus":{"enum":["pending","sent","failed","disabled"],"type":"string"}},"required":["reportId","requestId","outcome","sentryStatus"]}}}}}}},"/api/public/v1/remoteControl/onCommands":{"post":{"operationId":"remoteControl.onCommands","description":"Runs the remoteControl.onCommands procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"acceptsReload":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/remoteControl/createRequest":{"post":{"operationId":"remoteControl.createRequest","summary":"Request a diagnostic or a page reload from a device","description":"Queues one diagnostic, or a reload of its page, for an enrolled device to pick up. A reload needs no device capability and is not held back by the location. Refused with CONFLICT and refusal `deviceBusy` while that device already has an active request, CONFLICT and refusal `locationBusy` while another device at its location has picked one up, and TOO_MANY_REQUESTS past the device's hourly limit. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"},"kind":{"enum":["network","application","reload"],"type":"string"}},"required":["instanceId","kind"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"const":1},"requestId":{"type":"string","format":"uuid"},"bindingId":{"type":"string","format":"uuid"},"kind":{"enum":["network","application","reload"],"type":"string"},"expiresAt":{"type":"string","format":"date-time","x-native-type":"date"},"status":{"const":"queued"}},"required":["version","requestId","bindingId","kind","expiresAt","status"]}}}}}}},"/api/public/v1/remoteControl/listDevices":{"post":{"operationId":"remoteControl.listDevices","description":"Reads the remoteControl.listDevices procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"string","maxLength":3840},"locationId":{"type":"string","minLength":1,"maxLength":128}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"devices":{"type":"array","items":{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"},"locationId":{"type":"string","minLength":1,"maxLength":128},"legacyInstallId":{"type":"string","minLength":1,"maxLength":128},"appVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"capabilities":{"type":"array","maxItems":32,"items":{"type":"string","minLength":1,"maxLength":128}},"bindingId":{"type":"string","format":"uuid"},"organizationId":{"type":"string","minLength":1},"platform":{"enum":["android","ios","macos","windows","linux"],"type":"string"},"userId":{"type":"string","minLength":1},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"lastSeenAt":{"type":"string","format":"date-time","x-native-type":"date"},"foreground":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"userName":{"anyOf":[{"type":"string"},{"type":"null"}]},"presence":{"enum":["revoked","signedOut","background","online","offline"],"type":"string"},"online":{"type":"boolean"},"locationName":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationName":{"anyOf":[{"type":"string"},{"type":"null"}]},"latestRequestStatus":{"anyOf":[{"enum":["queued","received","running","expired","completed","partial","failed"],"type":"string"},{"type":"null"}]}},"required":["instanceId","locationId","legacyInstallId","appVersion","capabilities","bindingId","organizationId","platform","userId","revokedAt","lastSeenAt","foreground","createdAt","name","userName","presence","online","locationName","organizationName","latestRequestStatus"]}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["devices","nextCursor"]}}}}}}},"/api/public/v1/remoteControl/deviceDetail":{"post":{"operationId":"remoteControl.deviceDetail","description":"Reads the remoteControl.deviceDetail procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"},"cursor":{"type":"string","maxLength":128}},"required":["instanceId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"device":{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"},"locationId":{"type":"string","minLength":1,"maxLength":128},"legacyInstallId":{"type":"string","minLength":1,"maxLength":128},"appVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"capabilities":{"type":"array","maxItems":32,"items":{"type":"string","minLength":1,"maxLength":128}},"bindingId":{"type":"string","format":"uuid"},"organizationId":{"type":"string","minLength":1},"platform":{"enum":["android","ios","macos","windows","linux"],"type":"string"},"userId":{"type":"string","minLength":1},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"lastSeenAt":{"type":"string","format":"date-time","x-native-type":"date"},"foreground":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"userName":{"anyOf":[{"type":"string"},{"type":"null"}]},"presence":{"enum":["revoked","signedOut","background","online","offline"],"type":"string"},"online":{"type":"boolean"},"locationName":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["instanceId","locationId","legacyInstallId","appVersion","capabilities","bindingId","organizationId","platform","userId","revokedAt","lastSeenAt","foreground","createdAt","name","userName","presence","online","locationName","organizationName"]},"requests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"instanceId":{"type":"string","format":"uuid"},"bindingId":{"type":"string","format":"uuid"},"organizationId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1},"requestedById":{"type":"string","minLength":1},"kind":{"enum":["network","application","reload"],"type":"string"},"status":{"enum":["queued","received","running","expired","completed","partial","failed"],"type":"string"},"expiresAt":{"type":"string","format":"date-time","x-native-type":"date"},"receivedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"startedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"failureReason":{"anyOf":[{"enum":["payment","printing","editing","mutation","in-use","hidden","unavailable"],"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","instanceId","bindingId","organizationId","locationId","requestedById","kind","status","expiresAt","receivedAt","startedAt","finishedAt","failureReason","createdAt","updatedAt"]}},"reports":{"type":"array","items":{"type":"object","properties":{"reportId":{"type":"string","format":"uuid"},"requestId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"kind":{"enum":["network","application"],"type":"string"},"outcome":{"enum":["completed","partial","failed"],"type":"string"},"failureReason":{"anyOf":[{"enum":["storage-failed","invalid-journal","storage-full","request-conflict","identity-unavailable","invalid-request","unsupported-platform","collection-failed","execution-interrupted"],"type":"string"},{"type":"null"}]},"organizationId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"sentryStatus":{"enum":["pending","sent","failed","disabled"],"type":"string"},"sentryEventId":{"type":"string","minLength":1}},"required":["reportId","requestId","kind","outcome","failureReason","organizationId","locationId","createdAt","sentryStatus","sentryEventId"]}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"printers":{"type":"array","items":{"type":"object","properties":{"printerId":{"type":"string","minLength":1},"printerName":{"type":"string"},"reached":{"type":"boolean"},"checkedAgoSeconds":{"type":"number"}},"required":["printerId","printerName","reached","checkedAgoSeconds"]}}},"required":["device","requests","reports","nextCursor","printers"]}}}}}}},"/api/public/v1/remoteControl/reportDetail":{"post":{"operationId":"remoteControl.reportDetail","description":"Reads the remoteControl.reportDetail procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"type":"string","format":"uuid"}},"required":["reportId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"requestId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"kind":{"enum":["network","application"],"type":"string"},"outcome":{"enum":["completed","partial","failed"],"type":"string"},"failureReason":{"anyOf":[{"enum":["storage-failed","invalid-journal","storage-full","request-conflict","identity-unavailable","invalid-request","unsupported-platform","collection-failed","execution-interrupted"],"type":"string"},{"type":"null"}]},"organizationId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"sentryStatus":{"enum":["pending","sent","failed","disabled"],"type":"string"},"sentryEventId":{"type":"string","minLength":1},"id":{"type":"string","format":"uuid"},"instanceId":{"type":"string","format":"uuid"},"bindingId":{"type":"string","format":"uuid"},"userId":{"type":"string","minLength":1},"payload":{"anyOf":[{"anyOf":[{"type":"object","properties":{"reportId":{"type":"string","minLength":1,"maxLength":1024},"startedAt":{"type":"string","maxLength":1024},"finishedAt":{"type":"string","maxLength":1024},"completeness":{"enum":["complete","partial","limited"],"type":"string"},"identity":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":1024},"locationId":{"type":"string","minLength":1,"maxLength":1024},"installId":{"type":"string","minLength":1,"maxLength":1024}},"required":["organizationId","locationId","installId"]},"environment":{"type":"object","properties":{"platform":{"enum":["native","browser"],"type":"string"},"userAgent":{"type":"string","maxLength":1024},"osPlatform":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"nativeAppVersion":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"nativeProtocolVersion":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"nativeCapabilities":{"type":"array","maxItems":128,"items":{"type":"string","maxLength":1024}},"webRelease":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]}},"required":["platform","userAgent","osPlatform","nativeAppVersion","nativeProtocolVersion","nativeCapabilities","webRelease"]},"failures":{"type":"array","maxItems":128,"items":{"type":"object","properties":{"step":{"type":"string","minLength":1,"maxLength":1024},"reason":{"type":"string","maxLength":1024}},"required":["step","reason"]}},"limitations":{"type":"array","maxItems":128,"items":{"type":"string","maxLength":1024}},"version":{"const":2},"scope":{"type":"string","maxLength":1024},"discovery":{"anyOf":[{"type":"object","properties":{"mdns":{"anyOf":[{"type":"object","properties":{"state":{"const":"running"}},"required":["state"]},{"type":"object","properties":{"state":{"const":"succeeded"}},"required":["state"]},{"type":"object","properties":{"state":{"const":"failed"},"reason":{"type":"string","maxLength":1024}},"required":["state","reason"]}]},"scan":{"anyOf":[{"type":"object","properties":{"state":{"const":"running"}},"required":["state"]},{"type":"object","properties":{"state":{"const":"succeeded"}},"required":["state"]},{"type":"object","properties":{"state":{"const":"failed"},"reason":{"type":"string","maxLength":1024}},"required":["state","reason"]}]}},"required":["mdns","scan"]},{"type":"null"}]},"endpoints":{"type":"array","maxItems":256,"items":{"type":"object","properties":{"address":{"type":"string","maxLength":1024},"host":{"type":"string","maxLength":1024},"port":{"type":"integer","minimum":1,"maximum":65535},"label":{"type":"string","maxLength":1024},"model":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"discoveredBy":{"type":"array","maxItems":2,"items":{"enum":["mdns","scan"],"type":"string"}},"status":{"enum":["reachable","discovered"],"type":"string"},"macAddress":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"matchedPrinterIds":{"type":"array","maxItems":64,"items":{"type":"string","minLength":1,"maxLength":1024}}},"required":["address","host","port","label","model","discoveredBy","status","macAddress","matchedPrinterIds"]}},"endpointsOmitted":{"type":"integer","minimum":0,"maximum":9007199254740991},"printers":{"anyOf":[{"type":"array","maxItems":64,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":1024},"name":{"type":"string","maxLength":1024},"transport":{"enum":["network","serial","ble","usb"],"type":"string"},"address":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"status":{"enum":["reachable","unreachable","unknown"],"type":"string"},"reason":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"matchedEndpoint":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]}},"required":["id","name","transport","address","status","reason","matchedEndpoint"]}},{"type":"null"}]},"networkMap":{"anyOf":[{"type":"object","properties":{"state":{"enum":["scanning","completed","cancelled"],"type":"string"},"os":{"type":"object","properties":{"platform":{"type":"string"},"version":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["platform","version"]},"interfaces":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"family":{"enum":["ipv4","ipv6"],"type":"string"},"prefixLength":{"type":"number"}},"required":["address","family","prefixLength"]}},"gateways":{"type":"array","items":{"type":"string"}},"macAddress":{"type":"string"}},"required":["name","addresses","gateways"]}},"hosts":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"interfaceName":{"type":"string"},"hostname":{"type":"string"},"macAddress":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"port":{"type":"number"},"source":{"enum":["mdns","tcp"],"type":"string"},"reachable":{"type":"boolean"}},"required":["port","source"]}},"reachability":{"enum":["reachable","unknown"],"type":"string"},"latencyMs":{"type":"number"},"sources":{"type":"array","items":{"enum":["local","gateway","mdns","tcp"],"type":"string"}}},"required":["address","services","reachability","sources"]}},"sources":{"type":"object","properties":{"interfaces":{"anyOf":[{"type":"object","properties":{"state":{"enum":["running","succeeded"],"type":"string"}},"required":["state"]},{"type":"object","properties":{"state":{"enum":["failed","unsupported"],"type":"string"},"reason":{"type":"string"}},"required":["state","reason"]}]},"mdns":{"anyOf":[{"type":"object","properties":{"state":{"enum":["running","succeeded"],"type":"string"}},"required":["state"]},{"type":"object","properties":{"state":{"enum":["failed","unsupported"],"type":"string"},"reason":{"type":"string"}},"required":["state","reason"]}]},"scan":{"anyOf":[{"type":"object","properties":{"state":{"enum":["running","succeeded"],"type":"string"}},"required":["state"]},{"type":"object","properties":{"state":{"enum":["failed","unsupported"],"type":"string"},"reason":{"type":"string"}},"required":["state","reason"]}]}},"required":["interfaces","mdns","scan"]},"limitations":{"type":"array","items":{"type":"string"}},"bounds":{"type":"object","properties":{"maxHosts":{"type":"number"},"maxServices":{"type":"number"},"maxDurationMs":{"type":"number"},"ports":{"type":"array","items":{"type":"number"}}},"required":["maxHosts","maxServices","maxDurationMs","ports"]},"truncated":{"type":"boolean"}},"required":["state","os","interfaces","hosts","sources","limitations","bounds","truncated"]},{"type":"null"}]},"unavailable":{"type":"object","properties":{"macAddress":{"type":"string","maxLength":1024},"interfaces":{"type":"string","maxLength":1024},"gateway":{"type":"string","maxLength":1024},"osVersion":{"type":"string","maxLength":1024}}}},"required":["reportId","startedAt","finishedAt","completeness","identity","environment","failures","limitations","version","scope","discovery","endpoints","endpointsOmitted","printers","networkMap","unavailable"]},{"type":"object","properties":{"reportId":{"type":"string","minLength":1,"maxLength":1024},"startedAt":{"type":"string","maxLength":1024},"finishedAt":{"type":"string","maxLength":1024},"completeness":{"enum":["complete","partial","limited"],"type":"string"},"identity":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":1024},"locationId":{"type":"string","minLength":1,"maxLength":1024},"installId":{"type":"string","minLength":1,"maxLength":1024}},"required":["organizationId","locationId","installId"]},"environment":{"type":"object","properties":{"platform":{"enum":["native","browser"],"type":"string"},"userAgent":{"type":"string","maxLength":1024},"osPlatform":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"nativeAppVersion":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]},"nativeProtocolVersion":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"nativeCapabilities":{"type":"array","maxItems":128,"items":{"type":"string","maxLength":1024}},"webRelease":{"anyOf":[{"type":"string","maxLength":1024},{"type":"null"}]}},"required":["platform","userAgent","osPlatform","nativeAppVersion","nativeProtocolVersion","nativeCapabilities","webRelease"]},"failures":{"type":"array","maxItems":128,"items":{"type":"object","properties":{"step":{"type":"string","minLength":1,"maxLength":1024},"reason":{"type":"string","maxLength":1024}},"required":["step","reason"]}},"limitations":{"type":"array","maxItems":128,"items":{"type":"string","maxLength":1024}},"version":{"const":1},"reportType":{"const":"application"},"snapshot":{"type":"object","properties":{"version":{"const":1},"collectedAt":{"type":"string"},"durationMs":{"type":"number"},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"source":{"type":"string"},"status":{"enum":["available","unsupported","permission-denied","not-applicable","collection-failed"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]},"reason":{"type":"string"}},"required":["key","source","status"]}},"interfaces":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"source":{"type":"string"},"status":{"enum":["available","unsupported","permission-denied","not-applicable","collection-failed"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]},"reason":{"type":"string"}},"required":["key","source","status"]}}},"required":["id","fields"]}},"peripherals":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"source":{"type":"string"},"status":{"enum":["available","unsupported","permission-denied","not-applicable","collection-failed"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}}]},"reason":{"type":"string"}},"required":["key","source","status"]}},"kind":{"enum":["bluetooth","usb"],"type":"string"}},"required":["id","fields","kind"]}},"limitations":{"type":"array","items":{"type":"string"}},"truncated":{"type":"boolean"}},"required":["version","collectedAt","durationMs","fields","interfaces","peripherals","limitations","truncated"]},"browserFields":{"type":"array","maxItems":34,"items":{"anyOf":[{"type":"object","properties":{"key":{"enum":["browser.userAgent","browser.platform","browser.logicalProcessors","browser.approximateMemoryGiB","browser.heapUsedBytes","browser.heapLimitBytes","browser.online","browser.connectionType","browser.effectiveConnectionType","browser.downlinkMbps","browser.roundTripMs","browser.saveData","browser.language","browser.languages","browser.timeZone","browser.displayWidthPixels","browser.displayHeightPixels","browser.pixelRatio","browser.orientation","browser.visibility","browser.focused","browser.pageUptimeSeconds","browser.secureContext","browser.cookiesEnabled","browser.originQuotaBytes","browser.originUsageBytes","browser.batteryLevelFraction","browser.batteryCharging","browser.permission.geolocation","browser.permission.notifications","browser.permission.camera","browser.permission.microphone","browser.bluetoothAuthorizedDevices","browser.usbAuthorizedDevices"],"type":"string"},"source":{"type":"string","minLength":1,"maxLength":256},"status":{"const":"available"},"value":{"anyOf":[{"type":"string","maxLength":256},{"type":"number"},{"type":"boolean"},{"type":"array","maxItems":32,"items":{"type":"string","maxLength":256}}]}},"required":["key","source","status","value"]},{"type":"object","properties":{"key":{"enum":["browser.userAgent","browser.platform","browser.logicalProcessors","browser.approximateMemoryGiB","browser.heapUsedBytes","browser.heapLimitBytes","browser.online","browser.connectionType","browser.effectiveConnectionType","browser.downlinkMbps","browser.roundTripMs","browser.saveData","browser.language","browser.languages","browser.timeZone","browser.displayWidthPixels","browser.displayHeightPixels","browser.pixelRatio","browser.orientation","browser.visibility","browser.focused","browser.pageUptimeSeconds","browser.secureContext","browser.cookiesEnabled","browser.originQuotaBytes","browser.originUsageBytes","browser.batteryLevelFraction","browser.batteryCharging","browser.permission.geolocation","browser.permission.notifications","browser.permission.camera","browser.permission.microphone","browser.bluetoothAuthorizedDevices","browser.usbAuthorizedDevices"],"type":"string"},"source":{"type":"string","minLength":1,"maxLength":256},"status":{"enum":["unsupported","permission-denied","not-applicable","collection-failed"],"type":"string"},"value":{"not":{}},"reason":{"type":"string","minLength":1,"maxLength":512}},"required":["key","source","status","reason"]}]}}},"required":["reportId","startedAt","finishedAt","completeness","identity","environment","failures","limitations","version","reportType","snapshot","browserFields"]}]},{"type":"null"}]},"payloadHash":{"type":"string","minLength":1},"sentryAttempts":{"type":"integer","minimum":0,"maximum":9007199254740991},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["requestId","kind","outcome","failureReason","organizationId","locationId","createdAt","sentryStatus","sentryEventId","id","instanceId","bindingId","userId","payload","payloadHash","sentryAttempts","updatedAt"]}}}}}}},"/api/public/v1/remoteControl/rename":{"post":{"operationId":"remoteControl.rename","description":"Runs the remoteControl.rename procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"},"name":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}]}},"required":["instanceId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name"]}}}}}}},"/api/public/v1/remoteControl/revoke":{"post":{"operationId":"remoteControl.revoke","description":"Runs the remoteControl.revoke procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"instanceId":{"type":"string","format":"uuid"}},"required":["instanceId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"revoked":{"const":true}},"required":["revoked"]}}}}}}},"/api/public/v1/customerDisplay/onDisplay":{"post":{"operationId":"customerDisplay.onDisplay","description":"Runs the customerDisplay.onDisplay procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"displayId":{"type":"string","format":"uuid"}},"required":["locationId","displayId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customerDisplay/standby":{"post":{"operationId":"customerDisplay.standby","description":"Reads the customerDisplay.standby procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"tag":{"enum":["best_seller","signature"],"type":"string"},"imageUrl":{"type":"string"},"image":{"anyOf":[{"type":"object","properties":{"srcSet":{"type":"string"}},"required":["srcSet"]},{"type":"null"}]},"variations":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"priceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","priceCents"]}}},"required":["id","name","tag","imageUrl","image","variations"]}},"loyalty":{"anyOf":[{"type":"object","properties":{"organizationName":{"type":"string"},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"cashbackBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"signupUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"card":{"type":"object","properties":{"background":{"type":"string"},"foreground":{"type":"string"},"pointsLabel":{"type":"string"}},"required":["background","foreground","pointsLabel"]}},"required":["organizationName","logoUrl","cashbackBasisPoints","signupUrl","card"]},{"type":"null"}]}},"required":["items","loyalty"]}}}}}}},"/api/public/v1/customerDisplay/pairing":{"post":{"operationId":"customerDisplay.pairing","description":"Reads the customerDisplay.pairing procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"tillId":{"type":"string","format":"uuid"}},"required":["locationId","tillId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"paired":{"type":"boolean"}},"required":["paired"]}}}}}}},"/api/public/v1/customerDisplay/pair":{"post":{"operationId":"customerDisplay.pair","description":"Runs the customerDisplay.pair procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"tillId":{"type":"string","format":"uuid"},"code":{"type":"string","pattern":"^\\d{4}$"}},"required":["locationId","tillId","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"paired":{"type":"boolean"}},"required":["paired"]}}}}}}},"/api/public/v1/customerDisplay/unpair":{"post":{"operationId":"customerDisplay.unpair","description":"Runs the customerDisplay.unpair procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"tillId":{"type":"string","format":"uuid"}},"required":["locationId","tillId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customerDisplay/claim":{"post":{"operationId":"customerDisplay.claim","description":"Runs the customerDisplay.claim procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"displayId":{"type":"string","format":"uuid"},"phone":{"type":"string","minLength":1,"maxLength":40}},"required":["locationId","displayId","phone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"isNewMember":{"type":"boolean"},"balanceHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"earnedHundredths":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["isNewMember","balanceHundredths","earnedHundredths"]}}}}}}},"/api/public/v1/customerDisplay/respond":{"post":{"operationId":"customerDisplay.respond","description":"Runs the customerDisplay.respond procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"displayId":{"type":"string","format":"uuid"},"action":{"enum":["usePoints","noThanks","claiming"],"type":"string"}},"required":["locationId","displayId","action"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customerDisplay/guestAction":{"post":{"operationId":"customerDisplay.guestAction","description":"Reads the customerDisplay.guestAction procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"tillId":{"type":"string","format":"uuid"},"orderId":{"type":"string","minLength":1,"maxLength":128}},"required":["locationId","tillId","orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"anyOf":[{"enum":["joined","usePoints","noThanks","claiming"],"type":"string"},{"type":"null"}]}},"required":["action"]}}}}}}},"/api/public/v1/customerDisplay/tip":{"post":{"operationId":"customerDisplay.tip","description":"Runs the customerDisplay.tip procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"displayId":{"type":"string","format":"uuid"},"tip":{"anyOf":[{"type":"object","properties":{"kind":{"const":"preset"},"key":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","key"]},{"type":"object","properties":{"kind":{"const":"custom"},"cents":{"type":"integer","minimum":100,"maximum":999900,"multipleOf":100}},"required":["kind","cents"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]}},"required":["locationId","displayId","tip"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customerDisplay/guestTip":{"post":{"operationId":"customerDisplay.guestTip","description":"Reads the customerDisplay.guestTip procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"tillId":{"type":"string","format":"uuid"},"orderId":{"type":"string","minLength":1,"maxLength":128}},"required":["locationId","tillId","orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tip":{"anyOf":[{"anyOf":[{"type":"object","properties":{"kind":{"const":"preset"},"key":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","key"]},{"type":"object","properties":{"kind":{"const":"custom"},"cents":{"type":"integer","minimum":100,"maximum":999900,"multipleOf":100}},"required":["kind","cents"]},{"type":"object","properties":{"kind":{"const":"none"}},"required":["kind"]}]},{"type":"null"}]}},"required":["tip"]}}}}}}},"/api/public/v1/customerDisplay/thanksOffer":{"post":{"operationId":"customerDisplay.thanksOffer","description":"Reads the customerDisplay.thanksOffer procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"tillId":{"type":"string","format":"uuid"},"orderId":{"type":"string","minLength":1,"maxLength":128}},"required":["locationId","tillId","orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"pointsHundredths":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["pointsHundredths"]},{"type":"null"}]}}}}}}},"/api/public/v1/customerDisplay/publish":{"post":{"operationId":"customerDisplay.publish","description":"Runs the customerDisplay.publish procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":128},"tillId":{"type":"string","format":"uuid"},"order":{"anyOf":[{"type":"object","properties":{"orderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"currency":{"anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}]},"lines":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":500},"variationName":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"default":null},"modifiers":{"type":"array","maxItems":50,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","maxLength":200},"quantity":{"type":"integer","minimum":0,"maximum":9007199254740991},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"default":0}},"required":["id","name","quantity"]},"default":[]},"quantity":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"itemCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"default":null},"discount":{"anyOf":[{"type":"object","properties":{"percent":{"type":"number","minimum":0,"maximum":100},"passName":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"passNeedsCode":{"type":"boolean"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["percent","passName","passNeedsCode","cents"]},{"type":"null"}],"default":null},"originalCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"default":null}},"required":["id","name","quantity","totalCents"]}},"breakdown":{"anyOf":[{"type":"object","properties":{"subtotalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"itemDiscountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderDiscount":{"anyOf":[{"type":"object","properties":{"percent":{"type":"number","minimum":0,"maximum":100},"name":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["percent","name","cents"]},{"type":"null"}]},"addedVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"default":0}},"required":["subtotalCents","itemDiscountCents","orderDiscount"]},{"type":"null"}],"default":null},"vat":{"anyOf":[{"type":"object","properties":{"exclusive":{"type":"boolean"},"rows":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"beforeVat":{"type":"boolean"},"basisPoints":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]},"cents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["beforeVat","basisPoints","cents"]}}},"required":["exclusive","rows"]},{"type":"null"}],"default":null},"totalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stage":{"enum":["order","claim","tip","pay","thanks"],"type":"string","default":"order"},"pay":{"anyOf":[{"type":"object","properties":{"orderCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pointsCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"amountCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"isCash":{"type":"boolean"}},"required":["orderCents","tipCents","pointsCents","amountCents","isCash"]},{"type":"null"}],"default":null},"tip":{"anyOf":[{"type":"object","properties":{"orderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"presets":{"type":"array","maxItems":4,"items":{"type":"object","properties":{"preset":{"anyOf":[{"type":"object","properties":{"kind":{"const":"percent"},"basisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","basisPoints"]},{"type":"object","properties":{"kind":{"const":"fixed"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["preset","cents"]}}},"required":["orderCents","presets"]},{"type":"null"}],"default":null},"loyalty":{"anyOf":[{"type":"object","properties":{"pointsHundredths":{"type":"integer","minimum":0,"maximum":9007199254740991},"cashbackBasisPoints":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"balanceHundredths":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["pointsHundredths","cashbackBasisPoints","balanceHundredths"]},{"type":"null"}],"default":null},"claimable":{"type":"boolean","default":false},"claiming":{"type":"boolean","default":false}},"required":["orderId","currency","lines","totalCents"]},{"type":"null"}]}},"required":["locationId","tillId","order"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"paired":{"type":"boolean"}},"required":["paired"]}}}}}}},"/api/public/v1/support/contact":{"post":{"operationId":"support.contact","description":"Reads the support.contact procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/support/inspect":{"post":{"operationId":"support.inspect","description":"Reads the support.inspect procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/support/confirm":{"post":{"operationId":"support.confirm","description":"Runs the support.confirm procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"},"organizationId":{"type":"string","minLength":1}},"required":["token","organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/support/disconnect":{"post":{"operationId":"support.disconnect","description":"Runs the support.disconnect procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/analytics/merchantSnapshot":{"post":{"operationId":"analytics.merchantSnapshot","description":"Reads the analytics.merchantSnapshot procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"asOf":{"type":"string","format":"date-time"},"window":{"type":"object","properties":{"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"},"locationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timeZonesDiffer":{"type":"boolean"},"spansMultipleDays":{"type":"boolean"}},"required":["timeZone","fellBackToUtc","fromDate","toDate","locationCount","timeZonesDiffer","spansMultipleDays"]},"locations":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"name":{"type":"string"}},"required":["locationId","name"]}},"financial":{"type":"object","properties":{"current":{"type":"object","properties":{"windows":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"fromDate":{"type":"string"},"toDate":{"type":"string"},"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"businessDayStartHour":{"type":"integer","minimum":1,"maximum":23,"description":"The whole hour a one-venue, one-date window's business day begins at, for drawing its hours in event order; absent when the day reads on the calendar."},"intervals":{"type":"array","items":{"type":"object","properties":{"startUtc":{"type":"string"},"endUtc":{"type":"string"}},"required":["startUtc","endUtc"]}}},"required":["locationId","fromDate","toDate","timeZone","fellBackToUtc"]}},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"methods":{"type":"array","items":{"type":"object","properties":{"paymentType":{"type":"string"},"paymentMethodName":{"anyOf":[{"type":"string"},{"type":"null"}]},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unknownRefundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["paymentType","paymentMethodName","saleCents","refundedCents","netCents","refundAmountCents","unknownRefundCount","sharePercent"]}},"locations":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["locationId","figures","sharePercent"]}},"buckets":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"localDate":{"type":"string"},"localHour":{"type":"integer","minimum":0,"maximum":23},"businessDate":{"type":"string","description":"The business date the period holds this bucket by: for a venue whose current hours run past midnight, the operating day an after-midnight event belongs to; otherwise localDate. localDate stays the factual calendar date."},"businessHour":{"type":"integer","minimum":0,"maximum":23,"description":"The hour this bucket reports in, on the clock of the venue's current time zone when its hours run past midnight; otherwise localHour. localHour stays the factual hour."},"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tradingRevenueCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["locationId","localDate","localHour","businessDate","businessHour","grossCents","discountCents","refundCents","netCents","tradingRevenueCents","saleCount","refundCount"]}}},"required":["currency","figures","methods","locations","buckets"]}}},"required":["windows","currencies"]},"previous":{"type":"object","properties":{"windows":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"fromDate":{"type":"string"},"toDate":{"type":"string"},"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"businessDayStartHour":{"type":"integer","minimum":1,"maximum":23,"description":"The whole hour a one-venue, one-date window's business day begins at, for drawing its hours in event order; absent when the day reads on the calendar."},"intervals":{"type":"array","items":{"type":"object","properties":{"startUtc":{"type":"string"},"endUtc":{"type":"string"}},"required":["startUtc","endUtc"]}}},"required":["locationId","fromDate","toDate","timeZone","fellBackToUtc"]}},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"methods":{"type":"array","items":{"type":"object","properties":{"paymentType":{"type":"string"},"paymentMethodName":{"anyOf":[{"type":"string"},{"type":"null"}]},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unknownRefundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["paymentType","paymentMethodName","saleCents","refundedCents","netCents","refundAmountCents","unknownRefundCount","sharePercent"]}},"locations":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["locationId","figures","sharePercent"]}},"buckets":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"localDate":{"type":"string"},"localHour":{"type":"integer","minimum":0,"maximum":23},"businessDate":{"type":"string","description":"The business date the period holds this bucket by: for a venue whose current hours run past midnight, the operating day an after-midnight event belongs to; otherwise localDate. localDate stays the factual calendar date."},"businessHour":{"type":"integer","minimum":0,"maximum":23,"description":"The hour this bucket reports in, on the clock of the venue's current time zone when its hours run past midnight; otherwise localHour. localHour stays the factual hour."},"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tradingRevenueCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["locationId","localDate","localHour","businessDate","businessHour","grossCents","discountCents","refundCents","netCents","tradingRevenueCents","saleCount","refundCount"]}}},"required":["currency","figures","methods","locations","buckets"]}}},"required":["windows","currencies"]}},"required":["current","previous"]},"financialItems":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"coverageComplete":{"type":"boolean"},"unitsComparable":{"type":"boolean"},"revenueCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityMilli":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"bestByRevenue":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"catalogItemId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"merchantName":{"type":"string"},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"unitSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastSoldOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["id","catalogItemId","name","quantityMilli","quantityUnit","netCents","revenueSharePercent","unitSharePercent","lastSoldOn"]}},"leastByRevenue":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"catalogItemId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"merchantName":{"type":"string"},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"unitSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastSoldOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["id","catalogItemId","name","quantityMilli","quantityUnit","netCents","revenueSharePercent","unitSharePercent","lastSoldOn"]}},"bestByUnits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"catalogItemId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"merchantName":{"type":"string"},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"unitSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastSoldOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["id","catalogItemId","name","quantityMilli","quantityUnit","netCents","revenueSharePercent","unitSharePercent","lastSoldOn"]}},"leastByUnits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"catalogItemId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"merchantName":{"type":"string"},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"unitSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastSoldOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["id","catalogItemId","name","quantityMilli","quantityUnit","netCents","revenueSharePercent","unitSharePercent","lastSoldOn"]}}},"required":["currency","coverageComplete","unitsComparable","revenueCents","quantityMilli","bestByRevenue","leastByRevenue","bestByUnits","leastByUnits"]}},"financialTrading":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"complete":{"type":"boolean"},"hasTimezoneFallback":{"type":"boolean"},"data":{"type":"object","properties":{"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"},"locationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timeZonesDiffer":{"type":"boolean"},"spansMultipleDays":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"on":{"type":"string","format":"date"}},"required":["netCents","orderCount","on"]}},"cells":{"type":"array","items":{"type":"object","properties":{"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"weekday":{"type":"integer","minimum":1,"maximum":7},"hour":{"type":"integer","minimum":0,"maximum":23}},"required":["netCents","orderCount","weekday","hour"]}},"peak":{"type":"object","properties":{"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["netCents","orderCount"]}},"required":["timeZone","fellBackToUtc","fromDate","toDate","locationCount","timeZonesDiffer","spansMultipleDays","days","cells","peak"]}},"required":["currency","complete","hasTimezoneFallback","data"]}},"payment":{"type":"object","properties":{"paidCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"paidCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unpaidCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unpaidCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["paidCount","paidCents","unpaidCount","unpaidCents"]},"tipsEnabled":{"type":"boolean"}},"required":["asOf","window","locations","financial","financialItems","financialTrading","payment","tipsEnabled"]}}}}}}},"/api/public/v1/analytics/dashboard":{"post":{"operationId":"analytics.dashboard","description":"Reads the analytics.dashboard procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/analytics/chart":{"post":{"operationId":"analytics.chart","summary":"Legacy operational order-value chart; use analytics.dashboard financial buckets.","description":"Reads the analytics.chart procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/analytics/sales":{"post":{"operationId":"analytics.sales","summary":"Legacy activated order values before refunds; use analytics.dashboard.financial for sales Net.","description":"Reads the analytics.sales procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]},{"type":"object","properties":{"paymentTypes":{"type":"array","minItems":1,"items":{"enum":["cash","card","wallet","mixed","other","points"],"type":"string"}}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/analytics/items":{"post":{"operationId":"analytics.items","summary":"Legacy mutable catalog line ranking; use analytics.dashboard.financialItems.","description":"Reads the analytics.items procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]},{"type":"object","properties":{"paymentTypes":{"type":"array","minItems":1,"items":{"enum":["cash","card","wallet","mixed","other","points"],"type":"string"}}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/analytics/reconciliation":{"post":{"operationId":"analytics.reconciliation","summary":"Legacy order-period tax and cumulative refunds; use analytics.dashboard.financial.","description":"Reads the analytics.reconciliation procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]},{"type":"object","properties":{"paymentTypes":{"type":"array","minItems":1,"items":{"enum":["cash","card","wallet","mixed","other","points"],"type":"string"}}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/analytics/trend":{"post":{"operationId":"analytics.trend","summary":"Legacy activated-order activity; use analytics.dashboard.financialTrading.","description":"Reads the analytics.trend procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]},{"type":"object","properties":{"paymentTypes":{"type":"array","minItems":1,"items":{"enum":["cash","card","wallet","mixed","other","points"],"type":"string"}}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/analytics/venues":{"post":{"operationId":"analytics.venues","summary":"Legacy activated-order location values before refunds; use analytics.dashboard.financial.","description":"Reads the analytics.venues procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]},{"type":"object","properties":{"paymentTypes":{"type":"array","minItems":1,"items":{"enum":["cash","card","wallet","mixed","other","points"],"type":"string"}}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/analytics/venueFinancialPulse":{"post":{"operationId":"analytics.venueFinancialPulse","description":"Reads the analytics.venueFinancialPulse procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"venues":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"activityComplete":{"type":"boolean"},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"todayCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"yesterdayCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"complete":{"type":"boolean"},"comparisonComplete":{"type":"boolean"},"deltaPercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"points":{"type":"array","items":{"type":"object","properties":{"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cents"]}},"peakPoints":{"type":"array","items":{"type":"object","properties":{"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cents"]}}},"required":["currency","todayCents","yesterdayCents","complete","comparisonComplete","deltaPercent","points","peakPoints"]}},"activity":{"type":"array","items":{"type":"object","properties":{"weekday":{"type":"integer","minimum":1,"maximum":7},"hour":{"type":"integer","minimum":0,"maximum":23},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["weekday","hour","orderCount"]}}},"required":["locationId","activityComplete","currencies","activity"]}}},"required":["venues"]}}}}}}},"/api/public/v1/analytics/venuePulse":{"post":{"operationId":"analytics.venuePulse","summary":"Legacy operational venue pulse; use analytics.venueFinancialPulse.","description":"Reads the analytics.venuePulse procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/reports/financialSummary":{"post":{"operationId":"reports.financialSummary","description":"Reads the reports.financialSummary procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"current":{"type":"object","properties":{"windows":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"fromDate":{"type":"string"},"toDate":{"type":"string"},"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"businessDayStartHour":{"type":"integer","minimum":1,"maximum":23,"description":"The whole hour a one-venue, one-date window's business day begins at, for drawing its hours in event order; absent when the day reads on the calendar."},"intervals":{"type":"array","items":{"type":"object","properties":{"startUtc":{"type":"string"},"endUtc":{"type":"string"}},"required":["startUtc","endUtc"]}}},"required":["locationId","fromDate","toDate","timeZone","fellBackToUtc"]}},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"methods":{"type":"array","items":{"type":"object","properties":{"paymentType":{"type":"string"},"paymentMethodName":{"anyOf":[{"type":"string"},{"type":"null"}]},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unknownRefundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["paymentType","paymentMethodName","saleCents","refundedCents","netCents","refundAmountCents","unknownRefundCount","sharePercent"]}},"locations":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["locationId","figures","sharePercent"]}},"buckets":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"localDate":{"type":"string"},"localHour":{"type":"integer","minimum":0,"maximum":23},"businessDate":{"type":"string","description":"The business date the period holds this bucket by: for a venue whose current hours run past midnight, the operating day an after-midnight event belongs to; otherwise localDate. localDate stays the factual calendar date."},"businessHour":{"type":"integer","minimum":0,"maximum":23,"description":"The hour this bucket reports in, on the clock of the venue's current time zone when its hours run past midnight; otherwise localHour. localHour stays the factual hour."},"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tradingRevenueCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["locationId","localDate","localHour","businessDate","businessHour","grossCents","discountCents","refundCents","netCents","tradingRevenueCents","saleCount","refundCount"]}}},"required":["currency","figures","methods","locations","buckets"]}}},"required":["windows","currencies"]},"previous":{"type":"object","properties":{"windows":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"fromDate":{"type":"string"},"toDate":{"type":"string"},"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"businessDayStartHour":{"type":"integer","minimum":1,"maximum":23,"description":"The whole hour a one-venue, one-date window's business day begins at, for drawing its hours in event order; absent when the day reads on the calendar."},"intervals":{"type":"array","items":{"type":"object","properties":{"startUtc":{"type":"string"},"endUtc":{"type":"string"}},"required":["startUtc","endUtc"]}}},"required":["locationId","fromDate","toDate","timeZone","fellBackToUtc"]}},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"methods":{"type":"array","items":{"type":"object","properties":{"paymentType":{"type":"string"},"paymentMethodName":{"anyOf":[{"type":"string"},{"type":"null"}]},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unknownRefundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["paymentType","paymentMethodName","saleCents","refundedCents","netCents","refundAmountCents","unknownRefundCount","sharePercent"]}},"locations":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["locationId","figures","sharePercent"]}},"buckets":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"localDate":{"type":"string"},"localHour":{"type":"integer","minimum":0,"maximum":23},"businessDate":{"type":"string","description":"The business date the period holds this bucket by: for a venue whose current hours run past midnight, the operating day an after-midnight event belongs to; otherwise localDate. localDate stays the factual calendar date."},"businessHour":{"type":"integer","minimum":0,"maximum":23,"description":"The hour this bucket reports in, on the clock of the venue's current time zone when its hours run past midnight; otherwise localHour. localHour stays the factual hour."},"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tradingRevenueCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["locationId","localDate","localHour","businessDate","businessHour","grossCents","discountCents","refundCents","netCents","tradingRevenueCents","saleCount","refundCount"]}}},"required":["currency","figures","methods","locations","buckets"]}}},"required":["windows","currencies"]}},"required":["current","previous"]}}}}}}},"/api/public/v1/reports/financialDataset":{"post":{"operationId":"reports.financialDataset","description":"Reads the reports.financialDataset procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]},{"type":"object","properties":{"report":{"enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails"],"type":"string"}},"required":["report"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"currencies":{"type":"array","items":{"type":"string"},"readOnly":true},"accountingBasis":{"type":"string"},"columns":{"type":"array","items":{"type":"string"},"readOnly":true},"rows":{"type":"array","items":{"type":"object","properties":{"kind":{"enum":["group","child","caption","grandTotal"],"type":"string"},"level":{"anyOf":[{"const":0},{"const":1},{"const":2},{"const":3}]},"cells":{"type":"array","items":{"type":"string"},"readOnly":true}},"required":["kind","level","cells"]},"readOnly":true},"labelColumns":{"type":"object","properties":{"group":{"type":"array","items":{"type":"string"},"readOnly":true},"child":{"type":"array","items":{"type":"string"},"readOnly":true},"caption":{"type":"array","items":{"type":"string"},"readOnly":true},"grandTotal":{"type":"array","items":{"type":"string"},"readOnly":true}}},"truncated":{"type":"boolean"}},"required":["columns","rows"]}}}}}}},"/api/public/v1/reports/summary":{"post":{"operationId":"reports.summary","summary":"Legacy operational pre-refund summary; use reports.financialSummary.","description":"Reads the reports.summary procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/reports/byItems":{"post":{"operationId":"reports.byItems","summary":"Legacy operational pre-refund item totals; use reports.financialDataset with report items.","description":"Reads the reports.byItems procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/reports/byLocation":{"post":{"operationId":"reports.byLocation","summary":"Legacy operational pre-refund location totals; use reports.financialDataset with report locations.","description":"Reads the reports.byLocation procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/reports/byEmployee":{"post":{"operationId":"reports.byEmployee","summary":"Legacy operational pre-refund employee totals; use reports.financialDataset with report employees.","description":"Reads the reports.byEmployee procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/reports/paymentType":{"post":{"operationId":"reports.paymentType","summary":"Legacy collected-payment totals; use reports.financialDataset with report paymentTypes for financial Net.","description":"Reads the reports.paymentType procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/reports/refunds":{"post":{"operationId":"reports.refunds","summary":"Legacy cumulative refunds attributed to the original sale period; use reports.financialDataset with report refunds for posted returns.","description":"Reads the reports.refunds procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/reportExportJobs/create":{"post":{"operationId":"reportExportJobs.create","description":"Runs the reportExportJobs.create procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"locale":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string"},"kind":{"const":"merchant"},"target":{"type":"object","properties":{"report":{"enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails"],"type":"string"},"format":{"enum":["csv","pdf"],"type":"string"}},"required":["report","format"]},"filter":{"allOf":[{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"locationMode":{"enum":["single","all"],"type":"string","default":"single"}},"required":["locationId"]},{"type":"object","properties":{"paymentTypes":{"type":"array","minItems":1,"items":{"enum":["cash","card","wallet","mixed","other","points"],"type":"string"}}}}]}},"required":["requestId","locale","kind","target","filter"]},{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"locale":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string"},"kind":{"const":"enterprise"},"target":{"type":"object","properties":{"report":{"enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails","merchants","events"],"type":"string"},"format":{"enum":["csv","pdf"],"type":"string"}},"required":["report","format"]},"filter":{"allOf":[{"type":"object","properties":{"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}}},{"type":"object","properties":{"merchantId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1},"eventId":{"type":"string","minLength":1},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}}}]}},"required":["requestId","locale","kind","target","filter"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"enum":["merchant","enterprise"],"type":"string"},"report":{"enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails","merchants","events"],"type":"string"},"format":{"enum":["csv","pdf"],"type":"string"},"status":{"enum":["queued","running","ready","failed","expired"],"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"scopeLabel":{"type":"string"},"fromDate":{"type":"string"},"toDate":{"type":"string"},"downloadUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"errorCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","report","format","status","createdAt","expiresAt","scopeLabel","fromDate","toDate","downloadUrl","errorCode"]}}}}}}},"/api/public/v1/reportExportJobs/list":{"post":{"operationId":"reportExportJobs.list","description":"Reads the reportExportJobs.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"enum":["merchant","enterprise"],"type":"string"},"jobId":{"type":"string","format":"uuid"}},"required":["kind"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"jobs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"enum":["merchant","enterprise"],"type":"string"},"report":{"enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails","merchants","events"],"type":"string"},"format":{"enum":["csv","pdf"],"type":"string"},"status":{"enum":["queued","running","ready","failed","expired"],"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"scopeLabel":{"type":"string"},"fromDate":{"type":"string"},"toDate":{"type":"string"},"downloadUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"errorCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","report","format","status","createdAt","expiresAt","scopeLabel","fromDate","toDate","downloadUrl","errorCode"]}}},"required":["enabled","jobs"]}}}}}}},"/api/public/v1/reportExportJobs/acknowledge":{"post":{"operationId":"reportExportJobs.acknowledge","description":"Runs the reportExportJobs.acknowledge procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"enum":["merchant","enterprise"],"type":"string"},"ids":{"type":"array","maxItems":20,"items":{"type":"string","format":"uuid"}}},"required":["kind","ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/reportExportJobs/retry":{"post":{"operationId":"reportExportJobs.retry","description":"Runs the reportExportJobs.retry procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"requestId":{"type":"string","format":"uuid"}},"required":["id","requestId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"kind":{"enum":["merchant","enterprise"],"type":"string"},"report":{"enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails","merchants","events"],"type":"string"},"format":{"enum":["csv","pdf"],"type":"string"},"status":{"enum":["queued","running","ready","failed","expired"],"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"scopeLabel":{"type":"string"},"fromDate":{"type":"string"},"toDate":{"type":"string"},"downloadUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"errorCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","report","format","status","createdAt","expiresAt","scopeLabel","fromDate","toDate","downloadUrl","errorCode"]}}}}}}},"/api/public/v1/auth/enterOrganization":{"post":{"operationId":"auth.enterOrganization","description":"Runs the auth.enterOrganization procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/auth/capabilities":{"post":{"operationId":"auth.capabilities","description":"Reads the auth.capabilities procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/auth/refreshFlags":{"post":{"operationId":"auth.refreshFlags","description":"Reads the auth.refreshFlags procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"enum":["/dashboard","/catalog","/auth/create-enterprise","/auth/create-organization","/auth/venue","/auth/sign-in","/auth/sign-in-code","/auth/invitation","/auth/sign-up","/auth/purchase","/support/link","/event-join/$token","/merchant-join/$token"],"type":"string"}},"required":["path"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/auth/fortisLogoutUrl":{"post":{"operationId":"auth.fortisLogoutUrl","description":"Reads the auth.fortisLogoutUrl procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/auth/deviceAccounts":{"post":{"operationId":"auth.deviceAccounts","description":"Reads the auth.deviceAccounts procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"sessionId":{"type":"string"},"userId":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"image":{"anyOf":[{"type":"string"},{"type":"null"}]},"isCurrent":{"type":"boolean"},"unlockFactor":{"enum":["none","pin","otp"],"type":"string"}},"required":["sessionId","userId","name","email","image","isCurrent","unlockFactor"]}},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"logo":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","logo"]}},"isFull":{"type":"boolean"}},"required":["accounts","organizations","isFull"]}}}}}}},"/api/public/v1/auth/switchAccount":{"post":{"operationId":"auth.switchAccount","description":"Runs the auth.switchAccount procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","minLength":1},"organizationId":{"type":"string","minLength":1},"code":{"type":"string","pattern":"^(\\d{4}|\\d{6})$"}},"required":["sessionId","organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/auth/signOutAccount":{"post":{"operationId":"auth.signOutAccount","description":"Runs the auth.signOutAccount procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"isKept":{"type":"boolean"}},"required":["isKept"]}}}}}}},"/api/public/v1/auth/otpStatus":{"post":{"operationId":"auth.otpStatus","description":"Reads the auth.otpStatus procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]}}}}}}},"/api/public/v1/auth/startOtpEnrollment":{"post":{"operationId":"auth.startOtpEnrollment","description":"Runs the auth.startOtpEnrollment procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"secret":{"type":"string"},"qr":{"type":"object","properties":{"modules":{"type":"number"},"path":{"type":"string"}},"required":["modules","path"]}},"required":["secret","qr"]}}}}}}},"/api/public/v1/auth/confirmOtpEnrollment":{"post":{"operationId":"auth.confirmOtpEnrollment","description":"Runs the auth.confirmOtpEnrollment procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/auth/disableOtp":{"post":{"operationId":"auth.disableOtp","description":"Runs the auth.disableOtp procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/billing/classifyTestOrganization":{"post":{"operationId":"billing.classifyTestOrganization","description":"Platform admins only. Classifies the business with `organizationSlug` as a test organization, recording the admin, the time and `reason`. Classification is permanent and is what Stripe Sandbox billing requires besides the organization's FF targeting. Refused with NOT_FOUND for an unknown slug, and with PRECONDITION_FAILED as `testOrganizationRefused` for a demo, a business with Live billing records, or one with an open purchase. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationSlug":{"type":"string","minLength":1},"reason":{"type":"string","minLength":1,"maxLength":500}},"required":["organizationSlug","reason"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string"},"organizationSlug":{"type":"string"}},"required":["organizationId","organizationSlug"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/getPlan":{"post":{"operationId":"billing.getPlan","description":"The business's own monthly and yearly price, with the plan code and trial length. Deprecated: use billing.getOffer. Refused with PRECONDITION_FAILED as `organizationBrandUnknown` or `organizationRegionUnknown` when the business has no recognized brand or region, as `priceUnusable` when a configured Stripe price cannot back a subscription or the offer's prices name different products or currencies and no period remains usable, as `catalogTermsConflict` when the deployed catalog redefines a published plan or add-on version, and as `billingNotConfigured` when the offer names prices but billing is not configured. For a classified test organization, billed in the Stripe Sandbox: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee holding the `billing-sandbox` experiment, with PRECONDITION_FAILED as `sandboxEligibilityPending` until the business's `billing-sandbox-organization` targeting matches, and as `billingNotConfigured` while the Sandbox is not configured. Also refused as `intervalNotOffered` when the business's brand and region are not offered both monthly and yearly billing. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"planCode":{"type":"string"},"trialPeriodDays":{"type":"number"},"prices":{"type":"array","items":{"type":"object","properties":{"interval":{"enum":["month","year"],"type":"string"},"unitAmount":{"type":"number"},"currency":{"type":"string"}},"required":["interval","unitAmount","currency"],"additionalProperties":false}}},"required":["planCode","trialPeriodDays","prices"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/getOffer":{"post":{"operationId":"billing.getOffer","description":"The business's own plan offer: the plan code, trial length and the intervals its brand and region sell, for legacy pro (zero to two), plus every sellable tier and add-on. `availability` is `available`, `noOffer` when nothing is configured for the brand and region, or `noIntervals` when the offer names no period yet. Refused with FORBIDDEN as `demoOrganization` for a demo business. Refused with PRECONDITION_FAILED as `organizationBrandUnknown` or `organizationRegionUnknown` when the business has no recognized brand or region, as `priceUnusable` when a configured Stripe price cannot back a subscription or the offer's prices name different products or currencies and no period remains usable, as `catalogTermsConflict` when the deployed catalog redefines a published plan or add-on version, and as `billingNotConfigured` when the offer names prices but billing is not configured. For a classified test organization, billed in the Stripe Sandbox: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee holding the `billing-sandbox` experiment, with PRECONDITION_FAILED as `sandboxEligibilityPending` until the business's `billing-sandbox-organization` targeting matches, and as `billingNotConfigured` while the Sandbox is not configured.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"planCode":{"type":"string"},"trialPeriodDays":{"type":"number"},"prices":{"type":"array","items":{"type":"object","properties":{"interval":{"enum":["month","year"],"type":"string"},"unitAmount":{"type":"number"},"currency":{"type":"string"}},"required":["interval","unitAmount","currency"],"additionalProperties":false}},"availability":{"enum":["available","noOffer","noIntervals"],"type":"string"},"tiers":{"type":"array","items":{"type":"object","properties":{"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"planVersion":{"type":"number"},"includedFeatures":{"type":"array","items":{"type":"string"}},"limits":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},"availableAddons":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"}},"prices":{"type":"array","items":{"type":"object","properties":{"interval":{"enum":["month","year"],"type":"string"},"unitAmount":{"type":"number"},"currency":{"type":"string"},"intervalCount":{"type":"number"},"addons":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"}},"quoteId":{"type":"string"},"trialPeriodDays":{"type":"number"},"discountPercentOff":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["interval","unitAmount","currency","intervalCount","addons","quoteId","trialPeriodDays","discountPercentOff"],"additionalProperties":false}}},"required":["planCode","planVersion","includedFeatures","limits","availableAddons","prices"],"additionalProperties":false}},"addons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"version":{"type":"number"},"unit":{"enum":["organization","location","seat","device","usage"],"type":"string"},"grantsFeatures":{"type":"array","items":{"type":"string"}},"grantsLimits":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},"prices":{"type":"array","items":{"type":"object","properties":{"interval":{"enum":["month","year"],"type":"string"},"unitAmount":{"type":"number"},"currency":{"type":"string"},"intervalCount":{"type":"number"}},"required":["interval","unitAmount","currency","intervalCount"],"additionalProperties":false}}},"required":["code","version","unit","grantsFeatures","grantsLimits","prices"],"additionalProperties":false}},"sandbox":{"anyOf":[{"type":"object","properties":{"checkout":{"enum":["available","awaitingEligibility"],"type":"string"},"organizationSlug":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["checkout","organizationSlug"],"additionalProperties":false},{"type":"null"}]}},"required":["planCode","trialPeriodDays","prices","availability","tiers","addons","sandbox"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/getQuote":{"post":{"operationId":"billing.getQuote","description":"Prices a selection of the business's own plan, period and add-ons and returns the total, its lines and a `quoteId` that confirms exactly that. No Stripe Price id is returned. Refused as `planNotOffered`, `intervalNotOffered`, `addonNotOffered`, `addonIncompatible`, `addonRedundant`, `addonDuplicate` or `quantityUnsupported` when the selection is not sold, and as `quantityUnsupported` when `baseQuantity` is above one while the `pricing-multi-license` flag is off, with FORBIDDEN as `demoOrganization` for a demo business, and as for billing.getOffer: Refused with PRECONDITION_FAILED as `organizationBrandUnknown` or `organizationRegionUnknown` when the business has no recognized brand or region, as `priceUnusable` when a configured Stripe price cannot back a subscription or the offer's prices name different products or currencies and no period remains usable, as `catalogTermsConflict` when the deployed catalog redefines a published plan or add-on version, and as `billingNotConfigured` when the offer names prices but billing is not configured. For a classified test organization, billed in the Stripe Sandbox: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee holding the `billing-sandbox` experiment, with PRECONDITION_FAILED as `sandboxEligibilityPending` until the business's `billing-sandbox-organization` targeting matches, and as `billingNotConfigured` while the Sandbox is not configured.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"integer","minimum":1,"maximum":3,"default":1},"addons":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"quantity":{"type":"integer","minimum":1,"maximum":100,"default":1}},"required":["code"],"additionalProperties":false},"default":[]},"baseQuantity":{"type":"integer","minimum":1,"maximum":100,"default":1}},"required":["organizationId","interval"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"number"},"currency":{"type":"string"},"trialPeriodDays":{"type":"number"},"totalAmount":{"type":"number"},"amountDueToday":{"type":"number"},"discountPercentOff":{"anyOf":[{"type":"number"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","properties":{"kind":{"enum":["base","addon"],"type":"string"},"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"number"},"quantity":{"type":"number"},"unitAmount":{"type":"number"}},"required":["kind","code","interval","intervalCount","quantity","unitAmount"],"additionalProperties":false}},"quoteId":{"type":"string"}},"required":["planCode","interval","intervalCount","currency","trialPeriodDays","totalAmount","amountDueToday","discountPercentOff","items","quoteId"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/startCheckout":{"post":{"operationId":"billing.startCheckout","description":"Starts a hosted Stripe Checkout for the business's own brand and region offer at the chosen interval, optionally for a named plan and add-ons, and returns its URL; the subscription exists once Stripe confirms it. A `quoteId` from billing.getQuote is verified against the current terms. Refused with FORBIDDEN for a demo business, and with PRECONDITION_FAILED while billing is paused, as `intervalNotOffered` when the offer does not sell the interval, as `planNotOffered`, `addonNotOffered`, `addonIncompatible`, `addonRedundant`, `addonDuplicate` or `quantityUnsupported` when the selection is not sold, as `quoteRequired` when any selection other than legacy pro monthly or yearly omits `quoteId`, as `offerChanged` when `quoteId` no longer matches, as `currencyMismatch` when the business already bills in another currency, as `subscriptionExists` when it already has a subscription, as `checkoutInProgress` while another checkout of the business is being prepared or its outcome is being confirmed, as `checkoutConfirming` while a payment is being confirmed, as `previousPaymentPending`, `subscriptionUnverified`, `subscriptionConflict` or `checkoutCheckFailed` when Stripe's own state does not allow a new checkout, as `customerMismatch` when the business's Stripe Customer belongs to another organization, as `emailUnverified` before anything reaches Stripe while the caller's stored address is not verified (billing.sendEmailCode starts the verification), and as for billing.getOffer: Refused with PRECONDITION_FAILED as `organizationBrandUnknown` or `organizationRegionUnknown` when the business has no recognized brand or region, as `priceUnusable` when a configured Stripe price cannot back a subscription or the offer's prices name different products or currencies and no period remains usable, as `catalogTermsConflict` when the deployed catalog redefines a published plan or add-on version, and as `billingNotConfigured` when the offer names prices but billing is not configured. For a classified test organization, billed in the Stripe Sandbox: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee holding the `billing-sandbox` experiment, with PRECONDITION_FAILED as `sandboxEligibilityPending` until the business's `billing-sandbox-organization` targeting matches, and as `billingNotConfigured` while the Sandbox is not configured. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"integer","minimum":1,"maximum":3,"default":1},"addons":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"quantity":{"type":"integer","minimum":1,"maximum":100,"default":1}},"required":["code"],"additionalProperties":false},"default":[]},"quoteId":{"type":"string","maxLength":128}},"required":["organizationId","interval"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/billing/sendEmailCode":{"post":{"operationId":"billing.sendEmailCode","description":"Mails the caller's own stored address the code that verifies it before billing.startCheckout, as purchase.sendEmailCode does: answers `sent`, `cooldown` with `retryAfterSeconds`, `unavailable` when the mail could not be queued, or `verified`. Refused with FORBIDDEN unless the caller may manage the business's billing and for a demo business, and with TOO_MANY_REQUESTS once the account's hourly sends are spent. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"sent"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"cooldown"},"retryAfterSeconds":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["status","retryAfterSeconds"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"unavailable"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"verified"}},"required":["status"],"additionalProperties":false}]}}}}}}},"/api/public/v1/billing/verifyEmailCode":{"post":{"operationId":"billing.verifyEmailCode","description":"Checks `code` against the code mailed to the caller's own stored address, as purchase.verifyEmailCode does: answers `verified`, `wrong`, `expired` or `locked`. Refused with FORBIDDEN unless the caller may manage the business's billing and for a demo business. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["organizationId","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"outcome":{"enum":["verified","wrong","expired","locked"],"type":"string"}},"required":["outcome"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/openPortal":{"post":{"operationId":"billing.openPortal","description":"A Stripe Customer Portal session's URL for the business, returning to its Billing page. `flow` opens it straight on replacing the card (`paymentMethodUpdate`) or cancelling the live subscription (`subscriptionCancel`); for a Live business a `flow` is refused with FORBIDDEN as `pricingPreviewDisabled` while the `pricing-preview` flag is off. Refused with FORBIDDEN for a demo business, and with PRECONDITION_FAILED when the business has no billing account yet, or no live subscription to cancel. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"flow":{"enum":["paymentMethodUpdate","subscriptionCancel"],"type":"string"}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/billing/getPaymentDetails":{"post":{"operationId":"billing.getPaymentDetails","description":"The business's payment card (brand, last four digits and expiry only) and the first page of its issued invoices, newest first, read from Stripe. Drafts are left out; zero-total invoices, such as a trial's opening invoice, are listed. `interval` is null when the invoice's price is not in the business's catalog. `nextCursor` is null when Stripe holds no more invoices, else the `cursor` for billing.listInvoices. Empty for a business with no billing account. Refused for a Live business with FORBIDDEN as `pricingPreviewDisabled` while the `pricing-preview` flag is off, and with PRECONDITION_FAILED as `billingNotConfigured` when billing is not configured. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"paymentMethod":{"anyOf":[{"type":"object","properties":{"brand":{"type":"string"},"last4":{"type":"string"},"expMonth":{"type":"number"},"expYear":{"type":"number"}},"required":["brand","last4","expMonth","expYear"],"additionalProperties":false},{"type":"null"}]},"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"enum":["open","paid","uncollectible","void"],"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"total":{"type":"number"},"currency":{"type":"string"},"interval":{"anyOf":[{"enum":["month","year"],"type":"string"},{"type":"null"}]},"plan":{"anyOf":[{"type":"object","properties":{"planCode":{"type":"string"},"planVersion":{"type":"number"}},"required":["planCode","planVersion"],"additionalProperties":false},{"type":"null"}]},"hostedInvoiceUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","number","status","createdAt","total","currency","interval","plan","hostedInvoiceUrl"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["paymentMethod","invoices","nextCursor"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/listInvoices":{"post":{"operationId":"billing.listInvoices","description":"The next page of the business's issued invoices, newest first, after `cursor`: the `nextCursor` billing.getPaymentDetails or an earlier page returned. Drafts are left out and zero-total invoices are listed, as for billing.getPaymentDetails; `nextCursor` is null on the last page. Empty for a business with no billing account. Refused for a Live business with FORBIDDEN as `pricingPreviewDisabled` while the `pricing-preview` flag is off, with BAD_REQUEST when `cursor` is not one of the business's invoices, and with PRECONDITION_FAILED as `billingNotConfigured` when billing is not configured. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"cursor":{"type":"string","maxLength":255,"pattern":"^in_[A-Za-z0-9_]+$"}},"required":["organizationId","cursor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"enum":["open","paid","uncollectible","void"],"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"total":{"type":"number"},"currency":{"type":"string"},"interval":{"anyOf":[{"enum":["month","year"],"type":"string"},{"type":"null"}]},"plan":{"anyOf":[{"type":"object","properties":{"planCode":{"type":"string"},"planVersion":{"type":"number"}},"required":["planCode","planVersion"],"additionalProperties":false},{"type":"null"}]},"hostedInvoiceUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","number","status","createdAt","total","currency","interval","plan","hostedInvoiceUrl"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["invoices","nextCursor"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/getStanding":{"post":{"operationId":"billing.getStanding","description":"Where the business stands for new commitments: `open`; `readOnly` once an overdue subscription's grace has run out; or `suspended` once its verified base plan has ended with no eligible base in its place until the suspended operation policy explicitly relaxes every operation category for it. `suspension` is set whenever that verified suspension still refuses or warns in a category, beside `open` too while every category is relaxed and some only warn: `enforced` lists the categories whose new commitments are refused with `subscriptionEnded`, `warned` those that go through with their normal result and status while the subscription stays ended, and `recovery` the way back; it is `null` otherwise. A suspended business's `recovery` is `purchase` (start a new subscription), `resume` (resume the paused one through `resumeSubscription`) or `billing` (recover the one Stripe still holds through `openPortal`, such as paying an unpaid invoice); `canRestore` says whether the caller may manage the business's billing. Requires `order:read` at the business, so a role without order access is refused with FORBIDDEN; `getSuspensionNotice` returns the same answer to every member.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"standing":{"enum":["open","readOnly","suspended"],"type":"string"},"recovery":{"anyOf":[{"enum":["purchase","resume","billing"],"type":"string"},{"type":"null"}]},"canRestore":{"type":"boolean"},"suspension":{"anyOf":[{"type":"object","properties":{"enforced":{"type":"array","items":{"enum":["posOrders","orderExpansions","catalog","bookings","guestOrdering","loyalty","locations","imports"],"type":"string"}},"warned":{"type":"array","items":{"enum":["posOrders","orderExpansions","catalog","bookings","guestOrdering","loyalty","locations","imports"],"type":"string"}},"recovery":{"enum":["purchase","resume","billing"],"type":"string"}},"required":["enforced","warned","recovery"]},{"type":"null"}]}},"required":["standing","recovery","canRestore","suspension"]}}}}}}},"/api/public/v1/billing/getSuspensionNotice":{"post":{"operationId":"billing.getSuspensionNotice","description":"The same answer as `getStanding`, readable by every member of the business whatever their role grants, for the subscription-ended notice. `suspension` is set whenever the business's verified suspension still refuses or warns in an operation category, beside `standing: open` too while every category is relaxed and some only warn: `enforced` lists the categories whose new commitments are refused with `subscriptionEnded`, `warned` those that go through with their normal result and status while the subscription stays ended, and `recovery` the way back (`purchase`, `resume` or `billing`); it is `null` otherwise. `canRestore` says whether the caller may manage the business's billing. Refused with FORBIDDEN for a caller with no membership at the business, directly or through its enterprise, inside the credential's grant.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"standing":{"enum":["open","readOnly","suspended"],"type":"string"},"recovery":{"anyOf":[{"enum":["purchase","resume","billing"],"type":"string"},{"type":"null"}]},"canRestore":{"type":"boolean"},"suspension":{"anyOf":[{"type":"object","properties":{"enforced":{"type":"array","items":{"enum":["posOrders","orderExpansions","catalog","bookings","guestOrdering","loyalty","locations","imports"],"type":"string"}},"warned":{"type":"array","items":{"enum":["posOrders","orderExpansions","catalog","bookings","guestOrdering","loyalty","locations","imports"],"type":"string"}},"recovery":{"enum":["purchase","resume","billing"],"type":"string"}},"required":["enforced","warned","recovery"]},{"type":"null"}]}},"required":["standing","recovery","canRestore","suspension"]}}}}}}},"/api/public/v1/billing/resumeSubscription":{"post":{"operationId":"billing.resumeSubscription","description":"Asks Stripe to resume the business's paused subscription, invoicing it now against the card on file; replace the card first through `openPortal` with `paymentMethodUpdate`. Access returns once Stripe's verified webhook reports the subscription in good standing, never on this answer. Refused with FORBIDDEN for a demo business, and with PRECONDITION_FAILED while Live billing is paused for the business, when it has no paused subscription, as `subscriptionExists` while another subscription stands beside it, as `customerMismatch` when the paused subscription is not on the business's own billing account, and as `subscriptionUnverified` when Stripe no longer reports it paused. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/billing/getStatus":{"post":{"operationId":"billing.getStatus","description":"Reads the billing.getStatus procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/billing/getGrantedPlan":{"post":{"operationId":"billing.getGrantedPlan","description":"Reads the billing.getGrantedPlan procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"planCode":{"enum":["starter","essential"],"type":"string"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"next":{"anyOf":[{"type":"object","properties":{"planCode":{"enum":["starter","essential"],"type":"string"},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["planCode","startsAt","endsAt"]},{"type":"null"}]}},"required":["planCode","endsAt","next"]},{"type":"null"}]}}}}}}},"/api/public/v1/billing/getCheckoutReturn":{"post":{"operationId":"billing.getCheckoutReturn","description":"What became of one of the caller's own Billing Checkouts, by the Checkout Session id Stripe returned: the business it was for, `checkout` as `open` (not confirmed yet), `complete` or `expired`, and, once `checkout` is `complete`, `subscription` as the Stripe status of the subscription this Checkout started (`trialing`, `active`, `past_due`, `incomplete`, `incomplete_expired`, `unpaid`, `paused` or `canceled`), or null until the webhook records it; no other subscription of the business is reported, and a completed Checkout is no evidence of a charge. Null for an id that is not one of the caller's own Checkouts, and once the caller may no longer manage that business's billing, alike.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","minLength":1,"maxLength":255}},"required":["sessionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"organizationId":{"type":"string"},"organizationName":{"type":"string"},"checkout":{"enum":["open","complete","expired"],"type":"string"},"subscription":{"anyOf":[{"enum":["trialing","active","past_due","canceled","incomplete","incomplete_expired","unpaid","paused"],"type":"string"},{"type":"null"}]}},"required":["organizationId","organizationName","checkout","subscription"],"additionalProperties":false},{"type":"null"}]}}}}}}},"/api/public/v1/billing/getLocationLicensing":{"post":{"operationId":"billing.getLocationLicensing","description":"The business's licensed locations for each location-billed line: the licensed location ids, the paid quantity, the target quantity and the sync state (`inSync`, `pending`, `awaitingStripe` or `blocked`). Empty `lines` when nothing is billed per location. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"billableLocationCount":{"type":"number"},"lines":{"type":"array","items":{"type":"object","properties":{"licenseCode":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},{"const":"base"}]},"licensedLocationIds":{"type":"array","items":{"type":"string"}},"providerQuantity":{"type":"number"},"paidQuantity":{"type":"number"},"unverifiedQuantity":{"type":"number"},"licensedCapacity":{"type":"number"},"targetQuantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"syncState":{"enum":["inSync","pending","awaitingStripe","blocked","termsUnresolved"],"type":"string"},"discrepancy":{"type":"boolean"}},"required":["licenseCode","licensedLocationIds","providerQuantity","paidQuantity","unverifiedQuantity","licensedCapacity","targetQuantity","syncState","discrepancy"],"additionalProperties":false}}},"required":["billableLocationCount","lines"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/getBaseLicensing":{"post":{"operationId":"billing.getBaseLicensing","description":"The business's base-plan licenses: `state` (`noSubscription`, `eligible`, `unverified`, `pastDue`, `legacyUnrestricted` or `unavailable`), whether a location may be given one now (`canAssign`), the mirrored and verified quantities, the assigned location ids and the free count. Never calls Stripe. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"enum":["noSubscription","eligible","unverified","pastDue","legacyUnrestricted","unavailable"],"type":"string"},"canAssign":{"type":"boolean"},"providerQuantity":{"type":"number"},"verifiedCapacity":{"type":"number"},"unverifiedQuantity":{"type":"number"},"assignedLocationIds":{"type":"array","items":{"type":"string"}},"assignedCount":{"type":"number"},"freeCount":{"type":"number"}},"required":["state","canAssign","providerQuantity","verifiedCapacity","unverifiedQuantity","assignedLocationIds","assignedCount","freeCount"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/assignBaseLicense":{"post":{"operationId":"billing.assignBaseLicense","description":"Gives a location of the business one of its free, verified base licenses; a location that holds one already is left as it is. Refused with NOT_FOUND as `locationNotFound` for a location that is not the business's own, and with PRECONDITION_FAILED as `locationArchived` for an archived one and as `baseLicenseUnavailable` unless the base is `eligible` with a free license. Never changes what Stripe bills. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1}},"required":["organizationId","locationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"enum":["noSubscription","eligible","unverified","pastDue","legacyUnrestricted","unavailable"],"type":"string"},"canAssign":{"type":"boolean"},"providerQuantity":{"type":"number"},"verifiedCapacity":{"type":"number"},"unverifiedQuantity":{"type":"number"},"assignedLocationIds":{"type":"array","items":{"type":"string"}},"assignedCount":{"type":"number"},"freeCount":{"type":"number"}},"required":["state","canAssign","providerQuantity","verifiedCapacity","unverifiedQuantity","assignedLocationIds","assignedCount","freeCount"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/releaseBaseLicense":{"post":{"operationId":"billing.releaseBaseLicense","description":"Deprecated: a base license, once assigned, is never released by the business; it ends only when its location is archived, the verified license count falls or the subscription ends. Always refused with PRECONDITION_FAILED as `baseLicenseLocked` after the caller's access is checked. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1}},"required":["organizationId","locationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"enum":["noSubscription","eligible","unverified","pastDue","legacyUnrestricted","unavailable"],"type":"string"},"canAssign":{"type":"boolean"},"providerQuantity":{"type":"number"},"verifiedCapacity":{"type":"number"},"unverifiedQuantity":{"type":"number"},"assignedLocationIds":{"type":"array","items":{"type":"string"}},"assignedCount":{"type":"number"},"freeCount":{"type":"number"}},"required":["state","canAssign","providerQuantity","verifiedCapacity","unverifiedQuantity","assignedLocationIds","assignedCount","freeCount"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/reassignBaseLicense":{"post":{"operationId":"billing.reassignBaseLicense","description":"Deprecated: a base license, once assigned, is never moved to another location by the business. Always refused with PRECONDITION_FAILED as `baseLicenseLocked` after the caller's access is checked. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"fromLocationId":{"type":"string","minLength":1},"toLocationId":{"type":"string","minLength":1}},"required":["organizationId","fromLocationId","toLocationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"enum":["noSubscription","eligible","unverified","pastDue","legacyUnrestricted","unavailable"],"type":"string"},"canAssign":{"type":"boolean"},"providerQuantity":{"type":"number"},"verifiedCapacity":{"type":"number"},"unverifiedQuantity":{"type":"number"},"assignedLocationIds":{"type":"array","items":{"type":"string"}},"assignedCount":{"type":"number"},"freeCount":{"type":"number"}},"required":["state","canAssign","providerQuantity","verifiedCapacity","unverifiedQuantity","assignedLocationIds","assignedCount","freeCount"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/previewLocationQuantity":{"post":{"operationId":"billing.previewLocationQuantity","description":"Previews, through Stripe, the invoice effect of moving a location-billed line to the quantity the server computed. Refused as `perLocationDisabled` while `billing-per-location` is off, as `commercialTermsUnresolved` until the terms and a proration rule are configured, and as `licenseNotPaid` when the business has no eligible line with that code. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"licenseCode":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},{"const":"base"}]}},"required":["organizationId","licenseCode"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"targetQuantity":{"type":"number"},"total":{"type":"number"},"amountDue":{"type":"number"},"currency":{"type":"string"},"previewToken":{"type":"string"}},"required":["targetQuantity","total","amountDue","currency","previewToken"],"additionalProperties":false}}}}}}},"/api/public/v1/billing/applyLocationQuantity":{"post":{"operationId":"billing.applyLocationQuantity","description":"Applies the server-computed quantity of a location-billed line after the business confirmed `previewToken` from billing.previewLocationQuantity. Refused as `previewChanged` when Stripe's figures differ now and `perLocationDisabled` while `billing-per-location` is off. Both refuse as `commercialTermsUnresolved` until Product has configured the quantity terms and a proration rule, and applying refuses as `emailUnverified` before anything reaches Stripe while the caller's stored address is not verified. For a classified test organization's Stripe Sandbox records: refused with FORBIDDEN as `sandboxNotAllowed` unless the caller is a verified Fortune OS employee, and with PRECONDITION_FAILED as `billingNotConfigured` while the Sandbox is not configured; the experiment and targeting are not asked. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"licenseCode":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},{"const":"base"}]},"previewToken":{"type":"string","maxLength":128}},"required":["organizationId","licenseCode","previewToken"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"billableLocationCount":{"type":"number"},"lines":{"type":"array","items":{"type":"object","properties":{"licenseCode":{"anyOf":[{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},{"const":"base"}]},"licensedLocationIds":{"type":"array","items":{"type":"string"}},"providerQuantity":{"type":"number"},"paidQuantity":{"type":"number"},"unverifiedQuantity":{"type":"number"},"licensedCapacity":{"type":"number"},"targetQuantity":{"anyOf":[{"type":"number"},{"type":"null"}]},"syncState":{"enum":["inSync","pending","awaitingStripe","blocked","termsUnresolved"],"type":"string"},"discrepancy":{"type":"boolean"}},"required":["licenseCode","licensedLocationIds","providerQuantity","paidQuantity","unverifiedQuantity","licensedCapacity","targetQuantity","syncState","discrepancy"],"additionalProperties":false}}},"required":["billableLocationCount","lines"],"additionalProperties":false}}}}}}},"/api/public/v1/publicLegal/terms":{"post":{"operationId":"publicLegal.terms","description":"The host brand's Terms in the translation `locale` resolves to: that locale, else its base language, else English. Answers the Markdown source with the locale it is written in and every locale it is published in, or `null` for a brand that publishes no Terms in the app. Anonymous and read-only.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locale":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string"}},"required":["locale"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"locale":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string"},"locales":{"type":"array","items":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string"}},"markdown":{"type":"string"}},"required":["locale","locales","markdown"],"additionalProperties":false},{"type":"null"}]}}}}}}},"/api/public/v1/publicLegal/privacy":{"post":{"operationId":"publicLegal.privacy","description":"The host brand's own Privacy Notice in the translation `locale` resolves to: that locale, else its base language, else English. Answers the Markdown source with the locale it is written in and every locale it is published in, or `null` for a brand whose pack ships no Privacy Notice, which shows the product's shared notice instead. Anonymous and read-only.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locale":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string"}},"required":["locale"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"locale":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string"},"locales":{"type":"array","items":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string"}},"markdown":{"type":"string"}},"required":["locale","locales","markdown"],"additionalProperties":false},{"type":"null"}]}}}}}}},"/api/public/v1/publicPricing/getOffer":{"post":{"operationId":"publicPricing.getOffer","description":"The plans, prices, included features and limits, and compatible add-ons the request's brand sells in its market, with `market.isReference` set when the price is quoted for a reference region rather than the visitor's own. Each plan price carries the opaque `quoteId` that `startPurchase` accepts for exactly that plan and period. `availability` is `available`, or why nothing is sold: `noMarket`, `noOffer`, `noIntervals` or `notConfigured`. Anonymous and read-only: no Stripe Price id is returned and no cookie is set. Refused with FORBIDDEN as `publicPricingDisabled` while the `public-pricing` flag is off.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"availability":{"const":"available"},"market":{"type":"object","properties":{"regionId":{"type":"string"},"country":{"type":"string"},"isReference":{"type":"boolean"}},"required":["regionId","country","isReference"],"additionalProperties":false},"trialPeriodDays":{"type":"number"},"plans":{"type":"array","items":{"type":"object","properties":{"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"planVersion":{"type":"number"},"includedFeatures":{"type":"array","items":{"type":"string"}},"limits":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},"prices":{"type":"array","items":{"type":"object","properties":{"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"number"},"unitAmount":{"type":"number"},"currency":{"type":"string"},"addons":{"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"}},"quoteId":{"type":"string"}},"required":["interval","intervalCount","unitAmount","currency","addons","quoteId"],"additionalProperties":false}}},"required":["planCode","planVersion","includedFeatures","limits","prices"],"additionalProperties":false}},"addons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"unit":{"enum":["organization","location","seat","device","usage"],"type":"string"},"grantsFeatures":{"type":"array","items":{"type":"string"}},"grantsLimits":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number"}},"prices":{"type":"array","items":{"type":"object","properties":{"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"number"},"unitAmount":{"type":"number"},"currency":{"type":"string"}},"required":["interval","intervalCount","unitAmount","currency"],"additionalProperties":false}}},"required":["code","unit","grantsFeatures","grantsLimits","prices"],"additionalProperties":false}},"sandbox":{"const":true}},"required":["availability","market","trialPeriodDays","plans","addons"],"additionalProperties":false},{"type":"object","properties":{"availability":{"enum":["noMarket","noOffer","noIntervals","notConfigured"],"type":"string"}},"required":["availability"],"additionalProperties":false}]}}}}}}},"/api/public/v1/publicPricing/getHardwareOffer":{"post":{"operationId":"publicPricing.getHardwareOffer","description":"The hardware the request's brand offers in its public market: `items`, each product code's unit price in its currency's minor unit, with the deprecated `tabletUnitAmount`, `unitAmount`, `printerUnitAmount` (null where no printer is offered) and `currency`; or null when no hardware is. Read-only, anonymous and independent of the plans `getOffer` sells: no organization is read and nothing can be requested here; a request is `hardware.requestOrder`, for a signed-in Owner. Refused with FORBIDDEN as `publicPricingDisabled` while the `public-pricing` flag is off and as `hardwareRequestsDisabled` while the `hardware-requests` flag is off.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"unitAmount":{"type":"number"},"currency":{"type":"string"}},"required":["unitAmount","currency"],"additionalProperties":false}},"tabletUnitAmount":{"type":"number"},"unitAmount":{"type":"number"},"printerUnitAmount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"}},"required":["items","tabletUnitAmount","unitAmount","printerUnitAmount","currency"],"additionalProperties":false},{"type":"null"}]}}}}}}},"/api/public/v1/publicPricing/startPurchase":{"post":{"operationId":"publicPricing.startPurchase","description":"Starts or edits the caller's purchase selection from public Pricing, or replays the answer a `startKey` already recorded. Takes plan, period and add-on codes with the `quoteId` shown, never a price: any other field is refused as BAD_REQUEST. Answers `signUp` for a visitor and `continue` for a signed-in caller, with the new `choiceRevision`, and sets the signed purchase cookie for a visitor. A signed-in caller's start without a revision is a fresh choice: it replaces the plan of the caller's live purchase in the same environment and keeps its business and confirmations; a purchase frozen for a Checkout is released only after Stripe confirms every session it made is no longer payable, and is refused `checkoutCheckFailed` (freeze kept) when Stripe cannot confirm it, or `checkoutAlreadyPaid` for a session the business's standing subscription paid; it also deletes the unbound selection the browser's cookie carried from before sign-in and clears the cookie, while a refused start keeps both. With `restart`, a start over after a discarded carried plan, it instead begins a purchase only while the caller has none live in either environment, and is refused PRECONDITION_FAILED with `purchaseInProgress` otherwise, leaving that purchase untouched. Refused with FORBIDDEN and refusal `publicPricingDisabled` while the `public-pricing` flag is off, PRECONDITION_FAILED with `selectionChanged` for a stale revision or a concurrent first start, `checkoutInProgress` while a Checkout attempt is reserved or unknown, `checkoutPaymentPending` while a paid session is still being settled, `startKeyUnavailable` for a visitor's replay that lost its cookie, `purchaseIntentClosed` for a replay whose purchase closed, and the Billing refusals (`offerChanged`, `planNotOffered`, `intervalNotOffered`, the add-on refusals) for a selection the offer rejects. TOO_MANY_REQUESTS past the per-IP budget.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"integer","minimum":1,"maximum":3,"default":1},"addons":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"quantity":{"type":"integer","minimum":1,"maximum":100,"default":1}},"required":["code"],"additionalProperties":false},"default":[]},"quoteId":{"type":"string","minLength":1,"maxLength":128},"startKey":{"type":"string","format":"uuid"},"choiceRevision":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"promo":{"type":"string","maxLength":200},"restart":{"const":true}},"required":["interval","quoteId","startKey","choiceRevision"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"next":{"enum":["signUp","continue"],"type":"string"},"choiceRevision":{"type":"number"}},"required":["next","choiceRevision"],"additionalProperties":false}}}}}}},"/api/public/v1/hardware/getOffer":{"post":{"operationId":"hardware.getOffer","description":"Reads the hardware.getOffer procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"object","properties":{"unitAmount":{"type":"number"},"currency":{"type":"string"}},"required":["unitAmount","currency"],"additionalProperties":false}},"tabletUnitAmount":{"type":"number"},"unitAmount":{"type":"number"},"printerUnitAmount":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"type":"string"}},"required":["items","tabletUnitAmount","unitAmount","printerUnitAmount","currency"],"additionalProperties":false},{"type":"null"}]}}}}}}},"/api/public/v1/hardware/requestOrder":{"post":{"operationId":"hardware.requestOrder","description":"Runs the hardware.requestOrder procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"items":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-zA-Z0-9]{0,31}$"},"quantity":{"type":"integer","minimum":1,"maximum":50}},"required":["code","quantity"],"additionalProperties":false}},"tablets":{"type":"integer","minimum":0,"maximum":50},"printers":{"type":"integer","minimum":0,"maximum":50},"contact":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","maxLength":254,"format":"email"}},"required":["email"],"additionalProperties":false},"clientRequestId":{"type":"string","minLength":1,"maxLength":100}},"required":["organizationId","contact","clientRequestId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"quantity":{"type":"number"},"unitAmount":{"type":"number"},"currency":{"type":"string"}},"required":["code","quantity","unitAmount","currency"],"additionalProperties":false}},"tablets":{"type":"number"},"printers":{"type":"number"},"totalAmount":{"type":"number"},"currency":{"type":"string"},"deliveryStatus":{"enum":["notQueued","pending","sent","failed"],"type":"string"}},"required":["id","items","tablets","printers","totalAmount","currency","deliveryStatus"],"additionalProperties":false}}}}}}},"/api/public/v1/hardware/getRequest":{"post":{"operationId":"hardware.getRequest","description":"Reads the hardware.getRequest procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}},"required":["organizationId","id"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"quantity":{"type":"number"},"unitAmount":{"type":"number"},"currency":{"type":"string"}},"required":["code","quantity","unitAmount","currency"],"additionalProperties":false}},"tablets":{"type":"number"},"printers":{"type":"number"},"totalAmount":{"type":"number"},"currency":{"type":"string"},"deliveryStatus":{"enum":["notQueued","pending","sent","failed"],"type":"string"}},"required":["id","items","tablets","printers","totalAmount","currency","deliveryStatus"],"additionalProperties":false}}}}}}},"/api/public/v1/inventory/stock":{"post":{"operationId":"inventory.stock","description":"Every product of the location's organization with its stock there: on hand, value (null without cost access or while no stock has a known cost), linked suppliers and the latest movement, plus when stock there last changed, summed over its storages or in the one `storageId` names. Archived products only with `includeArchived`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"includeArchived":{"type":"boolean"},"storageId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"},"archived":{"type":"boolean"},"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"onHand":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"hasUnknownCost":{"type":"boolean"},"currency":{"anyOf":[{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"},{"type":"null"}]},"recipeOutput":{"anyOf":[{"type":"string"},{"type":"null"}]},"lowStockAt":{"type":"string"},"isLow":{"type":"boolean"},"unitCost":{"anyOf":[{"type":"string"},{"type":"null"}]},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"lastMovement":{"anyOf":[{"type":"object","properties":{"kind":{"enum":["add","remove","consume","reprice"],"type":"string"},"reason":{"anyOf":[{"enum":["spoiled","expired","damaged","other","lost","recount","import","prep","variance","correction","move","shortage","currencyChanged","transfer","shipment","surplus","recall"],"type":"string"},{"type":"null"}],"description":"Why it moved. New reasons are added as the ledger grows (`recall` is the latest), so read a reason you do not know by `kind` alone."},"recordedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["kind","reason","recordedAt"]},{"type":"null"}]}},"required":["id","name","baseUnit","archived","categoryId","imageUrl","onHand","value","hasUnknownCost","currency","recipeOutput","lowStockAt","isLow","unitCost","suppliers","lastMovement"]}},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]}},"required":["rows","updatedAt"]}}}}}}},"/api/public/v1/inventory/stockPage":{"post":{"operationId":"inventory.stockPage","description":"One page of the Stock table: the location's products as `stock` reads them, narrowed by name (`query`), kind, unit, linked supplier, stock state and days without a movement (`idleDays`, never moved included), ordered by one column with a missing key last, and the cursor the next page starts from (null on the last), with, on the first page only, how many products the location lists and how many the filters leave. On hand sorts only within one `unit`; value sorts only with `inventoryCost:read`, FORBIDDEN otherwise. BAD_REQUEST for a cursor no page under this sort returned. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"includeArchived":{"type":"boolean"},"storageId":{"type":"string","minLength":1},"query":{"type":"string","maxLength":120},"kind":{"enum":["purchased","prepared"],"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"},"supplierId":{"type":"string","minLength":1},"categoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"state":{"enum":["belowZero","zero","unknownCost","low"],"type":"string"},"idleDays":{"type":"integer","minimum":1,"maximum":3650},"sort":{"enum":["name","onHand","value","suppliers","lastChange"],"type":"string"},"direction":{"enum":["asc","desc"],"type":"string"},"cursor":{"type":"string","maxLength":2048}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"},"archived":{"type":"boolean"},"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"onHand":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"hasUnknownCost":{"type":"boolean"},"currency":{"anyOf":[{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"},{"type":"null"}]},"recipeOutput":{"anyOf":[{"type":"string"},{"type":"null"}]},"lowStockAt":{"type":"string"},"isLow":{"type":"boolean"},"unitCost":{"anyOf":[{"type":"string"},{"type":"null"}]},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"lastMovement":{"anyOf":[{"type":"object","properties":{"kind":{"enum":["add","remove","consume","reprice"],"type":"string"},"reason":{"anyOf":[{"enum":["spoiled","expired","damaged","other","lost","recount","import","prep","variance","correction","move","shortage","currencyChanged","transfer","shipment","surplus","recall"],"type":"string"},{"type":"null"}],"description":"Why it moved. New reasons are added as the ledger grows (`recall` is the latest), so read a reason you do not know by `kind` alone."},"recordedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["kind","reason","recordedAt"]},{"type":"null"}]}},"required":["id","name","baseUnit","archived","categoryId","imageUrl","onHand","value","hasUnknownCost","currency","recipeOutput","lowStockAt","isLow","unitCost","suppliers","lastMovement"]}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"listed":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]},"low":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["rows","nextCursor","listed","total","low"]}}}}}}},"/api/public/v1/inventory/stockShelves":{"post":{"operationId":"inventory.stockShelves","description":"The Stock grid's shelves at the location: each category in use, the one holding the most listed products first, then the products in none, each with its first products as `stockPage` orders them by default and how many it holds, summed over the storages or in the one `storageId` names. Archived products only with `includeArchived`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"includeArchived":{"type":"boolean"},"storageId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"},"archived":{"type":"boolean"},"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"onHand":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"hasUnknownCost":{"type":"boolean"},"currency":{"anyOf":[{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"},{"type":"null"}]},"recipeOutput":{"anyOf":[{"type":"string"},{"type":"null"}]},"lowStockAt":{"type":"string"},"isLow":{"type":"boolean"},"unitCost":{"anyOf":[{"type":"string"},{"type":"null"}]},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"lastMovement":{"anyOf":[{"type":"object","properties":{"kind":{"enum":["add","remove","consume","reprice"],"type":"string"},"reason":{"anyOf":[{"enum":["spoiled","expired","damaged","other","lost","recount","import","prep","variance","correction","move","shortage","currencyChanged","transfer","shipment","surplus","recall"],"type":"string"},{"type":"null"}],"description":"Why it moved. New reasons are added as the ledger grows (`recall` is the latest), so read a reason you do not know by `kind` alone."},"recordedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["kind","reason","recordedAt"]},{"type":"null"}]}},"required":["id","name","baseUnit","archived","categoryId","imageUrl","onHand","value","hasUnknownCost","currency","recipeOutput","lowStockAt","isLow","unitCost","suppliers","lastMovement"]}},"total":{"type":"number"}},"required":["categoryId","rows","total"]}}}}}}}},"/api/public/v1/inventory/movements":{"post":{"operationId":"inventory.movements","description":"One page of movements at the location, optionally in one storage or of one product and only its adds by hand or import (`correctable`), with who made them, the storage each changed, both sides of a transfer and the supplier of an add's batch, and the cursor the next page starts from (null on the last). Narrowed by what happened, the batch's supplier, who made it, the product's unit and a period resolved in the venue's time zone (`custom` from `from` through `to`, under the Dashboard's rules; none reads all time); ordered by time (newest first by default), product name or supplier name, a movement without a supplier last. The first page counts the movements its storage or product holds (`listed`) and those the filters leave (`total`). BAD_REQUEST for a cursor no page of that sort returned. New reasons are added as the ledger grows (`recall` is the latest), so read a reason you do not know by its `kind`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"storageId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"correctable":{"type":"boolean"},"what":{"enum":["added","removed","used","repriced","shortage","recounted","imported","prepared","transfer","shipped","received","recalled","correction","move"],"type":"string"},"supplierId":{"type":"string","minLength":1},"actorId":{"type":"string","minLength":1},"unit":{"enum":["g","ml","pcs"],"type":"string"},"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"sort":{"enum":["when","product","supplier"],"type":"string"},"direction":{"enum":["asc","desc"],"type":"string"},"cursor":{"type":"string","maxLength":2048}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"enum":["add","remove","consume","reprice"],"type":"string"},"reason":{"anyOf":[{"enum":["spoiled","expired","damaged","other","lost","recount","import","prep","variance","correction","move","shortage","currencyChanged","transfer","shipment","surplus","recall"],"type":"string"},{"type":"null"}],"description":"Why it moved. New reasons are added as the ledger grows (`recall` is the latest), so read a reason you do not know by `kind` alone."},"quantity":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"},"recordedAt":{"type":"string","format":"date-time","x-native-type":"date"},"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"actorName":{"type":"string"},"supplierName":{"anyOf":[{"type":"string"},{"type":"null"}]},"importedFrom":{"anyOf":[{"type":"string"},{"type":"null"}]},"storage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"}},"required":["id","name","locationId","locationName"]},"transfer":{"anyOf":[{"type":"object","properties":{"from":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"}},"required":["id","name","locationId","locationName"]},"to":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"}},"required":["id","name","locationId","locationName"]},"shipmentStatus":{"anyOf":[{"enum":["inTransit","received","recalled","neverReceived"],"type":"string"},{"type":"null"}],"description":"A shipment's status, null for a transfer; read a status you do not know as closed."}},"required":["from","to","shipmentStatus"]},{"type":"null"}]},"corrects":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"recordedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","recordedAt"]},{"type":"null"}]},"adjusts":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"recordedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","recordedAt"]},{"type":"null"}]},"shortage":{"anyOf":[{"type":"object","properties":{"openQuantity":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["openQuantity","value"]},{"type":"null"}]},"correctable":{"anyOf":[{"type":"object","properties":{"batchId":{"type":"string"},"quantity":{"type":"string"},"remaining":{"type":"string"},"unitCost":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["batchId","quantity","remaining","unitCost"]},{"type":"null"}]}},"required":["id","kind","reason","quantity","value","currency","recordedAt","stockItem","actorName","supplierName","importedFrom","storage","transfer","corrects","adjusts","shortage","correctable"]}},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"listed":{"anyOf":[{"type":"number"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["rows","nextCursor","listed","total"]}}}}}}},"/api/public/v1/inventory/movementActors":{"post":{"operationId":"inventory.movementActors","description":"Everyone who has made a movement at the location, by name: who the Movements filter offers. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}}}}}}},"/api/public/v1/inventory/product":{"post":{"operationId":"inventory.product","description":"One product's stock at the location, summed over its storages or in the one `storageId` names: on hand, held, value, linked suppliers, on hand in each storage and batches with stock left (earliest expiry first), its nutrition per 100 g whatever its base unit and `gramsPerUnit`, the grams in 1 ml or one piece, and its allergen codes as stored; its movements page through `movements`. NOT_FOUND for a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"storageId":{"type":"string","minLength":1}},"required":["locationId","stockItemId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"},"archived":{"type":"boolean"},"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"nutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"gramsPerUnit":{"anyOf":[{"type":"number"},{"type":"null"}]},"allergens":{"type":"array","items":{"enum":["eggs","wheat","soy","fish","shellfish","sesame","milk","peanuts","tree_nuts","gluten","corn"],"type":"string"}},"onHand":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"hasUnknownCost":{"type":"boolean"},"currency":{"anyOf":[{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"},{"type":"null"}]},"recipeOutput":{"anyOf":[{"type":"string"},{"type":"null"}]},"lowStockAt":{"type":"string"},"isLow":{"type":"boolean"},"reserved":{"type":"string"},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"storages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"onHand":{"type":"string"}},"required":["id","name","onHand"]}},"batches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"string"},"unitCost":{"anyOf":[{"type":"string"},{"type":"null"}]},"supplierName":{"anyOf":[{"type":"string"},{"type":"null"}]},"storageName":{"type":"string"},"expiresOn":{"anyOf":[{"type":"string"},{"type":"null"}]},"receivedAt":{"type":"string","format":"date-time","x-native-type":"date"},"isPrepared":{"type":"boolean"}},"required":["id","quantity","unitCost","supplierName","storageName","expiresOn","receivedAt","isPrepared"]}}},"required":["id","name","baseUnit","archived","categoryId","imageUrl","nutrition","gramsPerUnit","allergens","onHand","value","hasUnknownCost","currency","recipeOutput","lowStockAt","isLow","reserved","suppliers","storages","batches"]}}}}}}},"/api/public/v1/inventory/suppliers":{"post":{"operationId":"inventory.suppliers","description":"The organization's suppliers by name; archived ones only with `includeArchived`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"includeArchived":{"type":"boolean"}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":120},"phone":{},"email":{},"note":{},"archived":{"type":"boolean"}},"required":["id","name","archived"]}}}}}}}},"/api/public/v1/inventory/categories":{"post":{"operationId":"inventory.categories","description":"The organization's categories by name, each with the standard type it stands for (null for the merchant's own) and how many products in use it holds; archived ones only with `includeArchived`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"includeArchived":{"type":"boolean"}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"anyOf":[{"enum":["dairy","vegetables","fruit","meat","fish","bakery","dry_goods","drinks","sauces","frozen","cleaning","packaging"],"type":"string"},{"type":"null"}]},"archived":{"type":"boolean"},"products":{"type":"number"}},"required":["id","name","type","archived","products"]}}}}}}}},"/api/public/v1/inventory/uncategorizedCount":{"post":{"operationId":"inventory.uncategorizedCount","description":"How many of the organization's products in use are in no category. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"number"}}}}}}},"/api/public/v1/inventory/createCategory":{"post":{"operationId":"inventory.createCategory","description":"Creates a category, free-named, standing for one standard type or none, and answers the id products take: a type the organization already has a category for answers that one, unarchived, so a type never makes two. A repeated id is a no-op. NOT_FOUND for an id another organization holds. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"type":{"anyOf":[{"enum":["dairy","vegetables","fruit","meat","fish","bakery","dry_goods","drinks","sauces","frozen","cleaning","packaging"],"type":"string"},{"type":"null"}]}},"required":["organizationId","id","name","type"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/api/public/v1/inventory/renameCategory":{"post":{"operationId":"inventory.renameCategory","description":"Renames a category; the type it stands for stays. NOT_FOUND for a category the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["organizationId","id","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/archiveCategory":{"post":{"operationId":"inventory.archiveCategory","description":"Archives a category: it leaves the lists and the pickers, and every product in it is left in none. Archiving again keeps the first time. NOT_FOUND for a category the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}},"required":["organizationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/unarchiveCategory":{"post":{"operationId":"inventory.unarchiveCategory","description":"Brings an archived category back to the lists, empty; a category not archived is left as it is. NOT_FOUND for a category the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}},"required":["organizationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/setProductsCategory":{"post":{"operationId":"inventory.setProductsCategory","description":"Puts products in one category, or with `categoryId` null in none. NOT_FOUND, and nothing changes, for a product the organization does not hold or a category it does not hold in use. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"ids":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1}},"categoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["organizationId","ids","categoryId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/setProductImage":{"post":{"operationId":"inventory.setProductImage","description":"Sets a product's photo to a canonical URL this application's media gateway minted, or removes it with null. The photo it replaces stays in media storage. NOT_FOUND for a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["organizationId","id","imageUrl"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/dictionarySearch":{"post":{"operationId":"inventory.dictionarySearch","description":"Entries of the stock dictionary named like `query`, each as its name in `locale`, its base unit, its nutrition per 100 g, `gramsPerUnit`, the grams one of its units weighs, and its allergen codes, for naming a new product; nutrition is null where the dictionary has no figures for the entry, grams per unit where it has no weight for the unit and always for g, and allergens empty where it records none. The dictionary is no organization's, so the grant may be held at any; empty while no dictionary is configured or it does not answer. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":120},"locale":{"enum":["en","ru","ar","hy","es"],"type":"string"}},"required":["query","locale"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"},"nutrition":{"anyOf":[{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},{"type":"null"}]},"gramsPerUnit":{"anyOf":[{"type":"number"},{"type":"null"}]},"allergens":{"type":"array","items":{"enum":["eggs","wheat","soy","fish","shellfish","sesame","milk","peanuts","tree_nuts","gluten","corn"],"type":"string"}}},"required":["name","baseUnit","nutrition","gramsPerUnit","allergens"]}}}}}}}},"/api/public/v1/inventory/createProduct":{"post":{"operationId":"inventory.createProduct","description":"Creates a product counted in g, ml or pcs; the base unit never changes. With nutrition, its calories, proteins, fats and carbs per 100 g whatever the base unit, refused past what food can hold as `setProductNutrition` says. With `gramsPerUnit`, the grams in 1 ml of a product counted in ml or in one piece of one counted in pcs, which turn its figures per 100 g into figures per 100 ml or per piece for recipe calories and never touch stock; BAD_REQUEST for one on a product counted in g, at zero or below, or over 3 g in 1 ml or 100000 g in one piece. With allergens, its codes from the stock dictionary's list, kept once each; left out, it records none. With a recipe the product is prepared: what one batch makes, in thousandths of its base unit, and at least one line, written with the product. A repeated id is a no-op. NOT_FOUND as `stockNotFound` for a line naming a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"},"nutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"gramsPerUnit":{"anyOf":[{"type":"number"},{"type":"null"}]},"allergens":{"type":"array","maxItems":11,"items":{"enum":["eggs","wheat","soy","fish","shellfish","sesame","milk","peanuts","tree_nuts","gluten","corn"],"type":"string"}},"recipe":{"type":"object","properties":{"output":{"type":"string","pattern":"^\\d{1,16}$"},"lines":{"type":"array","maxItems":100,"items":{"type":"object","properties":{"stockItemId":{"type":"string","minLength":1},"net":{"type":"string","pattern":"^\\d{1,16}$"},"gross":{"type":"string","pattern":"^\\d{1,16}$"}},"required":["stockItemId","net","gross"]}}},"required":["output","lines"]}},"required":["organizationId","id","name","baseUnit"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/renameProduct":{"post":{"operationId":"inventory.renameProduct","description":"Renames a product. NOT_FOUND for a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["organizationId","id","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/setProductNutrition":{"post":{"operationId":"inventory.setProductNutrition","description":"Sets a product's calories, proteins, fats and carbs per 100 g whatever its base unit, and `gramsPerUnit`, the grams in 1 ml of a product counted in ml or in one piece of one counted in pcs, which turn them into figures per 100 ml or per piece for recipe calories and never touch stock; null clears one, and `gramsPerUnit` left out keeps the stored weight. With allergens, replaces its allergen codes, kept once each; left out, it keeps them. A prepared product's calories and allergens are worked out of its recipe whatever is set here. BAD_REQUEST for figures past what food can hold: over 900 kcal, a macronutrient over 100 g or all three together over 100 g; and for grams per unit on a product counted in g, at zero or below, or over 3 g in 1 ml or 100000 g in one piece. NOT_FOUND for a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"nutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"gramsPerUnit":{"anyOf":[{"type":"number"},{"type":"null"}]},"allergens":{"type":"array","maxItems":11,"items":{"enum":["eggs","wheat","soy","fish","shellfish","sesame","milk","peanuts","tree_nuts","gluten","corn"],"type":"string"}}},"required":["organizationId","id","nutrition"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/archiveProduct":{"post":{"operationId":"inventory.archiveProduct","description":"Archives a product: it leaves the stock list, the pickers and import matching, while its movements, batches and page keep it. Archiving again keeps the first time. NOT_FOUND for a product the organization does not hold; CONFLICT as `productHasStock` while any location has it on hand, below zero or held or a shipment of it is in transit, and `productInUse` while a current recipe or a modifier stock effect takes it. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}},"required":["organizationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/unarchiveProduct":{"post":{"operationId":"inventory.unarchiveProduct","description":"Brings an archived product back to the lists; a product not archived is left as it is. NOT_FOUND for a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}},"required":["organizationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/setLowStockAt":{"post":{"operationId":"inventory.setLowStockAt","description":"Sets the on hand, in thousandths of the product's base unit, at or below which a product reads as running low at any location that has stocked it, one for the whole organization; `quantity` null resets it to its unit's default (1 kg, 1 L or 5 pcs). NOT_FOUND for a product the organization does not hold; CONFLICT as `productArchived` for an archived product. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"quantity":{"anyOf":[{"type":"string","pattern":"^\\d{1,16}$"},{"type":"null"}]}},"required":["organizationId","id","quantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/setProductSuppliers":{"post":{"operationId":"inventory.setProductSuppliers","description":"Replaces the suppliers in use a product is bought from; its links to archived suppliers are kept. NOT_FOUND for a product or supplier the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"supplierIds":{"type":"array","maxItems":100,"items":{"type":"string","minLength":1}}},"required":["organizationId","id","supplierIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/createSupplier":{"post":{"operationId":"inventory.createSupplier","description":"Creates a supplier with an optional phone, email and note. A repeated id is a no-op. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"phone":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"email":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"note":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["organizationId","id","name","phone","email","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/updateSupplier":{"post":{"operationId":"inventory.updateSupplier","description":"Changes a supplier's name, phone, email and note. NOT_FOUND for a supplier the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"phone":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"email":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"note":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]}},"required":["organizationId","id","name","phone","email","note"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/archiveSupplier":{"post":{"operationId":"inventory.archiveSupplier","description":"Archives a supplier: it leaves the supplier list, the pickers and import matching, while its product links and batches keep it. Archiving again keeps the first time. NOT_FOUND for a supplier the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}},"required":["organizationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/unarchiveSupplier":{"post":{"operationId":"inventory.unarchiveSupplier","description":"Brings an archived supplier back to the lists; a supplier not archived is left as it is. NOT_FOUND for a supplier the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}},"required":["organizationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/addStock":{"post":{"operationId":"inventory.addStock","description":"Adds stock in a storage of the location, `storageId` or the location's default when left out (NOT_FOUND for one the location does not hold or has archived). A bought line is one new batch with an optional supplier (linked to the product), expiry and line value in minor units excluding VAT. A prep line, one with `ingredients`, makes a prepared product: it removes what each ingredient actually gave, earliest expiry first and below zero when short, and adds its actual output as one batch with an optional expiry, at the value those removes took or at unknown cost when any part of an ingredient's cost is unknown; both sides are movements with the reason `prep`. Below-zero stock is filled first. All lines post together; a movement id repeated for the same line is a no-op. A priced line needs inventoryCost update (FORBIDDEN otherwise); NOT_FOUND as `stockNotFound` or `supplierNotFound` for a product or supplier the organization does not hold; CONFLICT as `movementReused` for a movement id reused for another line, `notPrepared` for a prep line of a product with no recipe and `productArchived` for a line making or taking an archived product. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"storageId":{"type":"string","minLength":1},"lines":{"type":"array","minItems":1,"maxItems":100,"items":{"anyOf":[{"type":"object","properties":{"movementId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"quantity":{"type":"string","pattern":"^\\d{1,16}$"},"expiresOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"ingredients":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"stockItemId":{"type":"string","minLength":1},"quantity":{"type":"string","pattern":"^\\d{1,16}$"}},"required":["stockItemId","quantity"]}}},"required":["movementId","stockItemId","quantity","expiresOn","ingredients"]},{"type":"object","properties":{"movementId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"quantity":{"type":"string","pattern":"^\\d{1,16}$"},"expiresOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"value":{"anyOf":[{"type":"string","pattern":"^\\d{1,16}$"},{"type":"null"}]},"supplierId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["movementId","stockItemId","quantity","expiresOn","value","supplierId"],"additionalProperties":false}]}}},"required":["locationId","lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/recount":{"post":{"operationId":"inventory.recount","description":"Sets a product's on hand in a storage of the location, `storageId` or the default when left out, to the counted quantity by posting the difference: an add of unknown cost above on hand, or a remove with its reason below. A movement id repeated while on hand still reads its count is a no-op. CONFLICT as `movementReused` for a movement id reused otherwise, `recountReasonRequired` below on hand without a reason and `productArchived` for an archived product; NOT_FOUND as `stockNotFound` for a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"storageId":{"type":"string","minLength":1},"movementId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"counted":{"type":"string","pattern":"^\\d{1,16}$"},"reason":{"anyOf":[{"enum":["spoiled","expired","damaged","other","lost"],"type":"string"},{"type":"null"}]}},"required":["locationId","movementId","stockItemId","counted","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/repriceBatch":{"post":{"operationId":"inventory.repriceBatch","description":"Prices what is left of one batch added without a price, in millionths of a minor unit per base unit excluding VAT: the stock it holds at unknown cost becomes valued, recorded as a value-only `reprice` movement. Needs inventory post and inventoryCost update at the location (FORBIDDEN otherwise). A movement id repeated for the same batch and price is a no-op. NOT_FOUND as `stockNotFound` or `batchNotFound` for a product or batch the location does not hold; CONFLICT as `movementReused` for a movement id reused for another, `batchPriced` for a batch that has a price, `batchEmpty` for one with nothing left and `valueTooLarge` past one priced line's value, `currencyChanged` while the stock is valued in a former currency of the organization, `productArchived` for an archived product. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"movementId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"batchId":{"type":"string","minLength":1},"unitCost":{"type":"string","pattern":"^\\d{1,16}$"}},"required":["locationId","movementId","stockItemId","batchId","unitCost"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/correctAdd":{"post":{"operationId":"inventory.correctAdd","description":"Corrects an add posted by hand, by an import or by a move to the quantity it should have brought and, with `unitCost` in millionths of a minor unit per base unit excluding VAT, the price it should have had. The add never changes: each difference is a movement with the reason `correction` that references it, a value-only `reprice` on its batch for the price, revaluing what the stock still holds of the batch, then an add into the batch or a remove from it first for the quantity. Stock already used is not re-costed. A second correction starts from the figures the first left. Needs inventory post at the location, and inventoryCost update with a unit cost (FORBIDDEN otherwise). A movement id repeated for a correction of the same add is a no-op. NOT_FOUND as `stockNotFound` or `movementNotFound` for a product or add the location does not hold; CONFLICT as `movementReused` for a movement id reused for anything else, `notCorrectable` for a movement that is not an add by hand, import or move, `addUnpriced` for a price on an add of unknown cost (price its batch instead), `currencyChanged` for a price while the stock is valued in a former currency of the organization, `nothingToCorrect` for the figures it already has, `valueTooLarge` past one priced line's value and `productArchived` for an archived product. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"movementId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"correctsMovementId":{"type":"string","minLength":1},"quantity":{"type":"string","pattern":"^\\d{1,16}$"},"unitCost":{"anyOf":[{"type":"string","pattern":"^\\d{1,16}$"},{"type":"null"}]}},"required":["locationId","movementId","stockItemId","correctsMovementId","quantity","unitCost"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/ship":{"post":{"operationId":"inventory.ship","description":"Ships stock from a storage of the location to another storage of the organization, at this location or another, as one shipment under the client's id: each line is a `remove` with the reason `shipment` from the source, earliest expiry first at its average cost, posted at once, and the shipment stays in transit, on hand nowhere, holding the value and batches that left until the destination accepts it with `receiveShipment`. A shipment repeated with the same id, storages and lines is a no-op. Needs inventory post at both locations. NOT_FOUND for a storage either location does not hold or has archived, and as `stockNotFound` for a product the organization does not hold; CONFLICT as `insufficientStock` for a line asking more than the source has on hand, `movementReused` for a shipment or movement id reused for another, and `productArchived` for an archived product. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"id":{"type":"string","format":"uuid"},"fromStorageId":{"type":"string","minLength":1},"toStorageId":{"type":"string","minLength":1},"lines":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"movementId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"quantity":{"type":"string","pattern":"^\\d{1,16}$"}},"required":["movementId","stockItemId","quantity"]}}},"required":["locationId","id","fromStorageId","toStorageId","lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/transfer":{"post":{"operationId":"inventory.transfer","summary":"Legacy immediate move between storages; use inventory.ship.","description":"Deprecated: use `ship`, whose stock the destination accepts. Moves stock at once from a storage of the location into another storage of the organization, at this location or another: each line is a `remove` with the reason `transfer` from the source, earliest expiry first at its average cost, and an `add` with the same reason into the destination that names it, posted together so neither side stands alone. The valued part keeps its value and the unknown-cost part stays of unknown cost; each source batch arrives as its own batch with the same supplier, unit cost and expiry, and the add covers the destination's open shortages first. A line repeated with the same movement id, product, quantity and storages is a no-op. Needs inventory post at both locations. NOT_FOUND for a storage either location does not hold or has archived, and as `stockNotFound` for a product the organization does not hold; CONFLICT as `insufficientStock` for a line asking more than the source has on hand, `movementReused` for a movement id reused for another line, and `productArchived` for an archived product. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"fromStorageId":{"type":"string","minLength":1},"toStorageId":{"type":"string","minLength":1},"lines":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"movementId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"quantity":{"type":"string","pattern":"^\\d{1,16}$"}},"required":["movementId","stockItemId","quantity"]}}},"required":["locationId","fromStorageId","toStorageId","lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/shipments":{"post":{"operationId":"inventory.shipments","description":"The shipments in transit to any storage of the location, oldest first, each with the storages it comes from and goes to and their locations, who sent it and when, and its lines with the quantity sent. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"}},"required":["id","name","locationId","locationName"]},"to":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"}},"required":["id","name","locationId","locationName"]},"sentByName":{"type":"string"},"sentAt":{"type":"string","format":"date-time","x-native-type":"date"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"sentQuantity":{"type":"string"}},"required":["id","stockItem","sentQuantity"]}}},"required":["id","from","to","sentByName","sentAt","lines"]}}}}}}}},"/api/public/v1/inventory/sentShipments":{"post":{"operationId":"inventory.sentShipments","description":"The shipments in transit from any storage of the location, oldest first, each with the storages it comes from and goes to and their locations, who sent it and when, and its lines with the quantity sent; the sender may recall any of them with `recallShipment`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"}},"required":["id","name","locationId","locationName"]},"to":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"}},"required":["id","name","locationId","locationName"]},"sentByName":{"type":"string"},"sentAt":{"type":"string","format":"date-time","x-native-type":"date"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"sentQuantity":{"type":"string"}},"required":["id","stockItem","sentQuantity"]}}},"required":["id","from","to","sentByName","sentAt","lines"]}}}}}}}},"/api/public/v1/inventory/recallShipment":{"post":{"operationId":"inventory.recallShipment","description":"Recalls a shipment in transit from a storage of the location, once: each line returns to its source as an `add` with the reason `recall` of what was sent, with the value and batches it holds when the source is valued in the same currency, covering open shortages first. The shipment then reads recalled. Needs inventory post at the location. NOT_FOUND as `shipmentNotFound` for a shipment not sent from the location; CONFLICT as `shipmentReceived` once accepted and `shipmentClosed` once recalled or closed as never received. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shipmentId":{"type":"string","minLength":1}},"required":["locationId","shipmentId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/markShipmentNeverReceived":{"post":{"operationId":"inventory.markShipmentNeverReceived","description":"Closes a shipment in transit to a storage of the location as never received, once: it did not arrive, so each line arrives as an `add` with the reason `shipment` of what was sent and a remove with the reason `lost` writes all of it off, so the loss is a movement of its own. The shipment then reads never received. Needs inventory post at the location. NOT_FOUND as `shipmentNotFound` for a shipment not in transit to the location; CONFLICT as `shipmentReceived` once accepted and `shipmentClosed` once recalled or closed as never received. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shipmentId":{"type":"string","minLength":1}},"required":["locationId","shipmentId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/receiveShipment":{"post":{"operationId":"inventory.receiveShipment","description":"Accepts a shipment in transit to a storage of the location, once, with what arrived of every line. Each line arrives as an `add` with the reason `shipment` of what was sent, with the value and batches it holds when the destination is valued in the same currency, covering open shortages first; less received posts a remove with `shortfallReason` (`lost`, `spoiled`, `damaged` or `other`) for the difference, and more received an `add` with the reason `surplus` at unknown cost. The shipment then reads received. Needs inventory post at the location. NOT_FOUND as `shipmentNotFound` for a shipment not in transit to the location; CONFLICT as `shipmentReceived` once accepted, `shipmentClosed` once recalled or closed as never received, `receiptIncomplete` unless every line is named, and `shortfallReasonRequired` for a line received short without a reason. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shipmentId":{"type":"string","minLength":1},"lines":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"lineId":{"type":"string","minLength":1},"receivedQuantity":{"type":"string","pattern":"^\\d{1,16}$"},"shortfallReason":{"anyOf":[{"enum":["lost","spoiled","damaged","other"],"type":"string"},{"type":"null"}]}},"required":["lineId","receivedQuantity","shortfallReason"]}}},"required":["locationId","shipmentId","lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventory/moveAdd":{"post":{"operationId":"inventory.moveAdd","description":"Moves what is left of an add posted by hand, by an import or by a move to another product at the location. A remove with the reason `correction` takes the batch's remaining quantity at its unit cost, and an add with the reason `move` brings `quantity`, in the target's base unit, to `toStockItemId` as one new batch with that value, so at that value over `quantity` a unit, the add's supplier and its expiry, filling the target's below-zero stock first; both reference the add. What was already used stays on the add's product, and the moved add may itself be moved back or on, or corrected. `quantity` may be left out when both products share a base unit, and then is what is left of the batch; across units it is required. Needs inventory post and inventoryCost update at the location (FORBIDDEN otherwise). A movement id repeated for the same move is a no-op. NOT_FOUND as `stockNotFound` or `movementNotFound` for a product or add the location does not hold; CONFLICT as `movementReused` for a movement id reused for anything else, `notCorrectable` for a movement that is not an add by hand, import or move, `sameProduct` for the add's own product, `quantityRequired` for a target in another base unit without `quantity`, `batchEmpty` for a batch with nothing left and `productArchived` for an archived product. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"movementId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"correctsMovementId":{"type":"string","minLength":1},"toStockItemId":{"type":"string","minLength":1},"quantity":{"anyOf":[{"type":"string","pattern":"^\\d{1,16}$"},{"type":"null"}],"default":null}},"required":["locationId","movementId","stockItemId","correctsMovementId","toStockItemId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryRecipes/get":{"post":{"operationId":"inventoryRecipes.get","summary":"Read a variation's recipe","description":"The variation's latest recipe revision: its number, author and date, how many portions its lines make, the batch's planned output (an integer string of thousandths of its unit, g, ml or pcs; null when none was entered), portionNutrition (one portion's calories in kcal and proteins, fats and carbs in grams as a person corrected them, each null where the lines' stand), and its lines in order, each a product with its base unit, its net (what reaches the dish) and its gross (what leaves stock) for one portion — the batch's divided by the portion count, rounded up — and batchNet and batchGross for the whole batch as entered, all integer strings of thousandths of that unit. Null when the variation has no recipe. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemVariationId":{"type":"string","minLength":1}},"required":["itemVariationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}}},"required":["number","createdAt","createdByName","portionCount","output","portionNutrition","lines"]},{"type":"null"}]}}}}}}},"/api/public/v1/inventoryRecipes/itemVariations":{"post":{"operationId":"inventoryRecipes.itemVariations","summary":"List which of an item's variations have a recipe","description":"Each live variation of the catalog item, in catalog order, with whether its latest recipe revision takes anything: a variation with no recipe, or one cleared of its lines, reads false. With it, one portion's calories as that revision gives them: its portionCalories correction, else its lines' at each product's calories while every line has some; null where it gives none. And its allergens: every code of the products its lines take, a prepared product's from its own recipe, in the stock dictionary's order; empty where it gives none. NOT_FOUND for an item that does not exist. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1}},"required":["catalogItemId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"itemVariationId":{"type":"string"},"hasRecipe":{"type":"boolean"},"calories":{"anyOf":[{"type":"number"},{"type":"null"}]},"allergens":{"type":"array","items":{"enum":["eggs","wheat","soy","fish","shellfish","sesame","milk","peanuts","tree_nuts","gluten","corn"],"type":"string"}}},"required":["itemVariationId","hasRecipe","calories","allergens"]}}}}}}}},"/api/public/v1/inventoryRecipes/variationsWithRecipe":{"post":{"operationId":"inventoryRecipes.variationsWithRecipe","summary":"List the variations that have a recipe","description":"The ids of the organization's live variations, of live items, whose latest recipe revision takes anything: the recipes another variation may be copied from. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/public/v1/inventoryRecipes/productRecipe":{"post":{"operationId":"inventoryRecipes.productRecipe","summary":"Read a product's recipe","description":"A prepared product's latest recipe revision, as `get` answers a variation's, one batch of one portion whose output is in the product's base unit; null for a purchased product. With it, what takes the product: each variation and prepared product whose current recipe names it. NOT_FOUND as `stockNotFound` for a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1}},"required":["organizationId","stockItemId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"recipe":{"anyOf":[{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}}},"required":["number","createdAt","createdByName","portionCount","output","portionNutrition","lines"]},{"type":"null"}]},"usedBy":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"kind":{"const":"variation"},"catalogItemId":{"type":"string"},"itemName":{"type":"string"},"variationName":{"type":"string"}},"required":["kind","catalogItemId","itemName","variationName"]},{"type":"object","properties":{"kind":{"const":"product"},"stockItemId":{"type":"string"},"name":{"type":"string"}},"required":["kind","stockItemId","name"]}]}}},"required":["recipe","usedBy"]}}}}}}},"/api/public/v1/inventoryRecipes/preparedRecipes":{"post":{"operationId":"inventoryRecipes.preparedRecipes","summary":"Read every prepared product's recipe","description":"Each prepared product of the organization with its current recipe, as a prep starts from it: what one batch makes in the product's base unit, and its lines as `productRecipe` answers them. Purchased products are left out. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"stockItemId":{"type":"string"},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}}},"required":["stockItemId","output","lines"]}}}}}}}},"/api/public/v1/inventoryRecipes/saveProductRecipe":{"post":{"operationId":"inventoryRecipes.saveProductRecipe","summary":"Save a product's recipe","description":"Writes the next recipe revision of a product, which makes it prepared: what one batch makes, an integer string of thousandths of the product's base unit, and at least one line, as `save` takes a batch's. expectedNumber is the revision the edit started from, 0 for a purchased product. Refused with CONFLICT as `recipeChanged` from an older revision and as `recipeCycle` when the recipe would take the product it makes, directly or through other prepared products; NOT_FOUND as `stockNotFound` for a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"stockItemId":{"type":"string","minLength":1},"expectedNumber":{"type":"integer","minimum":0,"maximum":9007199254740991},"output":{"type":"string","pattern":"^\\d{1,16}$"},"lines":{"type":"array","maxItems":100,"items":{"type":"object","properties":{"stockItemId":{"type":"string","minLength":1},"net":{"type":"string","pattern":"^\\d{1,16}$"},"gross":{"type":"string","pattern":"^\\d{1,16}$"}},"required":["stockItemId","net","gross"]}}},"required":["organizationId","stockItemId","expectedNumber","output","lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}}},"required":["number","createdAt","createdByName","portionCount","output","portionNutrition","lines"]},{"type":"null"}]}}}}}}},"/api/public/v1/inventoryRecipes/stockItems":{"post":{"operationId":"inventoryRecipes.stockItems","summary":"List stock items for recipes","description":"The organization's products by name, archived ones left out, each with its base unit, as a recipe line may name them, and its unit cost at locationId: the venue's average, an integer string of millionths of a minor unit per base unit excluding VAT. The unit cost is null without locationId, without inventoryCost read at that venue, or while the product has no stock of known cost there in the organization's current currency. Each also carries its nutrition — calories, proteins, fats and carbs — per 100 g, per 100 ml or per piece: a purchased product's as set on it, a prepared product's worked out of its current recipe; a figure is null where unknown, as for a prepared product with an ingredient of unknown figure. And its allergen codes: a purchased product's as set on it, a prepared product's every code its current recipe reaches; empty where none is recorded. NOT_FOUND for a locationId outside the organization. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"},"unitCost":{"anyOf":[{"type":"string"},{"type":"null"}]},"nutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"allergens":{"type":"array","items":{"enum":["eggs","wheat","soy","fish","shellfish","sesame","milk","peanuts","tree_nuts","gluten","corn"],"type":"string"}}},"required":["id","name","baseUnit","unitCost","nutrition","allergens"]}}}}}}}},"/api/public/v1/inventoryRecipes/save":{"post":{"operationId":"inventoryRecipes.save","summary":"Save a variation's recipe","description":"Writes the next recipe revision for the variation: its lines in order, each a product of the organization at most once with a net above zero and a gross no less than it, both integer strings of thousandths of the product's base unit. With portionCount (1 to 1000) the lines are for a batch of that many portions and output is the batch's planned output; without it they are for one portion, with no output. portionNutrition, { calories, proteins, fats, carbs } each at least 0 (kcal, then grams), corrects one portion's figures, which the lines leave cooking out of; a null figure, or portionNutrition left out, keeps the lines'. An empty list clears the recipe, its output and its correction. expectedNumber is the revision the edit started from, 0 for none; a save started from an older revision is refused with CONFLICT as `recipeChanged`, and a product the organization does not hold with NOT_FOUND as `stockNotFound`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. The write is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemVariationId":{"type":"string","minLength":1},"expectedNumber":{"type":"integer","minimum":0,"maximum":9007199254740991},"portionCount":{"type":"integer","minimum":1,"maximum":1000},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string","pattern":"^\\d{1,16}$"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","maxItems":100,"items":{"type":"object","properties":{"stockItemId":{"type":"string","minLength":1},"net":{"type":"string","pattern":"^\\d{1,16}$"},"gross":{"type":"string","pattern":"^\\d{1,16}$"}},"required":["stockItemId","net","gross"]}}},"required":["itemVariationId","expectedNumber","lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}}},"required":["number","createdAt","createdByName","portionCount","output","portionNutrition","lines"]},{"type":"null"}]}}}}}}},"/api/public/v1/inventoryRecipes/getDraft":{"post":{"operationId":"inventoryRecipes.getDraft","summary":"Read a variation's recipe draft","description":"The recipe as staff are editing it before publishing, in the shape get answers without a number: when and by whom it was saved last, its portions, output and lines. lines holds the lines that name a product, in order; unlinkedLines holds the ingredients no product is linked to yet, each with its position among all the draft's lines (from 0) and its source, the name, quantity and unit as the import file wrote them. Sales and costing never read it. Null when nothing differs from the latest revision. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemVariationId":{"type":"string","minLength":1}},"required":["itemVariationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}},"unlinkedLines":{"type":"array","items":{"type":"object","properties":{"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"source":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"quantity":{"type":"string","maxLength":120},"unit":{"type":"string","maxLength":120}},"required":["name","quantity","unit"]}},"required":["position","source"]}}},"required":["createdAt","createdByName","portionCount","output","portionNutrition","lines","unlinkedLines"]},{"type":"null"}]}}}}}}},"/api/public/v1/inventoryRecipes/saveDraft":{"post":{"operationId":"inventoryRecipes.saveDraft","summary":"Save a variation's recipe draft","description":"Replaces the variation's draft with these lines, portions, output and portion nutrition, as save takes them, without writing a revision: the last save wins, and sales keep the latest revision until publish. unlinkedLines, each { position, source: { name, quantity, unit } }, keeps the ingredients no product is linked to yet exactly as the import file wrote them, each placed at its position among all the lines; left out, the draft keeps the unlinked lines it has, so a caller that knows only lines never drops them. A draft that says what the latest revision says is deleted, and null is answered. A product the organization does not hold is refused with NOT_FOUND as `stockNotFound`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. The write is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemVariationId":{"type":"string","minLength":1},"portionCount":{"type":"integer","minimum":1,"maximum":1000},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string","pattern":"^\\d{1,16}$"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","maxItems":100,"items":{"type":"object","properties":{"stockItemId":{"type":"string","minLength":1},"net":{"type":"string","pattern":"^\\d{1,16}$"},"gross":{"type":"string","pattern":"^\\d{1,16}$"}},"required":["stockItemId","net","gross"]}},"unlinkedLines":{"type":"array","items":{"type":"object","properties":{"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"source":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"quantity":{"type":"string","maxLength":120},"unit":{"type":"string","maxLength":120}},"required":["name","quantity","unit"]}},"required":["position","source"]}}},"required":["itemVariationId","lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}},"unlinkedLines":{"type":"array","items":{"type":"object","properties":{"position":{"type":"integer","minimum":0,"maximum":9007199254740991},"source":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"quantity":{"type":"string","maxLength":120},"unit":{"type":"string","maxLength":120}},"required":["name","quantity","unit"]}},"required":["position","source"]}}},"required":["createdAt","createdByName","portionCount","output","portionNutrition","lines","unlinkedLines"]},{"type":"null"}]}}}}}}},"/api/public/v1/inventoryRecipes/publish":{"post":{"operationId":"inventoryRecipes.publish","summary":"Publish a variation's recipe draft","description":"Writes the variation's draft as its next revision, the one new order lines take, and deletes the draft. expectedNumber is the revision the editor shows, 0 for none; a publish over an older one is refused with CONFLICT as `recipeChanged`. With no draft, nothing is written and the latest revision is answered, so a repeated publish changes nothing. A draft holding a line no product is linked to is refused with CONFLICT as `recipeUnlinked`, writing nothing and keeping the draft. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. The write is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemVariationId":{"type":"string","minLength":1},"expectedNumber":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["itemVariationId","expectedNumber"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}}},"required":["number","createdAt","createdByName","portionCount","output","portionNutrition","lines"]},{"type":"null"}]}}}}}}},"/api/public/v1/inventoryRecipes/deleteDraft":{"post":{"operationId":"inventoryRecipes.deleteDraft","summary":"Delete a variation's recipe draft","description":"Deletes the variation's draft, discarding its unpublished changes, and answers the latest revision the editor goes back to. Deleting no draft changes nothing. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. The write is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemVariationId":{"type":"string","minLength":1}},"required":["itemVariationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}}},"required":["number","createdAt","createdByName","portionCount","output","portionNutrition","lines"]},{"type":"null"}]}}}}}}},"/api/public/v1/inventoryRecipes/revisions":{"post":{"operationId":"inventoryRecipes.revisions","summary":"List a variation's recipe revisions","description":"Every revision of the variation's recipe, newest first: its number, when and by whom it was published, and how many lines it has. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemVariationId":{"type":"string","minLength":1}},"required":["itemVariationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"lineCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["number","createdAt","createdByName","lineCount"]}}}}}}}},"/api/public/v1/inventoryRecipes/getRevision":{"post":{"operationId":"inventoryRecipes.getRevision","summary":"Read one recipe revision","description":"Revision number of the variation's recipe, in the shape get answers. NOT_FOUND for a number the variation has no revision for. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemVariationId":{"type":"string","minLength":1},"number":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["itemVariationId","number"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}}},"required":["number","createdAt","createdByName","portionCount","output","portionNutrition","lines"]}}}}}}},"/api/public/v1/inventoryRecipes/restoreRevision":{"post":{"operationId":"inventoryRecipes.restoreRevision","summary":"Restore a recipe revision","description":"Writes a copy of revision number as the variation's next revision, the one new order lines take, and deletes the draft, so the editor starts again from it. Restoring the latest revision only deletes the draft. expectedNumber is the revision the editor shows; a restore over an older one is refused with CONFLICT as `recipeChanged`, and a number the variation has no revision for with NOT_FOUND. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. The write is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemVariationId":{"type":"string","minLength":1},"number":{"type":"integer","minimum":1,"maximum":9007199254740991},"expectedNumber":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["itemVariationId","number","expectedNumber"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdByName":{"anyOf":[{"type":"string"},{"type":"null"}]},"portionCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"output":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"string"},"unit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["quantity","unit"]},{"type":"null"}]},"portionNutrition":{"type":"object","properties":{"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]}},"required":["calories","proteins","fats","carbs"]},"lines":{"type":"array","items":{"type":"object","properties":{"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"net":{"type":"string"},"gross":{"type":"string"},"batchNet":{"type":"string"},"batchGross":{"type":"string"}},"required":["stockItem","net","gross","batchNet","batchGross"]}}},"required":["number","createdAt","createdByName","portionCount","output","portionNutrition","lines"]},{"type":"null"}]}}}}}}},"/api/public/v1/inventoryModifiers/list":{"post":{"operationId":"inventoryModifiers.list","summary":"List modifier stock effects","description":"Every live modifier of the organization that takes something from stock: its effect (adds, taking the product each time the modifier is chosen, or removes, taking up to that much less of it than the item's recipe asks for), the product with its base unit, and the quantity, an integer string of thousandths of that unit. A modifier that is not listed takes nothing. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"modifierId":{"type":"string"},"effect":{"enum":["adds","removes"],"type":"string"},"stockItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]},"quantity":{"type":"string"}},"required":["modifierId","effect","stockItem","quantity"]}}}}}}}},"/api/public/v1/inventoryModifiers/save":{"post":{"operationId":"inventoryModifiers.save","summary":"Save a modifier's stock effect","description":"Sets what the modifier does to stock each time it is chosen, replacing what it did: an effect (adds or removes), a product of the modifier's organization, and a quantity above zero, an integer string of thousandths of the product's base unit. stock null clears it, so the modifier takes nothing. NOT_FOUND for a modifier that does not exist, and as `stockNotFound` for a product the organization does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"modifierId":{"type":"string","minLength":1},"stock":{"anyOf":[{"type":"object","properties":{"effect":{"enum":["adds","removes"],"type":"string"},"stockItemId":{"type":"string","minLength":1},"quantity":{"type":"string","pattern":"^\\d{1,16}$"}},"required":["effect","stockItemId","quantity"]},{"type":"null"}]}},"required":["modifierId","stock"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryImports/create":{"post":{"operationId":"inventoryImports.create","description":"Starts importing one file at the location, into the storage `storageId` names or the location's default when left out (NOT_FOUND for one the location does not hold or has archived): an invoice photo or PDF, or a stock spreadsheet. PRECONDITION_FAILED as `importUnavailable` while document import is not configured. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"storageId":{"type":"string","minLength":1},"kind":{"enum":["invoice","spreadsheet"],"type":"string"},"source":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"enum":["application/pdf","application/zip","image/jpeg","image/png","image/webp","text/csv","text/tab-separated-values","text/plain","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","text/markdown","application/msword","application/vnd.ms-word.document.macroEnabled.12","application/vnd.ms-excel","application/vnd.ms-excel.sheet.macroEnabled.12","application/vnd.ms-excel.sheet.binary.macroEnabled.12","application/vnd.ms-powerpoint","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.ms-powerpoint.presentation.macroEnabled.12","application/vnd.openxmlformats-officedocument.presentationml.slideshow","application/vnd.ms-powerpoint.slideshow.macroEnabled.12","application/vnd.oasis.opendocument.text","application/vnd.oasis.opendocument.spreadsheet","application/vnd.oasis.opendocument.presentation","application/rtf","application/epub+zip"],"type":"string"},"bytes":{"type":"integer","minimum":1,"maximum":26214400},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["fileName","mediaType","bytes"],"additionalProperties":false}},"required":["locationId","kind","source"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"importId":{"type":"string","format":"uuid"}},"required":["importId"]}}}}}}},"/api/public/v1/inventoryImports/attach":{"post":{"operationId":"inventoryImports.attach","description":"Attaches an uploaded image to its import. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"sourceUrl":{"type":"string","maxLength":4096,"format":"uri"}},"required":["locationId","importId","sourceUrl"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryImports/initialize":{"post":{"operationId":"inventoryImports.initialize","description":"Opens a signed upload for a document. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid"},"upload":{"type":"object","properties":{"expiresAt":{"type":"string","format":"date-time"},"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"url":{"type":"string","format":"uri"}},"required":["expiresAt","fields","url"],"additionalProperties":false}},"required":["artifactId","upload"],"additionalProperties":false}}}}}}},"/api/public/v1/inventoryImports/complete":{"post":{"operationId":"inventoryImports.complete","description":"Confirms a document's upload. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryImports/submit":{"post":{"operationId":"inventoryImports.submit","description":"Sends the uploaded file to be read; a repeat is a no-op, answered even once the business is suspended. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"enum":["uploading","submitted","ready","completed","failed"],"type":"string"}},"required":["state"]}}}}}}},"/api/public/v1/inventoryImports/open":{"post":{"operationId":"inventoryImports.open","description":"The imports at the location still needing someone: uploading, being read, waiting for review or failed, newest first, with how many lines are still open. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"enum":["invoice","spreadsheet"],"type":"string"},"state":{"enum":["uploading","submitted","ready","completed","failed"],"type":"string"},"fileName":{"type":"string"},"failureCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"stalled":{"type":"boolean"},"openLines":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","kind","state","fileName","failureCode","createdAt","stalled","openLines"]}}}}}}}},"/api/public/v1/inventoryImports/review":{"post":{"operationId":"inventoryImports.review","description":"One import's draft: its lines as written, what each posts to, and the questions still open. Prices read null without inventoryCost read. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"enum":["invoice","spreadsheet"],"type":"string"},"mode":{"enum":["add","set"],"type":"string"},"fileName":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"incomplete":{"type":"boolean"},"columns":{"type":"array","items":{"type":"object","properties":{"header":{"type":"string"},"field":{"anyOf":[{"enum":["name","quantity","unit","packSize","unitPrice","lineTotal","supplier","expiresOn"],"type":"string"},{"type":"null"}]}},"required":["header","field"]}},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["id","name","baseUnit"]}},"invoices":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"number":{"anyOf":[{"type":"string"},{"type":"null"}]},"printed":{"anyOf":[{"type":"string"},{"type":"null"}]},"lines":{"anyOf":[{"type":"string"},{"type":"null"}]},"off":{"type":"boolean"}},"required":["source","number","printed","lines","off"]}},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"position":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"source":{"type":"string"},"invoice":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"string"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"packSize":{"anyOf":[{"type":"string"},{"type":"null"}]},"packUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"unitPrice":{"anyOf":[{"type":"string"},{"type":"null"}]},"lineTotal":{"anyOf":[{"type":"string"},{"type":"null"}]},"supplier":{"anyOf":[{"type":"string"},{"type":"null"}]},"expiresOn":{"anyOf":[{"type":"string"},{"type":"null"}]},"doubts":{"type":"array","items":{"enum":["name","quantity","unit","price","unreadable"],"type":"string"}},"sameAs":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"enum":["open","ignored","posted"],"type":"string"},"answer":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"kind":{"const":"existing"},"stockItemId":{"type":"string","minLength":1}},"required":["kind","stockItemId"]},{"type":"object","properties":{"kind":{"const":"new"},"name":{"type":"string","minLength":1,"maxLength":120},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["kind","name","baseUnit"]}]},"quantity":{"type":"string","pattern":"^\\d+(?:[.,]\\d{1,3})?$"},"unit":{"enum":["g","kg","ml","l","pcs"],"type":"string"},"productOnly":{"type":"boolean"},"price":{"anyOf":[{"const":"empty"},{"type":"string","pattern":"^\\d+$"}]},"duplicate":{"enum":["same","separate"],"type":"string"},"confirmed":{"type":"array","maxItems":5,"items":{"enum":["name","quantity","unit","price","unreadable"],"type":"string"}}},"additionalProperties":false},"product":{"anyOf":[{"anyOf":[{"type":"object","properties":{"kind":{"const":"existing"},"stockItemId":{"type":"string","minLength":1}},"required":["kind","stockItemId"]},{"type":"object","properties":{"kind":{"const":"new"},"name":{"type":"string","minLength":1,"maxLength":120},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["kind","name","baseUnit"]}]},{"type":"null"}]},"similar":{"type":"boolean"},"unitBase":{"anyOf":[{"enum":["g","ml","pcs"],"type":"string"},{"type":"null"}]},"existing":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["name","baseUnit"]},{"type":"null"}]},"baseQuantity":{"anyOf":[{"type":"string"},{"type":"null"}]},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"actions":{"type":"array","items":{"enum":["unreadable","product","duplicate","quantity","unit","price"],"type":"string"}}},"required":["id","position","source","invoice","name","quantity","unit","packSize","packUnit","unitPrice","lineTotal","supplier","expiresOn","doubts","sameAs","state","answer","product","similar","unitBase","existing","baseQuantity","value","actions"]}}},"required":["kind","mode","fileName","warnings","incomplete","columns","products","invoices","lines"]}}}}}}},"/api/public/v1/inventoryImports/answer":{"post":{"operationId":"inventoryImports.answer","description":"Saves answers to an open line, merged into its earlier ones. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"lineId":{"type":"string","format":"uuid"},"answer":{"type":"object","properties":{"product":{"anyOf":[{"type":"object","properties":{"kind":{"const":"existing"},"stockItemId":{"type":"string","minLength":1}},"required":["kind","stockItemId"]},{"type":"object","properties":{"kind":{"const":"new"},"name":{"type":"string","minLength":1,"maxLength":120},"baseUnit":{"enum":["g","ml","pcs"],"type":"string"}},"required":["kind","name","baseUnit"]}]},"quantity":{"type":"string","pattern":"^\\d+(?:[.,]\\d{1,3})?$"},"unit":{"enum":["g","kg","ml","l","pcs"],"type":"string"},"productOnly":{"type":"boolean"},"price":{"anyOf":[{"const":"empty"},{"type":"string","pattern":"^\\d+$"}]},"duplicate":{"enum":["same","separate"],"type":"string"},"confirmed":{"type":"array","maxItems":5,"items":{"enum":["name","quantity","unit","price","unreadable"],"type":"string"}}},"additionalProperties":false}},"required":["locationId","importId","lineId","answer"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryImports/ignore":{"post":{"operationId":"inventoryImports.ignore","description":"Ignores open lines; they stay in the draft as ignored. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"lineIds":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","format":"uuid"}}},"required":["locationId","importId","lineIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryImports/setMode":{"post":{"operationId":"inventoryImports.setMode","description":"Chooses whether a spreadsheet's lines for products already in stock add to it or set it to the file's amount; invoices always add. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"mode":{"enum":["add","set"],"type":"string"}},"required":["locationId","importId","mode"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryImports/confirm":{"post":{"operationId":"inventoryImports.confirm","description":"Posts every open line with nothing left to answer, in transactions of at most 100 lines, as movements with the reason `import`; lines still open stay in the draft. CONFLICT as `importTotalsOff` when an invoice's lines do not add up to its printed subtotal of goods and totalsAccepted is false; FORBIDDEN as `inventoryManageRequired` when a line needs a new product without inventory manage; CONFLICT as `productArchived` when a line's product was archived after the draft was read. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"totalsAccepted":{"type":"boolean"}},"required":["locationId","importId","totalsAccepted"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"posted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["posted"]}}}}}}},"/api/public/v1/inventoryImports/delete":{"post":{"operationId":"inventoryImports.delete","description":"Deletes an import whose file was never read, or whose reading outlasted the processing window. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryStorages/list":{"post":{"operationId":"inventoryStorages.list","description":"The location's storages, the default first then by name, each with the stations whose sales take from it; archived ones only with `includeArchived`, flagged `archived`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"includeArchived":{"type":"boolean"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"isDefault":{"type":"boolean"},"archived":{"type":"boolean"},"stationIds":{"type":"array","items":{"type":"string"}},"stockedCount":{"type":"number"}},"required":["id","name","isDefault","archived","stationIds","stockedCount"]}}}}}}}},"/api/public/v1/inventoryStorages/transferTargets":{"post":{"operationId":"inventoryStorages.transferTargets","description":"The storages stock may be moved into from the location: every storage, not archived, at each location of its organization where the caller may post stock, with its location's name. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"},"isDefault":{"type":"boolean"}},"required":["id","name","locationId","locationName","isDefault"]}}}}}}}},"/api/public/v1/inventoryStorages/create":{"post":{"operationId":"inventoryStorages.create","description":"Adds a storage to the location; its id comes from the client, so a repeated create adds nothing. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["locationId","id","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryStorages/rename":{"post":{"operationId":"inventoryStorages.rename","description":"Renames a storage of the location, the default included. NOT_FOUND for one the location does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["locationId","id","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryStorages/setStations":{"post":{"operationId":"inventoryStorages.setStations","description":"Makes `stationIds` the stations of the location whose sales take from the storage: each moves here from the storage it took from, and one the storage served that the list leaves out takes from the location's default again. Order lines already held keep the storage they were held from. NOT_FOUND for a storage the location does not hold or has archived, and as `stationNotFound` for a station of another location. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"stationIds":{"type":"array","maxItems":100,"items":{"type":"string","minLength":1}}},"required":["locationId","id","stationIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryStorages/archive":{"post":{"operationId":"inventoryStorages.archive","description":"Archives a storage of the location: it leaves the lists and pickers and takes no stock, while its history keeps it, and the stations it served and the open order lines held on it take from the location's default again; one already archived keeps its stamp. With `moveStock`, what it keeps on hand moves into the default first, as a transfer in the same transaction. NOT_FOUND for one the location does not hold; CONFLICT as `storageDefault` for the location's default `storageHasStock` while it keeps or owes stock, `storageHeld` while an order holds stock in it, `storageImporting` while an import not finished yet posts into it and `storageHasShipments` while a shipment from or to it is in transit; FORBIDDEN without inventory post when `moveStock` asks to move stock. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"moveStock":{"type":"boolean"}},"required":["locationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/inventoryStorages/unarchive":{"post":{"operationId":"inventoryStorages.unarchive","description":"Brings an archived storage of the location back; one not archived is left as it is. NOT_FOUND for one the location does not hold. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}},"required":["locationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/create":{"post":{"operationId":"recipeImports.create","description":"Starts one import for the recipe-cards files chosen together and answers each file's id, in order; each file is then uploaded, submitted, and read on its own, ending read, an invoice, without recipe cards, or failed. Started for a menu item (and one of its sizes, else its default), the import drafts one dish card onto that size and creates no new dishes; NOT_FOUND for an item or size that is not the organization's. PRECONDITION_FAILED as `importUnavailable` while files cannot be read. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"files":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"enum":["application/pdf","application/zip","image/jpeg","image/png","image/webp","text/csv","text/tab-separated-values","text/plain","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","text/markdown","application/msword","application/vnd.ms-word.document.macroEnabled.12","application/vnd.ms-excel","application/vnd.ms-excel.sheet.macroEnabled.12","application/vnd.ms-excel.sheet.binary.macroEnabled.12","application/vnd.ms-powerpoint","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.ms-powerpoint.presentation.macroEnabled.12","application/vnd.openxmlformats-officedocument.presentationml.slideshow","application/vnd.ms-powerpoint.slideshow.macroEnabled.12","application/vnd.oasis.opendocument.text","application/vnd.oasis.opendocument.spreadsheet","application/vnd.oasis.opendocument.presentation","application/rtf","application/epub+zip"],"type":"string"},"bytes":{"type":"integer","minimum":1,"maximum":26214400},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["fileName","mediaType","bytes"],"additionalProperties":false}},"catalogItemId":{"type":"string","minLength":1},"itemVariationId":{"type":"string","minLength":1}},"required":["locationId","files"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"importId":{"type":"string","minLength":1},"files":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1}},"required":["fileId","fileName"]}}},"required":["importId","files"]}}}}}}},"/api/public/v1/recipeImports/initialize":{"post":{"operationId":"recipeImports.initialize","description":"Opens a signed upload for one document of an import and answers where to post it. CONFLICT once the file was submitted. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1},"fileId":{"type":"string","minLength":1}},"required":["locationId","importId","fileId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"artifactId":{"type":"string","format":"uuid"},"upload":{"type":"object","properties":{"expiresAt":{"type":"string","format":"date-time"},"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"url":{"type":"string","format":"uri"}},"required":["expiresAt","fields","url"],"additionalProperties":false}},"required":["artifactId","upload"],"additionalProperties":false}}}}}}},"/api/public/v1/recipeImports/complete":{"post":{"operationId":"recipeImports.complete","description":"Confirms one document's upload. PRECONDITION_FAILED when its bytes did not arrive. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1},"fileId":{"type":"string","minLength":1}},"required":["locationId","importId","fileId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/attach":{"post":{"operationId":"recipeImports.attach","description":"Takes one image of an import from its media URL. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1},"fileId":{"type":"string","minLength":1},"sourceUrl":{"type":"string","maxLength":4096,"format":"uri"}},"required":["locationId","importId","fileId","sourceUrl"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/submit":{"post":{"operationId":"recipeImports.submit","description":"Sends every uploaded file of an import to be read, each in its own run; a file that did not finish uploading fails. Submitting again sends nothing twice and answers even once the business is suspended. A first submission: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/availability":{"post":{"operationId":"recipeImports.availability","description":"Whether recipe-cards files can be read here, so a new import is not refused as `importUnavailable`. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"isAvailable":{"type":"boolean"}},"required":["isAvailable"]}}}}}}},"/api/public/v1/recipeImports/current":{"post":{"operationId":"recipeImports.current","description":"The location's import not imported yet, the one started for the menu item named, else the one of the whole menu, each file with its state and what it holds and the item it is for, or null. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"catalogItemId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"fileName":{"type":"string"},"state":{"enum":["waiting","reading","read","invoice","notRecipes","failed"],"type":"string"},"dishes":{"type":"integer","minimum":0,"maximum":9007199254740991},"preps":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","fileName","state","dishes","preps"]}},"finished":{"type":"integer","minimum":0,"maximum":9007199254740991},"isReady":{"type":"boolean"},"target":{"anyOf":[{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"itemVariationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"}},"required":["catalogItemId","itemVariationId","name"]},{"type":"null"}]}},"required":["id","files","finished","isReady","target"]},{"type":"null"}]}}}}}}},"/api/public/v1/recipeImports/cancel":{"post":{"operationId":"recipeImports.cancel","description":"Discards an import that was not imported. CONFLICT as `importConfirming` once a confirm began writing it: some of its rows may be written, so it is finished by confirming again. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/summary":{"post":{"operationId":"recipeImports.summary","description":"Where the read files' recipes go, across every file: dishes on the menu and not, preps, ingredients in stock and missing, how many questions, and the dishes the menu lacks with their categories. NOT_FOUND until every file is read. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"integer","minimum":0,"maximum":9007199254740991},"dishes":{"type":"object","properties":{"matched":{"type":"integer","minimum":0,"maximum":9007199254740991},"new":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["matched","new"]},"preps":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"inStock":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["count","inStock"]},"ingredients":{"type":"object","properties":{"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"inStock":{"type":"integer","minimum":0,"maximum":9007199254740991},"missing":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["count","inStock","missing"]},"questions":{"type":"integer","minimum":0,"maximum":9007199254740991},"unmatchedFiles":{"type":"integer","minimum":0,"maximum":9007199254740991},"newDishes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"name":{"type":"string"},"add":{"type":"boolean"},"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"newCategory":{"type":"string"}},"required":["key","name","add","categoryId","newCategory"]}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"}},"required":["id","name"]}},"existingRecipes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"name":{"type":"string"},"kind":{"enum":["dish","prep"],"type":"string"},"state":{"enum":["published","draft"],"type":"string"},"version":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},{"type":"null"}]},"choice":{"enum":["keep","replace"],"type":"string"},"canReplace":{"type":"boolean"}},"required":["key","name","kind","state","version","choice","canReplace"]}},"targetCard":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},{"type":"null"}]}},"required":["files","dishes","preps","ingredients","questions","unmatchedFiles","newDishes","categories","existingRecipes","targetCard"]}}}}}}},"/api/public/v1/recipeImports/setDish":{"post":{"operationId":"recipeImports.setDish","description":"Adds a dish the menu lacks, or not, and picks its category; a null category makes a new one from the file's heading. BAD_REQUEST for a dish or category that is not there. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1},"key":{"type":"string","minLength":1},"add":{"type":"boolean"},"categoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["locationId","importId","key","add","categoryId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/questions":{"post":{"operationId":"recipeImports.questions","description":"The parser's questions across every file, each with the lines it is about, its options, its guess, whether it can be left for later and the saved answer. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"kind":{"enum":["dish","portions","prepOutput","piecesOrGrams","sameProduct","missingPrep","product"],"type":"string"},"subject":{"type":"string"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"lines":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"gross":{"type":"string"},"net":{"type":"string"},"unit":{"type":"string"}},"required":["name","gross","net","unit"]}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"kind":{"enum":["existingDish","newDish","portions","netWeight","perPortion","otherAmount","pieces","grams","sameProduct","differentProducts","purchased","leaveOut","stockProduct"],"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantity":{"anyOf":[{"type":"string"},{"type":"null"}]},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","kind","name","quantity","unit"]}},"guess":{"type":"string","minLength":1},"canDecideLater":{"type":"boolean"},"answer":{"anyOf":[{"anyOf":[{"type":"object","properties":{"kind":{"const":"option"},"optionId":{"type":"string","minLength":1},"quantity":{"type":"string","pattern":"^\\d+([.,]\\d+)?$"}},"required":["kind","optionId"]},{"type":"object","properties":{"kind":{"const":"later"}},"required":["kind"]}]},{"type":"null"}]}},"required":["id","kind","subject","reason","lines","options","guess","canDecideLater","answer"]}}}}}}}},"/api/public/v1/recipeImports/answer":{"post":{"operationId":"recipeImports.answer","description":"Saves one answer at once: an option, with an amount for another amount, or left for later where the question allows it. BAD_REQUEST when the answer does not fit the question. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1},"questionId":{"type":"string","minLength":1},"answer":{"anyOf":[{"type":"object","properties":{"kind":{"const":"option"},"optionId":{"type":"string","minLength":1},"quantity":{"type":"string","pattern":"^\\d+([.,]\\d+)?$"}},"required":["kind","optionId"]},{"type":"object","properties":{"kind":{"const":"later"}},"required":["kind"]}]}},"required":["locationId","importId","questionId","answer"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/deferAll":{"post":{"operationId":"recipeImports.deferAll","description":"Leaves every unanswered question for later where it may be, and on the parser's guess where it may not. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/ingredients":{"post":{"operationId":"recipeImports.ingredients","description":"The ingredients the parser found nothing in stock for, grouped by name across every file, each with its unit as written, how many recipes use it, whether a prep does, and its choice; with the products a choice may pick. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"name":{"type":"string"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}]},"recipes":{"type":"integer","minimum":0,"maximum":9007199254740991},"inPrep":{"type":"boolean"},"choice":{"anyOf":[{"anyOf":[{"type":"object","properties":{"kind":{"const":"create"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"existing"},"stockItemId":{"type":"string","minLength":1}},"required":["kind","stockItemId"]},{"type":"object","properties":{"kind":{"const":"unlinked"}},"required":["kind"]}]},{"type":"null"}]},"productName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["key","name","unit","recipes","inPrep","choice","productName"]}},"stock":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"unit":{"type":"string"}},"required":["id","name","unit"]}}},"required":["items","stock"]}}}}}}},"/api/public/v1/recipeImports/chooseIngredient":{"post":{"operationId":"recipeImports.chooseIngredient","description":"Decides one ingredient missing from stock: create it as a product, link it to an existing one, or leave it unlinked in the recipe drafts. BAD_REQUEST for an unknown ingredient or product, or a prep's ingredient left unlinked. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1},"key":{"type":"string","minLength":1},"choice":{"anyOf":[{"type":"object","properties":{"kind":{"const":"create"}},"required":["kind"]},{"type":"object","properties":{"kind":{"const":"existing"},"stockItemId":{"type":"string","minLength":1}},"required":["kind","stockItemId"]},{"type":"object","properties":{"kind":{"const":"unlinked"}},"required":["kind"]}]}},"required":["locationId","importId","key","choice"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/setExistingRecipe":{"post":{"operationId":"recipeImports.setExistingRecipe","description":"Keeps or replaces the recipe one matched dish or prep already has: a dish's with the file's as a draft over its draft, a prep's with the file's as its next revision. BAD_REQUEST for a card with no existing recipe. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1},"key":{"type":"string","minLength":1},"choice":{"enum":["keep","replace"],"type":"string"}},"required":["locationId","importId","key","choice"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/setAllExistingRecipes":{"post":{"operationId":"recipeImports.setAllExistingRecipes","description":"Keeps or replaces every recipe the matched dishes and preps already have. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1},"choice":{"enum":["keep","replace"],"type":"string"}},"required":["locationId","importId","choice"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/chooseAllIngredients":{"post":{"operationId":"recipeImports.chooseAllIngredients","description":"Decides every ingredient missing from stock at once; leaving them unlinked passes over a prep's ingredients. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1},"choice":{"enum":["create","unlinked"],"type":"string"}},"required":["locationId","importId","choice"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/recipeImports/ready":{"post":{"operationId":"recipeImports.ready","description":"What Import writes with the answers and choices so far: dish drafts, new hidden dishes and categories, preps, new products, ingredients left unlinked, and how many ingredients still wait for a choice. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"answered":{"type":"integer","minimum":0,"maximum":9007199254740991},"dishes":{"type":"object","properties":{"drafts":{"type":"integer","minimum":0,"maximum":9007199254740991},"existing":{"type":"integer","minimum":0,"maximum":9007199254740991},"new":{"type":"integer","minimum":0,"maximum":9007199254740991},"newCategories":{"type":"array","items":{"type":"string"}}},"required":["drafts","existing","new","newCategories"]},"preps":{"type":"integer","minimum":0,"maximum":9007199254740991},"products":{"type":"integer","minimum":0,"maximum":9007199254740991},"unlinked":{"type":"object","properties":{"ingredients":{"type":"integer","minimum":0,"maximum":9007199254740991},"drafts":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["ingredients","drafts"]},"undecided":{"type":"integer","minimum":0,"maximum":9007199254740991},"recipes":{"type":"object","properties":{"replaced":{"type":"integer","minimum":0,"maximum":9007199254740991},"kept":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["replaced","kept"]}},"required":["answered","dishes","preps","products","unlinked","undecided","recipes"]}}}}}}},"/api/public/v1/recipeImports/confirm":{"post":{"operationId":"recipeImports.confirm","description":"Imports the files in transactions of at most 100 writes: new categories, the products chosen to be created, preps with their recipes, and every dish's recipe as a draft, new dishes hidden and not for sale; an unanswered question takes the parser's guess. A matched dish or prep that already has a recipe keeps it unless its replace was chosen: a dish then gets the file's recipe as a draft over its draft, a prep its next revision. CONFLICT as `ingredientsUndecided` while an ingredient missing from stock has no choice; FORBIDDEN as `inventoryManageRequired` without inventory manage, since it writes recipe drafts and revisions. Answers the first dish draft to open, or null. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `inventoryDisabled` while the inventory flag is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"importId":{"type":"string","minLength":1}},"required":["locationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["catalogItemId"]}}}}}}},"/api/public/v1/bookings/availability":{"post":{"operationId":"bookings.availability","description":"The table a booking for this visit would get, or null when no free table fits, every table free for the whole visit that fits the party as `tables`, every table free for it whatever its seats as `freeTables` (the ones a join is made of; both smallest first, each with its `sectionId`), plus warnings such as `outsideOpeningHours`. A `bookingId` checks the visit for that stored booking, so the tables it holds read free, and answers them as `table` while they are free, whatever they seat. Writes nothing, and answers while the location's Bookings switch is off, so a booking already made can still be moved. Refused with BAD_REQUEST as `startInPast` or `invalidDuration`. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"date":{"type":"string","format":"date"},"startTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"endTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"partySize":{"type":"integer","minimum":1,"maximum":9007199254740991},"tableId":{"type":"string","minLength":1},"bookingId":{"type":"string","minLength":1}},"required":["locationId","date","startTime","partySize"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"table":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"capacity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sectionId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","prefix","number","capacity","sectionId"]},{"type":"null"}]},"tables":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"capacity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sectionId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","prefix","number","capacity","sectionId"]}},"freeTables":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"capacity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sectionId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","prefix","number","capacity","sectionId"]}},"warnings":{"type":"array","items":{"enum":["outsideOpeningHours"],"type":"string"}}},"required":["table","tables","freeTables","warnings"]}}}}}}},"/api/public/v1/bookings/create":{"post":{"operationId":"bookings.create","description":"Books a visit on the host's table, or on the tables the host joins as `tableIds` (all free), whatever they seat, or on the smallest free table that fits the party, for the picked customer if any, and returns the booking with its warnings. Refused with NOT_FOUND as `customerUnavailable` for a customer the organization does not hold, with CONFLICT as `noTableFree` or `tableUnavailable`, and with BAD_REQUEST as `startInPast` or `invalidDuration`. Refused with FORBIDDEN as `bookingsDisabled` while the location's Bookings or Tables switch is off. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `featureRestrictedByPlan` while the plan's current policy restricts Table Booking, or `featureNotEntitled` at an archived venue or under a plan with no policy. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"date":{"type":"string","format":"date"},"startTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"endTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"partySize":{"type":"integer","minimum":1,"maximum":9007199254740991},"tableId":{"type":"string","minLength":1},"guestName":{"type":"string","maxLength":120},"guestPhone":{"type":"string","maxLength":40},"customerId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"note":{"type":"string","maxLength":500},"tableIds":{"type":"array","minItems":2,"maxItems":8,"items":{"type":"string","minLength":1}}},"required":["locationId","date","startTime","partySize"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"booking":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]},"warnings":{"type":"array","items":{"enum":["outsideOpeningHours"],"type":"string"}}},"required":["booking","warnings"]}}}}}}},"/api/public/v1/bookings/seriesPreview":{"post":{"operationId":"bookings.seriesPreview","description":"What a repeat series would get on each of its dates, without writing: booked on the series' table, naming the booked one-off bookings it would move to another table, or skipped when the table cannot be cleared. It previews a new series, so it is refused as `createSeries` is. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"date":{"type":"string","format":"date"},"startTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"endTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"partySize":{"type":"integer","minimum":1,"maximum":9007199254740991},"tableId":{"type":"string","minLength":1},"weekdays":{"type":"array","minItems":1,"maxItems":7,"items":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"}},"until":{"type":"string","format":"date"}},"required":["locationId","date","startTime","partySize","tableId","weekdays","until"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dates":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"date":{"type":"string","format":"date"},"outcome":{"const":"booked"},"moves":{"type":"array","items":{"type":"object","properties":{"bookingId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"table":{"type":"object","properties":{"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["prefix","number"]}},"required":["bookingId","guestName","guestPhone","table"]}}},"required":["date","outcome","moves"]},{"type":"object","properties":{"date":{"type":"string","format":"date"},"outcome":{"const":"skipped"}},"required":["date","outcome"]}]}}},"required":["dates"]}}}}}}},"/api/public/v1/bookings/createSeries":{"post":{"operationId":"bookings.createSeries","description":"Books a visit on every chosen weekday from `date` through `until` on the series' table, as one series, for the picked customer if any. A booked one-off booking holding that table moves to the smallest other free table that fits it; a date the table cannot be cleared on is skipped. Returns what each date got. Refused with NOT_FOUND as `customerUnavailable` for a customer the organization does not hold, with CONFLICT as `noTableFree` when no date can be booked, or `bookingChanged` when a booking it moves changed first; and with BAD_REQUEST as `startInPast` or `invalidDuration`. Refused with FORBIDDEN as `bookingsDisabled` while the location's Bookings or Tables switch is off. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `featureRestrictedByPlan` while the plan's current policy restricts Table Booking, or `featureNotEntitled` at an archived venue or under a plan with no policy. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"date":{"type":"string","format":"date"},"startTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"endTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"partySize":{"type":"integer","minimum":1,"maximum":9007199254740991},"tableId":{"type":"string","minLength":1},"weekdays":{"type":"array","minItems":1,"maxItems":7,"items":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"}},"until":{"type":"string","format":"date"},"guestName":{"type":"string","maxLength":120},"guestPhone":{"type":"string","maxLength":40},"customerId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"note":{"type":"string","maxLength":500}},"required":["locationId","date","startTime","partySize","tableId","weekdays","until"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dates":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"date":{"type":"string","format":"date"},"outcome":{"const":"booked"},"moves":{"type":"array","items":{"type":"object","properties":{"bookingId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"table":{"type":"object","properties":{"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["prefix","number"]}},"required":["bookingId","guestName","guestPhone","table"]}}},"required":["date","outcome","moves"]},{"type":"object","properties":{"date":{"type":"string","format":"date"},"outcome":{"const":"skipped"}},"required":["date","outcome"]}]}},"seriesId":{"type":"string"}},"required":["dates","seriesId"]}}}}}}},"/api/public/v1/bookings/update":{"post":{"operationId":"bookings.update","description":"Replaces a booked or seated booking's guest name, phone, customer, note and party size; a blank or missing field clears it. A party may outgrow the seats of its tables. A newly picked customer the organization does not hold is refused with NOT_FOUND as `customerUnavailable`. Refused with NOT_FOUND when there is no such booking, and with CONFLICT as `transitionNotAllowed` when its status does not allow the change or `bookingChanged` when someone changed it first. A booking already made stays reachable while the location's Bookings switch is off, the plan restricts Table Booking or the business is read-only or suspended. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1},"guestName":{"type":"string","maxLength":120},"guestPhone":{"type":"string","maxLength":40},"customerId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"note":{"type":"string","maxLength":500},"partySize":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["bookingId","partySize"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}}}}}},"/api/public/v1/bookings/reschedule":{"post":{"operationId":"bookings.reschedule","description":"Moves a booked booking to a new start, keeping its duration unless a new duration or end time is given, onto the host's table or joined `tableIds`, or else its own tables while free, or else the smallest free table that fits. Returns the booking with its warnings. Refused with CONFLICT as `noTableFree` or `tableUnavailable`, and with BAD_REQUEST as `startInPast` or `invalidDuration`. Refused with NOT_FOUND when there is no such booking, and with CONFLICT as `transitionNotAllowed` when its status does not allow the change or `bookingChanged` when someone changed it first. A booking already made stays reachable while the location's Bookings switch is off, the plan restricts Table Booking or the business is read-only or suspended. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1},"date":{"type":"string","format":"date"},"startTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"endTime":{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},"tableId":{"type":"string","minLength":1},"tableIds":{"type":"array","minItems":2,"maxItems":8,"items":{"type":"string","minLength":1}}},"required":["bookingId","date","startTime"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"booking":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]},"warnings":{"type":"array","items":{"enum":["outsideOpeningHours"],"type":"string"}}},"required":["booking","warnings"]}}}}}}},"/api/public/v1/bookings/changeTable":{"post":{"operationId":"bookings.changeTable","description":"Moves a booked booking to the named table, or joins it across the named `tableIds`, whatever they seat. Refused with CONFLICT as `tableUnavailable` when a table is taken for the visit. Refused with NOT_FOUND when there is no such booking, and with CONFLICT as `transitionNotAllowed` when its status does not allow the change or `bookingChanged` when someone changed it first. A booking already made stays reachable while the location's Bookings switch is off, the plan restricts Table Booking or the business is read-only or suspended. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1},"tableId":{"type":"string","minLength":1},"tableIds":{"type":"array","minItems":2,"maxItems":8,"items":{"type":"string","minLength":1}}},"required":["bookingId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}}}}}},"/api/public/v1/bookings/markArrived":{"post":{"operationId":"bookings.markArrived","description":"Seats a booked booking: its party has arrived. There is no undo. Refused with NOT_FOUND when there is no such booking, and with CONFLICT as `transitionNotAllowed` when its status does not allow the change or `bookingChanged` when someone changed it first. A booking already made stays reachable while the location's Bookings switch is off, the plan restricts Table Booking or the business is read-only or suspended. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1}},"required":["bookingId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}}}}}},"/api/public/v1/bookings/cancel":{"post":{"operationId":"bookings.cancel","description":"Cancels a booked booking and frees its table; a seated one ends through `finish`. Refused with NOT_FOUND when there is no such booking, and with CONFLICT as `transitionNotAllowed` when its status does not allow the change or `bookingChanged` when someone changed it first. A booking already made stays reachable while the location's Bookings switch is off, the plan restricts Table Booking or the business is read-only or suspended. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1}},"required":["bookingId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}}}}}},"/api/public/v1/bookings/cancelFollowing":{"post":{"operationId":"bookings.cancelFollowing","description":"Cancels a booked booking of a repeat series and every booked one of the same series starting after it; earlier, seated and closed ones stay. A booking outside a series is refused with CONFLICT as `transitionNotAllowed`. Refused with NOT_FOUND when there is no such booking, and with CONFLICT as `transitionNotAllowed` when its status does not allow the change or `bookingChanged` when someone changed it first. A booking already made stays reachable while the location's Bookings switch is off, the plan restricts Table Booking or the business is read-only or suspended. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1}},"required":["bookingId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}}}}}},"/api/public/v1/bookings/markNoShow":{"post":{"operationId":"bookings.markNoShow","description":"Marks a booked booking as a no-show and frees its table. Refused with NOT_FOUND when there is no such booking, and with CONFLICT as `transitionNotAllowed` when its status does not allow the change or `bookingChanged` when someone changed it first. A booking already made stays reachable while the location's Bookings switch is off, the plan restricts Table Booking or the business is read-only or suspended. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1}},"required":["bookingId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}}}}}},"/api/public/v1/bookings/reinstate":{"post":{"operationId":"bookings.reinstate","description":"Books a cancelled or no-show booking of the venue's current day again at its time, even once that has passed, on its own tables while every one is free, or else the smallest free table that fits. The automatic no-show then counts its wait from the reinstate. Refused with CONFLICT as `bookingDayOver` when it starts on a past day, and as `noTableFree`. A reinstatement is a new commitment: Refused with FORBIDDEN as `bookingsDisabled` while the location's Bookings or Tables switch is off. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `featureRestrictedByPlan` while the plan's current policy restricts Table Booking, or `featureNotEntitled` at an archived venue or under a plan with no policy. Refused with NOT_FOUND when there is no such booking, and with CONFLICT as `transitionNotAllowed` when its status does not allow the change or `bookingChanged` when someone changed it first. A booking already made stays reachable while the location's Bookings switch is off, the plan restricts Table Booking or the business is read-only or suspended. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1}},"required":["bookingId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}}}}}},"/api/public/v1/bookings/finish":{"post":{"operationId":"bookings.finish","description":"Finishes a seated booking: its party has left and its table is free. Refused with UNPROCESSABLE_CONTENT as `ordersOpen` while an order linked to it is still open; paying or cancelling that order finishes the booking by itself. Refused with NOT_FOUND when there is no such booking, and with CONFLICT as `transitionNotAllowed` when its status does not allow the change or `bookingChanged` when someone changed it first. A booking already made stays reachable while the location's Bookings switch is off, the plan restricts Table Booking or the business is read-only or suspended. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1}},"required":["bookingId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}}}}}},"/api/public/v1/bookings/get":{"post":{"operationId":"bookings.get","description":"One booking with its tables. Refused with NOT_FOUND when there is no such booking. It answers while the location's Bookings switch is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1}},"required":["bookingId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}}}}}},"/api/public/v1/bookings/orders":{"post":{"operationId":"bookings.orders","description":"The booking's open orders, oldest first, each with its number once activated, and for a booked booking starting within one of the location's visit lengths whether its table still holds an open order. Refused with NOT_FOUND when there is no such booking. It answers while the location's Bookings switch is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"bookingId":{"type":"string","minLength":1}},"required":["bookingId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"openOrders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"orderNumber":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","orderNumber"]}},"tableHasOpenOrder":{"type":"boolean"}},"required":["openOrders","tableHasOpenOrder"]}}}}}}},"/api/public/v1/bookings/list":{"post":{"operationId":"bookings.list","description":"One page of a location's bookings in every status: one venue day by `date`, or a `view` of `today` and `upcoming` earliest first or `past` latest first; `date` wins when both are given. With `sort` (`time`, `guests`, `table`, `duration`; `direction` defaults to `asc`), the bookings still holding their tables come first, then that column. Optionally narrowed to guests whose name or phone contains `query` and by `statuses` (`late` and `booked` split the booked status at now), start-time `times` windows and `currentHour` in the venue's zone, `sectionIds`, `tableIds` and `partySizes`. It answers while the location's Bookings switch is off, so bookings already made stay readable. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"view":{"enum":["today","upcoming","past"],"type":"string"},"date":{"type":"string","format":"date"},"page":{"type":"integer","minimum":1,"maximum":9007199254740991,"default":1},"query":{"type":"string","maxLength":120},"statuses":{"type":"array","maxItems":200,"items":{"enum":["booked","late","seated","finished","cancelled","noShow"],"type":"string"}},"times":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":1439},"until":{"type":"integer","minimum":0,"maximum":1440}},"required":["from","until"]}},"currentHour":{"type":"boolean"},"sectionIds":{"type":"array","maxItems":200,"items":{"type":"string","minLength":1}},"tableIds":{"type":"array","maxItems":200,"items":{"type":"string","minLength":1}},"partySizes":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"min":{"type":"integer","minimum":1,"maximum":9007199254740991},"max":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["min"]}},"sort":{"enum":["time","guests","table","duration"],"type":"string"},"direction":{"enum":["asc","desc"],"type":"string"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"bookings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}},"hasMore":{"type":"boolean"}},"required":["bookings","hasMore"]}}}}}}},"/api/public/v1/bookings/day":{"post":{"operationId":"bookings.day","description":"One venue day for the timeline: the `span` it trades that `date` as instants (the day's own opening hours, one span past midnight when it closes after it, the whole day when no hours are stored, null when closed), every Booked, Seated and Finished booking overlapping it, earliest first, narrowed by the same search and filters as `list`, and the `holds` open orders without a booking keep on their tables inside it (one visit length from the order's start, a paid guest prepayment included); an order linked to a booking is drawn by its booking. Unpaginated. Refused with PAYLOAD_TOO_LARGE as `dayTooBusy` when the day holds more bookings than the timeline draws. It answers while the location's Bookings switch is off. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"date":{"type":"string","format":"date"},"query":{"type":"string","maxLength":120},"statuses":{"type":"array","maxItems":200,"items":{"enum":["booked","late","seated","finished","cancelled","noShow"],"type":"string"}},"times":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":1439},"until":{"type":"integer","minimum":0,"maximum":1440}},"required":["from","until"]}},"currentHour":{"type":"boolean"},"sectionIds":{"type":"array","maxItems":200,"items":{"type":"string","minLength":1}},"tableIds":{"type":"array","maxItems":200,"items":{"type":"string","minLength":1}},"partySizes":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"min":{"type":"integer","minimum":1,"maximum":9007199254740991},"max":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["min"]}}},"required":["locationId","date"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"span":{"anyOf":[{"type":"object","properties":{"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["startsAt","endsAt"]},{"type":"null"}]},"bookings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}},"holds":{"type":"array","items":{"type":"object","properties":{"tableId":{"type":"string"},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["tableId","startsAt","endsAt"]}}},"required":["span","bookings","holds"]}}}}}}},"/api/public/v1/bookings/todayHours":{"post":{"operationId":"bookings.todayHours","description":"The parts of the venue's current day, or of the calendar `date` when given, it trades in, as minutes since that day's midnight: the previous day's spill past midnight, then the day's own window. `windows` is empty on a closed day and null when no opening hours are stored; `opensAt` is the minute the day's own window opens, null on a closed day even when the previous night's spill covers its small hours. It answers while the location's Bookings switch is off, so bookings already made stay readable. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"date":{"type":"string","format":"date"}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"windows":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":1439},"until":{"type":"integer","minimum":0,"maximum":1440}},"required":["from","until"]}},{"type":"null"}]},"opensAt":{"anyOf":[{"type":"integer","minimum":0,"maximum":1439},{"type":"null"}]}},"required":["windows","opensAt"]}}}}}}},"/api/public/v1/bookings/rules":{"post":{"operationId":"bookings.rules","description":"The location's booking rules, a rule it never set read as the platform default: the visit length, what a seated table shows, the late-booking auto-cancel, the floor's look-ahead and the staff reminder. It answers while the location's Bookings switch is off, so bookings already made stay readable. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"visitMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tableDisplay":{"enum":["seated","left"],"type":"string"},"autoCancelEnabled":{"type":"boolean"},"autoCancelMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lookAheadMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reminderEnabled":{"type":"boolean"},"reminderMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["visitMinutes","tableDisplay","autoCancelEnabled","autoCancelMinutes","lookAheadMinutes","reminderEnabled","reminderMinutes"]}}}}}}},"/api/public/v1/bookings/newBookings":{"post":{"operationId":"bookings.newBookings","description":"Whether the location takes a new booking, series or reinstatement now, as `isAllowed`, and otherwise the `refusal` they would answer with: `bookingsDisabled` while its Bookings or Tables switch is off, `billingReadOnly` or `subscriptionEnded` for the business's standing, `featureRestrictedByPlan` while the plan's current policy restricts Table Booking, or `featureNotEntitled` at an archived venue or under a plan with no policy. So a client offers only what the server takes; it grants nothing, and bookings already made stay reachable either way. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"isAllowed":{"type":"boolean"},"refusal":{"anyOf":[{"enum":["bookingsDisabled","billingReadOnly","subscriptionEnded","featureRestrictedByPlan","featureNotEntitled"],"type":"string"},{"type":"null"}]}},"required":["isAllowed","refusal"]}}}}}}},"/api/public/v1/bookings/floor":{"post":{"operationId":"bookings.floor","description":"The location's Seated bookings and its Booked ones starting from the start of the venue's current day to the location's look-ahead, earliest first, for the floor's table marks, with `asOf`, the time they were read at. It answers while the location's Bookings switch is off, so bookings already made stay readable. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"bookings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}},"asOf":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["bookings","asOf"]}}}}}}},"/api/public/v1/bookings/upcoming":{"post":{"operationId":"bookings.upcoming","description":"The staff reminders: the location's reminder minutes, and its booked bookings starting after now and within them, earliest first, each with whether its table still holds an open order. None while the location's reminder rule is off. It answers while the location's Bookings switch is off, so bookings already made stay readable. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"minutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bookings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]},"tableHasOpenOrder":{"type":"boolean"}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId","tableHasOpenOrder"]}}},"required":["minutes","bookings"]}}}}}}},"/api/public/v1/bookings/forTable":{"post":{"operationId":"bookings.forTable","description":"One table's Seated booking, then its Booked ones from the start of today, earliest first, for the table's panel; with `includeClosed`, its finished, cancelled and no-show ones from today on too. It answers while the location's Bookings switch is off, so bookings already made stay readable. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"tableId":{"type":"string","minLength":1},"includeClosed":{"type":"boolean"}},"required":["locationId","tableId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"bookings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"locationId":{"type":"string"},"guestName":{"anyOf":[{"type":"string"},{"type":"null"}]},"guestPhone":{"anyOf":[{"type":"string"},{"type":"null"}]},"customerId":{"anyOf":[{"type":"string"},{"type":"null"}]},"partySize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"durationMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["booked","seated","finished","cancelled","noShow"],"type":"string"},"seatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"finishedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"cancelledAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdById":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"tables":{"type":"array","items":{"type":"object","properties":{"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tableId","prefix","number"]}},"seats":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"seriesId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","locationId","guestName","guestPhone","customerId","partySize","startsAt","endsAt","durationMinutes","status","seatedAt","finishedAt","cancelledAt","note","createdById","createdAt","tables","seats","seriesId"]}}},"required":["bookings"]}}}}}}},"/api/public/v1/catalog/categories":{"get":{"operationId":"catalog.listCategories","summary":"List catalog categories with their items","description":"Reads the organization-wide catalog, including item variations and their prices in minor currency units. Use this snapshot to resolve IDs before editing. Venue QR-menu placement is available separately through emenu.listContent. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"parameters":[{"name":"organizationId","in":"query","required":true,"schema":{"type":"string","minLength":1},"allowEmptyValue":true,"allowReserved":true},{"name":"includeArchived","in":"query","required":false,"schema":{"type":"boolean"},"allowEmptyValue":true,"allowReserved":true},{"name":"locationId","in":"query","required":false,"schema":{"type":"string","minLength":1},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/hasEverHadItems":{"post":{"operationId":"catalog.hasEverHadItems","summary":"Check whether the catalog ever held an item","description":"Returns true when the organization's catalog has ever held an item, archived items included, and false otherwise. It answers whether a menu was ever set up, not whether one exists now; use catalog.listCategories for the current items.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/proposeCategorySlug":{"post":{"operationId":"catalog.proposeCategorySlug","summary":"Preview the URL slug a category name would get","description":"Returns { slug }: the URL slug a category with this name would receive under parentCategoryId (root when omitted) right now, avoiding every slug held by its siblings, archived siblings included. Pass categoryId when previewing a rename so the category's own slug is not counted as taken. It is a proposal, not a reservation; catalog.createCategory derives the slug itself and a concurrent write can take this one first. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"categoryId":{"type":"string","minLength":1}},"required":["organizationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/createCategory":{"post":{"operationId":"catalog.createCategory","summary":"Create a catalog category","description":"Creates a category in the organization-wide live catalog. Omit parentCategoryId to create it at the root; the new category is placed first among siblings. Its URL slug is derived from the name automatically and cannot be chosen. Refused with CONFLICT (refusal nameTaken) when a live category under the same parent already has this name, compared case-insensitively after trimming whitespace. The refusal names that row as existingId. A destination folder that was deleted is refused with BAD_REQUEST and refusal `categoryArchived`, and nothing is stored. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["organizationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/updateCategory":{"post":{"operationId":"catalog.updateCategory","summary":"Edit or move a catalog category","description":"Updates only supplied fields in the organization-wide live catalog. Set parentCategoryId to null to move to the root. The URL slug is managed automatically: renaming preserves it, and moving can change it to avoid a conflict. Refused with CONFLICT (refusal nameTaken) when a live category under the same parent already has this name, compared case-insensitively after trimming whitespace. A destination folder that was deleted is refused with BAD_REQUEST and refusal `categoryArchived`, and nothing is stored. Putting the category back in service or on the guest menu, or moving it out from under a category closed at a venue or hidden from the guest menu to where it is offered, is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"isAvailableByDefault":{"type":"boolean"},"isShownInOnlineMenu":{"type":"boolean"},"position":{"type":"number"},"color":{"anyOf":[{"enum":["amber","orange","red","pink","purple","indigo","blue","cyan","teal","green","lime","brown","slate"],"type":"string"},{"type":"null"}]}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/archiveCategory":{"post":{"operationId":"catalog.archiveCategory","summary":"Archive a catalog category","description":"Archives only this category in the organization-wide live catalog and moves its direct child categories and items to its parent. Keep the returned moved IDs to restore their placement with restoreCategory. Lifting children out of a category closed at a venue or hidden from the guest menu to where they are offered is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/restoreCategory":{"post":{"operationId":"catalog.restoreCategory","summary":"Restore a catalog category","description":"Restores this category in the organization-wide live catalog. Pass movedCategoryIds and movedItemIds from archiveCategory to readopt children still at its parent; omitting them restores only the category. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"movedCategoryIds":{"type":"array","maxItems":500,"items":{"type":"string"}},"movedItemIds":{"type":"array","maxItems":500,"items":{"type":"string"}}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/createMasterItem":{"post":{"operationId":"catalog.createMasterItem","summary":"Create a shared master item template","description":"Creates a MasterItem in the platform-wide template library shared by every organization and returns its id; it adds nothing to any organization's catalog. Only platform administrators may call it. Each call inserts a new template, so a retry creates a duplicate. To put an item on a menu use catalog.addCatalogItem, optionally passing masterItemId as lineage. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"unit":{"enum":["piece","gram","kilogram","milliliter","liter"],"type":"string"},"quantity":{"type":"number","exclusiveMinimum":0},"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"videoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}},"required":["name","unit","quantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/items":{"post":{"operationId":"catalog.addCatalogItem","summary":"Add an item to the catalog","description":"Creates an organization-wide live catalog item and its unnamed pricing variation. priceCents is an absolute price in minor currency units. Omit categoryId for a root item; availability and online-menu visibility settings control where it appears. A resend with a caller-minted id this organization already holds an item under answers that item and changes nothing; an id held by another organization's item is refused with CONFLICT and refusal `catalogItemIdTaken`. Refused with CONFLICT (refusal nameTaken) when a live item in the same category already has this name, compared case-insensitively after trimming whitespace. The refusal names that row as existingId. A destination folder that was deleted is refused with BAD_REQUEST and refusal `categoryArchived`, and nothing is stored. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","format":"uuid"},"masterItemId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"categoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"priceCents":{"type":"integer","minimum":0,"maximum":2147483647},"isAvailableByDefault":{"type":"boolean"},"isShownInOnlineMenu":{"type":"boolean"},"name":{"type":"string","minLength":1,"maxLength":120},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"unit":{"enum":["piece","gram","kilogram","milliliter","liter"],"type":"string"},"quantity":{"type":"number","exclusiveMinimum":0},"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"videoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"allergens":{"type":"array","items":{"enum":["eggs","wheat","soy","fish","shellfish","sesame","milk","peanuts","tree_nuts","gluten","corn"],"type":"string"}},"labels":{"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}},"required":["organizationId","priceCents","name","unit","quantity"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}},"patch":{"operationId":"catalog.updateCatalogItem","summary":"Update a catalog item","description":"Updates only supplied fields in the organization-wide live catalog. Supplied allergens and labels replace their collections. priceCents is in minor currency units and can only update an item with an unnamed pricing variation; use updateItemVariation for named sizes. A supplied priceCents is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with CONFLICT (refusal nameTaken) when a live item in the same category already has this name, compared case-insensitively after trimming whitespace. A destination folder that was deleted is refused with BAD_REQUEST and refusal `categoryArchived`, and nothing is stored. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"categoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"priceCents":{"type":"integer","minimum":0,"maximum":2147483647},"isAvailableByDefault":{"type":"boolean"},"isShownInOnlineMenu":{"type":"boolean"},"position":{"type":"number"},"name":{"type":"string","minLength":1,"maxLength":120},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"unit":{"enum":["piece","gram","kilogram","milliliter","liter"],"type":"string"},"quantity":{"type":"number","exclusiveMinimum":0},"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"proteins":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"fats":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"carbs":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"videoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"allergens":{"type":"array","items":{"enum":["eggs","wheat","soy","fish","shellfish","sesame","milk","peanuts","tree_nuts","gluten","corn"],"type":"string"}},"labels":{"type":"array","items":{"type":"string","minLength":1,"maxLength":40}}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/archiveCatalogItem":{"post":{"operationId":"catalog.archiveCatalogItem","summary":"Archive a catalog item","description":"Immediately archives this item across the organization. This is reversible with restoreCatalogItem and does not delete historical sales. Archiving or restoring a pass item also takes the Owner's loyalty:configure grant and is refused with FORBIDDEN without it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/restoreCatalogItem":{"post":{"operationId":"catalog.restoreCatalogItem","summary":"Restore a catalog item","description":"Restores this archived item in the organization-wide live catalog. Existing availability and online-menu visibility settings still apply. Archiving or restoring a pass item also takes the Owner's loyalty:configure grant and is refused with FORBIDDEN without it. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/items/availability":{"put":{"operationId":"catalog.setCatalogItemAvailability","summary":"Set an item's availability per venue","description":"Immediately sets item availability and station overrides at the named venues. These overrides are separate from the organization-wide item defaults and remain subject to category availability gates. Making a row available anywhere is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Marking rows unavailable is never refused for billing. A station named for a pass item is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"overrides":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"isAvailable":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"stationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["locationId","isAvailable"]}}},"required":["catalogItemId","overrides"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/setCatalogRowsAvailability":{"post":{"operationId":"catalog.setCatalogRowsAvailability","summary":"Set availability for selected catalog rows","description":"Immediately updates selected categories and items at the named venues and optionally their organization-wide online-menu visibility in one transaction. Category gates affect descendants without replacing their own availability settings. Making a row available anywhere is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Marking rows unavailable is never refused for billing. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"categoryIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"catalogItemIds":{"type":"array","maxItems":5000,"items":{"type":"string","minLength":1}},"locations":{"type":"array","maxItems":500,"items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"isAvailable":{"type":"boolean"}},"required":["locationId","isAvailable"]}},"isAvailableByDefault":{"type":"boolean"},"isShownInOnlineMenu":{"type":"boolean"}},"required":["organizationId","categoryIds","catalogItemIds","locations"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/setCategoryAvailability":{"post":{"operationId":"catalog.setCategoryAvailability","summary":"Set category availability per venue","description":"Immediately sets category gates at the named venues. Descendants follow the gate without changing their own settings, which apply again when the category reopens. Making a row available anywhere is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Marking rows unavailable is never refused for billing. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"categoryId":{"type":"string","minLength":1},"overrides":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"isAvailable":{"type":"boolean"}},"required":["locationId","isAvailable"]}}},"required":["categoryId","overrides"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/sync":{"post":{"operationId":"catalog.sync","summary":"Sync the catalog as a full snapshot or a delta","description":"Returns the organization's catalog as { mode, revision, roots, data }, read from one database snapshot. Without since, or when since is ahead of the current revision, older than the retained change history, or followed by more than 10,000 changed roots or a reset, mode is full and data holds the whole catalog; otherwise mode is delta, roots lists the item, modifier-group and loose-modifier ids to replace (including ids whose rows no longer appear) and data holds only their current rows. Store revision and pass it as since on the next call. locationId applies that venue's availability to isAvailable and isOnMenu and must name a trading venue of the organization; use catalog.listCategories for a one-off nested read. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"includeArchived":{"type":"boolean"},"locationId":{"type":"string","minLength":1},"since":{"type":"string","pattern":"^\\d{1,19}$"}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/previewOrganization":{"post":{"operationId":"catalog.previewOrganization","summary":"Preview a proposed catalog organization change","description":"Validates a catalog organization diff against a consistent current snapshot and returns the projected structure with per-change reasons. Does not save or apply changes. Before-field checks are not a catalog version check; availability, slugs and concurrent-write safety must be checked again by a future application command. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"catalogId":{"type":"string","minLength":1},"proposal":{"type":"object","properties":{"schemaVersion":{"const":"catalog-organization-diff/v1"},"status":{"enum":["proposed","no_change","failed"],"type":"string"},"changes":{"type":"array","maxItems":500,"items":{"anyOf":[{"type":"object","properties":{"type":{"const":"create_category"},"id":{"type":"string","pattern":"^new:[a-z0-9][a-z0-9-]{0,63}$"},"name":{"type":"string","minLength":1,"maxLength":255},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","name","parentCategoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"rename_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeName":{"type":"string","maxLength":255},"name":{"type":"string","minLength":1,"maxLength":255},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeName","name","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"move_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeParentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeParentCategoryId","parentCategoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"move_item"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"categoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeCategoryId","categoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"archive_empty_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeName":{"type":"string","maxLength":255},"beforeParentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeName","beforeParentCategoryId","reason"],"additionalProperties":false}]}},"failureReason":{"type":"string","minLength":1,"maxLength":2000}},"required":["schemaVersion","status","changes"],"additionalProperties":false}},"required":["organizationId","catalogId","proposal"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/previewOrganizationSuggestion":{"post":{"operationId":"catalog.previewOrganizationSuggestion","summary":"Preview a suggested catalog organization","description":"Previews the catalog organization proposal carried by one of the caller's own catalog suggestion notifications, read from the notification rather than the request, and returns the projected structure with per-change reasons. Does not save or apply changes. Refused with NOT_FOUND when the notification is not the caller's catalog suggestion in this organization, and with CONFLICT when the catalog changed where the proposal acts. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"notificationId":{"type":"string","minLength":1}},"required":["organizationId","notificationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"const":"preview"},"catalogId":{"type":"string"},"changes":{"type":"array","maxItems":500,"items":{"anyOf":[{"type":"object","properties":{"type":{"const":"create_category"},"id":{"type":"string","pattern":"^new:[a-z0-9][a-z0-9-]{0,63}$"},"name":{"type":"string","minLength":1,"maxLength":255},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","name","parentCategoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"rename_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeName":{"type":"string","maxLength":255},"name":{"type":"string","minLength":1,"maxLength":255},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeName","name","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"move_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeParentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeParentCategoryId","parentCategoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"move_item"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"categoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeCategoryId","categoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"archive_empty_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeName":{"type":"string","maxLength":255},"beforeParentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeName","beforeParentCategoryId","reason"],"additionalProperties":false}]}},"structure":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"isArchived":{"type":"boolean"},"parentCategoryId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","position","isArchived","parentCategoryId"]}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"isArchived":{"type":"boolean"},"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","position","isArchived","categoryId"]}}},"required":["categories","items"]},"limitations":{"type":"array","items":{"type":"string"}}},"required":["mode","catalogId","changes","structure","limitations"]}}}}}}},"/api/public/v1/catalog/reviewOrganizationSuggestion":{"post":{"operationId":"catalog.reviewOrganizationSuggestion","summary":"Review a suggested catalog organization change by change","description":"Checks each change of the catalog organization proposal carried by one of the caller's own catalog suggestion notifications, read from the notification rather than the request, against a consistent current snapshot. Returns each change's state in `states`, in proposal order: `applied` once an editor applied it with `catalog.applyOrganizationProposal`, `dismissed` once an editor dismissed it with `catalog.dismissOrganizationSuggestionChanges`; otherwise `ready`, or `unavailable` with reason `stale` when the catalog changed where it acts and `invalid` when it no longer fits, together with the keys (`<type>/<id>`) of the changes it `requires` applied with it. A change that no longer fits leaves the others ready. The structure is the catalog as applying every ready change would leave it, or as it is now when those changes do not fit together. Does not save or apply changes. Refused with NOT_FOUND when the notification is not the caller's catalog suggestion in this organization. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"notificationId":{"type":"string","minLength":1}},"required":["organizationId","notificationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"const":"preview"},"catalogId":{"type":"string"},"changes":{"type":"array","maxItems":500,"items":{"anyOf":[{"type":"object","properties":{"type":{"const":"create_category"},"id":{"type":"string","pattern":"^new:[a-z0-9][a-z0-9-]{0,63}$"},"name":{"type":"string","minLength":1,"maxLength":255},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","name","parentCategoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"rename_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeName":{"type":"string","maxLength":255},"name":{"type":"string","minLength":1,"maxLength":255},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeName","name","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"move_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeParentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeParentCategoryId","parentCategoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"move_item"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"categoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeCategoryId","categoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"archive_empty_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeName":{"type":"string","maxLength":255},"beforeParentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeName","beforeParentCategoryId","reason"],"additionalProperties":false}]}},"structure":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"isArchived":{"type":"boolean"},"parentCategoryId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","position","isArchived","parentCategoryId"]}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"position":{"type":"number"},"isArchived":{"type":"boolean"},"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","position","isArchived","categoryId"]}}},"required":["categories","items"]},"limitations":{"type":"array","items":{"type":"string"}},"states":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"status":{"enum":["applied","dismissed"],"type":"string"}},"required":["key","status"]},{"type":"object","properties":{"key":{"type":"string"},"status":{"const":"ready"},"requires":{"type":"array","items":{"type":"string"}}},"required":["key","status","requires"]},{"type":"object","properties":{"key":{"type":"string"},"status":{"const":"unavailable"},"requires":{"type":"array","items":{"type":"string"}},"reason":{"enum":["stale","invalid"],"type":"string"}},"required":["key","status","requires","reason"]}]}}},"required":["mode","catalogId","changes","structure","limitations","states"]}}}}}}},"/api/public/v1/catalog/applyOrganizationProposal":{"post":{"operationId":"catalog.applyOrganizationProposal","summary":"Apply a suggested catalog organization","description":"Applies changes of the catalog organization proposal carried by one of the caller's own catalog suggestion notifications, in one transaction: the changes named by `changeKeys` (each `<type>/<id>`, as `catalog.reviewOrganizationSuggestion` lists them), or without it every change not yet applied or dismissed, all or none. Returns how many changes remain undecided; once none does, the suggestion closes and leaves every editor's inbox. Refused with NOT_FOUND when the notification is not the caller's catalog suggestion in this organization, and with BAD_REQUEST when a key names no change of the proposal. Refused with CONFLICT and refusal `alreadyApplied` when any editor already applied a requested change, or the suggestion closed with every change applied, with CONFLICT and refusal `alreadyDismissed` when any editor already dismissed a requested change, or the suggestion closed after dismissals, with CONFLICT and refusal `dependencyRequired` when a requested change needs another not requested (the create of the new category it lands in, or the moves out of the category it archives), and with CONFLICT and refusal `stale` when the catalog changed where any of those changes act. Availability effects of moving rows are not evaluated. Creating a category, or moving a row or lifting an archived category's children out from under a category closed at a venue or hidden from the guest menu to where it is offered, is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"notificationId":{"type":"string","minLength":1},"changeKeys":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"string","minLength":1}}},"required":["organizationId","notificationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dispatchId":{"type":"string"},"remaining":{"type":"number"}},"required":["dispatchId","remaining"]}}}}}}},"/api/public/v1/catalog/dismissOrganizationSuggestionChanges":{"post":{"operationId":"catalog.dismissOrganizationSuggestionChanges","summary":"Dismiss suggested catalog organization changes","description":"Dismisses changes of the catalog organization proposal carried by one of the caller's own catalog suggestion notifications, for every editor who received it, in one transaction: the changes named by `changeKeys` (each `<type>/<id>`, as `catalog.reviewOrganizationSuggestion` lists them), or without it every change not yet applied or dismissed. A dismissed change can no longer be applied and cannot be restored. Writes nothing in the catalog. Returns how many changes remain undecided; once none does, the suggestion closes and leaves every editor's inbox. Refused with NOT_FOUND when the notification is not the caller's catalog suggestion in this organization, and with BAD_REQUEST when a key names no change of the proposal. Refused with CONFLICT and refusal `alreadyApplied` when any editor already applied a requested change, or the suggestion closed with every change applied, with CONFLICT and refusal `alreadyDismissed` when any editor already dismissed a requested change, or the suggestion closed after dismissals, and with CONFLICT and refusal `dependentRequired` when a change not requested cannot land without a requested one (what lands in the new category a requested change creates, or the archive of the category a requested change moves a row out of). Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"notificationId":{"type":"string","minLength":1},"changeKeys":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"string","minLength":1}}},"required":["organizationId","notificationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dispatchId":{"type":"string"},"remaining":{"type":"number"}},"required":["dispatchId","remaining"]}}}}}}},"/api/public/v1/catalog/listCatalogLabels":{"post":{"operationId":"catalog.listCatalogLabels","summary":"List the catalog's item labels","description":"Returns { labels } with the id and name of every label in the organization's catalog vocabulary: built-in labels first in their declared order, then labels the merchant added, alphabetically. These names are the values catalog.addCatalogItem and catalog.updateCatalogItem accept in labels. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/createCatalogLabel":{"post":{"operationId":"catalog.createCatalogLabel","summary":"Create a catalog item label","description":"Adds a label to the organization's catalog vocabulary and returns its id and name. Labels are matched case-insensitively with spaces, hyphens and underscores treated alike, so naming an existing label returns that label with its stored spelling instead of creating a second one; repeating the call is safe. Requires menu create or menu update permission; the label is attached to items through catalog.updateCatalogItem. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":40}},"required":["organizationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/listStations":{"post":{"operationId":"catalog.listStations","summary":"List kitchen stations across the organization","description":"Returns every kitchen station at the organization's non-archived venues, each with id, name, symbol, position, isDefault and locationId, ordered by venue and then position. It covers all venues at once, so filter by locationId for one venue. Readable with order read permission.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/createStation":{"post":{"operationId":"catalog.createStation","description":"Creates a kitchen station at a venue. Refused with CONFLICT (refusal nameTaken) when a live station at the same venue already has this name, compared case-insensitively after trimming whitespace. The refusal names that row as existingId. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"symbol":{"anyOf":[{"anyOf":[{"type":"object","properties":{"type":{"const":"icon"},"value":{"enum":["chef-hat","flame","cooking-pot","utensils-crossed","coffee","wine","pizza","cake-slice","snowflake","soup"],"type":"string"}},"required":["type","value"]},{"type":"object","properties":{"type":{"const":"emoji"},"value":{"enum":["👨‍🍳","🔥","🍳","🍲","🥗","🍕","🍣","🍰","☕","🍹"],"type":"string"}},"required":["type","value"]}]},{"type":"null"}],"default":null}},"required":["locationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/updateStation":{"post":{"operationId":"catalog.updateStation","description":"Renames a kitchen station or changes its symbol. Refused with CONFLICT (refusal nameTaken) when a live station at the same venue already has this name, compared case-insensitively after trimming whitespace.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"symbol":{"anyOf":[{"anyOf":[{"type":"object","properties":{"type":{"const":"icon"},"value":{"enum":["chef-hat","flame","cooking-pot","utensils-crossed","coffee","wine","pizza","cake-slice","snowflake","soup"],"type":"string"}},"required":["type","value"]},{"type":"object","properties":{"type":{"const":"emoji"},"value":{"enum":["👨‍🍳","🔥","🍳","🍲","🥗","🍕","🍣","🍰","☕","🍹"],"type":"string"}},"required":["type","value"]}]},{"type":"null"}]}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/deleteStation":{"post":{"operationId":"catalog.deleteStation","summary":"Delete a kitchen station","description":"Permanently deletes a kitchen station and returns its id; there is no restore. Catalog items routed to it and its live kitchen tickets lose their station, so their later orders route to the venue's Default station. Requires settings update permission at the station's venue. The built-in Default station cannot be deleted.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/createModifierGroup":{"post":{"operationId":"catalog.createModifierGroup","summary":"Create a reusable modifier set","description":"Creates an organization-wide set without attaching it to items. A required set needs minSelect >= 1; maxSelect must be null or >= minSelect. Refused with CONFLICT (refusal nameTaken) when a live modifier group in the catalog already has this name, compared case-insensitively after trimming whitespace. The refusal names that row as existingId. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"selectionType":{"enum":["single","multiple"],"type":"string"},"isRequired":{"type":"boolean"},"minSelect":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxSelect":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["organizationId","name","selectionType"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/updateModifierGroup":{"post":{"operationId":"catalog.updateModifierGroup","summary":"Edit a shared modifier set","description":"Changes the set wherever its options are attached. Omitted fields stay unchanged. Effective minSelect/maxSelect must remain compatible, and required sets need minSelect >= 1. Refused with CONFLICT (refusal nameTaken) when a live modifier group in the catalog already has this name, compared case-insensitively after trimming whitespace. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"isAvailableByDefault":{"type":"boolean"},"position":{"type":"number"},"selectionType":{"enum":["single","multiple"],"type":"string"},"isRequired":{"type":"boolean"},"minSelect":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxSelect":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/archiveModifierGroup":{"post":{"operationId":"catalog.archiveModifierGroup","summary":"Archive a modifier set across all items","description":"Hides the set and its options everywhere while retaining rows and attachments for restoration. To remove the set from one item, use detachModifierGroupFromCatalogItem. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/restoreModifierGroup":{"post":{"operationId":"catalog.restoreModifierGroup","summary":"Restore an archived modifier set","description":"Clears the set's archive flag, retaining its existing attachments. Separately archived options and availability switches remain unchanged. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/createModifier":{"post":{"operationId":"catalog.createModifier","summary":"Create a reusable modifier option","description":"Creates an option in the organization's set, or loose when modifierGroupId is null. priceDeltaCents is a nonnegative additive price in cents. A grouped option immediately appears on items assigned to its set; a loose option needs an explicit assignment. Refused with CONFLICT (refusal nameTaken) when a live modifier in the same group, or among the catalog's loose modifiers already has this name, compared case-insensitively after trimming whitespace. The refusal names that row as existingId. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"modifierGroupId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":120},"priceDeltaCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"imageUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"videoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}},"required":["organizationId","modifierGroupId","name","priceDeltaCents"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/updateModifier":{"post":{"operationId":"catalog.updateModifier","summary":"Edit a shared modifier option","description":"Updates the option across all attached items. priceDeltaCents is additive cents. Omitted fields stay unchanged; changing modifierGroupId changes which assigned sets expose it. Moving it to null does not create standalone item assignments. Refused with CONFLICT (refusal nameTaken) when a live modifier in the same group, or among the catalog's loose modifiers already has this name, compared case-insensitively after trimming whitespace. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"modifierGroupId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"isAvailableByDefault":{"type":"boolean"},"position":{"type":"number"},"name":{"type":"string","minLength":1,"maxLength":120},"priceDeltaCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"imageUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"videoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/archiveModifier":{"post":{"operationId":"catalog.archiveModifier","summary":"Archive a modifier option across all items","description":"Hides this option everywhere while retaining its row and attachments for restoration. Detaching a grouped assignment from one item removes the whole set; standalone assignments detach individually. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/restoreModifier":{"post":{"operationId":"catalog.restoreModifier","summary":"Restore an archived modifier option","description":"Clears the option's archive flag. Existing attachments remain; an archived or unavailable parent set can still hide the option. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/attachModifierToCatalogItem":{"post":{"operationId":"catalog.attachModifierToCatalogItem","summary":"Attach an option or its whole set to one item","description":"Attaches a standalone option or the whole current set of a grouped option; returns the actual assignment ID. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. The attach is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"modifierId":{"type":"string","minLength":1}},"required":["catalogItemId","modifierId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/detachModifierFromCatalogItem":{"post":{"operationId":"catalog.detachModifierFromCatalogItem","summary":"Remove a modifier assignment from one item","description":"Detaches a standalone assignment or the entire set resolved by a set assignment, effective option, or retained option-link ID. Stale identifiers are refused. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemModifierId":{"type":"string","minLength":1,"description":"Standalone link ID, set-assignment ID, effective group-option ID, or retained grouped link ID with a current assignment; grouped identifiers address the whole set."}},"required":["catalogItemModifierId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/setItemModifierAvailability":{"post":{"operationId":"catalog.setItemModifierAvailability","summary":"Set one modifier assignment’s availability","description":"Switches a standalone assignment or the entire set resolved by a set assignment, effective option, or retained option-link ID. Making a row available is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Marking it unavailable never is. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemModifierId":{"type":"string","minLength":1,"description":"Standalone link ID, set-assignment ID, effective group-option ID, or retained grouped link ID with a current assignment; grouped identifiers address the whole set."},"isAvailable":{"type":"boolean"}},"required":["catalogItemModifierId","isAvailable"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/reorderCatalogItemModifiers":{"post":{"operationId":"catalog.reorderCatalogItemModifiers","summary":"Reorder one item’s modifier assignments","description":"Orders standalone and whole-set assignments. Option aliases for the same set use the first positions entry; explicit groupPositions override that set position. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"positions":{"type":"array","maxItems":500,"items":{"type":"object","properties":{"catalogItemModifierId":{"type":"string","minLength":1},"position":{"type":"number"}},"required":["catalogItemModifierId","position"]},"default":[],"description":"Assignment identifiers; multiple option aliases for one set use their first array entry."},"groupPositions":{"type":"array","maxItems":500,"items":{"type":"object","properties":{"catalogItemModifierGroupId":{"type":"string","minLength":1},"position":{"type":"number"}},"required":["catalogItemModifierGroupId","position"]},"default":[]}},"required":["catalogItemId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/attachModifierGroupToCatalogItem":{"post":{"operationId":"catalog.attachModifierGroupToCatalogItem","summary":"Attach a live modifier set to one item","description":"Attaches a live set, including an empty set. attachedCount counts set assignments, not options. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. The attach is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"modifierGroupId":{"type":"string","minLength":1}},"required":["catalogItemId","modifierGroupId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/detachModifierGroupFromCatalogItem":{"post":{"operationId":"catalog.detachModifierGroupFromCatalogItem","summary":"Remove a live modifier set from one item","description":"Detaches the live set assignment. detachedCount counts assignments, not options. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"modifierGroupId":{"type":"string","minLength":1}},"required":["catalogItemId","modifierGroupId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/setItemModifierGroupAvailability":{"post":{"operationId":"catalog.setItemModifierGroupAvailability","summary":"Set availability of an item’s modifier set","description":"Switches the live set assignment. updatedCount counts assignments, not options. Making a row available is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Marking it unavailable never is. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["catalog"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"modifierGroupId":{"type":"string","minLength":1},"isAvailable":{"type":"boolean"}},"required":["catalogItemId","modifierGroupId","isAvailable"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/archiveModifierRows":{"post":{"operationId":"catalog.archiveModifierRows","summary":"Archive selected modifier sets and options","description":"Archives a same-organization selection atomically across all items, retaining rows and assignments. Returns only IDs newly archived by this call. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"modifierGroupIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"modifierIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}}},"required":["organizationId","modifierGroupIds","modifierIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/setModifierRowsAvailability":{"post":{"operationId":"catalog.setModifierRowsAvailability","summary":"Set availability of shared modifier sets and options","description":"Sets one organization-wide availability value on the selected sets and options. Preserves each item's assignment switches; this does not attach, detach or archive rows. Making a row available is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Marking it unavailable never is. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"modifierGroupIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"modifierIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"isAvailableByDefault":{"type":"boolean"}},"required":["organizationId","modifierGroupIds","modifierIds","isAvailableByDefault"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/moveModifierRows":{"post":{"operationId":"catalog.moveModifierRows","summary":"Move modifier options into or out of a set","description":"Moves live options to a same-organization set, or the catalog root when modifierGroupId is null. Keeps option IDs; effective assignments follow current set membership. Loose assignments promote to the destination set; moving out creates no standalone assignments. Moving an option into a set an item already offers puts it on sale: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"modifierIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"modifierGroupId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["organizationId","modifierIds","modifierGroupId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/repositionModifierRows":{"post":{"operationId":"catalog.repositionModifierRows","summary":"Reposition modifier sets and options","description":"Writes the supplied positions to organization-wide sets and options in one transaction, moving the options to modifierGroupId; null means the catalog root. Sets are only positioned at the root. Moving an option into a set an item already offers puts it on sale: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"modifierGroupId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"modifierGroups":{"type":"array","maxItems":500,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"position":{"type":"number"}},"required":["id","position"]}},"modifiers":{"type":"array","maxItems":500,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"position":{"type":"number"}},"required":["id","position"]}}},"required":["organizationId","modifierGroupId","modifierGroups","modifiers"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"modifierGroupIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"modifierIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}}},"required":["modifierGroupIds","modifierIds"]}}}}}}},"/api/public/v1/catalog/createItemVariation":{"post":{"operationId":"catalog.createItemVariation","summary":"Create an item variation","description":"Creates a named size in the organization-wide live catalog. priceCents is an absolute price in minor currency units. The first named size reuses the unnamed pricing row and returns its ID; an omitted price preserves or copies an existing price. Refused with CONFLICT (refusal nameTaken) when a live variation of the same item already has this name, compared case-insensitively after trimming whitespace. The refusal names that row as existingId. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. The write is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"id":{"type":"string","format":"uuid"},"isDefault":{"type":"boolean"},"isAvailableByDefault":{"type":"boolean"},"name":{"type":"string","minLength":1,"maxLength":120},"priceCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"videoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}},"required":["catalogItemId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/updateItemVariation":{"post":{"operationId":"catalog.updateItemVariation","summary":"Edit an item variation or price","description":"Updates only supplied fields on this organization-wide live variation. priceCents is an absolute price in minor currency units, not a modifier surcharge. Setting isDefault clears the other defaults for this item. Refused with CONFLICT (refusal nameTaken) when a live variation of the same item already has this name, compared case-insensitively after trimming whitespace. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. The write is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"isDefault":{"type":"boolean"},"isAvailableByDefault":{"type":"boolean"},"position":{"type":"number"},"name":{"type":"string","minLength":1,"maxLength":120},"priceCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"calories":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"videoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/archiveItemVariation":{"post":{"operationId":"catalog.archiveItemVariation","summary":"Archive an item variation","description":"Immediately removes this variation from the live catalog. Removing the last named variation instead clears its name, keeps its price, and enables its default availability. The last unnamed pricing row cannot be archived. Keep blankedSibling from the response for restoreItemVariation. Only when that last named variation was switched off does enabling it sell something new: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. The write is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/restoreItemVariation":{"post":{"operationId":"catalog.restoreItemVariation","summary":"Restore an item variation","description":"Restores this variation in the organization-wide live catalog. Pass blankedSibling from archiveItemVariation when undoing removal of the last named variation to restore its name and availability. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. The write is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"blankedSibling":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"isAvailableByDefault":{"type":"boolean"}},"required":["id","name","isAvailableByDefault"]}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/duplicateCatalogItem":{"post":{"operationId":"catalog.duplicateCatalogItem","summary":"Duplicate a catalog item","description":"Creates a live organization-wide copy below the original, including variations, tags, availability and links to the same shared modifiers. Identity fields such as barcodes and SKUs are cleared. Only live items can be copied. Refused with CONFLICT (refusal nameTaken) when a live item in the same category already has this name, compared case-insensitively after trimming whitespace. The refusal names that row as existingId. A destination folder that was deleted is refused with BAD_REQUEST and refusal `categoryArchived`, and nothing is stored. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. The copy is refused with BAD_REQUEST as `passItemLocked` for a pass item, whose price and setup change through passes.update. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["id","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/duplicateCategory":{"post":{"operationId":"catalog.duplicateCategory","summary":"Duplicate a category and its contents","description":"Copies this category and its live subtree into the organization-wide live catalog in one transaction, including items, variations and per-location folder availability; pass items are left out. Modifier links still reference shared options. The copy is placed below the original. Refused with CONFLICT (refusal nameTaken) when a live category under the same parent already has this name, compared case-insensitively after trimming whitespace. The refusal names that row as existingId. A destination folder that was deleted is refused with BAD_REQUEST and refusal `categoryArchived`, and nothing is stored. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["id","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/archiveCatalogRows":{"post":{"operationId":"catalog.archiveCatalogRows","summary":"Archive selected catalog rows","description":"Immediately archives the selected organization-wide categories, items and variations in one transaction. Category children are lifted to the parent; selecting a category does not archive its subtree. Selecting every live variation of an item archives all but its earliest-created one, which instead loses its name, keeps its price, and enables its default availability. Keep the returned IDs, blankedSiblings and category move records for restoreCatalogRows. Archiving or restoring a pass item also takes the Owner's loyalty:configure grant and is refused with FORBIDDEN without it. Re-enabling a switched-off row that way, or lifting a category's children out of a category closed at a venue or hidden from the guest menu to where they are offered, is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"categoryIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"itemIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"variationIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1},"default":[]}},"required":["organizationId","categoryIds","itemIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/moveCatalogRows":{"post":{"operationId":"catalog.moveCatalogRows","summary":"Move catalog categories and items","description":"Moves the selected organization-wide live catalog rows to parentCategoryId with the supplied positions in one transaction; null means the root. An item may carry a name to land under. Category URL slugs may change to avoid conflicts. Venue-specific QR-menu order overrides remain separate. Refused with CONFLICT (refusal nameTaken) when a live item in the same category already has this name, compared case-insensitively after trimming whitespace. A destination folder that was deleted is refused with BAD_REQUEST and refusal `categoryArchived`, and nothing is stored. Moving a row out from under a category closed at a venue or hidden from the guest menu to where it is offered is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"categories":{"type":"array","maxItems":500,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"position":{"type":"number"}},"required":["id","position"]}},"items":{"type":"array","maxItems":500,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"position":{"type":"number"},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["id","position"]}}},"required":["organizationId","parentCategoryId","categories","items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalog/restoreCatalogRows":{"post":{"operationId":"catalog.restoreCatalogRows","summary":"Restore a batch of catalog rows","description":"Restores organization-wide catalog rows in one transaction using the IDs, blankedSiblings and category move records returned by archiveCatalogRows. Categories readopt moved children only when those children still remain at the expected parent. Pass blankedSiblings back unchanged to restore those variations' names and availability. Returns BAD_REQUEST with refusal blankedSiblingsMismatch when a blankedSiblings entry is no longer its item's unnamed variation, or when restoring would leave an unnamed variation beside a named one because blankedSiblings omits it. Archiving or restoring a pass item also takes the Owner's loyalty:configure grant and is refused with FORBIDDEN without it. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"itemIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"variationIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1},"default":[]},"blankedSiblings":{"type":"array","maxItems":500,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"isAvailableByDefault":{"type":"boolean"}},"required":["id","name","isAvailableByDefault"]},"default":[]},"categories":{"type":"array","maxItems":500,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"movedCategoryIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}},"movedItemIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}}},"required":["id","movedCategoryIds","movedItemIds"]}}},"required":["organizationId","itemIds","categories"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/consent/get":{"post":{"operationId":"consent.get","description":"Reads the visitor's consent state for the optional categories: `off` while capture is switched off, `notConfigured` without an approved policy for the brand and market, else `active` with each category's unknown, granted or denied state and whether Global Privacy Control is on. Sets no cookie.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":["off","notConfigured","active","unavailable"],"type":"string"},"analyticsAllowed":{"type":"boolean"},"stamp":{"type":"string"},"version":{"type":"string"},"policyVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"privacyPolicyUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"gpc":{"type":"boolean"},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"enum":["analytics","marketing","referral"],"type":"string"},"state":{"enum":["unknown","granted","denied"],"type":"string"}},"required":["category","state"]}},"needsChoice":{"type":"boolean"}},"required":["status","analyticsAllowed","stamp","version","policyVersion","privacyPolicyUrl","gpc","categories","needsChoice"]}}}}}}},"/api/public/v1/consent/set":{"post":{"operationId":"consent.set","description":"Records the visitor's grant or refusal per optional category under the current policy version, then sets the consent cookie. Answers `stored` only after the server read the state back. Refused with FORBIDDEN for a cross-origin request or refusal `notConfigured`, `categoryNotOffered`, `captureOff`, `gpcActive` or `stale` (a newer choice is stored than the `expectedVersion` the save was made on), and TOO_MANY_REQUESTS past the budget. A refusal of a category asks the capture deletion contract; `deletion` says whether it was taken (`requested`), is not wired (`notAvailable`) or failed (`failed`, the choice is still stored; submit it again). A stored grant can always be withdrawn, even while capture is off.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"choices":{"type":"array","minItems":1,"maxItems":3,"items":{"type":"object","properties":{"category":{"enum":["analytics","marketing","referral"],"type":"string"},"decision":{"enum":["granted","denied"],"type":"string"}},"required":["category","decision"]}},"source":{"enum":["banner","preferences"],"type":"string"},"expectedVersion":{"type":"string","pattern":"^\\d+$"}},"required":["choices","source","expectedVersion"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"stored":{"const":true},"view":{"type":"object","properties":{"status":{"enum":["off","notConfigured","active","unavailable"],"type":"string"},"analyticsAllowed":{"type":"boolean"},"stamp":{"type":"string"},"version":{"type":"string"},"policyVersion":{"anyOf":[{"type":"string"},{"type":"null"}]},"privacyPolicyUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"gpc":{"type":"boolean"},"categories":{"type":"array","items":{"type":"object","properties":{"category":{"enum":["analytics","marketing","referral"],"type":"string"},"state":{"enum":["unknown","granted","denied"],"type":"string"}},"required":["category","state"]}},"needsChoice":{"type":"boolean"}},"required":["status","analyticsAllowed","stamp","version","policyVersion","privacyPolicyUrl","gpc","categories","needsChoice"]},"deletion":{"enum":["none","requested","notAvailable","failed"],"type":"string"}},"required":["stored","view","deletion"]}}}}}}},"/api/public/v1/catalogImports/create":{"post":{"operationId":"catalogImports.create","description":"Opens a catalog import for the uploaded files, in `uploading` until it is submitted. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"sources":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"enum":["application/pdf","application/zip","image/jpeg","image/png","image/webp","text/csv","text/tab-separated-values","text/plain","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","text/markdown","application/msword","application/vnd.ms-word.document.macroEnabled.12","application/vnd.ms-excel","application/vnd.ms-excel.sheet.macroEnabled.12","application/vnd.ms-excel.sheet.binary.macroEnabled.12","application/vnd.ms-powerpoint","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.ms-powerpoint.presentation.macroEnabled.12","application/vnd.openxmlformats-officedocument.presentationml.slideshow","application/vnd.ms-powerpoint.slideshow.macroEnabled.12","application/vnd.oasis.opendocument.text","application/vnd.oasis.opendocument.spreadsheet","application/vnd.oasis.opendocument.presentation","application/rtf","application/epub+zip"],"type":"string"},"bytes":{"type":"integer","minimum":1,"maximum":26214400},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["fileName","mediaType","bytes"],"additionalProperties":false}}},"required":["organizationId","sources"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalogImports/attach":{"post":{"operationId":"catalogImports.attach","description":"Runs the catalogImports.attach procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"sourceId":{"type":"string","format":"uuid"},"sourceUrl":{"type":"string","maxLength":4096,"format":"uri"}},"required":["organizationId","importId","sourceId","sourceUrl"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalogImports/initialize":{"post":{"operationId":"catalogImports.initialize","description":"Runs the catalogImports.initialize procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"sourceId":{"type":"string","format":"uuid"}},"required":["organizationId","importId","sourceId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalogImports/complete":{"post":{"operationId":"catalogImports.complete","description":"Runs the catalogImports.complete procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"sourceId":{"type":"string","format":"uuid"}},"required":["organizationId","importId","sourceId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalogImports/submit":{"post":{"operationId":"catalogImports.submit","description":"Sends an uploaded import to be read; a repeat answers with the submission already sent, even once the business is suspended. A first submission: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["organizationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalogImports/active":{"post":{"operationId":"catalogImports.active","description":"Reads the catalogImports.active procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/catalogImports/status":{"post":{"operationId":"catalogImports.status","description":"Reads the catalogImports.status procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["organizationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customerImports/create":{"post":{"operationId":"customerImports.create","description":"Opens a customer import for the uploaded files, in `uploading` until it is submitted. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"sources":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"enum":["application/pdf","application/zip","image/jpeg","image/png","image/webp","text/csv","text/tab-separated-values","text/plain","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.wordprocessingml.document","text/markdown","application/msword","application/vnd.ms-word.document.macroEnabled.12","application/vnd.ms-excel","application/vnd.ms-excel.sheet.macroEnabled.12","application/vnd.ms-excel.sheet.binary.macroEnabled.12","application/vnd.ms-powerpoint","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.ms-powerpoint.presentation.macroEnabled.12","application/vnd.openxmlformats-officedocument.presentationml.slideshow","application/vnd.ms-powerpoint.slideshow.macroEnabled.12","application/vnd.oasis.opendocument.text","application/vnd.oasis.opendocument.spreadsheet","application/vnd.oasis.opendocument.presentation","application/rtf","application/epub+zip"],"type":"string"},"bytes":{"type":"integer","minimum":1,"maximum":26214400},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["fileName","mediaType","bytes"],"additionalProperties":false}}},"required":["organizationId","sources"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customerImports/attach":{"post":{"operationId":"customerImports.attach","description":"Runs the customerImports.attach procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"sourceId":{"type":"string","format":"uuid"},"sourceUrl":{"type":"string","maxLength":4096,"format":"uri"}},"required":["organizationId","importId","sourceId","sourceUrl"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customerImports/initialize":{"post":{"operationId":"customerImports.initialize","description":"Runs the customerImports.initialize procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"sourceId":{"type":"string","format":"uuid"}},"required":["organizationId","importId","sourceId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customerImports/complete":{"post":{"operationId":"customerImports.complete","description":"Runs the customerImports.complete procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"},"sourceId":{"type":"string","format":"uuid"}},"required":["organizationId","importId","sourceId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customerImports/submit":{"post":{"operationId":"customerImports.submit","description":"Sends an uploaded import to be read; a repeat answers with the submission already sent, even once the business is suspended. A first submission: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["organizationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customerImports/latest":{"post":{"operationId":"customerImports.latest","description":"Reads the customerImports.latest procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customerImports/status":{"post":{"operationId":"customerImports.status","description":"Reads the customerImports.status procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["organizationId","importId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/list":{"post":{"operationId":"customers.list","description":"Reads the customers.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"query":{"type":"string","maxLength":120},"page":{"type":"integer","minimum":1,"maximum":9007199254740991,"default":1},"segment":{"enum":["contactOnly","new","oneTime","active","atRisk","lost"],"type":"string"},"badge":{"enum":["regular","vip"],"type":"string"},"timeZone":{"type":"string","minLength":1},"sort":{"enum":["created","totalSpent","visits","lastVisit"],"type":"string"},"direction":{"enum":["asc","desc"],"type":"string"},"createdFrom":{"type":"string","format":"date"},"createdTo":{"type":"string","format":"date"},"source":{"enum":["manual","import","pos","signup","booking","customer_display"],"type":"string"},"birthdayFrom":{"type":"string","pattern":"^(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"birthdayTo":{"type":"string","pattern":"^(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"orderedFrom":{"type":"string","format":"date"},"orderedTo":{"type":"string","format":"date"},"firstOrderFrom":{"type":"string","format":"date"},"firstOrderTo":{"type":"string","format":"date"},"lastOrderFrom":{"type":"string","format":"date"},"lastOrderTo":{"type":"string","format":"date"},"minOrders":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxOrders":{"type":"integer","minimum":0,"maximum":9007199254740991},"minSpentCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxSpentCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"categoryId":{"type":"string","minLength":1,"maxLength":64},"catalogItemId":{"type":"string","minLength":1,"maxLength":64},"locationId":{"type":"string","minLength":1,"maxLength":64},"loyalty":{"enum":["members","nonMembers"],"type":"string"},"tier":{"type":"string","minLength":1,"maxLength":64},"pass":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","timeZone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/composition":{"post":{"operationId":"customers.composition","description":"Reads the customers.composition procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"query":{"type":"string","maxLength":120},"timeZone":{"type":"string","minLength":1},"createdFrom":{"type":"string","format":"date"},"createdTo":{"type":"string","format":"date"},"source":{"enum":["manual","import","pos","signup","booking","customer_display"],"type":"string"},"birthdayFrom":{"type":"string","pattern":"^(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"birthdayTo":{"type":"string","pattern":"^(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$"},"orderedFrom":{"type":"string","format":"date"},"orderedTo":{"type":"string","format":"date"},"firstOrderFrom":{"type":"string","format":"date"},"firstOrderTo":{"type":"string","format":"date"},"lastOrderFrom":{"type":"string","format":"date"},"lastOrderTo":{"type":"string","format":"date"},"minOrders":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxOrders":{"type":"integer","minimum":0,"maximum":9007199254740991},"minSpentCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxSpentCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"categoryId":{"type":"string","minLength":1,"maxLength":64},"catalogItemId":{"type":"string","minLength":1,"maxLength":64},"locationId":{"type":"string","minLength":1,"maxLength":64},"loyalty":{"enum":["members","nonMembers"],"type":"string"},"tier":{"type":"string","minLength":1,"maxLength":64},"pass":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/loyaltyFilters":{"post":{"operationId":"customers.loyaltyFilters","description":"Reads the customers.loyaltyFilters procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"isMembershipFilterable":{"type":"boolean"},"tiers":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"readOnly":true},{"type":"null"}]},"passes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"readOnly":true},{"type":"null"}]}},"required":["isMembershipFilterable","tiers","passes"]}}}}}}},"/api/public/v1/customers/search":{"post":{"operationId":"customers.search","description":"Reads the customers.search procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"query":{"type":"string","minLength":1,"maxLength":120}},"required":["organizationId","query"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/tillSearch":{"post":{"operationId":"customers.tillSearch","description":"Reads the customers.tillSearch procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"mode":{"enum":["phone","name"],"type":"string"},"query":{"type":"string","maxLength":120}},"required":["organizationId","mode","query"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"isExact":{"type":"boolean"},"loyaltyStatus":{"enum":["member","joinable","needsPhone"],"type":"string"}},"required":["id","name","phone","isExact","loyaltyStatus"]}}},"required":["customers"]}}}}}}},"/api/public/v1/customers/tillPhoneCountry":{"post":{"operationId":"customers.tillPhoneCountry","description":"Reads the customers.tillPhoneCountry procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"phoneCountry":{"anyOf":[{"not":{}},{"type":"null"}]}},"required":["phoneCountry"]}}}}}}},"/api/public/v1/customers/tillCard":{"post":{"operationId":"customers.tillCard","description":"The till's card for the customer attached to an order. `loyalty` is null while the organization's loyalty program is not live, and also while the organization's plan lacks Loyalty and Loyalty is enforced. A non-member's `loyalty` is also null while the business may start no new Loyalty commitment: its own switch is off, its plan restricts Loyalty, or its billing standing admits no new commitment; a member's stays. A non-member's `needsCode` says whether joining asks for the guest's WhatsApp code. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"profileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"segment":{"enum":["contactOnly","new","oneTime","active","atRisk","lost"],"type":"string"},"visits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"usualOrder":{"type":"array","items":{"type":"string"}},"latestNote":{"anyOf":[{"type":"string"},{"type":"null"}]},"loyalty":{"anyOf":[{"anyOf":[{"type":"object","properties":{"status":{"const":"notMember"},"hasPhone":{"type":"boolean"},"needsCode":{"type":"boolean"}},"required":["status","hasPhone","needsCode"]},{"type":"object","properties":{"status":{"const":"member"},"balanceHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tier":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"endsAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]}},"required":["name","endsAt"]},{"type":"null"}]},"cashbackBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"earnBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"nextExpiry":{"anyOf":[{"type":"object","properties":{"amountHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"date":{"type":"string","format":"date"}},"required":["amountHundredths","date"]},{"type":"null"}]}},"required":["status","balanceHundredths","tier","cashbackBasisPoints","earnBasisPoints","nextExpiry"]}]},{"type":"null"}]},"passes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"endsOn":{"type":"string","format":"date"},"allowanceCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowancePeriod":{"enum":["day","week","month"],"type":"string"},"left":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"resetsOn":{"type":"string","format":"date"},"lastUse":{"anyOf":[{"type":"object","properties":{"day":{"type":"string","format":"date"},"isToday":{"type":"boolean"},"time":{"type":"string"},"locationName":{"type":"string"}},"required":["day","isToday","time","locationName"]},{"type":"null"}]}},"required":["name","endsOn","allowanceCount","allowancePeriod","left","resetsOn","lastUse"]}},"endedPasses":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"endsOn":{"type":"string","format":"date"}},"required":["name","endsOn"]}}},"required":["profileId","name","phone","segment","visits","usualOrder","latestNote","loyalty","passes","endedPasses"]}}}}}}},"/api/public/v1/customers/bookingCard":{"post":{"operationId":"customers.bookingCard","description":"The card of the customer a host picked for a booking, read at the booking's location: since when, how many paid orders, the last one with its lines, the lifetime spend and the newest note. It answers while the location's Bookings switch is off, so a booking already made keeps its guest's card. Refused with NOT_FOUND for a location or a customer the organization does not hold. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1}},"required":["locationId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"profileId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"visits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lifetimeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastOrder":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","x-native-type":"date"},"totalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"items":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["at","totalCents","items"]},{"type":"null"}]},"latestNote":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["profileId","name","phone","createdAt","visits","lifetimeCents","lastOrder","latestNote"]}}}}}}},"/api/public/v1/customers/tillAddresses":{"post":{"operationId":"customers.tillAddresses","description":"Reads the customers.tillAddresses procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address":{"type":"string"},"area":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"isDefault":{"type":"boolean"}},"required":["id","address","area","city","isDefault"]}}},"required":["addresses"]}}}}}}},"/api/public/v1/customers/tillCustomerAddresses":{"post":{"operationId":"customers.tillCustomerAddresses","description":"Reads the customers.tillCustomerAddresses procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"address":{"type":"string"},"area":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"isDefault":{"type":"boolean"}},"required":["id","address","area","city","isDefault"]}}},"required":["addresses"]}}}}}}},"/api/public/v1/customers/tillPoints":{"post":{"operationId":"customers.tillPoints","description":"Whether the customer attached to an order can spend loyalty points on it and, for a member, the balance and the limits a spend is held to. Answers status `off` while the program is not live, and also while the business may start no new Loyalty commitment: its own switch is off, its plan restricts or lacks Loyalty, or its billing standing admits no new commitment. A non-member's `needsCode` says whether joining asks for the guest's WhatsApp code; a member's says whether spending does, with `isVerified` whether `verifyPointsCode` verified the order for them, and `phone` the number the code goes to. Every status but `off` carries `earn`: the cashback rate the order earns its guest at, a member's tier rate or the program's own, and the happy-hours multiplier when the order was opened inside them, both in basis points. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"off"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"noCustomer"},"earn":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"multiplierBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cashbackBasisPoints","multiplierBasisPoints"]}},"required":["status","earn"]},{"type":"object","properties":{"status":{"const":"notMember"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"hasPhone":{"type":"boolean"},"needsCode":{"type":"boolean"},"earn":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"multiplierBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cashbackBasisPoints","multiplierBasisPoints"]}},"required":["status","name","hasPhone","needsCode","earn"]},{"type":"object","properties":{"status":{"const":"member"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"earn":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"multiplierBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cashbackBasisPoints","multiplierBasisPoints"]},"balanceHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"maxPercent":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"capLeftHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"needsCode":{"type":"boolean"},"isVerified":{"type":"boolean"}},"required":["status","name","earn","balanceHundredths","minHundredths","maxPercent","capLeftHundredths","phone","needsCode","isVerified"]}]}}}}}}},"/api/public/v1/customers/tillOrderEarn":{"post":{"operationId":"customers.tillOrderEarn","description":"What a paid order earned its loyalty member and their balance after it, or null when it earned nothing. Also null while the plan lacks Loyalty under enforcement. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"earnedHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"balanceHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["firstName","earnedHundredths","balanceHundredths"]},{"type":"null"}]}}}}}}},"/api/public/v1/customers/tillLoyaltyProgram":{"post":{"operationId":"customers.tillLoyaltyProgram","description":"Whether the organization's loyalty program is live, so the till offers to enrol a new customer. Answers `isLive: false` while the business may start no new Loyalty commitment: its own switch is off, its plan restricts or lacks Loyalty, or its billing standing admits no new commitment. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"isLive":{"type":"boolean"}},"required":["isLive"]}}}}}}},"/api/public/v1/customers/sendTillJoinCode":{"post":{"operationId":"customers.sendTillJoinCode","description":"Sends the WhatsApp code that proves the customer attached to an order holds their number, for `joinLoyaltyAtTill` to join them with. Answers `sent`, `cooldown` with `retryAfterSeconds` while the last code is too fresh, or `unavailable` when no code can be sent, the organization asks for no code when the till adds a guest to loyalty, or the customer is already a member or has no phone. Refused with TOO_MANY_REQUESTS past the number's hourly budget, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty, before any code is sent. A code for a non-member: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"sent"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"cooldown"},"retryAfterSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["status","retryAfterSeconds"]},{"type":"object","properties":{"status":{"const":"unavailable"}},"required":["status"]}]}}}}}}},"/api/public/v1/customers/sendPointsCode":{"post":{"operationId":"customers.sendPointsCode","description":"Sends the WhatsApp code that proves the loyalty member attached to an order holds their number, for `verifyPointsCode` to verify the order with before its points pay. Answers `sent`, `cooldown` with `retryAfterSeconds` while the last code is too fresh, or `unavailable` when no code can be sent, the organization asks for no code before points pay, or the customer is not a member or has no phone. Refused with TOO_MANY_REQUESTS past the number's hourly budget, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty, and with FORBIDDEN and refusal `billingReadOnly` or `subscriptionEnded` while its billing standing admits no new commitment, before any code is sent. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"sent"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"cooldown"},"retryAfterSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["status","retryAfterSeconds"]},{"type":"object","properties":{"status":{"const":"unavailable"}},"required":["status"]}]}}}}}}},"/api/public/v1/customers/verifyPointsCode":{"post":{"operationId":"customers.verifyPointsCode","description":"Verifies an order with the WhatsApp code `sendPointsCode` sent its loyalty member, so `payments.pay` may spend that member's points on it for the next 30 minutes, any number of times. Refused with FORBIDDEN and refusal `phoneCodeWrong` or `phoneCodeExpired` for a code that does not prove the number, PRECONDITION_FAILED and refusal `pointsUnavailable` when the customer is not a member or has no phone, and FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty, or `billingReadOnly` or `subscriptionEnded` while its billing standing admits no new commitment, before any code is checked. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"phoneCode":{"type":"string","pattern":"^\\d{4}$"}},"required":["orderId","phoneCode"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customers/tillPassSale":{"post":{"operationId":"customers.tillPassSale","description":"What paying for an order holding a pass gives its customer: the pass's name, the customer's name, whether the organization asks for the guest's WhatsApp code when selling a pass (`needsCode`), sent to `phone`, whether `verifyPassSaleCode` verified the order for its customer (`isVerified`), and `renewsUntil`, the end the sale moves the customer's active pass of the same kind to, null for a new pass. Answers status `noCustomer` for an order with no customer or no pass. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"noCustomer"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"sale"},"passName":{"type":"string"},"customerName":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"needsCode":{"type":"boolean"},"isVerified":{"type":"boolean"},"renewsUntil":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["status","passName","customerName","phone","needsCode","isVerified","renewsUntil"]}]}}}}}}},"/api/public/v1/customers/sendPassSaleCode":{"post":{"operationId":"customers.sendPassSaleCode","description":"Sends the WhatsApp code that proves the customer attached to an order holding a pass holds their number, for `verifyPassSaleCode` to verify the order with before it is paid. Answers `sent`, `cooldown` with `retryAfterSeconds` while the last code is too fresh, or `unavailable` when no code can be sent, the organization asks for no code when selling a pass, the order holds no pass or the customer has no phone. Refused with TOO_MANY_REQUESTS past the number's hourly budget. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"sent"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"cooldown"},"retryAfterSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["status","retryAfterSeconds"]},{"type":"object","properties":{"status":{"const":"unavailable"}},"required":["status"]}]}}}}}}},"/api/public/v1/customers/verifyPassSaleCode":{"post":{"operationId":"customers.verifyPassSaleCode","description":"Verifies an order holding a pass with the WhatsApp code `sendPassSaleCode` sent its customer, so the order may be paid for the next 30 minutes, any number of times; another customer on the order needs their own. Refused with FORBIDDEN and refusal `phoneCodeWrong` or `phoneCodeExpired` for a code that does not prove the number, and PRECONDITION_FAILED and refusal `passSaleUnavailable` when the order holds no pass or the customer has no phone. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"phoneCode":{"type":"string","pattern":"^\\d{4}$"}},"required":["orderId","phoneCode"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customers/tillOrderPass":{"post":{"operationId":"customers.tillOrderPass","description":"The pass a paid order sold or renewed for its customer, with the customer's name and the pass's last valid day after the sale, or null when it gave none. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"endsOn":{"type":"string","format":"date"},"customerName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","endsOn","customerName"]},{"type":"null"}]}}}}}}},"/api/public/v1/customers/tillPassRedemption":{"post":{"operationId":"customers.tillPassRedemption","description":"What an order redeems for its customer: each line a pass the customer holds covers (`redemptions`, the pass, the item and the uses `left` in the period, this order's not yet counted), each pass covering several different items on the order with the lines to pick one from with `orders.choosePassLine` (`choices`), whether the cashier charged the pass lines at full price with `orders.declinePassRedemption` (`isDeclined`) and the passes that left unredeemed (`declinedPassNames`), whether the organization asks for the guest's WhatsApp code when redeeming a pass (`needsCode`), sent to `phone`, and whether the order holds a live verification of its guest (`isVerified`), which any of the order's guest codes gives. Answers status `none` for an order with no customer or nothing to redeem. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"none"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"redemption"},"customerName":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"needsCode":{"type":"boolean"},"isVerified":{"type":"boolean"},"isDeclined":{"type":"boolean"},"redemptions":{"type":"array","items":{"type":"object","properties":{"itemId":{"type":"string"},"passName":{"type":"string"},"itemName":{"type":"string"},"left":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowanceCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowancePeriod":{"enum":["day","week","month"],"type":"string"}},"required":["itemId","passName","itemName","left","allowanceCount","allowancePeriod"]}},"choices":{"type":"array","items":{"type":"object","properties":{"passName":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"itemId":{"type":"string"},"name":{"type":"string"}},"required":["itemId","name"]}}},"required":["passName","lines"]}},"declinedPassNames":{"type":"array","items":{"type":"string"}}},"required":["status","customerName","phone","needsCode","isVerified","isDeclined","redemptions","choices","declinedPassNames"]}]}}}}}}},"/api/public/v1/customers/sendPassRedemptionCode":{"post":{"operationId":"customers.sendPassRedemptionCode","description":"Sends the WhatsApp code that proves the customer on an order with a line a pass redeems holds their number, for `verifyPassRedemptionCode` to verify the order with before it is paid. Answers `sent`, `cooldown` with `retryAfterSeconds` while the last code is too fresh, or `unavailable` when no code can be sent, the organization asks for no code when redeeming a pass, the order redeems no pass or the customer has no phone. Refused with TOO_MANY_REQUESTS past the number's hourly budget. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"sent"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"cooldown"},"retryAfterSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["status","retryAfterSeconds"]},{"type":"object","properties":{"status":{"const":"unavailable"}},"required":["status"]}]}}}}}}},"/api/public/v1/customers/verifyPassRedemptionCode":{"post":{"operationId":"customers.verifyPassRedemptionCode","description":"Verifies an order with a line a pass redeems with the WhatsApp code `sendPassRedemptionCode` sent its customer, so the order may be paid for the next 30 minutes, a points spend included; another customer on the order needs their own. Refused with FORBIDDEN and refusal `phoneCodeWrong` or `phoneCodeExpired` for a code that does not prove the number, and PRECONDITION_FAILED and refusal `passRedemptionUnavailable` when the order redeems no pass or the customer has no phone. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"phoneCode":{"type":"string","pattern":"^\\d{4}$"}},"required":["orderId","phoneCode"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customers/joinLoyaltyAtTill":{"post":{"operationId":"customers.joinLoyaltyAtTill","description":"Enrols the customer attached to an order in the live loyalty program, crediting the welcome bonus, and the order's earn when it is already paid. A customer already enrolled answers as joined, with or without `phoneCode`. While the organization asks for the guest's WhatsApp code when the till adds them to loyalty, a non-member joins only with the code `sendTillJoinCode` sent them, refused with FORBIDDEN and refusal `phoneCodeRequired` without one, and `phoneCodeWrong` or `phoneCodeExpired` for one that does not prove the number. Refused with PRECONDITION_FAILED when the program is not live or the customer has no phone, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty, before anything is enrolled. A non-member's join: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. A member still answers as joined, earning nothing new while the business is refused. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"phoneCode":{"type":"string","pattern":"^\\d{4}$"}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customers/addNoteAtTill":{"post":{"operationId":"customers.addNoteAtTill","description":"Runs the customers.addNoteAtTill procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"text":{"type":"string","minLength":1,"maxLength":500}},"required":["orderId","text"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customers/create":{"post":{"operationId":"customers.create","description":"Runs the customers.create procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"phone":{"type":"string","minLength":1,"maxLength":40},"email":{"type":"string","format":"email"},"dateOfBirth":{"type":"string","format":"date"},"comment":{"type":"string","maxLength":500}},"required":["organizationId","phone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/createAtTill":{"post":{"operationId":"customers.createAtTill","description":"Creates the customer a cashier is about to attach to an order, answering with an existing customer that already holds the number. With `joinLoyalty`, a live program enrols the customer; when the program is not live, or the business takes no new Loyalty work (its own switch is off, or its plan restricts or lacks Loyalty), the customer is created without enrolling, as before for a program that is not live. While the organization asks for the guest's WhatsApp code when the till adds them to loyalty, `joinLoyalty` enrols nobody and sends the code to a customer who is not yet a member instead: `joinCode` is that send (`sent`, `cooldown` or `unavailable`), and null when no code was sent. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"phone":{"type":"string","minLength":1,"maxLength":40},"email":{"type":"string","format":"email"},"dateOfBirth":{"type":"string","format":"date"},"comment":{"type":"string","maxLength":500},"joinLoyalty":{"type":"boolean"}},"required":["organizationId","phone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"loyaltyStatus":{"enum":["member","joinable","needsPhone"],"type":"string"},"loyaltyJoin":{"anyOf":[{"type":"object","properties":{"welcomeHundredths":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["welcomeHundredths"]},{"type":"null"}]},"joinCode":{"anyOf":[{"anyOf":[{"type":"object","properties":{"status":{"const":"sent"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"cooldown"},"retryAfterSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["status","retryAfterSeconds"]},{"type":"object","properties":{"status":{"const":"unavailable"}},"required":["status"]}]},{"type":"null"}]}},"required":["id","name","phone","loyaltyStatus","loyaltyJoin","joinCode"]}}}}}}},"/api/public/v1/customers/createAtBooking":{"post":{"operationId":"customers.createAtBooking","description":"Creates the customer a host is about to pick for a booking, answering with an existing customer that already holds the number. A `bookingId` names the stored booking the guest is added to: one of this organization the caller may update in its current status, whatever the location's Bookings switch, plan or standing. Otherwise `locationId` names the location a new booking is taken at, which must take it as `bookings.create` does: refused with FORBIDDEN as `bookingsDisabled`, `billingReadOnly`, `subscriptionEnded`, `featureRestrictedByPlan` or `featureNotEntitled`. Naming neither, the business as a whole is judged: refused with FORBIDDEN as `billingReadOnly`, `subscriptionEnded`, `featureRestrictedByPlan` or `featureNotEntitled`. Refused with NOT_FOUND for a booking or location this organization does not hold, with CONFLICT as `transitionNotAllowed` for a closed booking, and with UNPROCESSABLE_CONTENT for a number that cannot be read as one. Customers are still created through `customers.create`. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"phone":{"type":"string","minLength":1,"maxLength":40},"bookingId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1}},"required":["organizationId","phone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"loyaltyStatus":{"enum":["member","joinable","needsPhone"],"type":"string"}},"required":["id","name","phone","loyaltyStatus"]}}}}}}},"/api/public/v1/customers/profile":{"post":{"operationId":"customers.profile","description":"Reads the customers.profile procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/loyalty":{"post":{"operationId":"customers.loyalty","description":"Reads the customers.loyalty procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"programStatus":{"anyOf":[{"enum":["draft","live","stopped"],"type":"string"},{"type":"null"}]},"isAdmitted":{"type":"boolean"},"hasPhone":{"type":"boolean"},"member":{"anyOf":[{"type":"object","properties":{"joinedAt":{"type":"string","format":"date-time","x-native-type":"date"},"balanceHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tier":{"anyOf":[{"type":"object","properties":{"name":{"type":"string"},"endsAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]}},"required":["name","endsAt"]},{"type":"null"}]}},"required":["joinedAt","balanceHundredths","tier"]},{"type":"null"}]}},"required":["programStatus","isAdmitted","hasPhone","member"]}}}}}}},"/api/public/v1/customers/passes":{"post":{"operationId":"customers.passes","description":"Reads the customers.passes procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64},"timeZone":{"type":"string"}},"required":["organizationId","customerId","timeZone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"endsOn":{"type":"string"},"state":{"enum":["live","voided","expired"],"type":"string"},"allowance":{"anyOf":[{"type":"object","properties":{"allowanceCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowancePeriod":{"enum":["day","week","month"],"type":"string"},"left":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"resetsOn":{"type":"string","format":"date"},"lastUse":{"anyOf":[{"type":"object","properties":{"day":{"type":"string","format":"date"},"isToday":{"type":"boolean"},"time":{"type":"string"},"locationName":{"type":"string"}},"required":["day","isToday","time","locationName"]},{"type":"null"}]}},"required":["allowanceCount","allowancePeriod","left","resetsOn","lastUse"]},{"type":"null"}]}},"required":["id","name","endsOn","state","allowance"]}}}}}}}},"/api/public/v1/customers/joinLoyalty":{"post":{"operationId":"customers.joinLoyalty","description":"Adds a customer to the live loyalty program from their profile, crediting the welcome bonus. A customer already enrolled answers as joined. Refused with PRECONDITION_FAILED when the program is not live or the customer has no phone, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty. A non-member's join: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. A member still answers as joined. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customers/adjustLoyalty":{"post":{"operationId":"customers.adjustLoyalty","description":"Adds or removes a member's points by hand, with a reason; removing more than the member can spend is refused whole. Adding points grants a new redeemable balance, so it is refused with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty, while removing points stays open whatever the switch, plan or standing. Adding points: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64},"direction":{"enum":["add","remove"],"type":"string"},"amountHundredths":{"type":"integer","minimum":1,"maximum":100000000},"reasonCode":{"enum":["goodwill","staff_error","promotion","program_migration"],"type":"string"},"note":{"type":"string","maxLength":500}},"required":["organizationId","customerId","direction","amountHundredths","reasonCode"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"balanceHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["balanceHundredths"]}}}}}}},"/api/public/v1/customers/topItems":{"post":{"operationId":"customers.topItems","description":"Reads the customers.topItems procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/timelinePage":{"post":{"operationId":"customers.timelinePage","description":"Reads the customers.timelinePage procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64},"tab":{"enum":["all","orders","notes","loyalty","passes"],"type":"string"},"timeZone":{"type":"string"},"page":{"type":"integer","minimum":1,"maximum":9007199254740991,"default":1},"withLoyalty":{"type":"boolean"},"withTiers":{"type":"boolean"},"withPasses":{"type":"boolean"},"withRedemptions":{"type":"boolean"},"withPassRefunds":{"type":"boolean"}},"required":["organizationId","customerId","tab","timeZone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","x-native-type":"date"},"kind":{"const":"order"},"orderNumber":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"totalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"locationName":{"type":"string"},"items":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","occurredAt","kind","orderNumber","totalCents","locationName","items"]},{"type":"object","properties":{"id":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","x-native-type":"date"},"kind":{"const":"note"},"body":{"type":"string"},"authorName":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"enum":["manual","import","carriedOver"],"type":"string"}},"required":["id","occurredAt","kind","body","authorName","source"]},{"type":"object","properties":{"id":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","x-native-type":"date"},"kind":{"const":"created"},"source":{"anyOf":[{"enum":["manual","import","pos","signup","booking","customer_display"],"type":"string"},{"type":"null"}]}},"required":["id","occurredAt","kind","source"]},{"type":"object","properties":{"id":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","x-native-type":"date"},"kind":{"const":"loyalty"},"entryKind":{"enum":["welcome","earn","birthday","adjustment","redeem","earn_reversal","redeem_return","expiry"],"type":"string"},"amountHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderId":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"reasonCode":{"anyOf":[{"enum":["goodwill","staff_error","promotion","program_migration"],"type":"string"},{"type":"null"}]},"note":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","occurredAt","kind","entryKind","amountHundredths","orderId","orderNumber","reasonCode","note"]},{"type":"object","properties":{"id":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","x-native-type":"date"},"kind":{"const":"tier"},"reason":{"enum":["upgrade","refund_undo","term_renewal","term_drop","tiers_enabled","tiers_disabled","ladder_upgrade","tier_deleted"],"type":"string"},"fromTier":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name"]},{"type":"null"}]},"toTier":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name"]},{"type":"null"}]},"toEndsAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"orderId":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["id","occurredAt","kind","reason","fromTier","toTier","toEndsAt","orderId","orderNumber"]},{"type":"object","properties":{"id":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","x-native-type":"date"},"kind":{"const":"pass"},"event":{"enum":["bought","renewed","voided","renewalRefunded","redeemed"],"type":"string"},"name":{"type":"string"},"endsOn":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"enum":["refundWithin14Days","soldByMistake","customerRequest","misuse"],"type":"string"},{"type":"null"}]},"orderId":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"itemName":{"anyOf":[{"type":"string"},{"type":"null"}]},"locationName":{"anyOf":[{"type":"string"},{"type":"null"}]},"cashierName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","occurredAt","kind","event","name","endsOn","reason","orderId","orderNumber","itemName","locationName","cashierName"]}]}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pageCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rows","total","page","pageCount"]}}}}}}},"/api/public/v1/customers/notes":{"post":{"operationId":"customers.notes","description":"Reads the customers.notes procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/addNote":{"post":{"operationId":"customers.addNote","description":"Runs the customers.addNote procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64},"body":{"type":"string","minLength":1,"maxLength":500}},"required":["organizationId","customerId","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/update":{"post":{"operationId":"customers.update","description":"Runs the customers.update procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64},"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":120},{"type":"null"}]},"phone":{"type":"string","minLength":1,"maxLength":40},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}]},"dateOfBirth":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["organizationId","customerId","name","phone","dateOfBirth"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/customers/addAddress":{"post":{"operationId":"customers.addAddress","description":"Runs the customers.addAddress procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","maxLength":300},"area":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"city":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},"required":["organizationId","customerId","address","area","city"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"address":{"type":"string"},"area":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"isDefault":{"type":"boolean"}},"required":["id","address","area","city","isDefault"]}}}}}}},"/api/public/v1/customers/updateAddress":{"post":{"operationId":"customers.updateAddress","description":"Runs the customers.updateAddress procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64},"addressId":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","maxLength":300},"area":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"city":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},"required":["organizationId","customerId","addressId","address","area","city"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"address":{"type":"string"},"area":{"anyOf":[{"type":"string"},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"isDefault":{"type":"boolean"}},"required":["id","address","area","city","isDefault"]}}}}}}},"/api/public/v1/customers/deleteAddress":{"post":{"operationId":"customers.deleteAddress","description":"Runs the customers.deleteAddress procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64},"addressId":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","customerId","addressId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customers/setDefaultAddress":{"post":{"operationId":"customers.setDefaultAddress","description":"Runs the customers.setDefaultAddress procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64},"addressId":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","customerId","addressId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/customers/archive":{"post":{"operationId":"customers.archive","description":"Runs the customers.archive procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/demo/ensure":{"post":{"operationId":"demo.ensure","description":"Runs the demo.ensure procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"realOrganizationId":{"type":"string","minLength":1}},"required":["realOrganizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"ready"},"demoOrganizationId":{"type":"string","minLength":1}},"required":["status","demoOrganizationId"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"preparing"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"unavailable"}},"required":["status"],"additionalProperties":false}]}}}}}}},"/api/public/v1/demo/enter":{"post":{"operationId":"demo.enter","description":"Runs the demo.enter procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"realOrganizationId":{"type":"string","minLength":1}},"required":["realOrganizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/demo/topUp":{"post":{"operationId":"demo.topUp","description":"Runs the demo.topUp procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"enum":["updated","current","busy"],"type":"string"}}}}}}},"/api/public/v1/demo/leave":{"post":{"operationId":"demo.leave","description":"Runs the demo.leave procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/loyalty/getProgram":{"post":{"operationId":"loyalty.getProgram","description":"Returns the organization's loyalty program, or null when it was never launched. Readable whatever the plan, so existing configuration survives a lapse. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"enum":["draft","live","stopped"],"type":"string"},"settings":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000,"default":500},"expiryDays":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":365},"welcome":{"type":"object","properties":{"enabled":{"type":"boolean","default":true},"points":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0,"default":1000},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"minRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},"default":{}},"maxRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"percent":{"type":"integer","minimum":1,"maximum":100,"default":100}},"default":{}},"birthday":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"happyHours":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"weekdays":{"type":"array","items":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"default":[]},"from":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"15:00"},"to":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"18:00"},"multiplierBasisPoints":{"type":"integer","minimum":10001,"maximum":100000,"default":15000}},"default":{}},"policy":{"type":"object","properties":{"privacy":{"type":"string","maxLength":20000,"default":""},"terms":{"type":"string","maxLength":20000,"default":""}},"default":{}},"tiers":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"ladder":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":40},"thresholdCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000}},"required":["id","name","thresholdCents","cashbackBasisPoints"]},"default":[]}},"default":{}},"signupFields":{"type":"object","properties":{"name":{"enum":["off","optional","required"],"type":"string","default":"optional"},"email":{"enum":["off","optional","required"],"type":"string","default":"optional"},"dateOfBirth":{"enum":["off","optional","required"],"type":"string","default":"optional"}},"default":{}}}}},"required":["status","settings"]},{"type":"null"}]}}}}}}},"/api/public/v1/loyalty/availability":{"post":{"operationId":"loyalty.availability","description":"Says whether the business takes new Loyalty work: `availability` is `null` when it does, `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan's policy restricts Loyalty, and `featureNotEntitled` while its plan lacks Loyalty, and `billingReadOnly` or `subscriptionEnded` while its billing standing admits no new commitment. While it is not `null`, launching, running and configuring the program and reading its sign-up kit are refused, while reading the program and stopping it are not. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"availability":{"anyOf":[{"enum":["loyaltyDisabled","featureRestrictedByPlan","featureNotEntitled","billingReadOnly","subscriptionEnded"],"type":"string"},{"type":"null"}]}},"required":["availability"]}}}}}}},"/api/public/v1/loyalty/launchProgram":{"post":{"operationId":"loyalty.launchProgram","description":"Launches the organization's loyalty program as live with the given settings, its tiers included; without `tiers` it starts with none. Queues no re-placement, since the program has no members yet. Refused with CONFLICT when it was already launched, with FORBIDDEN and refusal `loyaltyTiersDisabled` when it sets tiers outside the loyalty tiers pilot, with BAD_REQUEST and refusal `cashbackAboveTier` when tiers are on and the cashback is above the first tier's, with BAD_REQUEST and refusal `birthdayNeedsDateOfBirth` when the birthday bonus is on while `signupFields.dateOfBirth` is `off`, with BAD_REQUEST when the settings are otherwise invalid, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"settings":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000,"default":500},"expiryDays":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":365},"welcome":{"type":"object","properties":{"enabled":{"type":"boolean","default":true},"points":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0,"default":1000},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"minRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},"default":{}},"maxRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"percent":{"type":"integer","minimum":1,"maximum":100,"default":100}},"default":{}},"birthday":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"happyHours":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"weekdays":{"type":"array","items":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"default":[]},"from":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"15:00"},"to":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"18:00"},"multiplierBasisPoints":{"type":"integer","minimum":10001,"maximum":100000,"default":15000}},"default":{}},"policy":{"type":"object","properties":{"privacy":{"type":"string","maxLength":20000,"default":""},"terms":{"type":"string","maxLength":20000,"default":""}},"default":{}},"tiers":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"ladder":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":40},"thresholdCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000}},"required":["id","name","thresholdCents","cashbackBasisPoints"]},"default":[]}}},"signupFields":{"type":"object","properties":{"name":{"enum":["off","optional","required"],"type":"string","default":"optional"},"email":{"enum":["off","optional","required"],"type":"string","default":"optional"},"dateOfBirth":{"enum":["off","optional","required"],"type":"string","default":"optional"}},"default":{}}}}},"required":["organizationId","settings"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":["draft","live","stopped"],"type":"string"},"settings":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000,"default":500},"expiryDays":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":365},"welcome":{"type":"object","properties":{"enabled":{"type":"boolean","default":true},"points":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0,"default":1000},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"minRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},"default":{}},"maxRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"percent":{"type":"integer","minimum":1,"maximum":100,"default":100}},"default":{}},"birthday":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"happyHours":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"weekdays":{"type":"array","items":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"default":[]},"from":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"15:00"},"to":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"18:00"},"multiplierBasisPoints":{"type":"integer","minimum":10001,"maximum":100000,"default":15000}},"default":{}},"policy":{"type":"object","properties":{"privacy":{"type":"string","maxLength":20000,"default":""},"terms":{"type":"string","maxLength":20000,"default":""}},"default":{}},"tiers":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"ladder":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":40},"thresholdCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000}},"required":["id","name","thresholdCents","cashbackBasisPoints"]},"default":[]}},"default":{}},"signupFields":{"type":"object","properties":{"name":{"enum":["off","optional","required"],"type":"string","default":"optional"},"email":{"enum":["off","optional","required"],"type":"string","default":"optional"},"dateOfBirth":{"enum":["off","optional","required"],"type":"string","default":"optional"}},"default":{}}}}},"required":["status","settings"]}}}}}}},"/api/public/v1/loyalty/updateSettings":{"post":{"operationId":"loyalty.updateSettings","description":"Replaces the settings of the organization's launched loyalty program, its tiers included, in one write; without `tiers` it keeps the stored ones. A save that changes the tiers, or finds a failed re-placement, deletes the failed re-placements and queues the re-placement of the members by the saved ladder unless tiers were off and stay off with no failed one to retry. Refused with NOT_FOUND before the first launch, with FORBIDDEN and refusal `loyaltyTiersDisabled` when it changes the tiers outside the loyalty tiers pilot, with BAD_REQUEST and refusal `cashbackAboveTier` when tiers are on and the cashback is above the first tier's, with BAD_REQUEST and refusal `birthdayNeedsDateOfBirth` when the birthday bonus is on while `signupFields.dateOfBirth` is `off`, with BAD_REQUEST when the settings are otherwise invalid, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"settings":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000,"default":500},"expiryDays":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":365},"welcome":{"type":"object","properties":{"enabled":{"type":"boolean","default":true},"points":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0,"default":1000},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"minRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},"default":{}},"maxRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"percent":{"type":"integer","minimum":1,"maximum":100,"default":100}},"default":{}},"birthday":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"happyHours":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"weekdays":{"type":"array","items":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"default":[]},"from":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"15:00"},"to":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"18:00"},"multiplierBasisPoints":{"type":"integer","minimum":10001,"maximum":100000,"default":15000}},"default":{}},"policy":{"type":"object","properties":{"privacy":{"type":"string","maxLength":20000,"default":""},"terms":{"type":"string","maxLength":20000,"default":""}},"default":{}},"tiers":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"ladder":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":40},"thresholdCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000}},"required":["id","name","thresholdCents","cashbackBasisPoints"]},"default":[]}}},"signupFields":{"type":"object","properties":{"name":{"enum":["off","optional","required"],"type":"string","default":"optional"},"email":{"enum":["off","optional","required"],"type":"string","default":"optional"},"dateOfBirth":{"enum":["off","optional","required"],"type":"string","default":"optional"}},"default":{}}}}},"required":["organizationId","settings"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":["draft","live","stopped"],"type":"string"},"settings":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000,"default":500},"expiryDays":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":365},"welcome":{"type":"object","properties":{"enabled":{"type":"boolean","default":true},"points":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0,"default":1000},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"minRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},"default":{}},"maxRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"percent":{"type":"integer","minimum":1,"maximum":100,"default":100}},"default":{}},"birthday":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"happyHours":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"weekdays":{"type":"array","items":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"default":[]},"from":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"15:00"},"to":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"18:00"},"multiplierBasisPoints":{"type":"integer","minimum":10001,"maximum":100000,"default":15000}},"default":{}},"policy":{"type":"object","properties":{"privacy":{"type":"string","maxLength":20000,"default":""},"terms":{"type":"string","maxLength":20000,"default":""}},"default":{}},"tiers":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"ladder":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":40},"thresholdCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000}},"required":["id","name","thresholdCents","cashbackBasisPoints"]},"default":[]}},"default":{}},"signupFields":{"type":"object","properties":{"name":{"enum":["off","optional","required"],"type":"string","default":"optional"},"email":{"enum":["off","optional","required"],"type":"string","default":"optional"},"dateOfBirth":{"enum":["off","optional","required"],"type":"string","default":"optional"}},"default":{}}}}},"required":["status","settings"]}}}}}}},"/api/public/v1/loyalty/updateTiers":{"post":{"operationId":"loyalty.updateTiers","summary":"Legacy tier ladder save; send tiers to loyalty.updateSettings instead.","description":"Replaces the tier ladder of the organization's launched loyalty program and whether tiers apply, keeping its other settings, through the same save as `updateSettings`. Refused with NOT_FOUND before the first launch, with FORBIDDEN and refusal `loyaltyTiersDisabled` when it changes the tiers outside the loyalty tiers pilot, with BAD_REQUEST and refusal `cashbackAboveTier` when tiers are on and the stored cashback is above the first tier's, with BAD_REQUEST when the ladder is otherwise invalid, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"tiers":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"ladder":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":40},"thresholdCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000}},"required":["id","name","thresholdCents","cashbackBasisPoints"]},"default":[]}},"default":{}}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":["draft","live","stopped"],"type":"string"},"settings":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000,"default":500},"expiryDays":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":365},"welcome":{"type":"object","properties":{"enabled":{"type":"boolean","default":true},"points":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0,"default":1000},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"minRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},"default":{}},"maxRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"percent":{"type":"integer","minimum":1,"maximum":100,"default":100}},"default":{}},"birthday":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"happyHours":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"weekdays":{"type":"array","items":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"default":[]},"from":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"15:00"},"to":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"18:00"},"multiplierBasisPoints":{"type":"integer","minimum":10001,"maximum":100000,"default":15000}},"default":{}},"policy":{"type":"object","properties":{"privacy":{"type":"string","maxLength":20000,"default":""},"terms":{"type":"string","maxLength":20000,"default":""}},"default":{}},"tiers":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"ladder":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":40},"thresholdCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000}},"required":["id","name","thresholdCents","cashbackBasisPoints"]},"default":[]}},"default":{}},"signupFields":{"type":"object","properties":{"name":{"enum":["off","optional","required"],"type":"string","default":"optional"},"email":{"enum":["off","optional","required"],"type":"string","default":"optional"},"dateOfBirth":{"enum":["off","optional","required"],"type":"string","default":"optional"}},"default":{}}}}},"required":["status","settings"]}}}}}}},"/api/public/v1/loyalty/tierCounts":{"post":{"operationId":"loyalty.tierCounts","description":"Returns how many members of the organization's loyalty program sit on the base and on each tier id, leaving out archived customers. Readable whatever the plan and the tiers pilot. A tier just removed from the ladder may still be counted until the re-placement queued by its save moves its members. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"base":{"type":"integer","minimum":0,"maximum":9007199254740991},"tiers":{"type":"array","items":{"type":"object","properties":{"tierId":{"type":"string"},"members":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["tierId","members"]}}},"required":["base","tiers"]}}}}}}},"/api/public/v1/loyalty/tierPlacement":{"post":{"operationId":"loyalty.tierPlacement","description":"Returns where the re-placement queued by the organization's last ladder saves stands: `running` with the percent of all its members, archived included, the slowest chain has read, held below 100 until it ends; `failed` when a page exhausted its attempts and none runs since, retried by saving the tiers again; `idle` otherwise. Readable whatever the plan and the tiers pilot. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"idle"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"running"},"percent":{"type":"integer","minimum":0,"maximum":99}},"required":["status","percent"]},{"type":"object","properties":{"status":{"const":"failed"}},"required":["status"]}]}}}}}}},"/api/public/v1/loyalty/getWalletDesign":{"post":{"operationId":"loyalty.getWalletDesign","description":"Returns the Wallet card design overrides of the organization's launched loyalty program, null colors meaning inherited, and the effective design they resolve to over the organization's name and logo and the Wallet defaults. Readable whatever the plan. Refused with NOT_FOUND before the first launch. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"design":{},"effective":{"type":"object","properties":{"organizationName":{"type":"string"},"organizationLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"appleIconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"centralImageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"colors":{"type":"object","properties":{"background":{"type":"string"},"foreground":{"type":"string"},"accent":{"type":"string"}},"required":["background","foreground","accent"]},"pointsLabel":{"type":"string"},"slots":{"type":"object","properties":{"header":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"points"},"field1":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"memberName"},"field2":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"tier"}},"additionalProperties":false},"fields":{"type":"object","properties":{"memberName":{"type":"boolean","default":true},"cashback":{"type":"boolean","default":true}},"additionalProperties":false},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"links":{"type":"array","maxItems":3,"items":{"anyOf":[{},{"type":"null"}]},"default":[]}},"required":["organizationName","organizationLogoUrl","logoUrl","appleIconUrl","centralImageUrl","colors","pointsLabel","slots","fields","description"]}},"required":["effective"]}}}}}}},"/api/public/v1/loyalty/previewWalletDesign":{"post":{"operationId":"loyalty.previewWalletDesign","description":"Returns what `getWalletDesign` returns, and before the first launch no overrides over the organization's name and logo, so a Wallet card can be previewed before the program exists. Readable whatever the plan. Saving a design still needs a launched program. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"design":{},"effective":{"type":"object","properties":{"organizationName":{"type":"string"},"organizationLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"appleIconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"centralImageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"colors":{"type":"object","properties":{"background":{"type":"string"},"foreground":{"type":"string"},"accent":{"type":"string"}},"required":["background","foreground","accent"]},"pointsLabel":{"type":"string"},"slots":{"type":"object","properties":{"header":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"points"},"field1":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"memberName"},"field2":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"tier"}},"additionalProperties":false},"fields":{"type":"object","properties":{"memberName":{"type":"boolean","default":true},"cashback":{"type":"boolean","default":true}},"additionalProperties":false},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"links":{"type":"array","maxItems":3,"items":{"anyOf":[{},{"type":"null"}]},"default":[]}},"required":["organizationName","organizationLogoUrl","logoUrl","appleIconUrl","centralImageUrl","colors","pointsLabel","slots","fields","description"]}},"required":["effective"]}}}}}}},"/api/public/v1/loyalty/updateWalletDesign":{"post":{"operationId":"loyalty.updateWalletDesign","description":"Replaces the Wallet card design overrides of the organization's launched loyalty program, or clears them back to inheriting every default with `design: null`. A client editing `slots` leaves the deprecated `fields` out; `fields` that equal the stored design's are read as a copy and never undo a `slots` edit, and BAD_REQUEST refuses a `fields` toggle turned on with no empty slot. An editor sends the design it edited from as `baseline`: the save is then refused with CONFLICT and refusal `walletDesignChanged` when the stored design no longer equals it, a cleared design reading as its defaults, and stores nothing. Without `baseline` the save overwrites as before. The draft images the design names are adopted with the save; a design naming one of another organization, or one being or already deleted, is refused with CONFLICT and refusal `mediaDraftImageExpired`, and that image must be uploaded again. Each image in `images` the stored design does not already name must also be a Wallet design draft image this organization uploaded through `mediaDrafts.control`: a URL no upload recorded is refused the same way, so a save never publishes an arbitrary URL as an override. Leaves the program's settings untouched, issues and updates no pass. Refused with NOT_FOUND before the first launch, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"design":{"anyOf":[{"type":"object","properties":{"colors":{"type":"object","properties":{"background":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"foreground":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"accent":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"additionalProperties":false,"default":{}},"pointsLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":20},{"type":"null"}],"default":null},"slots":{"type":"object","properties":{"header":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"points"},"field1":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"memberName"},"field2":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"tier"}},"additionalProperties":false},"fields":{"type":"object","properties":{"memberName":{"type":"boolean","default":true},"cashback":{"type":"boolean","default":true}},"additionalProperties":false},"description":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"default":null},"links":{"type":"array","maxItems":3,"items":{"type":"object","properties":{"kind":{"anyOf":[{"enum":["instagram","googleReviews","custom"],"type":"string"},{"type":"null"}],"default":null},"label":{"anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}],"default":null},"url":{"type":"string","maxLength":2048}},"required":["url"],"additionalProperties":false},"default":[]},"images":{"type":"object","properties":{"logoUrl":{"anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"default":null},"appleIconUrl":{"anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"default":null},"centralImageUrl":{"anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"default":null}},"additionalProperties":false,"default":{}}},"additionalProperties":false},{"type":"null"}]},"baseline":{"type":"object","properties":{"colors":{"type":"object","properties":{"background":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"foreground":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"accent":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"additionalProperties":false,"default":{}},"pointsLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":20},{"type":"null"}],"default":null},"slots":{"type":"object","properties":{"header":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"points"},"field1":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"memberName"},"field2":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"tier"}},"additionalProperties":false},"fields":{"type":"object","properties":{"memberName":{"type":"boolean","default":true},"cashback":{"type":"boolean","default":true}},"additionalProperties":false},"description":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"default":null},"links":{"type":"array","maxItems":3,"items":{"type":"object","properties":{"kind":{"anyOf":[{"enum":["instagram","googleReviews","custom"],"type":"string"},{"type":"null"}],"default":null},"label":{"anyOf":[{"type":"string","minLength":1,"maxLength":40},{"type":"null"}],"default":null},"url":{"type":"string","maxLength":2048}},"required":["url"],"additionalProperties":false},"default":[]},"images":{"type":"object","properties":{"logoUrl":{"anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"default":null},"appleIconUrl":{"anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"default":null},"centralImageUrl":{"anyOf":[{"type":"string","maxLength":4096},{"type":"null"}],"default":null}},"additionalProperties":false,"default":{}}},"additionalProperties":false}},"required":["organizationId","design"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"design":{},"effective":{"type":"object","properties":{"organizationName":{"type":"string"},"organizationLogoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"appleIconUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"centralImageUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"colors":{"type":"object","properties":{"background":{"type":"string"},"foreground":{"type":"string"},"accent":{"type":"string"}},"required":["background","foreground","accent"]},"pointsLabel":{"type":"string"},"slots":{"type":"object","properties":{"header":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"points"},"field1":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"memberName"},"field2":{"enum":["points","memberName","tier","cashback","pointsExpiry","memberSince","none"],"type":"string","default":"tier"}},"additionalProperties":false},"fields":{"type":"object","properties":{"memberName":{"type":"boolean","default":true},"cashback":{"type":"boolean","default":true}},"additionalProperties":false},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"links":{"type":"array","maxItems":3,"items":{"anyOf":[{},{"type":"null"}]},"default":[]}},"required":["organizationName","organizationLogoUrl","logoUrl","appleIconUrl","centralImageUrl","colors","pointsLabel","slots","fields","description"]}},"required":["effective"]}}}}}}},"/api/public/v1/loyalty/issueTestGoogleWalletPass":{"post":{"operationId":"loyalty.issueTestGoogleWalletPass","summary":"Issue a test Google Wallet pass (platform admins, test organizations in production)","description":"Issues, or issues again, a real Google Wallet loyalty pass for one member of the organization's program with its brand's issuer, and returns its signed Save to Google Wallet link. Internal test tooling: only platform administrators may call it, and in production only for a classified test organization. Refused with FORBIDDEN in production for an organization that is not a test organization and while the `loyalty-wallet` flag does not admit the organization, and with PRECONDITION_FAILED when the brand has no Google Wallet issuer key, the program is missing or not live, or the design has no https logo. The class goes through the Wallet class image gate first, so CONFLICT refuses it while an earlier request for the class may still reach Google or when it would show an image the organization no longer holds. The class and object ids are stable per environment, organization and member, so a retry reaches the same pass and updates its points. NOT_FOUND refuses a customer who is not an active member of this organization; BAD_GATEWAY reports a Google error by the call that failed. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"customerId":{"type":"string","minLength":1}},"required":["organizationId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"classId":{"type":"string"},"objectId":{"type":"string"},"classState":{"enum":["pending","confirmed","unknown","stale"],"type":"string"},"saveUrl":{"type":"string","format":"uri"}},"required":["classId","objectId","classState","saveUrl"]}}}}}}},"/api/public/v1/loyalty/setStatus":{"post":{"operationId":"loyalty.setStatus","description":"Runs (`live`) or stops (`stopped`) the organization's launched loyalty program. Refused with NOT_FOUND before the first launch. Running it is refused with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty; stopping it never is. Running it is also a new commitment, while stopping it never is refused for billing: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"status":{"enum":["live","stopped"],"type":"string"}},"required":["organizationId","status"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":["draft","live","stopped"],"type":"string"},"settings":{"type":"object","properties":{"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000,"default":500},"expiryDays":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":365},"welcome":{"type":"object","properties":{"enabled":{"type":"boolean","default":true},"points":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0,"default":1000},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"minRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0}},"default":{}},"maxRedemption":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"percent":{"type":"integer","minimum":1,"maximum":100,"default":100}},"default":{}},"birthday":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"points":{"type":"integer","minimum":0,"maximum":2147483647,"default":0},"days":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0,"default":30}},"default":{}},"happyHours":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"weekdays":{"type":"array","items":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"default":[]},"from":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"15:00"},"to":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","default":"18:00"},"multiplierBasisPoints":{"type":"integer","minimum":10001,"maximum":100000,"default":15000}},"default":{}},"policy":{"type":"object","properties":{"privacy":{"type":"string","maxLength":20000,"default":""},"terms":{"type":"string","maxLength":20000,"default":""}},"default":{}},"tiers":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"ladder":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":40},"thresholdCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"cashbackBasisPoints":{"type":"integer","minimum":1,"maximum":10000}},"required":["id","name","thresholdCents","cashbackBasisPoints"]},"default":[]}},"default":{}},"signupFields":{"type":"object","properties":{"name":{"enum":["off","optional","required"],"type":"string","default":"optional"},"email":{"enum":["off","optional","required"],"type":"string","default":"optional"},"dateOfBirth":{"enum":["off","optional","required"],"type":"string","default":"optional"}},"default":{}}}}},"required":["status","settings"]}}}}}}},"/api/public/v1/loyalty/signupKit":{"post":{"operationId":"loyalty.signupKit","description":"Returns the public sign-up link of the organization's launched loyalty program, creating the code on the first read. `isEnabled` is always true and deprecated, kept one release for stale callers. Refused with NOT_FOUND before the first launch, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty. A sign-up kit is new Loyalty work: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"url":{"type":"string"},"isEnabled":{"const":true}},"required":["code","url","isEnabled"]}}}}}}},"/api/public/v1/loyalty/signupLink":{"post":{"operationId":"loyalty.signupLink","summary":"Legacy sign-up link; read loyalty.signupKit instead.","description":"Returns the public sign-up link of the organization's launched loyalty program, creating its code on the first read. Refused with NOT_FOUND before the first launch, and with FORBIDDEN and refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty. A sign-up kit is new Loyalty work: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"url":{"type":"string"}},"required":["code","url"]}}}}}}},"/api/public/v1/loyaltySignup/page":{"post":{"operationId":"loyaltySignup.page","description":"Reads the loyalty sign-up page a join code opens: the business and its brand, the program's rule line, the phone field's country, the policy texts, the captcha site key, whether the join asks for a WhatsApp code to the number (`verifiesPhone`) and whether the name, email and date of birth are `off`, `optional` or `required` (`signupFields`), or `closed` while the program is stopped, the merchant unpaid, the plan lacking Loyalty while Loyalty is enforced, or the region unset. NOT_FOUND for an unknown code or while sign-up is switched off.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":32}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"open"},"businessName":{"type":"string"},"brandId":{"type":"string"},"cashbackBasisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"welcomeHundredths":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"phoneCountry":{"anyOf":[{"not":{}},{"type":"null"}]},"privacy":{"type":"string"},"terms":{"type":"string"},"captchaSiteKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"verifiesPhone":{"type":"boolean"},"signupFields":{"type":"object","properties":{"name":{"enum":["off","optional","required"],"type":"string"},"email":{"enum":["off","optional","required"],"type":"string"},"dateOfBirth":{"enum":["off","optional","required"],"type":"string"}},"required":["name","email","dateOfBirth"]}},"required":["status","businessName","brandId","cashbackBasisPoints","welcomeHundredths","phoneCountry","privacy","terms","captchaSiteKey","verifiesPhone","signupFields"]},{"type":"object","properties":{"status":{"const":"closed"},"businessName":{"type":"string"},"brandId":{"type":"string"}},"required":["status","businessName","brandId"]}]}}}}}}},"/api/public/v1/loyaltySignup/sendCode":{"post":{"operationId":"loyaltySignup.sendCode","description":"Sends the WhatsApp code that proves a guest holds the number they typed on the sign-up page a join code opens. Answers `sent`, `cooldown` with `retryAfterSeconds` while the last code is too fresh, or `unavailable` when the page does not verify the phone or no code can be sent. Refused with FORBIDDEN and refusal `signupClosed` while the page is closed, `captcha` for a failed check, UNPROCESSABLE_CONTENT for an unreadable number and TOO_MANY_REQUESTS past the per-number budget.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":32},"phone":{"type":"string","minLength":1,"maxLength":40},"captchaToken":{"type":"string","maxLength":2048}},"required":["code","phone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"sent"}},"required":["status"]},{"type":"object","properties":{"status":{"const":"cooldown"},"retryAfterSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["status","retryAfterSeconds"]},{"type":"object","properties":{"status":{"const":"unavailable"}},"required":["status"]}]}}}}}}},"/api/public/v1/loyaltySignup/join":{"post":{"operationId":"loyaltySignup.join","description":"Joins a guest to the program a join code opens, creating the customer for a new number. Without `phoneCode` an existing customer is never changed and the answer is `joined` whether the number was new, a customer or already a member. With the code `sendCode` sent, on a page that `verifiesPhone`, no captcha is asked for, an existing customer's empty name, email and date of birth take the guest's, and `joined` carries the member's `balanceHundredths`. A name, email or date of birth the program's `signupFields` turns `off` is ignored and never stored. Refused with UNPROCESSABLE_CONTENT and refusal `nameRequired`, `emailRequired` or `dateOfBirthRequired` when the program requires that field and the join leaves it out, checked before the captcha and the code, with FORBIDDEN and refusal `signupClosed` while the page is closed, `captcha` for a failed check, `phoneCodeUnavailable` for a code on a page that does not verify the phone, `phoneCodeWrong` or `phoneCodeExpired` for a code that does not prove the number, UNPROCESSABLE_CONTENT for an unreadable number and TOO_MANY_REQUESTS past the per-number budget.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":32},"phone":{"type":"string","minLength":1,"maxLength":40},"name":{"type":"string","minLength":1,"maxLength":120},"email":{"type":"string","maxLength":254,"format":"email"},"dateOfBirth":{"type":"string","format":"date"},"captchaToken":{"type":"string","maxLength":2048},"phoneCode":{"type":"string","pattern":"^\\d{4}$"}},"required":["code","phone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"const":"joined"},"balanceHundredths":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["status"]}}}}}}},"/api/public/v1/passes/figures":{"post":{"operationId":"passes.figures","summary":"Read the organization's pass figures","description":"On the calendar of timeZone: for each pass with any, the sales and renewals made this month (soldThisMonthCount) and what they took in minor currency units (soldThisMonthCents), counting voided passes, and the passes held active today (activeCount: status active, an end day not passed, a customer not archived), which is also how many guests hold it; and activeHolders, the guests holding any pass active. Refused with FORBIDDEN as `passesDisabled` while the passes flag is off for the organization. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"timeZone":{"type":"string"}},"required":["organizationId","timeZone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"activeHolders":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"passes":{"type":"array","items":{"type":"object","properties":{"passId":{"type":"string"},"soldThisMonthCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"soldThisMonthCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"activeCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"redeemedTodayCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"usedThisPeriodCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowanceThisPeriodCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["passId","soldThisMonthCount","soldThisMonthCents","activeCount","redeemedTodayCount","usedThisPeriodCount","allowanceThisPeriodCount"]}}},"required":["activeHolders","passes"]}}}}}}},"/api/public/v1/passes/voidSoldPass":{"post":{"operationId":"passes.voidSoldPass","summary":"Void a guest's pass","description":"Voids a pass a guest bought: its status becomes voided, with the reason, the caller and the time recorded. No money moves. A pass already voided is refused with CONFLICT as `soldPassAlreadyVoided`; an unknown one is NOT_FOUND. Refused with FORBIDDEN as `passesDisabled` while the passes flag is off for the organization. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"soldPassId":{"type":"string","minLength":1},"reason":{"enum":["refundWithin14Days","soldByMistake","customerRequest","misuse"],"type":"string"}},"required":["soldPassId","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/api/public/v1/passes/list":{"post":{"operationId":"passes.list","summary":"List the organization's passes","description":"The organization's live passes, newest first, or with includeArchived the archived ones too, each marked by isArchived: each pass item's id, name, category and price in minor currency units, its validity in days, its allowance of allowanceCount uses per allowancePeriod (day, week or month), and the catalog items it covers. Refused with FORBIDDEN as `passesDisabled` while the passes flag is off for the organization. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"includeArchived":{"type":"boolean","default":false}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"isArchived":{"type":"boolean"},"name":{"type":"string"},"categoryId":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"validityDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowanceCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"allowancePeriod":{"enum":["day","week","month"],"type":"string"},"includedItemIds":{"type":"array","items":{"type":"string"}}},"required":["id","isArchived","name","categoryId","priceCents","validityDays","allowanceCount","allowancePeriod","includedItemIds"]}}}}}}}},"/api/public/v1/passes/create":{"post":{"operationId":"passes.create","summary":"Create a pass","description":"Creates a pass: a live catalog item of kind pass with its single price row at priceCents (minor currency units), its terms (validityDays, and allowanceCount uses per allowancePeriod) and the catalog items it covers, in one write. Omit categoryId for a root item. Refused with CONFLICT (refusal nameTaken) when a live item in the same category already has this name, compared case-insensitively after trimming whitespace. The refusal names that row as existingId. A destination folder that was deleted is refused with BAD_REQUEST and refusal `categoryArchived`, and nothing is stored. includedItemIds naming an item that is archived, outside the organization's catalog or itself a pass is refused with BAD_REQUEST as `passItemNotIncludable`, and nothing is stored. Refused with FORBIDDEN as `passesDisabled` while the passes flag is off for the organization. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":120},"categoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"priceCents":{"type":"integer","minimum":1,"maximum":2147483647},"validityDays":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0},"allowanceCount":{"type":"integer","minimum":-9007199254740991,"maximum":1000,"exclusiveMinimum":0},"allowancePeriod":{"enum":["day","week","month"],"type":"string"},"includedItemIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}}},"required":["organizationId","name","priceCents","validityDays","allowanceCount","allowancePeriod","includedItemIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/api/public/v1/passes/update":{"post":{"operationId":"passes.update","summary":"Edit a pass","description":"Updates only the supplied name, categoryId, price (priceCents, minor currency units) and terms of a pass. Supplied includedItemIds replace the items it covers. The edit applies to sales made after it. A categoryId outside the organization is refused with BAD_REQUEST. Refused with CONFLICT (refusal nameTaken) when a live item in the same category already has this name, compared case-insensitively after trimming whitespace. A destination folder that was deleted is refused with BAD_REQUEST and refusal `categoryArchived`, and nothing is stored. includedItemIds naming an item that is archived, outside the organization's catalog or itself a pass is refused with BAD_REQUEST as `passItemNotIncludable`, and nothing is stored. Refused with FORBIDDEN as `passesDisabled` while the passes flag is off for the organization. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"categoryId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"priceCents":{"type":"integer","minimum":1,"maximum":2147483647},"validityDays":{"type":"integer","minimum":-9007199254740991,"maximum":3650,"exclusiveMinimum":0},"allowanceCount":{"type":"integer","minimum":-9007199254740991,"maximum":1000,"exclusiveMinimum":0},"allowancePeriod":{"enum":["day","week","month"],"type":"string"},"includedItemIds":{"type":"array","maxItems":500,"items":{"type":"string","minLength":1}}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/api/public/v1/passes/archive":{"post":{"operationId":"passes.archive","summary":"Archive a pass","description":"Archives the pass and its catalog item across the organization. passes.restore restores both. Sales already made are kept. Refused with FORBIDDEN as `passesDisabled` while the passes flag is off for the organization. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/api/public/v1/passes/restore":{"post":{"operationId":"passes.restore","summary":"Restore a pass","description":"Restores an archived pass and its catalog item, so it is sold again with the terms it had. Restoring a live pass changes nothing. Refused with FORBIDDEN as `passesDisabled` while the passes flag is off for the organization. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/api/public/v1/purchase/claim":{"post":{"operationId":"purchase.claim","description":"Answers the carried-selection card: `continue` binds the anonymous selection the signed cookie names to the caller at the `choiceRevision` shown, `discard` deletes it. Answers `bound`, `alreadyBound`, `changed` (the selection moved; nothing bound, cookie kept), `discarded` or `none`, the last disclosing nothing about anyone else's purchase. Merely signing in never binds, and `continue` never supersedes the caller's own purchase frozen for Checkout: it answers `none` and clears the cookie. Binding a Sandbox selection is refused with FORBIDDEN `sandboxNotAllowed` unless the caller is a verified Fortune OS employee holding the `billing-sandbox` arm.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"enum":["continue","discard"],"type":"string"},"choiceRevision":{"type":"integer","minimum":1,"maximum":9007199254740991},"dropPromo":{"type":"boolean","default":false}},"required":["decision","choiceRevision"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"outcome":{"enum":["bound","alreadyBound","changed","discarded","none"],"type":"string"}},"required":["outcome"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/resume":{"post":{"operationId":"purchase.resume","description":"Reads where the caller's purchase stands: the next step, derived from current Memberships, region, intent, subscription and Checkout facts, the unbound selection the cookie names, if any, unless the caller's own Checkout is open, unpaid, being settled or just completed, and whether a business the caller may buy for has a live venue (`hasOperationalBusiness`). Writes nothing, extends no expiry, sets no cookie and returns no Checkout URL or Price id. `returnedSessionId` is display-only.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"returnedSessionId":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"enum":["active","recovery"],"type":"string"},"intentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"selectionVersion":{"anyOf":[{"type":"number"},{"type":"null"}]},"candidates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","region"],"additionalProperties":false}},"hasOperationalBusiness":{"type":"boolean"},"claimable":{"anyOf":[{"type":"object","properties":{"choiceRevision":{"type":"number"},"quote":{"type":"object","properties":{"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"number"},"currency":{"type":"string"},"trialPeriodDays":{"type":"number"},"totalAmount":{"type":"number"},"amountDueToday":{"type":"number"},"discountPercentOff":{"anyOf":[{"type":"number"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","properties":{"kind":{"enum":["base","addon"],"type":"string"},"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"number"},"quantity":{"type":"number"},"unitAmount":{"type":"number"}},"required":["kind","code","interval","intervalCount","quantity","unitAmount"],"additionalProperties":false}},"quoteId":{"type":"string"}},"required":["planCode","interval","intervalCount","currency","trialPeriodDays","totalAmount","amountDueToday","discountPercentOff","items","quoteId"],"additionalProperties":false},"promoCode":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["choiceRevision","quote","promoCode"],"additionalProperties":false},{"type":"null"}]},"emailVerification":{"anyOf":[{"type":"object","properties":{"returnTo":{"type":"string"}},"required":["returnTo"],"additionalProperties":false},{"type":"null"}]},"step":{"anyOf":[{"type":"object","properties":{"step":{"const":"noIntent"},"businesses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","region"],"additionalProperties":false}},"suggestedInterval":{"anyOf":[{"type":"object","properties":{"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"number"}},"required":["interval","intervalCount"],"additionalProperties":false},{"type":"null"}]}},"required":["step","businesses","suggestedInterval"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"chooseOrganization"},"candidates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","region"],"additionalProperties":false}},"selectionVersion":{"type":"number"}},"required":["step","candidates","selectionVersion"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"createOrganization"},"selectionVersion":{"type":"number"}},"required":["step","selectionVersion"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"noAccess"}},"required":["step"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"organizationUnavailable"}},"required":["step"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"confirmOrganization"},"organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","region"],"additionalProperties":false}},"required":["step","organization"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"confirmBusinessRegion"},"organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","region"],"additionalProperties":false},"regions":{"type":"array","items":{"type":"string"}},"current":{"anyOf":[{"type":"string"},{"type":"null"}]},"countryChanged":{"type":"boolean"},"checkoutOpen":{"type":"boolean"}},"required":["step","organization","regions","current","countryChanged","checkoutOpen"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"review"},"organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","region"],"additionalProperties":false},"choiceRevision":{"type":"number"},"baseQuantity":{"type":"number"},"quote":{"anyOf":[{"type":"object","properties":{"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"number"},"currency":{"type":"string"},"trialPeriodDays":{"type":"number"},"totalAmount":{"type":"number"},"amountDueToday":{"type":"number"},"discountPercentOff":{"anyOf":[{"type":"number"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","properties":{"kind":{"enum":["base","addon"],"type":"string"},"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"number"},"quantity":{"type":"number"},"unitAmount":{"type":"number"}},"required":["kind","code","interval","intervalCount","quantity","unitAmount"],"additionalProperties":false}},"quoteId":{"type":"string"}},"required":["planCode","interval","intervalCount","currency","trialPeriodDays","totalAmount","amountDueToday","discountPercentOff","items","quoteId"],"additionalProperties":false},{"type":"null"}]},"changed":{"type":"boolean"},"mustChoosePlan":{"type":"boolean"},"checkoutOpen":{"type":"boolean"},"checkoutStatus":{"enum":["none","open","checking","paymentNotCompleted"],"type":"string"},"checking":{"anyOf":[{"type":"object","properties":{"reason":{"type":"string"},"since":{"type":"string"},"nextCheckAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"reference":{"type":"string"}},"required":["reason","since","nextCheckAt","reference"],"additionalProperties":false},{"type":"null"}]},"sandbox":{"anyOf":[{"anyOf":[{"type":"object","properties":{"checkout":{"const":"available"}},"required":["checkout"],"additionalProperties":false},{"type":"object","properties":{"checkout":{"const":"unavailable"}},"required":["checkout"],"additionalProperties":false},{"type":"object","properties":{"checkout":{"const":"awaitingEligibility"},"organizationSlug":{"type":"string"}},"required":["checkout","organizationSlug"],"additionalProperties":false}]},{"type":"null"}]}},"required":["step","organization","choiceRevision","baseQuantity","quote","changed","mustChoosePlan","checkoutOpen","checkoutStatus","checking","sandbox"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"confirming"},"organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","region"],"additionalProperties":false}},"required":["step","organization"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"alreadySubscribed"},"organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","region"],"additionalProperties":false}},"required":["step","organization"],"additionalProperties":false},{"type":"object","properties":{"step":{"const":"completed"},"organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"region":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","region"],"additionalProperties":false},"onboardingTarget":{"type":"string"},"intentId":{"type":"string"}},"required":["step","organization","onboardingTarget","intentId"],"additionalProperties":false}]}},"required":["mode","intentId","selectionVersion","candidates","hasOperationalBusiness","claimable","emailVerification","step"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/startFromPricing":{"post":{"operationId":"purchase.startFromPricing","description":"Deprecated: kept one release for stale bundles and API/MCP callers; no screen calls it. Saves a plan choice for the caller's current business on the caller's live purchase and selects that business, answering the `choiceRevision` the review continues from; the buyer then reviews the business's own terms and consents before any Checkout. A fresh choice: it replaces the plan of a purchase already under way and keeps its confirmations when they name this business. A purchase frozen for an unpaid Checkout has its sessions closed in Stripe first, and is refused `checkoutCheckFailed` when Stripe cannot confirm one closed, `checkoutAlreadyPaid` for one the business's standing subscription paid, leaving the Checkout as it was. Refused with FORBIDDEN as `pricingPreviewDisabled` while the `pricing-preview` flag is off, and when the caller may not manage the business's billing; with PRECONDITION_FAILED as `organizationNotEligible`, `subscriptionExists` or `previousPaymentPending` when the business already holds a subscription, `offerChanged` unless `quoteId` still signs to the business's own offer, `checkoutInProgress` while a Checkout attempt is reserved or unknown, `checkoutPaymentPending` while a paid session is still being settled, `selectionChanged` when another edit won, and the Billing and Sandbox refusals of a selection the offer rejects. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"integer","minimum":1,"maximum":3,"default":1},"addons":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"quantity":{"type":"integer","minimum":1,"maximum":100,"default":1}},"required":["code"],"additionalProperties":false},"default":[]},"quoteId":{"type":"string","minLength":1,"maxLength":128},"startKey":{"type":"string","format":"uuid"}},"required":["organizationId","interval","quoteId","startKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"choiceRevision":{"type":"number"}},"required":["choiceRevision"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/changePlan":{"post":{"operationId":"purchase.changePlan","description":"Saves the review's plan choice on the caller's live purchase `intentId` for the business it holds and has confirmed with its country, answering the `choiceRevision` the review continues from; the review then shows that business's own terms for the buyer to accept again before any Checkout. It is `startFromPricing`'s fresh choice: the same choice changes nothing and the confirmations stand. A purchase frozen for an unpaid Checkout has its sessions closed in Stripe first, and is refused `checkoutCheckFailed` when Stripe cannot confirm one closed, `checkoutAlreadyPaid` for one the business's standing subscription paid, leaving the Checkout as it was. Refused with FORBIDDEN as `publicPricingDisabled` while neither `public-pricing` nor `pricing-preview` is on, and when the caller may not manage the business's billing; with PRECONDITION_FAILED as `selectionChanged` unless `intentId` holds that business with both confirmations and the business is still in the confirmed country, or when another edit won, as `businessRegionNotSold` when the confirmed country is not one purchases are sold in, as `quantityUnsupported` when `baseQuantity` is not the base license count the purchase holds (checked on the locked purchase before anything is written, so its quantity and terms stay as they were; the `quoteId` is signed for that count) and, before anything is read, when `baseQuantity` is above one while `pricing-multi-license` is off, and with every other refusal of `startFromPricing`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"integer","minimum":1,"maximum":3,"default":1},"addons":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"quantity":{"type":"integer","minimum":1,"maximum":100,"default":1}},"required":["code"],"additionalProperties":false},"default":[]},"quoteId":{"type":"string","minLength":1,"maxLength":128},"startKey":{"type":"string","format":"uuid"},"baseQuantity":{"type":"integer","minimum":1,"maximum":100,"default":1},"intentId":{"type":"string","format":"uuid"}},"required":["organizationId","interval","quoteId","startKey","intentId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"choiceRevision":{"type":"number"}},"required":["choiceRevision"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/selectOrganization":{"post":{"operationId":"purchase.selectOrganization","description":"Runs the purchase.selectOrganization procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"intentId":{"type":"string","format":"uuid"},"organizationId":{"type":"string","minLength":1,"maxLength":255},"selectionVersion":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["intentId","organizationId","selectionVersion"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"selectionVersion":{"type":"number"},"choiceRevision":{"type":"number"}},"required":["selectionVersion","choiceRevision"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/createOrganization":{"post":{"operationId":"purchase.createOrganization","description":"Runs the purchase.createOrganization procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"intentId":{"type":"string","format":"uuid"},"createKey":{"type":"string","format":"uuid"},"selectionVersion":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["name","intentId","createKey","selectionVersion"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"selectionVersion":{"type":"number"},"choiceRevision":{"type":"number"},"organizationId":{"type":"string"},"name":{"type":"string"},"replayed":{"type":"boolean"}},"required":["selectionVersion","choiceRevision","organizationId","name","replayed"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/confirmOrganization":{"post":{"operationId":"purchase.confirmOrganization","description":"Runs the purchase.confirmOrganization procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"intentId":{"type":"string","format":"uuid"},"organizationId":{"type":"string","minLength":1,"maxLength":255}},"required":["intentId","organizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"outcome":{"enum":["confirmed","alreadySubscribed"],"type":"string"}},"required":["outcome"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/confirmBusinessRegion":{"post":{"operationId":"purchase.confirmBusinessRegion","description":"Confirms the country of the caller's live purchase's confirmed business. A business with no country gets it written; the same country is confirmed without a write; a different one is refused with PRECONDITION_FAILED as `businessRegionMismatch` and left to the business details, and a country purchases are not sold in (outside `purchaseRegionIds`, whatever the deployment enables) is refused as `businessRegionNotSold`, writing nothing. Refused with FORBIDDEN as `publicPricingDisabled` while neither `public-pricing` nor `pricing-preview` is on, and with PRECONDITION_FAILED as `organizationUnconfirmed`, `organizationNotEligible`, `purchaseIntentClosed` or `selectionChanged` when the purchase moved meanwhile; an optional `selectionVersion` other than the purchase's is refused as `selectionChanged` before any Stripe call or write. A purchase frozen for a hosted Checkout is refused `checkoutInProgress`, unless its business has since moved to another country than the one confirmed and the requested country is that business's own country and one purchases are sold in, all checked before any Stripe call (a different country is refused `businessRegionMismatch`, and one purchases are not sold in `businessRegionNotSold`, with the session left open): then every session the purchase opened is closed first, by the rules of `purchase.cancel`, and refused as `checkoutInProgress` while an attempt is reserved or unknown, `checkoutPaymentPending` while a paid session is still being settled, `checkoutAlreadyPaid` once that business's subscription stands, and `checkoutCheckFailed` when Stripe cannot confirm a session closed; once all are closed the freeze is released, or refused as `checkoutInProgress` when another attempt appeared meanwhile or `selectionChanged` when the freeze moved, and the country is confirmed on the same purchase.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"intentId":{"type":"string","format":"uuid"},"regionId":{"not":{}},"selectionVersion":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["intentId","regionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"regionId":{"type":"string"}},"required":["regionId"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/updateSelection":{"post":{"operationId":"purchase.updateSelection","description":"Replaces the accepted terms of the caller's live purchase `intentId` with the plan, period and base license count the review shows, at the `choiceRevision` it holds and with the `quoteId` it was shown. The server re-prices the selection, from the confirmed business's own offer once the business and its country are confirmed and from the brand's reference market before; only the business's own offer prices more than one license. Refused with FORBIDDEN as `publicPricingDisabled` while neither `public-pricing` nor `pricing-preview` is on; with PRECONDITION_FAILED as `quantityUnsupported` when `baseQuantity` is above one while `pricing-multi-license` is off (checked before the purchase is read, so nothing is written), `organizationUnconfirmed` for more than one license before both confirmations, `selectionChanged` for another revision, `offerChanged` unless `quoteId` still signs to the re-priced terms, `planNotOffered`, `checkoutInProgress` and `purchaseIntentClosed`; with NOT_FOUND when the caller has no such purchase. No Stripe call.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"integer","minimum":1,"maximum":3,"default":1},"addons":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"quantity":{"type":"integer","minimum":1,"maximum":100,"default":1}},"required":["code"],"additionalProperties":false},"default":[]},"baseQuantity":{"type":"integer","minimum":1,"maximum":100,"default":1},"intentId":{"type":"string","format":"uuid"},"quoteId":{"type":"string","minLength":1,"maxLength":128},"choiceRevision":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["interval","intentId","quoteId","choiceRevision"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"choiceRevision":{"type":"number"}},"required":["choiceRevision"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/startCheckout":{"post":{"operationId":"purchase.startCheckout","description":"Starts the hosted Stripe Checkout of the caller's live purchase and returns its URL, or `confirming` while an earlier payment is being confirmed. The server re-prices the confirmed business's own offer and refuses `offerChanged` unless `quoteId` still signs to it; the browser supplies no price, amount, currency, trial or license count, and the session bills the base licenses the accepted terms name. `choiceRevision` is the purchase revision the terms were accepted at (optional only for a page still running the previous bundle): any other is refused as `selectionChanged` before anything reaches Stripe, and the freeze is written only at that revision, so a change made since (another tab's included, even one that restored the same terms) is reviewed and accepted again. Refused with FORBIDDEN as `publicPricingDisabled` while neither `public-pricing` nor `pricing-preview` is on, and with PRECONDITION_FAILED as `selectionChanged`, `organizationUnconfirmed`, `businessRegionUnconfirmed`, `businessRegionNotSold` (the confirmed country is not one purchases are sold in, even with an offer configured there), `quantityUnsupported` while the purchase holds more than one base license and `pricing-multi-license` is off (nothing is written; the count is chosen again on the review), `organizationNotEligible`, `purchaseIntentClosed`, `offerChanged`, `billingPaused`, `emailUnverified` (the caller's stored address is not verified yet; nothing reaches Stripe, and `sendEmailCode` starts the verification) or any refusal of Billing's own Checkout. Before creating a session it closes the sessions the purchase opened for any other business it named: refused as `checkoutInProgress` while such an attempt is reserved or unknown, `checkoutPaymentPending` or `checkoutAlreadyPaid` while its payment may have landed, and `checkoutCheckFailed` when Stripe cannot confirm one closed.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"intentId":{"type":"string","format":"uuid"},"organizationId":{"type":"string","minLength":1,"maxLength":255},"interval":{"enum":["month","year"],"type":"string"},"quoteId":{"type":"string","minLength":1,"maxLength":128},"choiceRevision":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["intentId","organizationId","interval","quoteId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"outcome":{"const":"url"},"url":{"type":"string","minLength":1}},"required":["outcome","url"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"const":"confirming"}},"required":["outcome"],"additionalProperties":false}]}}}}}}},"/api/public/v1/purchase/sendEmailCode":{"post":{"operationId":"purchase.sendEmailCode","description":"Mails the caller's own stored address the code that verifies it before paying, replacing any earlier code, and answers `sent`, `cooldown` with `retryAfterSeconds` while the last code is too recent, `unavailable` when the mail could not be queued (nothing was sent and another send may follow at once), or `verified` when the address needs no code. No address is accepted from the caller. Refused with NOT_FOUND when the caller has no purchase under way, of their own or carried by the browser, and with TOO_MANY_REQUESTS once the account's hourly sends are spent.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"status":{"const":"sent"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"cooldown"},"retryAfterSeconds":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["status","retryAfterSeconds"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"unavailable"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"const":"verified"}},"required":["status"],"additionalProperties":false}]}}}}}}},"/api/public/v1/purchase/verifyEmailCode":{"post":{"operationId":"purchase.verifyEmailCode","description":"Checks `code` against the code mailed to the caller's own stored address and, on a match, marks the address verified, answering `verified`; otherwise `wrong`, `expired`, or `locked` once the code took its last wrong guess, when a new one must be sent. A code is valid once. Refused with NOT_FOUND when the caller has no purchase under way.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","pattern":"^\\d{6}$"}},"required":["code"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"outcome":{"enum":["verified","wrong","expired","locked"],"type":"string"}},"required":["outcome"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/closeCheckout":{"post":{"operationId":"purchase.closeCheckout","description":"Closes the hosted Checkout the caller's live purchase is frozen for and releases the freeze, keeping the purchase, its business, confirmations and plan, so it can go on to another business through `selectOrganization` or `createOrganization`, which clear the confirmations and need fresh terms and consent before any new Checkout. Answers `closed: false` when nothing is frozen. Every session the purchase opened is closed first by the rules of `purchase.cancel`: refused with PRECONDITION_FAILED as `checkoutInProgress` while an attempt is reserved or unknown, or when another attempt appeared before the freeze was released, `checkoutPaymentPending` while a paid session is still being settled, `checkoutAlreadyPaid` once that business's subscription stands, and `checkoutCheckFailed` when Stripe cannot confirm a session closed, each leaving the purchase frozen; `purchaseIntentClosed` for a closed purchase and `selectionChanged` when the freeze moved. Refused with FORBIDDEN as `publicPricingDisabled` while neither `public-pricing` nor `pricing-preview` is on.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"intentId":{"type":"string","format":"uuid"}},"required":["intentId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"closed":{"type":"boolean"}},"required":["closed"],"additionalProperties":false}}}}}}},"/api/public/v1/purchase/cancel":{"post":{"operationId":"purchase.cancel","description":"Cancels the caller's live purchase after expiring the Checkout sessions it opened. Answers `checkout: closed`, `none` (nothing was open) or `unconfirmed` (Stripe could not be asked; a payment that lands later still completes the purchase). Refused as `checkoutAlreadyPaid` or `checkoutPaymentPending` when a session was paid, leaving the purchase as it was. Never gated by `public-pricing`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"intentId":{"type":"string","format":"uuid"}},"required":["intentId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"const":"cancelled"},"checkout":{"enum":["none","closed","unconfirmed"],"type":"string"}},"required":["result","checkout"],"additionalProperties":false}}}}}}},"/api/public/v1/emenu/codes/{code}":{"get":{"operationId":"emenu.resolveCode","summary":"Resolve a printed QR code to its venue and table","description":"Reads the emenu.resolveCode procedure, the same operation the app performs. The credential's live venue permissions bound it.","tags":["emenu"],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/venue":{"get":{"operationId":"emenu.venue","summary":"Read a venue's guest menu","description":"Returns the venue's published QR menu: categories and items ordered and styled by its published version, with names, prices and availability read live from the catalog. A venue that has never published answers not found; draft reorders and appearance reach guests only after emenu.publish.","tags":["emenu"],"parameters":[{"name":"organizationSlug","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":60},"allowEmptyValue":true,"allowReserved":true},{"name":"locationSlug","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":60},"allowEmptyValue":true,"allowReserved":true},{"name":"code","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":40},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/previewVenue":{"post":{"operationId":"emenu.previewVenue","summary":"Preview a venue's QR menu draft or past version","description":"Returns the same payload as emenu.venue, built from the venue's unpublished draft order and appearance, or from the version named by versionId, so a merchant can see what emenu.publish or emenu.restoreVersion would put live. Catalog names, prices and availability are read live as on the guest menu. It requires menu read permission at the venue and changes nothing. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationSlug":{"type":"string","minLength":1,"maxLength":60},"locationSlug":{"type":"string","minLength":1,"maxLength":60},"versionId":{"type":"string","minLength":1}},"required":["organizationSlug","locationSlug"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/item":{"post":{"operationId":"emenu.item","description":"Reads the emenu.item procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationSlug":{"type":"string","minLength":1,"maxLength":60},"locationSlug":{"type":"string","minLength":1,"maxLength":60},"catalogItemId":{"type":"string","minLength":1}},"required":["organizationSlug","locationSlug","catalogItemId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/tableOrder":{"post":{"operationId":"emenu.tableOrder","description":"Reads the emenu.tableOrder procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/listTableOrderStages":{"post":{"operationId":"emenu.listTableOrderStages","description":"Reads the emenu.listTableOrderStages procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"guestToken":{"type":"string","minLength":1,"maxLength":100}},"required":["code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/tableBill":{"post":{"operationId":"emenu.tableBill","description":"Reads the emenu.tableBill procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"guestToken":{"type":"string","minLength":1,"maxLength":100}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/createGuestPaymentSession":{"post":{"operationId":"emenu.createGuestPaymentSession","summary":"Reserve a guest's share of a table bill and open its checkout","description":"Reserves the requested share (full, equal, items or custom) against one of the table's live bills and opens a checkout for it with the venue's online payment provider. billId names the bill (its oldest order's id, as tableBill.bills lists it); without it the oldest bill is taken, and a bill the table no longer has is refused as shareChanged. A share held against a bill fixes its orders, so an order activated afterwards bills apart. The first share held for a bill, paid or still being paid, fixes the mode for the rest of that bill (refusal splitModeMismatch otherwise), and for equal also the way-count: any other ways value is refused as splitWaysMismatch, even after earlier shares were paid, so a paid split's remainder is never re-split. A slot already held is refused as equalSlotClaimed. The till's own split parts count as held shares too and fix the mode as a guest's share does: a By items part on any order of the open party holds its lines (refusal itemAlreadyClaimed for a line it took), and a Split equally part holds its slot while the party is that one order; with several open orders at the table an equal part divides only its own order and is not counted. An optional tip (a venue QR preset by its key, or a custom amount in cents) is priced on the reserved share and charged with it, never inside it; it is refused as tipsOff where the venue's QR tips are off and tipChanged for a preset the venue no longer offers, and a changed tip opens a new session. A new checkout is refused with NOT_FOUND where the venue's online payment is off or has no approved connection, and with FORBIDDEN: refusal featureRestrictedByPlan where the business's plan restricts QR Payment, or featureNotEntitled where its venue has no plan to decide it. The guest's own open checkout for exactly the same share, tip and bill, with time left on its session, is returned before either refusal, opening nothing new; a refused request leaves that checkout as it was. Any request is refused with CONFLICT: refusal paymentInProgress while this guest's earlier attempt at the table is being charged or authenticated, or is still being opened at the provider (pending, within the attempt hold); it is never superseded meanwhile. An order holding a pass without a guest attached is refused with BAD_REQUEST as `passNeedsGuest` before any money is taken. While the organization asks for the guest's WhatsApp code when selling a pass, an order holding a pass whose customer has not verified it with `customers.verifyPassSaleCode` is refused with FORBIDDEN as `passCodeRequired` before any money is taken. An unpaid order whose pass discount no longer holds (the pass's allowance was used on another order, or the pass ended, was voided or is not on sale at this Location) is refused with CONFLICT as `passRedemptionChanged` before any money is taken, and the order is repriced without it: read the order again for the new total. While the organization asks for the guest's WhatsApp code when redeeming a pass, an unpaid order with a line a pass redeems whose customer has not verified it (with `customers.verifyPassRedemptionCode`, or any other code that verifies the order's guest) is refused with FORBIDDEN as `passRedemptionCodeRequired` before any money is taken.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"mode":{"const":"full"},"guestToken":{"type":"string","minLength":1,"maxLength":100},"billId":{"type":"string","minLength":1,"maxLength":64},"tip":{"anyOf":[{"type":"object","properties":{"kind":{"const":"preset"},"key":{"type":"string","minLength":1,"maxLength":40}},"required":["kind","key"]},{"type":"object","properties":{"kind":{"const":"custom"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}},"required":["code","mode","guestToken"]},{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"mode":{"const":"equal"},"guestToken":{"type":"string","minLength":1,"maxLength":100},"billId":{"type":"string","minLength":1,"maxLength":64},"ways":{"type":"integer","minimum":1,"maximum":20},"slotIndex":{"type":"integer","minimum":1,"maximum":9007199254740991},"tip":{"anyOf":[{"type":"object","properties":{"kind":{"const":"preset"},"key":{"type":"string","minLength":1,"maxLength":40}},"required":["kind","key"]},{"type":"object","properties":{"kind":{"const":"custom"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}},"required":["code","mode","guestToken","ways","slotIndex"]},{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"mode":{"const":"items"},"guestToken":{"type":"string","minLength":1,"maxLength":100},"billId":{"type":"string","minLength":1,"maxLength":64},"items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":1,"maximum":99}},"tip":{"anyOf":[{"type":"object","properties":{"kind":{"const":"preset"},"key":{"type":"string","minLength":1,"maxLength":40}},"required":["kind","key"]},{"type":"object","properties":{"kind":{"const":"custom"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}},"required":["code","mode","guestToken","items"]},{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"mode":{"const":"custom"},"guestToken":{"type":"string","minLength":1,"maxLength":100},"billId":{"type":"string","minLength":1,"maxLength":64},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"tip":{"anyOf":[{"type":"object","properties":{"kind":{"const":"preset"},"key":{"type":"string","minLength":1,"maxLength":40}},"required":["kind","key"]},{"type":"object","properties":{"kind":{"const":"custom"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}},"required":["code","mode","guestToken","amountCents"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/createGuestPrepaySession":{"post":{"operationId":"emenu.createGuestPrepaySession","description":"Opens a checkout that charges the guest's cart before the order is sent, at a venue that takes payment first. The server prices the cart and freezes it on the session; only the confirmed charge creates the order. The guest's own open checkout for exactly the same cart and tip (same guestToken, with time left on its session) is returned first, before every refusal below, opening nothing new. Anything else is a new checkout. It is refused with FORBIDDEN: refusal notAcceptingOrders where the venue takes no prepaid orders (ordering or online payment off, payment not taken first, a browse-only table, or a standing that takes no guest orders), and with FORBIDDEN: refusal featureRestrictedByPlan where the business's plan restricts QR Ordering or QR Payment, or featureNotEntitled where its venue has no plan to decide it. It is refused with NOT_FOUND where the venue has no approved payment connection, with CONFLICT: refusal paymentInProgress while this guest's earlier prepayment at the table is being charged or an identical one is still being opened, and with CONFLICT: refusal kitchenDeliveryUnavailable when the order its charge would create could reach no kitchen on its own — the venue mints no ticket on a Kitchen Desk its per-location licence lets staff open and some station the cart's items route to has no printer — before any session is opened or charged. A basket holding a pass, or one joining an order that holds a pass, is refused with BAD_REQUEST as `passNotOnline`: a pass is bought at the till.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"lines":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"quantity":{"type":"integer","minimum":1,"maximum":99},"notes":{"type":"string","maxLength":500},"itemVariationId":{"type":"string","minLength":1},"modifierIds":{"type":"array","maxItems":12,"items":{"type":"string","minLength":1}}},"required":["catalogItemId","quantity"]}},"guestToken":{"type":"string","minLength":1,"maxLength":100},"tip":{"anyOf":[{"type":"object","properties":{"kind":{"const":"preset"},"key":{"type":"string","minLength":1,"maxLength":40}},"required":["kind","key"]},{"type":"object","properties":{"kind":{"const":"custom"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}},"required":["code","lines","guestToken"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/ownOpenPrepay":{"post":{"operationId":"emenu.ownOpenPrepay","description":"Reads the emenu.ownOpenPrepay procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"guestToken":{"type":"string","minLength":1,"maxLength":100}},"required":["code","guestToken"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"provider":{"enum":["myfatoorah","geidea"],"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"quantity":{"type":"integer","minimum":1,"maximum":99},"notes":{"type":"string","maxLength":500},"itemVariationId":{"type":"string","minLength":1},"modifierIds":{"type":"array","maxItems":12,"items":{"type":"string","minLength":1}}},"required":["catalogItemId","quantity"]}},"amountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tip":{"anyOf":[{"type":"object","properties":{"kind":{"const":"preset"},"key":{"type":"string","minLength":1,"maxLength":40}},"required":["kind","key"]},{"type":"object","properties":{"kind":{"const":"custom"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}},"required":["provider","lines","amountCents","tipCents"]},{"type":"null"}]}}}}}}},"/api/public/v1/emenu/executeGuestPaymentCharge":{"post":{"operationId":"emenu.executeGuestPaymentCharge","description":"Runs the emenu.executeGuestPaymentCharge procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"sessionId":{"type":"string","minLength":1}},"required":["code","sessionId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/cancelGuestPaymentSession":{"post":{"operationId":"emenu.cancelGuestPaymentSession","description":"Runs the emenu.cancelGuestPaymentSession procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"sessionId":{"type":"string","minLength":1},"guestToken":{"type":"string","minLength":1,"maxLength":100}},"required":["code","sessionId","guestToken"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/guestPaymentAttemptOutcome":{"post":{"operationId":"emenu.guestPaymentAttemptOutcome","description":"Reads the emenu.guestPaymentAttemptOutcome procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"guestToken":{"type":"string","minLength":1,"maxLength":100},"attemptId":{"type":"string","minLength":1}},"required":["code","guestToken","attemptId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/guestPaymentDocuments":{"post":{"operationId":"emenu.guestPaymentDocuments","description":"Reads the emenu.guestPaymentDocuments procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"guestToken":{"type":"string","minLength":1,"maxLength":100}},"required":["code","guestToken"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/guestPaymentReceipt":{"post":{"operationId":"emenu.guestPaymentReceipt","description":"Reads the emenu.guestPaymentReceipt procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"guestToken":{"type":"string","minLength":1,"maxLength":100},"receiptId":{"type":"string","minLength":1,"maxLength":100}},"required":["code","guestToken","receiptId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/guestInvoice":{"post":{"operationId":"emenu.guestInvoice","description":"Reads the emenu.guestInvoice procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"guestToken":{"type":"string","minLength":1,"maxLength":100},"invoiceId":{"type":"string","minLength":1,"maxLength":100}},"required":["code","guestToken","invoiceId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/orders":{"post":{"operationId":"emenu.submitOrder","summary":"Submit a guest order from a QR code","description":"Adds the guest's basket to the table's open order, priced from the catalog. A new basket is refused with FORBIDDEN: refusal notAcceptingOrders where the venue's guest ordering is off, the table is browse-only or the business's standing takes no guest orders; featureRestrictedByPlan where the business's plan restricts QR Ordering, or featureNotEntitled where its venue has no plan to decide it; and payBeforeSending where orders here are paid first. Where the venue is set to take payment first but cannot open a new prepayment, the basket is taken unpaid, and is refused with CONFLICT: refusal paymentInProgress while any prepayment at the table is being charged, is still open on a live checkout session, or is still being opened. Where the venue sends guest orders straight to the kitchen, a basket that would be sent is refused with CONFLICT: refusal kitchenDeliveryUnavailable when the venue mints no ticket on a Kitchen Desk its per-location licence lets staff open and some station the basket's items route to would get no queued kitchen slip; nothing of it is kept, so the same request can be retried. A basket already accepted under the same idempotencyKey at this table returns its original order before any of those checks, writing nothing. A basket holding a pass, or one joining an order that holds a pass, is refused with BAD_REQUEST as `passNotOnline`: a pass is bought at the till.","tags":["emenu"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":40},"idempotencyKey":{"type":"string","format":"uuid"},"lines":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"catalogItemId":{"type":"string","minLength":1},"quantity":{"type":"integer","minimum":1,"maximum":99},"notes":{"type":"string","maxLength":500},"itemVariationId":{"type":"string","minLength":1},"modifierIds":{"type":"array","maxItems":12,"items":{"type":"string","minLength":1}}},"required":["catalogItemId","quantity"]}},"captchaToken":{"type":"string","maxLength":2048}},"required":["code","idempotencyKey","lines"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/getVenueUrl":{"post":{"operationId":"emenu.getVenueUrl","summary":"Read a venue's public QR-menu address","description":"Returns the venue's guest menu address parts: organizationSlug, locationSlug, the organization's brand id, and publicOrigin, the origin printed codes encode (the organization brand's, or the default brand's). The guest menu lives at publicOrigin/organizationSlug/locationSlug. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/getPreviewConfig":{"post":{"operationId":"emenu.getPreviewConfig","summary":"Read whether the QR menu settles bills","description":"Returns { paysBill }: true when the venue's QR menu is set to let guests pay their bill in the menu and the venue is currently eligible to take guest online payments through an approved payment connection under a plan that admits QR Payment, false otherwise. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/getPreviewTable":{"post":{"operationId":"emenu.getPreviewTable","summary":"Deprecated: read the QR menu's preview table code","description":"Deprecated: use emenu.getPreviewConfig. Returns { tableCode }: the live printed code of the venue's lowest-numbered table that takes guest orders, or null when no such table has a code. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/listPrintedCodes":{"post":{"operationId":"emenu.listPrintedCodes","summary":"List a venue's printed QR codes","description":"Returns the venue's live printed QR codes, each with id, publicCode, tableId (null for a spare) and createdAt, spares first and then oldest first. The id is what emenu.reassignCode and emenu.unassignCode take; where a table holds several codes, tables.listTables shows its oldest. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/reassignCode":{"post":{"operationId":"emenu.reassignCode","summary":"Point a printed QR code at another table","description":"Points an existing printed code at tableId in the same venue, including assigning a spare, and returns { id, tableId }; repeating it changes nothing. The code string and the printed sticker stay the same and other codes on the target table are left in place; use tables.rotateCode to replace a leaked code. Requires menu update permission and the venue's QR menu switched on. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printedCodeId":{"type":"string","minLength":1},"tableId":{"type":"string","minLength":1}},"required":["printedCodeId","tableId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/unassignCode":{"post":{"operationId":"emenu.unassignCode","summary":"Return a printed QR code to the spare pool","description":"Detaches a printed code from its table, returning it to the venue's spare pool, and returns { id, tableId: null }; repeating it changes nothing. The code is kept, but a guest scanning it no longer reaches a table until emenu.reassignCode points it at one. Requires menu update permission and the venue's QR menu switched on. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printedCodeId":{"type":"string","minLength":1}},"required":["printedCodeId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/getQrDesign":{"post":{"operationId":"emenu.getQrDesign","summary":"Read a venue's QR code styling","description":"Returns the venue's stored QR code styling (dot and corner shapes, colors and optional logo), or the default design when none has been saved. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/getOutletInfo":{"post":{"operationId":"emenu.getOutletInfo","summary":"Read a venue's QR-menu outlet info","description":"Returns the venue's guest-facing outlet info: description and addressLine, which come from the venue's location settings, and the googleMapsUrl, website, instagram and customLinks that emenu.saveOutletInfo edits. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/saveOutletInfo":{"post":{"operationId":"emenu.saveOutletInfo","summary":"Save a venue's QR-menu outlet links","description":"Replaces the venue's googleMapsUrl, website, instagram and customLinks, dropping custom links with an empty label, and returns the saved values; repeating it is safe. These fields are not part of the QR menu draft, so guests see them immediately without emenu.publish. Description and address are edited in location settings, not here. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"googleMapsUrl":{"type":"string","maxLength":2048},"website":{"type":"string","maxLength":2048},"instagram":{"type":"string","maxLength":120},"customLinks":{"type":"array","maxItems":20,"items":{"type":"object","properties":{"label":{"type":"string","maxLength":60},"url":{"type":"string","maxLength":2048}},"required":["label","url"]}}},"required":["locationId","googleMapsUrl","website","instagram","customLinks"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/getAppearance":{"post":{"operationId":"emenu.getAppearance","summary":"Read a venue's QR-menu draft appearance","description":"Returns the venue's QR menu draft appearance (logoUrl, background color, backgroundImageUrl and itemGridColumns), with defaults filling any field never saved. This is the draft emenu.saveAppearance writes; guests see the appearance of the last emenu.publish, which emenu.previewVenue can compare. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/saveAppearance":{"post":{"operationId":"emenu.saveAppearance","summary":"Save a venue's QR-menu draft appearance","description":"Replaces the venue's QR menu draft appearance with the whole appearance object given and returns it; repeating it is safe. The change reaches guests only after emenu.publish. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"appearance":{"type":"object","properties":{"logoUrl":{"anyOf":[{"type":"string","maxLength":262144},{"type":"null"}]},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"backgroundImageUrl":{"anyOf":[{"type":"string","maxLength":262144},{"type":"null"}]},"itemGridColumns":{"anyOf":[{"const":1},{"const":2},{"const":3}]}},"required":["logoUrl","background","backgroundImageUrl","itemGridColumns"]}},"required":["locationId","appearance"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"logoUrl":{"anyOf":[{"type":"string","maxLength":262144},{"type":"null"}]},"background":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"backgroundImageUrl":{"anyOf":[{"type":"string","maxLength":262144},{"type":"null"}]},"itemGridColumns":{"anyOf":[{"const":1},{"const":2},{"const":3}]}},"required":["logoUrl","background","backgroundImageUrl","itemGridColumns"]}}}}}}},"/api/public/v1/emenu/contentOrder":{"post":{"operationId":"emenu.contentOrder","summary":"Read venue QR-menu order","description":"Returns QR-menu position overrides for this venue. These are separate from organization-wide catalog/POS positions; catalog positions apply where no override exists. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/listContent":{"post":{"operationId":"emenu.listContent","summary":"Read venue QR-menu content and placement","description":"Returns live catalog categories and items with effective QR-menu positions and on-menu flags at this venue. Off-menu and unavailable items are included; uncategorized items appear in a synthetic category. Content comes directly from the organization-wide catalog; positions are the venue's draft, which guests see once published. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/moveCategory":{"post":{"operationId":"emenu.moveCategory","summary":"Reorder a category on a venue QR menu","description":"Sets this category position in the venue's QR-menu draft only, leaving catalog/POS order and other venues unchanged; guests see it once emenu.publish publishes the draft. Accepts the synthetic Uncategorized category ID returned by listContent. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"categoryId":{"type":"string","minLength":1},"position":{"type":"number"}},"required":["locationId","categoryId","position"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/moveItem":{"post":{"operationId":"emenu.moveItem","summary":"Reorder an item on a venue QR menu","description":"Sets this item position in the venue's QR-menu draft only, leaving its catalog category, catalog/POS order and other venues unchanged; guests see it once emenu.publish publishes the draft. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"catalogItemId":{"type":"string","minLength":1},"position":{"type":"number"}},"required":["locationId","catalogItemId","position"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/emenu/publish":{"post":{"operationId":"emenu.publish","summary":"Publish the venue's QR menu","description":"Freezes the venue's draft QR-menu order and appearance as the version guests see, archiving the version published before it. Catalog content is never versioned. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"name":{"type":"string","maxLength":60}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"publishedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","name","publishedAt"]}}}}}}},"/api/public/v1/emenu/restoreVersion":{"post":{"operationId":"emenu.restoreVersion","summary":"Restore a published QR-menu version","description":"Publishes a copy of an earlier version and loads it into the draft. Restoring the version live now only resets the draft to it. A write naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"versionId":{"type":"string","minLength":1}},"required":["locationId","versionId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/emenu/renameVersion":{"post":{"operationId":"emenu.renameVersion","summary":"Rename a QR-menu version","description":"Sets or clears the owner's name for one of the venue's published or archived QR-menu versions. A name is a label only; it changes nothing guests see. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"versionId":{"type":"string","minLength":1},"name":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]}},"required":["locationId","versionId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"publishedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","name","publishedAt"]}}}}}}},"/api/public/v1/emenu/listVersions":{"post":{"operationId":"emenu.listVersions","summary":"List the venue's QR-menu versions","description":"Returns the venue's published and archived QR-menu versions, newest first, and whether the draft differs from the version guests see. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"publishedAt":{"type":"string","format":"date-time","x-native-type":"date"},"status":{"enum":["published","archived"],"type":"string"},"publishedByName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","publishedAt","status","publishedByName"]}},"hasUnpublishedChanges":{"type":"boolean"}},"required":["versions","hasUnpublishedChanges"]}}}}}}},"/api/public/v1/media/control":{"post":{"operationId":"media.control","description":"Runs the media.control procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"operation":{"const":"initUpload"},"input":{"anyOf":[{"type":"object","properties":{"owner":{"type":"object","properties":{"type":{"const":"organization"},"id":{"type":"string","minLength":1,"maxLength":119,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["type","id"],"additionalProperties":false},"contentType":{"enum":["image/jpeg","image/png","image/webp","image/avif"],"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":10485760,"exclusiveMinimum":0},"checksumSha256":{"type":"string","pattern":"^[A-Za-z0-9+/]{43}=$"},"idempotencyKey":{"type":"string","format":"uuid"}},"required":["contentType","sizeBytes","checksumSha256"],"additionalProperties":false},{"type":"object","properties":{"tenantId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_-]+$"},"contentType":{"enum":["image/jpeg","image/png","image/webp","image/avif"],"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":10485760,"exclusiveMinimum":0},"checksumSha256":{"type":"string","pattern":"^[A-Za-z0-9+/]{43}=$"},"idempotencyKey":{"type":"string","format":"uuid"}},"required":["tenantId","contentType","sizeBytes","checksumSha256"],"additionalProperties":false}]}},"required":["operation","input"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"completeUpload"},"receipt":{"type":"string","minLength":64,"maxLength":8192}},"required":["operation","receipt"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"signTransforms"},"canonicalUrl":{"type":"string","maxLength":4096,"format":"uri"},"transforms":{"type":"array","minItems":1,"maxItems":16,"items":{"anyOf":[{"type":"object","properties":{"preset":{"enum":["menuItemThumbnail","menuItemDetail","optimizedOriginal"],"type":"string"}},"required":["preset"],"additionalProperties":false},{"type":"object","properties":{"width":{"type":"integer","minimum":1,"maximum":4096},"height":{"type":"integer","minimum":1,"maximum":4096},"fit":{"enum":["fit","fill","crop"],"type":"string","default":"fit"},"gravity":{"enum":["center","north","south","east","west","smart"],"type":"string","default":"center"},"dpr":{"type":"integer","minimum":1,"maximum":3,"default":1},"quality":{"type":"integer","minimum":1,"maximum":100,"default":82},"format":{"enum":["auto","jpeg","png","webp","avif"],"type":"string","default":"auto"},"upscale":{"type":"boolean","default":false}},"additionalProperties":false}]}}},"required":["operation","canonicalUrl","transforms"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"signTransformsBatch"},"assets":{"type":"array","minItems":1,"maxItems":64,"items":{"type":"object","properties":{"canonicalUrl":{"type":"string","maxLength":4096,"format":"uri"},"transforms":{"type":"array","minItems":1,"maxItems":16,"items":{"anyOf":[{"type":"object","properties":{"preset":{"enum":["menuItemThumbnail","menuItemDetail","optimizedOriginal"],"type":"string"}},"required":["preset"],"additionalProperties":false},{"type":"object","properties":{"width":{"type":"integer","minimum":1,"maximum":4096},"height":{"type":"integer","minimum":1,"maximum":4096},"fit":{"enum":["fit","fill","crop"],"type":"string","default":"fit"},"gravity":{"enum":["center","north","south","east","west","smart"],"type":"string","default":"center"},"dpr":{"type":"integer","minimum":1,"maximum":3,"default":1},"quality":{"type":"integer","minimum":1,"maximum":100,"default":82},"format":{"enum":["auto","jpeg","png","webp","avif"],"type":"string","default":"auto"},"upscale":{"type":"boolean","default":false}},"additionalProperties":false}]}}},"required":["canonicalUrl","transforms"],"additionalProperties":false}}},"required":["operation","assets"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"deleteAsset"},"canonicalUrl":{"type":"string","maxLength":4096,"format":"uri"}},"required":["operation","canonicalUrl"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"initDocumentUpload"},"input":{"type":"object","properties":{"contentType":{"enum":["application/pdf","image/jpeg","image/png"],"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":10485760,"exclusiveMinimum":0},"checksumSha256":{"type":"string","pattern":"^[A-Za-z0-9+/]{43}=$"},"idempotencyKey":{"type":"string","format":"uuid"},"fileName":{"type":"string","minLength":1,"maxLength":255},"owner":{"type":"object","properties":{"type":{"const":"organization"},"id":{"type":"string","minLength":1,"maxLength":119,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["type","id"],"additionalProperties":false}},"required":["contentType","sizeBytes","checksumSha256","fileName","owner"],"additionalProperties":false}},"required":["operation","input"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"completeDocumentUpload"},"receipt":{"type":"string","minLength":64,"maxLength":8192}},"required":["operation","receipt"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"signDocumentDownload"},"input":{"type":"object","properties":{"owner":{"type":"object","properties":{"type":{"const":"organization"},"id":{"type":"string","minLength":1,"maxLength":119,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["type","id"],"additionalProperties":false},"assetId":{"type":"string","format":"uuid"}},"required":["owner","assetId"],"additionalProperties":false}},"required":["operation","input"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"deleteDocument"},"input":{"type":"object","properties":{"owner":{"type":"object","properties":{"type":{"const":"organization"},"id":{"type":"string","minLength":1,"maxLength":119,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["type","id"],"additionalProperties":false},"assetId":{"type":"string","format":"uuid"}},"required":["owner","assetId"],"additionalProperties":false}},"required":["operation","input"],"additionalProperties":false}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/mediaDrafts/control":{"post":{"operationId":"mediaDrafts.control","description":"Carries the media SDK's `initUpload` and `completeUpload` for a draft image of `purpose`. The upload must name an organization owner, and the caller needs the purpose's permission there (`loyalty:configure` for `wallet-design-draft`), and the organization must take new work of the purpose's feature (Loyalty), else FORBIDDEN with refusal `loyaltyDisabled` while the business switched Loyalty off, `featureRestrictedByPlan` while its plan restricts Loyalty, or `featureNotEntitled` while its plan lacks Loyalty, and with FORBIDDEN and refusal `billingReadOnly` or `subscriptionEnded` while its billing standing admits no new commitment, unless the suspended operation policy relaxes the `loyalty` category. The draft image is recorded before the presigned upload is answered, and its canonical URL before the completion is. Any other operation is refused with BAD_REQUEST; an image already released or expired with CONFLICT and refusal `mediaDraftImageExpired`. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"purpose":{"enum":["wallet-design-draft"],"type":"string"},"request":{"anyOf":[{"type":"object","properties":{"operation":{"const":"initUpload"},"input":{"anyOf":[{"type":"object","properties":{"owner":{"type":"object","properties":{"type":{"const":"organization"},"id":{"type":"string","minLength":1,"maxLength":119,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["type","id"],"additionalProperties":false},"contentType":{"enum":["image/jpeg","image/png","image/webp","image/avif"],"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":10485760,"exclusiveMinimum":0},"checksumSha256":{"type":"string","pattern":"^[A-Za-z0-9+/]{43}=$"},"idempotencyKey":{"type":"string","format":"uuid"}},"required":["contentType","sizeBytes","checksumSha256"],"additionalProperties":false},{"type":"object","properties":{"tenantId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_-]+$"},"contentType":{"enum":["image/jpeg","image/png","image/webp","image/avif"],"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":10485760,"exclusiveMinimum":0},"checksumSha256":{"type":"string","pattern":"^[A-Za-z0-9+/]{43}=$"},"idempotencyKey":{"type":"string","format":"uuid"}},"required":["tenantId","contentType","sizeBytes","checksumSha256"],"additionalProperties":false}]}},"required":["operation","input"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"completeUpload"},"receipt":{"type":"string","minLength":64,"maxLength":8192}},"required":["operation","receipt"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"signTransforms"},"canonicalUrl":{"type":"string","maxLength":4096,"format":"uri"},"transforms":{"type":"array","minItems":1,"maxItems":16,"items":{"anyOf":[{"type":"object","properties":{"preset":{"enum":["menuItemThumbnail","menuItemDetail","optimizedOriginal"],"type":"string"}},"required":["preset"],"additionalProperties":false},{"type":"object","properties":{"width":{"type":"integer","minimum":1,"maximum":4096},"height":{"type":"integer","minimum":1,"maximum":4096},"fit":{"enum":["fit","fill","crop"],"type":"string","default":"fit"},"gravity":{"enum":["center","north","south","east","west","smart"],"type":"string","default":"center"},"dpr":{"type":"integer","minimum":1,"maximum":3,"default":1},"quality":{"type":"integer","minimum":1,"maximum":100,"default":82},"format":{"enum":["auto","jpeg","png","webp","avif"],"type":"string","default":"auto"},"upscale":{"type":"boolean","default":false}},"additionalProperties":false}]}}},"required":["operation","canonicalUrl","transforms"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"signTransformsBatch"},"assets":{"type":"array","minItems":1,"maxItems":64,"items":{"type":"object","properties":{"canonicalUrl":{"type":"string","maxLength":4096,"format":"uri"},"transforms":{"type":"array","minItems":1,"maxItems":16,"items":{"anyOf":[{"type":"object","properties":{"preset":{"enum":["menuItemThumbnail","menuItemDetail","optimizedOriginal"],"type":"string"}},"required":["preset"],"additionalProperties":false},{"type":"object","properties":{"width":{"type":"integer","minimum":1,"maximum":4096},"height":{"type":"integer","minimum":1,"maximum":4096},"fit":{"enum":["fit","fill","crop"],"type":"string","default":"fit"},"gravity":{"enum":["center","north","south","east","west","smart"],"type":"string","default":"center"},"dpr":{"type":"integer","minimum":1,"maximum":3,"default":1},"quality":{"type":"integer","minimum":1,"maximum":100,"default":82},"format":{"enum":["auto","jpeg","png","webp","avif"],"type":"string","default":"auto"},"upscale":{"type":"boolean","default":false}},"additionalProperties":false}]}}},"required":["canonicalUrl","transforms"],"additionalProperties":false}}},"required":["operation","assets"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"deleteAsset"},"canonicalUrl":{"type":"string","maxLength":4096,"format":"uri"}},"required":["operation","canonicalUrl"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"initDocumentUpload"},"input":{"type":"object","properties":{"contentType":{"enum":["application/pdf","image/jpeg","image/png"],"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":10485760,"exclusiveMinimum":0},"checksumSha256":{"type":"string","pattern":"^[A-Za-z0-9+/]{43}=$"},"idempotencyKey":{"type":"string","format":"uuid"},"fileName":{"type":"string","minLength":1,"maxLength":255},"owner":{"type":"object","properties":{"type":{"const":"organization"},"id":{"type":"string","minLength":1,"maxLength":119,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["type","id"],"additionalProperties":false}},"required":["contentType","sizeBytes","checksumSha256","fileName","owner"],"additionalProperties":false}},"required":["operation","input"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"completeDocumentUpload"},"receipt":{"type":"string","minLength":64,"maxLength":8192}},"required":["operation","receipt"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"signDocumentDownload"},"input":{"type":"object","properties":{"owner":{"type":"object","properties":{"type":{"const":"organization"},"id":{"type":"string","minLength":1,"maxLength":119,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["type","id"],"additionalProperties":false},"assetId":{"type":"string","format":"uuid"}},"required":["owner","assetId"],"additionalProperties":false}},"required":["operation","input"],"additionalProperties":false},{"type":"object","properties":{"operation":{"const":"deleteDocument"},"input":{"type":"object","properties":{"owner":{"type":"object","properties":{"type":{"const":"organization"},"id":{"type":"string","minLength":1,"maxLength":119,"pattern":"^[A-Za-z0-9_-]+$"}},"required":["type","id"],"additionalProperties":false},"assetId":{"type":"string","format":"uuid"}},"required":["owner","assetId"],"additionalProperties":false}},"required":["operation","input"],"additionalProperties":false}]}},"required":["purpose","request"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"anyOf":[{"type":"object","properties":{"ok":{"const":true},"operation":{"const":"initDocumentUpload"},"result":{"type":"object","properties":{"apiVersion":{"const":"v1"},"upload":{"type":"object","properties":{"url":{"type":"string","maxLength":4096,"format":"uri"},"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["url","fields","expiresAt"],"additionalProperties":false},"receipt":{"type":"string","minLength":64,"maxLength":8192}},"required":["apiVersion","upload","receipt"],"additionalProperties":false}},"required":["ok","operation","result"],"additionalProperties":false},{"type":"object","properties":{"ok":{"const":true},"operation":{"const":"completeDocumentUpload"},"result":{"type":"object","properties":{"apiVersion":{"const":"v1"},"asset":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"fileName":{"type":"string","minLength":1,"maxLength":255},"contentType":{"enum":["application/pdf","image/jpeg","image/png"],"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":10485760,"exclusiveMinimum":0}},"required":["id","fileName","contentType","sizeBytes"],"additionalProperties":false}},"required":["apiVersion","asset"],"additionalProperties":false}},"required":["ok","operation","result"],"additionalProperties":false},{"type":"object","properties":{"ok":{"const":true},"operation":{"const":"signDocumentDownload"},"result":{"type":"object","properties":{"apiVersion":{"const":"v1"},"url":{"type":"string","maxLength":4096,"format":"uri"},"expiresAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["apiVersion","url","expiresAt"],"additionalProperties":false}},"required":["ok","operation","result"],"additionalProperties":false},{"type":"object","properties":{"ok":{"const":true},"operation":{"const":"deleteDocument"},"result":{"type":"object","properties":{"apiVersion":{"const":"v1"},"deleted":{"const":true}},"required":["apiVersion","deleted"],"additionalProperties":false}},"required":["ok","operation","result"],"additionalProperties":false},{"type":"object","properties":{"ok":{"const":true},"operation":{"const":"initUpload"},"result":{"type":"object","properties":{"apiVersion":{"const":"v1"},"upload":{"type":"object","properties":{"url":{"type":"string","maxLength":4096,"format":"uri"},"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"expiresAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["url","fields","expiresAt"],"additionalProperties":false},"receipt":{"type":"string","minLength":64,"maxLength":8192}},"required":["apiVersion","upload","receipt"],"additionalProperties":false}},"required":["ok","operation","result"],"additionalProperties":false},{"type":"object","properties":{"ok":{"const":true},"operation":{"const":"completeUpload"},"result":{"type":"object","properties":{"apiVersion":{"const":"v1"},"asset":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"url":{"type":"string","maxLength":4096,"format":"uri"},"contentType":{"enum":["image/jpeg","image/png","image/webp","image/avif"],"type":"string"},"sizeBytes":{"type":"integer","minimum":-9007199254740991,"maximum":10485760,"exclusiveMinimum":0},"width":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"height":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["id","url","contentType","sizeBytes","width","height"],"additionalProperties":false}},"required":["apiVersion","asset"],"additionalProperties":false}},"required":["ok","operation","result"],"additionalProperties":false},{"type":"object","properties":{"ok":{"const":true},"operation":{"const":"signTransforms"},"result":{"type":"array","minItems":1,"maxItems":16,"items":{"type":"string","maxLength":4096,"format":"uri"}}},"required":["ok","operation","result"],"additionalProperties":false},{"type":"object","properties":{"ok":{"const":true},"operation":{"const":"signTransformsBatch"},"result":{"type":"array","minItems":1,"maxItems":64,"items":{"type":"object","properties":{"canonicalUrl":{"type":"string","maxLength":4096,"format":"uri"},"urls":{"type":"array","minItems":1,"maxItems":16,"items":{"type":"string","maxLength":4096,"format":"uri"}}},"required":["canonicalUrl","urls"],"additionalProperties":false}}},"required":["ok","operation","result"],"additionalProperties":false},{"type":"object","properties":{"ok":{"const":true},"operation":{"const":"deleteAsset"},"result":{"type":"object","properties":{"apiVersion":{"const":"v1"},"deleted":{"const":true},"cachePurge":{"type":"string","minLength":1}},"required":["apiVersion","deleted","cachePurge"],"additionalProperties":false}},"required":["ok","operation","result"],"additionalProperties":false}]},{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object","properties":{"code":{"enum":["INVALID_REQUEST","INVALID_RECEIPT","RECEIPT_EXPIRED","ENVIRONMENT_MISMATCH","APPLICATION_MISMATCH","FORBIDDEN_CALLER","UPLOAD_NOT_FOUND","UPLOAD_MISMATCH","INVALID_IMAGE","ASSET_CONFLICT","INVALID_ASSET_URL","VALIDATOR_UNAVAILABLE","TRANSFORM_LIMIT_EXCEEDED","INTERNAL_ERROR","EDGE_UNAUTHORIZED","EDGE_FORBIDDEN","EDGE_THROTTLED","NETWORK_ERROR","INVALID_RESPONSE","UPLOAD_FAILED","ABORTED","PREPROCESS_FAILED"],"type":"string"},"operation":{"enum":["init","upload","complete","sign","delete","preprocess"],"type":"string"},"message":{"type":"string","minLength":1,"maxLength":2048},"retryable":{"type":"boolean"},"statusCode":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"requestId":{"type":"string","minLength":1}},"required":["code","operation","message","retryable"],"additionalProperties":false}},"required":["ok","error"],"additionalProperties":false}]}}}}}}},"/api/public/v1/mediaDrafts/renew":{"post":{"operationId":"mediaDrafts.renew","description":"Extends, by 48 hours, the lease of the uploaded draft images an open editor still holds, whatever the plan. Answers in `unavailable` the URLs that can no longer be used, released, expired or never this organization's, which the editor must upload again. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"purpose":{"enum":["wallet-design-draft"],"type":"string"},"canonicalUrls":{"type":"array","minItems":1,"maxItems":16,"items":{"type":"string","maxLength":4096,"format":"uri"}}},"required":["organizationId","purpose","canonicalUrls"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"unavailable":{"type":"array","items":{"type":"string"}}},"required":["unavailable"]}}}}}}},"/api/public/v1/mediaDrafts/release":{"post":{"operationId":"mediaDrafts.release","description":"Discards uploaded draft images an editor replaced, removed or reset, and queues their deletion from media storage, answering without waiting for it. Adopted, referenced and other organizations' images are left untouched. Allowed whatever the plan, so drafts can be let go after a lapse. Answers the released URLs in `released`; the reclaim job deletes them and retries a delete that fails. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"purpose":{"enum":["wallet-design-draft"],"type":"string"},"canonicalUrls":{"type":"array","minItems":1,"maxItems":16,"items":{"type":"string","maxLength":4096,"format":"uri"}}},"required":["organizationId","purpose","canonicalUrls"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"released":{"type":"array","items":{"type":"string"}}},"required":["released"]}}}}}}},"/api/public/v1/niPushToPay/availability":{"post":{"operationId":"niPushToPay.availability","description":"Reads the niPushToPay.availability procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niPushToPay/attemptForOrder":{"post":{"operationId":"niPushToPay.attemptForOrder","description":"Reads the niPushToPay.attemptForOrder procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niPushToPay/start":{"post":{"operationId":"niPushToPay.start","description":"Starts a card payment for what the order owes on one of the venue's NI terminals. The attempt is recorded before the terminal is asked, and a start the terminal did not answer is left unresolved rather than retried. An order holding a pass without a guest attached is refused with BAD_REQUEST as `passNeedsGuest` before any money is taken. While the organization asks for the guest's WhatsApp code when selling a pass, an order holding a pass whose customer has not verified it with `customers.verifyPassSaleCode` is refused with FORBIDDEN as `passCodeRequired` before any money is taken. An unpaid order whose pass discount no longer holds (the pass's allowance was used on another order, or the pass ended, was voided or is not on sale at this Location) is refused with CONFLICT as `passRedemptionChanged` before any money is taken, and the order is repriced without it: read the order again for the new total. While the organization asks for the guest's WhatsApp code when redeeming a pass, an unpaid order with a line a pass redeems whose customer has not verified it (with `customers.verifyPassRedemptionCode`, or any other code that verifies the order's guest) is refused with FORBIDDEN as `passRedemptionCodeRequired` before any money is taken. Refused with CONFLICT and the refusal orderNotShipped for a supplier's shipment order that has not shipped yet: Ship it first. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"terminalId":{"type":"string","minLength":1}},"required":["orderId","terminalId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niPushToPay/status":{"post":{"operationId":"niPushToPay.status","description":"The terminal payment attempt's current state, polled while the guest pays. Writes what NI answered and records the payment when a result exists. A payment that settles the order earns its loyalty member's points as `payments.pay` does, and earns nothing while the business takes no new Loyalty work (its own switch is off, or its plan restricts or lacks Loyalty). Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attemptId":{"type":"string","minLength":1}},"required":["attemptId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niPushToPay/recheck":{"post":{"operationId":"niPushToPay.recheck","description":"Re-reads an unresolved terminal payment attempt's result; nothing is re-sent to the terminal. A payment that settles the order earns its loyalty member's points as `payments.pay` does, and earns nothing while the business takes no new Loyalty work (its own switch is off, or its plan restricts or lacks Loyalty). Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attemptId":{"type":"string","minLength":1}},"required":["attemptId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niPushToPay/cancel":{"post":{"operationId":"niPushToPay.cancel","description":"Requests cancellation of the attempt the terminal is running, refused inside NI's three-second grace. An attempt NI already approved still records its payment. A payment that settles the order earns its loyalty member's points as `payments.pay` does, and earns nothing while the business takes no new Loyalty work (its own switch is off, or its plan restricts or lacks Loyalty). Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attemptId":{"type":"string","minLength":1}},"required":["attemptId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niPushToPayAdmin/merchants":{"post":{"operationId":"niPushToPayAdmin.merchants","description":"Reads the niPushToPayAdmin.merchants procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niPushToPayAdmin/get":{"post":{"operationId":"niPushToPayAdmin.get","description":"Reads the niPushToPayAdmin.get procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niPushToPayAdmin/save":{"post":{"operationId":"niPushToPayAdmin.save","description":"Runs the niPushToPayAdmin.save procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"enabled":{"type":"boolean"},"clientId":{"type":"string","minLength":1,"maxLength":256},"clientSecret":{"type":"string","minLength":1,"maxLength":256},"chainId":{"type":"string","minLength":1,"maxLength":256},"mid":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9]+$"}},"required":["organizationId","enabled","clientId","chainId","mid"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niTerminals/list":{"post":{"operationId":"niTerminals.list","description":"Reads the niTerminals.list procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niTerminals/save":{"post":{"operationId":"niTerminals.save","description":"Runs the niTerminals.save procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"terminalId":{"type":"string","minLength":1},"tid":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9]+$"},"name":{"type":"string","minLength":1,"maxLength":48}},"required":["locationId","tid","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/niTerminals/delete":{"post":{"operationId":"niTerminals.delete","description":"Runs the niTerminals.delete procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"terminalId":{"type":"string","minLength":1}},"required":["locationId","terminalId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/smartPosTerminals/list":{"post":{"operationId":"smartPosTerminals.list","description":"Reads the smartPosTerminals.list procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"activationStatus":{"enum":["NotActivated","Activated","Deactivated"],"type":"string"},"deviceManufacturer":{"anyOf":[{"type":"string"},{"type":"null"}]},"deviceModel":{"anyOf":[{"type":"string"},{"type":"null"}]},"activationCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"activationCodeExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","number","activationStatus","deviceManufacturer","deviceModel","activationCode","activationCodeExpiresAt"]}}}}}}}},"/api/public/v1/smartPosTerminals/create":{"post":{"operationId":"smartPosTerminals.create","description":"Runs the smartPosTerminals.create procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":64}},"required":["locationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","number"]}}}}}}},"/api/public/v1/smartPosTerminals/issueCode":{"post":{"operationId":"smartPosTerminals.issueCode","description":"Runs the smartPosTerminals.issueCode procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"terminalId":{"type":"string","minLength":1}},"required":["terminalId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"activationCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"activationCodeExpiresAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["activationCode","activationCodeExpiresAt"]}}}}}}},"/api/public/v1/smartPosTerminals/suspend":{"post":{"operationId":"smartPosTerminals.suspend","description":"Runs the smartPosTerminals.suspend procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"terminalId":{"type":"string","minLength":1}},"required":["terminalId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"terminalId":{"type":"string","minLength":1}},"required":["terminalId"]}}}}}}},"/api/public/v1/enterprises/create":{"post":{"operationId":"enterprises.create","description":"Runs the enterprises.create procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterprises/invite":{"post":{"operationId":"enterprises.invite","description":"Runs the enterprises.invite procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"userEmail":{"type":"string","format":"email"}},"required":["organizationId","userEmail"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterprises/merchantCommissions":{"post":{"operationId":"enterprises.merchantCommissions","description":"Reads the enterprises.merchantCommissions procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":200},"rateBps":{"type":"integer","minimum":0,"maximum":10000}},"required":["organizationId","rateBps"]}}}}}}}},"/api/public/v1/enterprises/setMerchantCommission":{"post":{"operationId":"enterprises.setMerchantCommission","description":"Runs the enterprises.setMerchantCommission procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":200},"rateBps":{"type":"integer","minimum":0,"maximum":10000}},"required":["organizationId","rateBps"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":200},"rateBps":{"type":"integer","minimum":0,"maximum":10000}},"required":["organizationId","rateBps"]}}}}}}},"/api/public/v1/enterprises/register":{"post":{"operationId":"enterprises.register","description":"Runs the enterprises.register procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterprises/snapshot":{"post":{"operationId":"enterprises.snapshot","description":"Reads the enterprises.snapshot procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}}},{"type":"object","properties":{"merchantId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1},"eventId":{"type":"string","minLength":1},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"asOf":{"type":"string","format":"date-time"},"currency":{"type":"string"},"currencies":{"type":"array","items":{"type":"string"}},"scope":{"type":"object","properties":{"merchants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"organizationId":{"type":"string"},"timeZone":{"type":"string"}},"required":["id","name","organizationId","timeZone"]}},"selectedMerchantId":{"anyOf":[{"type":"string"},{"type":"null"}]},"selectedLocationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"selectedEventId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["merchants","locations","selectedMerchantId","selectedLocationId","events","selectedEventId"]},"window":{"type":"object","properties":{"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"},"locationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timeZonesDiffer":{"type":"boolean"},"spansMultipleDays":{"type":"boolean"}},"required":["timeZone","fellBackToUtc","fromDate","toDate","locationCount","timeZonesDiffer","spansMultipleDays"]},"financial":{"type":"object","properties":{"current":{"type":"object","properties":{"windows":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"fromDate":{"type":"string"},"toDate":{"type":"string"},"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"businessDayStartHour":{"type":"integer","minimum":1,"maximum":23,"description":"The whole hour a one-venue, one-date window's business day begins at, for drawing its hours in event order; absent when the day reads on the calendar."},"intervals":{"type":"array","items":{"type":"object","properties":{"startUtc":{"type":"string"},"endUtc":{"type":"string"}},"required":["startUtc","endUtc"]}}},"required":["locationId","fromDate","toDate","timeZone","fellBackToUtc"]}},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"methods":{"type":"array","items":{"type":"object","properties":{"paymentType":{"type":"string"},"paymentMethodName":{"anyOf":[{"type":"string"},{"type":"null"}]},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unknownRefundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["paymentType","paymentMethodName","saleCents","refundedCents","netCents","refundAmountCents","unknownRefundCount","sharePercent"]}},"locations":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["locationId","figures","sharePercent"]}},"buckets":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"localDate":{"type":"string"},"localHour":{"type":"integer","minimum":0,"maximum":23},"businessDate":{"type":"string","description":"The business date the period holds this bucket by: for a venue whose current hours run past midnight, the operating day an after-midnight event belongs to; otherwise localDate. localDate stays the factual calendar date."},"businessHour":{"type":"integer","minimum":0,"maximum":23,"description":"The hour this bucket reports in, on the clock of the venue's current time zone when its hours run past midnight; otherwise localHour. localHour stays the factual hour."},"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tradingRevenueCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["locationId","localDate","localHour","businessDate","businessHour","grossCents","discountCents","refundCents","netCents","tradingRevenueCents","saleCount","refundCount"]}}},"required":["currency","figures","methods","locations","buckets"]}}},"required":["windows","currencies"]},"previous":{"type":"object","properties":{"windows":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"fromDate":{"type":"string"},"toDate":{"type":"string"},"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"businessDayStartHour":{"type":"integer","minimum":1,"maximum":23,"description":"The whole hour a one-venue, one-date window's business day begins at, for drawing its hours in event order; absent when the day reads on the calendar."},"intervals":{"type":"array","items":{"type":"object","properties":{"startUtc":{"type":"string"},"endUtc":{"type":"string"}},"required":["startUtc","endUtc"]}}},"required":["locationId","fromDate","toDate","timeZone","fellBackToUtc"]}},"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"methods":{"type":"array","items":{"type":"object","properties":{"paymentType":{"type":"string"},"paymentMethodName":{"anyOf":[{"type":"string"},{"type":"null"}]},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unknownRefundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["paymentType","paymentMethodName","saleCents","refundedCents","netCents","refundAmountCents","unknownRefundCount","sharePercent"]}},"locations":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"figures":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundAmountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"knownVatCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"averageItemsPerSale":{"anyOf":[{"type":"number"},{"type":"null"}]},"quantities":{"type":"array","items":{"type":"object","properties":{"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lineCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quantityUnit","quantityMilli","lineCount"]}},"coverage":{"type":"object","properties":{"missingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingSaleSnapshotCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unresolvedImportedOrderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"unresolvedImportedOrderCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodMissingSaleSnapshotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"periodUndatedRefundPaymentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"salesComplete":{"type":"boolean"},"refundsComplete":{"type":"boolean"},"vatComplete":{"type":"boolean"},"saleUnknownTaxLineCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownTaxCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundUnknownComponentsCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timezoneFallbackCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["missingSaleSnapshotCount","missingSaleSnapshotCents","unresolvedImportedOrderCount","unresolvedImportedOrderCents","undatedRefundCents","undatedRefundPaymentCount","periodMissingSaleSnapshotCount","periodUndatedRefundPaymentCount","salesComplete","refundsComplete","vatComplete","saleUnknownTaxLineCount","refundUnknownTaxCount","refundUnknownComponentsCount","timezoneFallbackCount"]}},"required":["grossCents","discountCents","saleCents","refundCents","netCents","saleCount","refundCount","refundAmountCents","municipalityFeeCents","refundedFeeCents","refundTipCents","tipCents","knownVatCents","vatCents","netWithoutVatCents","averageSaleCents","averageItemsPerSale","quantities","coverage"]},"sharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["locationId","figures","sharePercent"]}},"buckets":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"localDate":{"type":"string"},"localHour":{"type":"integer","minimum":0,"maximum":23},"businessDate":{"type":"string","description":"The business date the period holds this bucket by: for a venue whose current hours run past midnight, the operating day an after-midnight event belongs to; otherwise localDate. localDate stays the factual calendar date."},"businessHour":{"type":"integer","minimum":0,"maximum":23,"description":"The hour this bucket reports in, on the clock of the venue's current time zone when its hours run past midnight; otherwise localHour. localHour stays the factual hour."},"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tradingRevenueCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"saleCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["locationId","localDate","localHour","businessDate","businessHour","grossCents","discountCents","refundCents","netCents","tradingRevenueCents","saleCount","refundCount"]}}},"required":["currency","figures","methods","locations","buckets"]}}},"required":["windows","currencies"]}},"required":["current","previous"]},"financialPerformance":{"type":"object","properties":{"merchants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"locations":{"type":"integer","minimum":0,"maximum":9007199254740991},"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"current":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"complete":{"type":"boolean"},"commissionCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"payoutCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["grossCents","discountCents","refundCents","netCents","vatCents","netWithoutVatCents","orderCount","averageSaleCents","complete","commissionCents","payoutCents"]},"previous":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"complete":{"type":"boolean"},"commissionCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"payoutCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["grossCents","discountCents","refundCents","netCents","vatCents","netWithoutVatCents","orderCount","averageSaleCents","complete","commissionCents","payoutCents"]}},"required":["id","name","locations","rateBps","current","previous"]}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"organizationId":{"type":"string"},"timeZone":{"type":"string"},"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"},"previousFromDate":{"type":"string","format":"date"},"previousToDate":{"type":"string","format":"date"},"current":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"complete":{"type":"boolean"}},"required":["grossCents","discountCents","refundCents","netCents","vatCents","netWithoutVatCents","orderCount","averageSaleCents","complete"]},"previous":{"type":"object","properties":{"grossCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"vatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"netWithoutVatCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"averageSaleCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"complete":{"type":"boolean"}},"required":["grossCents","discountCents","refundCents","netCents","vatCents","netWithoutVatCents","orderCount","averageSaleCents","complete"]}},"required":["id","name","organizationId","timeZone","fromDate","toDate","previousFromDate","previousToDate","current","previous"]}}},"required":["merchants","locations"]},"financialSettlement":{"type":"object","properties":{"current":{"type":"object","properties":{"commissionCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"payoutCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["commissionCents","payoutCents"]},"previous":{"type":"object","properties":{"commissionCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"payoutCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["commissionCents","payoutCents"]}},"required":["current","previous"]},"financialTrading":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"complete":{"type":"boolean"},"hasTimezoneFallback":{"type":"boolean"},"data":{"type":"object","properties":{"timeZone":{"type":"string"},"fellBackToUtc":{"type":"boolean"},"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"},"locationCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"timeZonesDiffer":{"type":"boolean"},"spansMultipleDays":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"on":{"type":"string","format":"date"}},"required":["netCents","orderCount","on"]}},"cells":{"type":"array","items":{"type":"object","properties":{"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"weekday":{"type":"integer","minimum":1,"maximum":7},"hour":{"type":"integer","minimum":0,"maximum":23}},"required":["netCents","orderCount","weekday","hour"]}},"peak":{"type":"object","properties":{"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"orderCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["netCents","orderCount"]}},"required":["timeZone","fellBackToUtc","fromDate","toDate","locationCount","timeZonesDiffer","spansMultipleDays","days","cells","peak"]}},"required":["currency","complete","hasTimezoneFallback","data"]}},"financialItems":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string"},"coverageComplete":{"type":"boolean"},"unitsComparable":{"type":"boolean"},"revenueCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityMilli":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"bestByRevenue":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"catalogItemId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"merchantName":{"type":"string"},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"unitSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastSoldOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["id","catalogItemId","name","quantityMilli","quantityUnit","netCents","revenueSharePercent","unitSharePercent","lastSoldOn"]}},"leastByRevenue":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"catalogItemId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"merchantName":{"type":"string"},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"unitSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastSoldOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["id","catalogItemId","name","quantityMilli","quantityUnit","netCents","revenueSharePercent","unitSharePercent","lastSoldOn"]}},"bestByUnits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"catalogItemId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"merchantName":{"type":"string"},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"unitSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastSoldOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["id","catalogItemId","name","quantityMilli","quantityUnit","netCents","revenueSharePercent","unitSharePercent","lastSoldOn"]}},"leastByUnits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"catalogItemId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"merchantName":{"type":"string"},"quantityMilli":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"quantityUnit":{"anyOf":[{"type":"string"},{"type":"null"}]},"netCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revenueSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"unitSharePercent":{"anyOf":[{"type":"number"},{"type":"null"}]},"lastSoldOn":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["id","catalogItemId","name","quantityMilli","quantityUnit","netCents","revenueSharePercent","unitSharePercent","lastSoldOn"]}}},"required":["currency","coverageComplete","unitsComparable","revenueCents","quantityMilli","bestByRevenue","leastByRevenue","bestByUnits","leastByUnits"]}}},"required":["asOf","currency","currencies","scope","window","financial","financialPerformance","financialSettlement","financialTrading","financialItems"]}}}}}}},"/api/public/v1/enterprises/snapshotBatches":{"post":{"operationId":"enterprises.snapshotBatches","description":"Reads the enterprises.snapshotBatches procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}}},{"type":"object","properties":{"merchantId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1},"eventId":{"type":"string","minLength":1},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterprises/dashboard":{"post":{"operationId":"enterprises.dashboard","description":"Reads the enterprises.dashboard procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}}},{"type":"object","properties":{"merchantId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1},"eventId":{"type":"string","minLength":1},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterprises/dashboardExport":{"post":{"operationId":"enterprises.dashboardExport","summary":"Legacy enterprise CSV; download /api/enterprise-exports/v1 reports instead.","description":"Reads the enterprises.dashboardExport procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","properties":{"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}}},{"type":"object","properties":{"merchantId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1},"eventId":{"type":"string","minLength":1},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}}}]},{"type":"object","properties":{"report":{"enum":["summary","merchants","locations"],"type":"string"}},"required":["report"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterprises/dashboardExportV2":{"post":{"operationId":"enterprises.dashboardExportV2","summary":"Legacy enterprise CSV; download /api/enterprise-exports/v1 reports instead.","description":"Reads the enterprises.dashboardExportV2 procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"type":"object","properties":{"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}}},{"type":"object","properties":{"merchantId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1},"eventId":{"type":"string","minLength":1},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}}}]},{"type":"object","properties":{"report":{"enum":["summary","merchants","locations"],"type":"string"}},"required":["report"]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string"},"csv":{"type":"string"}},"required":["filename","csv"]}}}}}}},"/api/public/v1/enterprises/list":{"post":{"operationId":"enterprises.list","description":"Reads the enterprises.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterprises/merchants":{"post":{"operationId":"enterprises.merchants","description":"Reads the enterprises.merchants procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterprises/overview":{"post":{"operationId":"enterprises.overview","summary":"Legacy enterprise overview; call enterprises.overviewV2 instead.","description":"Reads the enterprises.overview procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterprises/overviewV2":{"post":{"operationId":"enterprises.overviewV2","description":"Reads the enterprises.overviewV2 procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"totals":{"type":"object","properties":{"locations":{"type":"integer","minimum":0,"maximum":9007199254740991},"members":{"type":"integer","minimum":0,"maximum":9007199254740991},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"ordersByStatus":{"type":"object","propertyNames":{"enum":["new","in_progress","done","cancelled"],"type":"string"},"additionalProperties":{"type":"integer","minimum":0,"maximum":9007199254740991}},"catalogItems":{"type":"integer","minimum":0,"maximum":9007199254740991},"merchants":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["locations","members","orders","ordersByStatus","catalogItems","merchants"]},"merchants":{"type":"array","items":{"type":"object","properties":{"organizationId":{"type":"string"},"name":{"type":"string"},"locations":{"type":"integer","minimum":0,"maximum":9007199254740991},"members":{"type":"integer","minimum":0,"maximum":9007199254740991},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"ordersByStatus":{"type":"object","propertyNames":{"enum":["new","in_progress","done","cancelled"],"type":"string"},"additionalProperties":{"type":"integer","minimum":0,"maximum":9007199254740991}},"catalogItems":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["organizationId","name","locations","members","orders","ordersByStatus","catalogItems"]}}},"required":["totals","merchants"]}}}}}}},"/api/public/v1/enterprises/merchantCatalog":{"post":{"operationId":"enterprises.merchantCatalog","description":"Reads the enterprises.merchantCatalog procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/suppliers/create":{"post":{"operationId":"suppliers.create","description":"Runs the suppliers.create procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug"]}}}}}}},"/api/public/v1/suppliers/invite":{"post":{"operationId":"suppliers.invite","description":"Runs the suppliers.invite procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"userEmail":{"type":"string","format":"email"}},"required":["organizationId","userEmail"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string"},"mailed":{"type":"boolean"}},"required":["userId","mailed"]}}}}}}},"/api/public/v1/suppliers/privacy":{"post":{"operationId":"suppliers.privacy","summary":"Read a supplier's private or public setting","description":"Returns the enterprise the supplier is private to, null while it is public, and the enterprises it shares at least one live location with, by name: the ones it may be private to. Refused with NOT_FOUND and the refusal supplierNotFound for an organization that is not a supplier. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"privateToEnterpriseId":{"anyOf":[{"type":"string"},{"type":"null"}]},"enterprises":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}},"required":["privateToEnterpriseId","enterprises"]}}}}}}},"/api/public/v1/suppliers/setPrivacy":{"post":{"operationId":"suppliers.setPrivacy","summary":"Make a supplier private to an enterprise, or public","description":"Makes the supplier private to privateToEnterpriseId, the one enterprise whose locations its shipment orders go to, or public with null, and returns the setting as suppliers.privacy does. A supplier shares with several enterprises but is private to at most one; a share ending later clears nothing, but the supplier then has no buyers until the setting changes. Refused with NOT_FOUND and the refusal supplierNotFound for an organization that is not a supplier, and with CONFLICT and the refusal enterpriseNotShared for an enterprise the supplier shares no live location with. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"privateToEnterpriseId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["organizationId","privateToEnterpriseId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"privateToEnterpriseId":{"anyOf":[{"type":"string"},{"type":"null"}]},"enterprises":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}},"required":["privateToEnterpriseId","enterprises"]}}}}}}},"/api/public/v1/enterpriseEvents/activeForLocation":{"post":{"operationId":"enterpriseEvents.activeForLocation","description":"Reads the enterpriseEvents.activeForLocation procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":200}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/participationForLocation":{"post":{"operationId":"enterpriseEvents.participationForLocation","description":"Reads the enterpriseEvents.participationForLocation procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":200}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200},"name":{"type":"string"}},"required":["id","name"]}},"nextChangeAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]}},"required":["events","nextChangeAt"]}}}}}}},"/api/public/v1/enterpriseEvents/list":{"post":{"operationId":"enterpriseEvents.list","description":"Reads the enterpriseEvents.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"includeArchived":{"type":"boolean"},"query":{"type":"string","maxLength":200},"page":{"type":"integer","minimum":1,"maximum":9007199254740991}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/availableParticipants":{"post":{"operationId":"enterpriseEvents.availableParticipants","description":"Reads the enterpriseEvents.availableParticipants procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/get":{"post":{"operationId":"enterpriseEvents.get","description":"Reads the enterpriseEvents.get procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200},"assignmentPage":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["eventId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/setVendorCommission":{"post":{"operationId":"enterpriseEvents.setVendorCommission","description":"Runs the enterpriseEvents.setVendorCommission procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200},"organizationId":{"type":"string","minLength":1,"maxLength":200},"rateBps":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000},{"type":"null"}]}},"required":["eventId","organizationId","rateBps"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/create":{"post":{"operationId":"enterpriseEvents.create","description":"Runs the enterpriseEvents.create procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"timeZone":{"type":"string","minLength":1}},"required":["name","startsAt","endsAt","timeZone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/update":{"post":{"operationId":"enterpriseEvents.update","description":"Runs the enterpriseEvents.update procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"timeZone":{"type":"string","minLength":1},"eventId":{"type":"string","minLength":1,"maxLength":200}},"required":["name","startsAt","endsAt","timeZone","eventId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/archive":{"post":{"operationId":"enterpriseEvents.archive","description":"Runs the enterpriseEvents.archive procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200}},"required":["eventId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/addParticipation":{"post":{"operationId":"enterpriseEvents.addParticipation","description":"Runs the enterpriseEvents.addParticipation procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200},"locationId":{"type":"string","minLength":1,"maxLength":200},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"}},"required":["eventId","locationId","startsAt","endsAt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/updateParticipation":{"post":{"operationId":"enterpriseEvents.updateParticipation","description":"Runs the enterpriseEvents.updateParticipation procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"participationId":{"type":"string","minLength":1,"maxLength":200},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"}},"required":["participationId","startsAt","endsAt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEvents/archiveParticipation":{"post":{"operationId":"enterpriseEvents.archiveParticipation","description":"Runs the enterpriseEvents.archiveParticipation procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"participationId":{"type":"string","minLength":1,"maxLength":200}},"required":["participationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventInvitations/get":{"post":{"operationId":"enterpriseEventInvitations.get","description":"Reads the enterpriseEventInvitations.get procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200}},"required":["eventId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventInvitations/enable":{"post":{"operationId":"enterpriseEventInvitations.enable","description":"Runs the enterpriseEventInvitations.enable procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200}},"required":["eventId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventInvitations/rotate":{"post":{"operationId":"enterpriseEventInvitations.rotate","description":"Runs the enterpriseEventInvitations.rotate procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200}},"required":["eventId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventInvitations/disable":{"post":{"operationId":"enterpriseEventInvitations.disable","description":"Runs the enterpriseEventInvitations.disable procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200}},"required":["eventId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventInvitations/preview":{"post":{"operationId":"enterpriseEventInvitations.preview","description":"Reads the enterpriseEventInvitations.preview procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventInvitations/choices":{"post":{"operationId":"enterpriseEventInvitations.choices","description":"Reads the enterpriseEventInvitations.choices procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventInvitations/join":{"post":{"operationId":"enterpriseEventInvitations.join","description":"Runs the enterpriseEventInvitations.join procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"},"organizationId":{"type":"string","minLength":1,"maxLength":200},"locationIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":200}},"consent":{"const":true}},"required":["token","organizationId","locationIds","consent"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventInvitations/listSharing":{"post":{"operationId":"enterpriseEventInvitations.listSharing","description":"Reads the enterpriseEventInvitations.listSharing procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":200}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventInvitations/revokeSharing":{"post":{"operationId":"enterpriseEventInvitations.revokeSharing","description":"Runs the enterpriseEventInvitations.revokeSharing procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":200},"enterpriseId":{"type":"string","minLength":1,"maxLength":200},"locationId":{"type":"string","minLength":1,"maxLength":200}},"required":["organizationId","enterpriseId","locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseMerchantInvitations/get":{"post":{"operationId":"enterpriseMerchantInvitations.get","description":"Reads the enterpriseMerchantInvitations.get procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseMerchantInvitations/enable":{"post":{"operationId":"enterpriseMerchantInvitations.enable","description":"Runs the enterpriseMerchantInvitations.enable procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseMerchantInvitations/disable":{"post":{"operationId":"enterpriseMerchantInvitations.disable","description":"Runs the enterpriseMerchantInvitations.disable procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseMerchantInvitations/preview":{"post":{"operationId":"enterpriseMerchantInvitations.preview","description":"Reads the enterpriseMerchantInvitations.preview procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseMerchantInvitations/choices":{"post":{"operationId":"enterpriseMerchantInvitations.choices","description":"Reads the enterpriseMerchantInvitations.choices procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"}},"required":["token"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseMerchantInvitations/join":{"post":{"operationId":"enterpriseMerchantInvitations.join","description":"Runs the enterpriseMerchantInvitations.join procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","pattern":"^[A-Za-z0-9_-]{43}$"},"organizationId":{"type":"string","minLength":1,"maxLength":200},"locationIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":200}},"consent":{"const":true}},"required":["token","organizationId","locationIds","consent"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventReports/get":{"post":{"operationId":"enterpriseEventReports.get","description":"Reads the enterpriseEventReports.get procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200}},"required":["eventId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseEventReports/exportCsv":{"post":{"operationId":"enterpriseEventReports.exportCsv","description":"Reads the enterpriseEventReports.exportCsv procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventId":{"type":"string","minLength":1,"maxLength":200}},"required":["eventId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/list":{"post":{"operationId":"enterpriseTerminals.list","description":"Reads the enterpriseTerminals.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"includeArchived":{"type":"boolean"},"query":{"type":"string","maxLength":200},"page":{"type":"integer","minimum":1,"maximum":9007199254740991}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/locations":{"post":{"operationId":"enterpriseTerminals.locations","description":"Reads the enterpriseTerminals.locations procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/history":{"post":{"operationId":"enterpriseTerminals.history","description":"Reads the enterpriseTerminals.history procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"terminalId":{"type":"string","minLength":1,"maxLength":200},"page":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["terminalId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/create":{"post":{"operationId":"enterpriseTerminals.create","description":"Runs the enterpriseTerminals.create procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"inventoryNumber":{"type":"string","minLength":1,"maxLength":100},"merchantId":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"terminalExternalId":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"provider":{"anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"null"}]}},"required":["name","inventoryNumber"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/update":{"post":{"operationId":"enterpriseTerminals.update","description":"Runs the enterpriseTerminals.update procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"inventoryNumber":{"type":"string","minLength":1,"maxLength":100},"merchantId":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"terminalExternalId":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"provider":{"anyOf":[{"type":"string","minLength":1,"maxLength":100},{"type":"null"}]},"terminalId":{"type":"string","minLength":1,"maxLength":200}},"required":["name","inventoryNumber","terminalId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/archive":{"post":{"operationId":"enterpriseTerminals.archive","description":"Runs the enterpriseTerminals.archive procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"terminalId":{"type":"string","minLength":1,"maxLength":200}},"required":["terminalId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/assign":{"post":{"operationId":"enterpriseTerminals.assign","description":"Runs the enterpriseTerminals.assign procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"maxLength":200},"participationId":{"type":"string","minLength":1,"maxLength":200},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"terminals":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"source":{"const":"fortis","default":"fortis"},"merchantId":{"type":"string","minLength":1,"maxLength":200},"terminalExternalId":{"type":"string","minLength":1,"maxLength":200},"provider":{"type":"string","minLength":1,"maxLength":100},"terminalId":{"type":"string","minLength":1,"maxLength":200}},"required":["terminalId"]}}},"required":["endsAt","terminals"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/return":{"post":{"operationId":"enterpriseTerminals.return","description":"Runs the enterpriseTerminals.return procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assignmentId":{"type":"string","minLength":1,"maxLength":200}},"required":["assignmentId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/transfer":{"post":{"operationId":"enterpriseTerminals.transfer","description":"Runs the enterpriseTerminals.transfer procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"const":"fortis","default":"fortis"},"merchantId":{"type":"string","minLength":1,"maxLength":200},"terminalExternalId":{"type":"string","minLength":1,"maxLength":200},"provider":{"type":"string","minLength":1,"maxLength":100},"assignmentId":{"type":"string","minLength":1,"maxLength":200},"locationId":{"type":"string","minLength":1,"maxLength":200},"participationId":{"type":"string","minLength":1,"maxLength":200},"endsAt":{"type":"string","format":"date-time"}},"required":["assignmentId","endsAt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/cancelAssignment":{"post":{"operationId":"enterpriseTerminals.cancelAssignment","description":"Runs the enterpriseTerminals.cancelAssignment procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assignmentId":{"type":"string","minLength":1,"maxLength":200}},"required":["assignmentId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/enterpriseTerminals/updateAssignment":{"post":{"operationId":"enterpriseTerminals.updateAssignment","description":"Runs the enterpriseTerminals.updateAssignment procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source":{"const":"fortis","default":"fortis"},"merchantId":{"type":"string","minLength":1,"maxLength":200},"terminalExternalId":{"type":"string","minLength":1,"maxLength":200},"provider":{"type":"string","minLength":1,"maxLength":100},"assignmentId":{"type":"string","minLength":1,"maxLength":200},"locationId":{"type":"string","minLength":1,"maxLength":200},"participationId":{"type":"string","minLength":1,"maxLength":200},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"}},"required":["assignmentId","startsAt","endsAt"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/fortis/importStatus":{"post":{"operationId":"fortis.importStatus","description":"Reads the fortis.importStatus procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/fortisSyncAdmin/list":{"post":{"operationId":"fortisSyncAdmin.list","description":"Reads the fortisSyncAdmin.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/fortisSyncAdmin/end":{"post":{"operationId":"fortisSyncAdmin.end","description":"Runs the fortisSyncAdmin.end procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"reason":{"type":"string","minLength":1,"maxLength":500,"default":"Transition to FortuneOS completed"}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/fortisSyncAdmin/resume":{"post":{"operationId":"fortisSyncAdmin.resume","description":"Runs the fortisSyncAdmin.resume procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/kitchen/getAccess":{"post":{"operationId":"kitchen.getAccess","description":"Returns how far the venue's Kitchen Desk runs: mode `full` while it takes new kitchen tickets; `drain` while it takes none, because the venue switched the Kitchen Desk off or the plan's restriction policy takes it away and is enforced, and an order the board shows still holds a received ticket; `closed` once none is left. refusal names why new tickets stopped: `kitchenDeskDisabled`, `featureRestrictedByPlan`, or `featureNotEntitled` when the plan does not stand; null in `full`. Refused with FORBIDDEN and refusal `featureNotEntitled` when the plan lacks the Kitchen Desk at the venue and it is enforced. It authorizes nothing. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1},"exactShift":{"const":true},"tableId":{"type":"string","minLength":1},"status":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["new","in_progress","done","cancelled"],"type":"string"}},"types":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["dine_in","takeaway","delivery","shipment"],"type":"string"}},"createdAfter":{"type":"string","format":"date"},"dateRange":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"]}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"enum":["full","drain","closed"],"type":"string"},"refusal":{"anyOf":[{"enum":["kitchenDeskDisabled","featureRestrictedByPlan","featureNotEntitled"],"type":"string"},{"type":"null"}]}},"required":["mode","refusal"]}}}}}}},"/api/public/v1/kitchen/board":{"post":{"operationId":"kitchen.board","summary":"Read the Kitchen Desk's board","description":"Returns what the Kitchen Desk renders for a venue: the orders of orders.board with kitchenPendingOnly true (open orders, and terminal orders activated on or after 00:00 UTC on createdAfter, holding at least one kitchen ticket still received, cancelled ones included), each carrying only its unvoided lines frozen onto a kitchen ticket, so a round sent while the venue admitted no new kitchen ticket, because its Kitchen Desk was switched off or the plan's restriction policy took it away, never appears. A createdAfter older than the Kitchen Desk's own window (two days) reads that window instead. At most 1,000 orders, open orders first, in board position order. Refused with FORBIDDEN and refusal `featureNotEntitled` when the plan lacks the Kitchen Desk at the venue and it is enforced, `licenseNotPaid` when the venue holds no Kitchen Desk licence its organization's ledger requires, and, once the venue takes no new kitchen ticket and nothing is left to drain, `kitchenDeskDisabled`, `featureRestrictedByPlan` or `featureNotEntitled` as kitchen.getTimerThresholds refuses. A caller with order:readAllShifts always sees every shift and shiftId is ignored; any other caller must name a shift they actively take part in. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1},"createdAfter":{"type":"string","format":"date"}},"required":["locationId","createdAfter"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"tablePrefix":{"type":"string"},"tableNumber":{"anyOf":[{"type":"number"},{"type":"null"}]},"tableSectionName":{"anyOf":[{"type":"string"},{"type":"null"}]},"pagerNumber":{"anyOf":[{"type":"number"},{"type":"null"}]},"pagerReturnedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"orderType":{"not":{}},"status":{"not":{}},"position":{"type":"number"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"saleComment":{"anyOf":[{"type":"string"},{"type":"null"}]},"deliveryChannel":{"not":{}},"cancelReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"number"},{"type":"null"}]},"kitchenChangedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"number"},"isReady":{"type":"boolean"},"kitchenTicketId":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"itemVariationName":{"anyOf":[{"type":"string"},{"type":"null"}]},"stationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiers":{"type":"array","items":{"type":"object","properties":{"modifierId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"type":"string"},"groupName":{"type":"string"},"priceDeltaCents":{"type":"number"},"quantity":{"type":"number"}},"required":["modifierId","name","groupName","priceDeltaCents","quantity"]}}},"required":["id","name","quantity","isReady","kitchenTicketId","notes","itemVariationName","stationId","modifiers"]}},"kitchenTickets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"orderId":{"type":"string"},"stationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"not":{}},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","orderId","stationId","status","updatedAt","createdAt"]}}},"required":["id","tablePrefix","tableNumber","tableSectionName","pagerNumber","pagerReturnedAt","orderType","status","position","notes","saleComment","deliveryChannel","cancelReason","orderNumber","kitchenChangedAt","createdAt","items","kitchenTickets"]}}}}}}}},"/api/public/v1/kitchen/getTimerThresholds":{"post":{"operationId":"kitchen.getTimerThresholds","description":"Returns the venue's Kitchen Desk aging thresholds in minutes, null for the platform default. Refused with FORBIDDEN and refusal `featureNotEntitled` when the plan lacks the Kitchen Desk at the venue and it is enforced. While the venue takes no new kitchen ticket it is served until no order the board shows holds a received ticket; afterwards refused with FORBIDDEN and refusal `kitchenDeskDisabled` when the Kitchen Desk is switched off, `featureRestrictedByPlan` when the plan's restriction policy takes it away and is enforced, or `featureNotEntitled` when the plan does not stand. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1},"exactShift":{"const":true},"tableId":{"type":"string","minLength":1},"status":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["new","in_progress","done","cancelled"],"type":"string"}},"types":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["dine_in","takeaway","delivery","shipment"],"type":"string"}},"createdAfter":{"type":"string","format":"date"},"dateRange":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"]}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/kitchen/ready":{"post":{"operationId":"kitchen.ready","description":"Runs the kitchen.ready procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/kitchen/readyMany":{"post":{"operationId":"kitchen.readyMany","description":"Runs the kitchen.readyMany procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"ticketIds":{"type":"array","items":{"type":"string","minLength":1}}},"required":["locationId","ticketIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/mailDelivery/search":{"post":{"operationId":"mailDelivery.search","description":"Reads the mailDelivery.search procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string"}},"required":["address"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"suppression":{"anyOf":[{"type":"object","properties":{"address":{"type":"string"},"reason":{"enum":["bounce","complaint"],"type":"string"},"since":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["address","reason","since"]},{"type":"null"}]},"deliveries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"template":{"type":"string"},"brandId":{"type":"string"},"locale":{"type":"string"},"skipped":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"enum":["sent","delivered","delivery_delayed","bounced","complained","failed","suppressed"],"type":"string"},"bounceType":{"anyOf":[{"type":"string"},{"type":"null"}]},"bounceSubType":{"anyOf":[{"type":"string"},{"type":"null"}]},"bounceMessage":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurredAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","type","bounceType","bounceSubType","bounceMessage","occurredAt"]}}},"required":["id","template","brandId","locale","skipped","createdAt","events"]}},"emails":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"brandId":{"anyOf":[{"type":"string"},{"type":"null"}]},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"enum":["sent","delivered","delivery_delayed","bounced","complained","failed","suppressed"],"type":"string"},"bounceType":{"anyOf":[{"type":"string"},{"type":"null"}]},"bounceSubType":{"anyOf":[{"type":"string"},{"type":"null"}]},"bounceMessage":{"anyOf":[{"type":"string"},{"type":"null"}]},"occurredAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","type","bounceType","bounceSubType","bounceMessage","occurredAt"]}}},"required":["id","subject","brandId","events"]}}},"required":["suppression","deliveries","emails"]}}}}}}},"/api/public/v1/mailDelivery/clearSuppression":{"post":{"operationId":"mailDelivery.clearSuppression","description":"Runs the mailDelivery.clearSuppression procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string"}},"required":["address"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"cleared":{"type":"boolean"}},"required":["cleared"]}}}}}}},"/api/public/v1/mailDelivery/exportBounces":{"post":{"operationId":"mailDelivery.exportBounces","description":"Reads the mailDelivery.exportBounces procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"csv":{"type":"string"},"truncated":{"type":"boolean"}},"required":["csv","truncated"]}}}}}}},"/api/public/v1/mailDelivery/myAddressStatus":{"post":{"operationId":"mailDelivery.myAddressStatus","description":"Reads the mailDelivery.myAddressStatus procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"undeliverable":{"type":"boolean"}},"required":["undeliverable"]}}}}}}},"/api/public/v1/myFatoorahDocuments/list":{"post":{"operationId":"myFatoorahDocuments.list","description":"Reads the myFatoorahDocuments.list procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/myFatoorahDocuments/confirm":{"post":{"operationId":"myFatoorahDocuments.confirm","description":"Runs the myFatoorahDocuments.confirm procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/myFatoorahDocuments/resubmit":{"post":{"operationId":"myFatoorahDocuments.resubmit","description":"Runs the myFatoorahDocuments.resubmit procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/myFatoorahPaymentMethods/list":{"post":{"operationId":"myFatoorahPaymentMethods.list","description":"Reads the myFatoorahPaymentMethods.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/myFatoorahPaymentMethods/refresh":{"post":{"operationId":"myFatoorahPaymentMethods.refresh","description":"Runs the myFatoorahPaymentMethods.refresh procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/myFatoorahPaymentMethods/setEnabled":{"post":{"operationId":"myFatoorahPaymentMethods.setEnabled","description":"Runs the myFatoorahPaymentMethods.setEnabled procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"paymentMethodId":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isEnabled":{"type":"boolean"}},"required":["paymentMethodId","isEnabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/myFatoorahPaymentMethods/setCommission":{"post":{"operationId":"myFatoorahPaymentMethods.setCommission","description":"Runs the myFatoorahPaymentMethods.setCommission procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"paymentMethodId":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"commissionValue":{"type":"number","minimum":0},"commissionPercentage":{"type":"number","minimum":0,"maximum":1},"isPercentageOfNetValue":{"type":"boolean"}},"required":["paymentMethodId","commissionValue","commissionPercentage","isPercentageOfNetValue"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/applePayDomains/status":{"post":{"operationId":"applePayDomains.status","description":"Reads the applePayDomains.status procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"enum":["sandbox","production"],"type":"string"},"hosts":{"type":"array","items":{"type":"object","properties":{"hostname":{"type":"string"},"registration":{"anyOf":[{"type":"object","properties":{"succeeded":{"type":"boolean"},"message":{"type":"string"},"registeredAt":{"type":"string","format":"date-time"},"actorName":{"type":"string"}},"required":["succeeded","message","registeredAt","actorName"]},{"type":"null"}]}},"required":["hostname","registration"]}}},"required":["environment","hosts"]}}}}}}},"/api/public/v1/applePayDomains/register":{"post":{"operationId":"applePayDomains.register","description":"Runs the applePayDomains.register procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hostname":{"type":"string"}},"required":["hostname"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"succeeded":{"type":"boolean"},"message":{"type":"string"},"registeredAt":{"type":"string","format":"date-time"},"actorName":{"type":"string"}},"required":["succeeded","message","registeredAt","actorName"]}}}}}}},"/api/public/v1/myFatoorahRecovery/run":{"post":{"operationId":"myFatoorahRecovery.run","description":"Runs the myFatoorahRecovery.run procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}},"required":["start","end"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/notificationSettings/supplierReview":{"post":{"operationId":"notificationSettings.supplierReview","description":"Reads the notificationSettings.supplierReview procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/notificationSettings/saveSupplierReview":{"post":{"operationId":"notificationSettings.saveSupplierReview","description":"Runs the notificationSettings.saveSupplierReview procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"channelId":{"anyOf":[{"type":"string","pattern":"^[CG][A-Z0-9]{8,}$"},{"const":""}]}},"required":["isEnabled","channelId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/notificationSettings/paymentIssues":{"post":{"operationId":"notificationSettings.paymentIssues","description":"Reads the notificationSettings.paymentIssues procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"channelId":{"anyOf":[{"type":"string","pattern":"^[CG][A-Z0-9]{8,}$"},{"const":""}]}},"required":["isEnabled","channelId"]}}}}}}},"/api/public/v1/notificationSettings/savePaymentIssues":{"post":{"operationId":"notificationSettings.savePaymentIssues","description":"Runs the notificationSettings.savePaymentIssues procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"channelId":{"anyOf":[{"type":"string","pattern":"^[CG][A-Z0-9]{8,}$"},{"const":""}]}},"required":["isEnabled","channelId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"channelId":{"anyOf":[{"type":"string","pattern":"^[CG][A-Z0-9]{8,}$"},{"const":""}]}},"required":["isEnabled","channelId"]}}}}}}},"/api/public/v1/userNotifications/list":{"post":{"operationId":"userNotifications.list","description":"Reads the userNotifications.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"supportedTypes":{"type":"array","minItems":1,"maxItems":3,"items":{"enum":["systemMessage","catalogSuggestion","reportExport"],"type":"string"}},"cursor":{"anyOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"id":{"type":"string","minLength":1}},"required":["createdAt","id"]},{"type":"null"}]}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"notifications":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"const":"systemMessage"},"payload":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"body":{"type":"string","minLength":1,"maxLength":2000}},"required":["title","body"]},"id":{"type":"string"},"readAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["type","payload","id","readAt","createdAt"]},{"type":"object","properties":{"type":{"const":"catalogSuggestion"},"payload":{"type":"object","properties":{"catalogId":{"type":"string","minLength":1},"dispatchId":{"type":"string","minLength":1},"proposal":{"type":"object","properties":{"schemaVersion":{"const":"catalog-organization-diff/v1"},"status":{"enum":["proposed","no_change","failed"],"type":"string"},"changes":{"type":"array","maxItems":500,"items":{"anyOf":[{"type":"object","properties":{"type":{"const":"create_category"},"id":{"type":"string","pattern":"^new:[a-z0-9][a-z0-9-]{0,63}$"},"name":{"type":"string","minLength":1,"maxLength":255},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","name","parentCategoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"rename_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeName":{"type":"string","maxLength":255},"name":{"type":"string","minLength":1,"maxLength":255},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeName","name","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"move_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeParentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"parentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeParentCategoryId","parentCategoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"move_item"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"categoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeCategoryId","categoryId","reason"],"additionalProperties":false},{"type":"object","properties":{"type":{"const":"archive_empty_category"},"id":{"type":"string","minLength":1,"maxLength":255},"beforeName":{"type":"string","maxLength":255},"beforeParentCategoryId":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"reason":{"type":"object","properties":{"problem":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"string","minLength":1,"maxLength":2000},"benefit":{"type":"string","minLength":1,"maxLength":2000}},"required":["problem","evidence","benefit"],"additionalProperties":false}},"required":["type","id","beforeName","beforeParentCategoryId","reason"],"additionalProperties":false}]}},"failureReason":{"type":"string","minLength":1,"maxLength":2000}},"required":["schemaVersion","status","changes"],"additionalProperties":false}},"required":["catalogId","dispatchId","proposal"]},"id":{"type":"string"},"readAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["type","payload","id","readAt","createdAt"]},{"type":"object","properties":{"type":{"const":"reportExport"},"payload":{"type":"object","properties":{"jobId":{"type":"string","format":"uuid"},"kind":{"enum":["merchant","enterprise"],"type":"string"},"report":{"enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails","merchants","events"],"type":"string"},"format":{"enum":["csv","pdf"],"type":"string"},"status":{"enum":["ready","failed"],"type":"string"},"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"}},"required":["jobId","kind","report","format","status","fromDate","toDate"]},"id":{"type":"string"},"readAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["type","payload","id","readAt","createdAt"]}]}},"nextCursor":{"anyOf":[{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"id":{"type":"string","minLength":1}},"required":["createdAt","id"]},{"type":"null"}]}},"required":["notifications","nextCursor"]}}}}}}},"/api/public/v1/userNotifications/unreadCount":{"post":{"operationId":"userNotifications.unreadCount","description":"Reads the userNotifications.unreadCount procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"supportedTypes":{"type":"array","minItems":1,"maxItems":3,"items":{"enum":["systemMessage","catalogSuggestion","reportExport"],"type":"string"}}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","minimum":0,"maximum":9007199254740991}}}}}}},"/api/public/v1/userNotifications/markRead":{"post":{"operationId":"userNotifications.markRead","description":"Runs the userNotifications.markRead procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"ids":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1}}},"required":["organizationId","ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/userNotifications/markAllRead":{"post":{"operationId":"userNotifications.markAllRead","description":"Runs the userNotifications.markAllRead procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/userNotifications/onCreated":{"post":{"operationId":"userNotifications.onCreated","description":"Runs the userNotifications.onCreated procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"supportedTypes":{"type":"array","minItems":1,"maxItems":3,"items":{"enum":["systemMessage","catalogSuggestion","reportExport"],"type":"string"}}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/userNotifications/emailPreferences/list":{"post":{"operationId":"userNotifications.emailPreferences.list","description":"Reads the userNotifications.emailPreferences.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"supportedTypes":{"type":"array","minItems":1,"maxItems":3,"items":{"enum":["systemMessage","catalogSuggestion","reportExport"],"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["systemMessage","catalogSuggestion","reportExport"],"type":"string"},"emailEnabled":{"type":"boolean"}},"required":["type","emailEnabled"]}}}}}}}},"/api/public/v1/userNotifications/emailPreferences/set":{"post":{"operationId":"userNotifications.emailPreferences.set","description":"Runs the userNotifications.emailPreferences.set procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"enum":["systemMessage","catalogSuggestion","reportExport"],"type":"string"},"emailEnabled":{"type":"boolean"}},"required":["type","emailEnabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/userNotifications/sendSystemMessage":{"post":{"operationId":"userNotifications.sendSystemMessage","description":"Runs the userNotifications.sendSystemMessage procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"userId":{"type":"string","minLength":1},"title":{"type":"string","minLength":1,"maxLength":120},"body":{"type":"string","minLength":1,"maxLength":2000}},"required":["organizationId","userId","title","body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/onboarding/active":{"post":{"operationId":"onboarding.active","description":"Reads the onboarding.active procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"}},"required":["key"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/onboarding/saveProgress":{"post":{"operationId":"onboarding.saveProgress","description":"Runs the onboarding.saveProgress procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quizId":{"type":"string","minLength":1},"answers":{"type":"array","maxItems":20,"items":{"type":"object","properties":{"questionId":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"},"optionIds":{"type":"array","maxItems":12,"items":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"}},"customText":{"type":"string","minLength":1,"maxLength":500}},"required":["questionId","optionIds"],"additionalProperties":false}}},"required":["quizId","answers"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/onboarding/submit":{"post":{"operationId":"onboarding.submit","description":"Runs the onboarding.submit procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quizId":{"type":"string","minLength":1},"answers":{"type":"array","maxItems":20,"items":{"type":"object","properties":{"questionId":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"},"optionIds":{"type":"array","maxItems":12,"items":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"}},"customText":{"type":"string","minLength":1,"maxLength":500}},"required":["questionId","optionIds"],"additionalProperties":false}},"skipped":{"type":"boolean"}},"required":["quizId","answers","skipped"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/onboarding/list":{"post":{"operationId":"onboarding.list","description":"Reads the onboarding.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/onboarding/create":{"post":{"operationId":"onboarding.create","description":"Runs the onboarding.create procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"},"title":{"type":"string","minLength":1,"maxLength":120},"definition":{"type":"object","properties":{"questions":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"},"kind":{"enum":["single","multi"],"type":"string"},"title":{"type":"string","minLength":1,"maxLength":200},"subtitle":{"type":"string","minLength":1,"maxLength":300},"options":{"type":"array","minItems":1,"maxItems":12,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"},"label":{"type":"string","minLength":1,"maxLength":120}},"required":["id","label"],"additionalProperties":false}},"allowCustom":{"type":"boolean"}},"required":["id","kind","title","options","allowCustom"],"additionalProperties":false}}},"required":["questions"],"additionalProperties":false}},"required":["key","title","definition"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/onboarding/update":{"post":{"operationId":"onboarding.update","description":"Runs the onboarding.update procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"title":{"type":"string","minLength":1,"maxLength":120},"definition":{"type":"object","properties":{"questions":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"},"kind":{"enum":["single","multi"],"type":"string"},"title":{"type":"string","minLength":1,"maxLength":200},"subtitle":{"type":"string","minLength":1,"maxLength":300},"options":{"type":"array","minItems":1,"maxItems":12,"items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$"},"label":{"type":"string","minLength":1,"maxLength":120}},"required":["id","label"],"additionalProperties":false}},"allowCustom":{"type":"boolean"}},"required":["id","kind","title","options","allowCustom"],"additionalProperties":false}}},"required":["questions"],"additionalProperties":false}},"required":["id"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/onboarding/archive":{"post":{"operationId":"onboarding.archive","description":"Runs the onboarding.archive procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/saveTradeLicense":{"post":{"operationId":"organization.saveTradeLicense","description":"Runs the organization.saveTradeLicense procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":256},"receipt":{"type":"string","minLength":64,"maxLength":8192},"expectedId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]}},"required":["organizationId","receipt","expectedId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/tradeLicense":{"post":{"operationId":"organization.tradeLicense","description":"Reads the organization.tradeLicense procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":256}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/createEnterprise":{"post":{"operationId":"organization.createEnterprise","description":"Runs the organization.createEnterprise procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setPaymentMethods":{"post":{"operationId":"organization.setPaymentMethods","description":"Runs the organization.setPaymentMethods procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"enabled":{"type":"array","items":{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"}}},"required":["organizationId","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/addCustomPaymentMethod":{"post":{"operationId":"organization.addCustomPaymentMethod","description":"Runs the organization.addCustomPaymentMethod procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":32}},"required":["organizationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/removeCustomPaymentMethod":{"post":{"operationId":"organization.removeCustomPaymentMethod","description":"Runs the organization.removeCustomPaymentMethod procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"key":{"not":{}}},"required":["organizationId","key"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setLocationPaymentMethods":{"post":{"operationId":"organization.setLocationPaymentMethods","description":"Runs the organization.setLocationPaymentMethods procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"disabled":{"type":"array","items":{"anyOf":[{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"}]}}},"required":["locationId","disabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/addDiscount":{"post":{"operationId":"organization.addDiscount","description":"Runs the organization.addDiscount procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"percent":{"type":"integer","minimum":1,"maximum":100},"id":{"type":"string","format":"uuid"},"name":{"anyOf":[{"type":"string","maxLength":30},{"type":"null"}],"default":null}},"required":["organizationId","percent"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"discounts":{"type":"object","properties":{"presets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"percent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","percent"]}}},"required":["presets"]},"id":{"type":"string"}},"required":["discounts","id"]}}}}}}},"/api/public/v1/organization/updateDiscount":{"post":{"operationId":"organization.updateDiscount","description":"Runs the organization.updateDiscount procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"percent":{"type":"integer","minimum":1,"maximum":100},"id":{"type":"string","minLength":1,"maxLength":64},"name":{"anyOf":[{"type":"string","maxLength":30},{"type":"null"}]}},"required":["organizationId","percent","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"discounts":{"type":"object","properties":{"presets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"percent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","percent"]}}},"required":["presets"]}},"required":["discounts"]}}}}}}},"/api/public/v1/organization/archiveDiscount":{"post":{"operationId":"organization.archiveDiscount","description":"Runs the organization.archiveDiscount procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"discounts":{"type":"object","properties":{"presets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"percent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","percent"]}}},"required":["presets"]}},"required":["discounts"]}}}}}}},"/api/public/v1/organization/removeDiscount":{"post":{"operationId":"organization.removeDiscount","description":"Runs the organization.removeDiscount procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"discounts":{"type":"object","properties":{"presets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"percent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","percent"]}}},"required":["presets"]}},"required":["discounts"]}}}}}}},"/api/public/v1/organization/setLocationDiscounts":{"post":{"operationId":"organization.setLocationDiscounts","description":"Runs the organization.setLocationDiscounts procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"disabled":{"type":"array","maxItems":100,"items":{"type":"string","minLength":1,"maxLength":64}}},"required":["locationId","disabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"discounts":{"type":"object","properties":{"disabled":{"type":"array","items":{"type":"string"}}},"required":["disabled"]}},"required":["discounts"]}}}}}}},"/api/public/v1/organization/locationDiscounts":{"post":{"operationId":"organization.locationDiscounts","description":"Reads the organization.locationDiscounts procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"presets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"percent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","percent"]}}},"required":["presets"]}}}}}}},"/api/public/v1/organization/setOrderTypes":{"post":{"operationId":"organization.setOrderTypes","description":"Runs the organization.setOrderTypes procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"enabled":{"type":"array","items":{"enum":["dine_in","takeaway","delivery","shipment"],"type":"string"}}},"required":["organizationId","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setLocationOrderTypes":{"post":{"operationId":"organization.setLocationOrderTypes","description":"Runs the organization.setLocationOrderTypes procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"disabled":{"type":"array","items":{"enum":["dine_in","takeaway","delivery","shipment"],"type":"string"}}},"required":["locationId","disabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setDeliveryMethods":{"post":{"operationId":"organization.setDeliveryMethods","description":"Refused with BAD_REQUEST (refusal deliveryOff) while the organization does not declare the Delivery order type, and with BAD_REQUEST (refusal regionUnavailable) when enabled names a delivery method the organization's region pack does not offer; the region's own methods are the venue's own courier plus the pack's providers.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"enabled":{"type":"array","items":{"enum":["own_rider","talabat","deliveroo","careem","noon","yandex_eats","delivery_club","doordash","uber_eats","grubhub","rappi","didi_food","glovo"],"type":"string"}}},"required":["organizationId","enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setLocationDeliveryMethods":{"post":{"operationId":"organization.setLocationDeliveryMethods","description":"Runs the organization.setLocationDeliveryMethods procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"disabled":{"type":"array","items":{"enum":["own_rider","talabat","deliveroo","careem","noon","yandex_eats","delivery_club","doordash","uber_eats","grubhub","rappi","didi_food","glovo"],"type":"string"}}},"required":["locationId","disabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/getPhoneVerification":{"post":{"operationId":"organization.getPhoneVerification","description":"Reads the organization.getPhoneVerification procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"joinPage":{"type":"boolean","default":false},"tillJoin":{"type":"boolean","default":false},"pointsPayment":{"type":"boolean","default":false},"passSale":{"type":"boolean","default":false},"passRedemption":{"type":"boolean","default":false}}}}}}}}},"/api/public/v1/organization/setPhoneVerification":{"post":{"operationId":"organization.setPhoneVerification","description":"Runs the organization.setPhoneVerification procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"joinPage":{"type":"boolean"},"tillJoin":{"type":"boolean"},"pointsPayment":{"type":"boolean"},"passSale":{"type":"boolean"},"passRedemption":{"type":"boolean"}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"joinPage":{"type":"boolean","default":false},"tillJoin":{"type":"boolean","default":false},"pointsPayment":{"type":"boolean","default":false},"passSale":{"type":"boolean","default":false},"passRedemption":{"type":"boolean","default":false}}}}}}}}},"/api/public/v1/organization/proposeSlug":{"post":{"operationId":"organization.proposeSlug","description":"Reads the organization.proposeSlug procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/create":{"post":{"operationId":"organization.create","description":"Runs the organization.create procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120}},"required":["name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/archive":{"post":{"operationId":"organization.archive","description":"Archives the business and signs its members out. Refused with CONFLICT and refusal `businessBeingSetUp` while its sample demo or a new Location is being created; retry in a moment.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/listArchived":{"post":{"operationId":"organization.listArchived","description":"Reads the organization.listArchived procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/unarchive":{"post":{"operationId":"organization.unarchive","description":"Runs the organization.unarchive procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/get":{"post":{"operationId":"organization.get","description":"Reads the organization.get procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/locations":{"post":{"operationId":"organization.locations","description":"Lists the organization's open Locations the caller's memberships cover with `location:read`, in roster order: name, menu address, labels, address, phone, opening hours and time zone. FORBIDDEN when the caller covers none. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}]},"addressLine":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"labels":{"type":"array","items":{"type":"string"}},"businessHours":{"anyOf":[{"type":"array","maxItems":7,"items":{"type":"object","properties":{"day":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"openedAt":{"anyOf":[{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},{"type":"null"}]},"closedAt":{"anyOf":[{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},{"type":"null"}]}},"required":["day","openedAt","closedAt"]}},{"type":"null"}]},"timeZone":{"type":"string"}},"required":["id","name","slug","addressLine","phone","labels","businessHours","timeZone"]}}}}}}}},"/api/public/v1/organization/hasBusinessDetails":{"post":{"operationId":"organization.hasBusinessDetails","description":"Reads the organization.hasBusinessDetails procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/rename":{"post":{"operationId":"organization.rename","description":"Runs the organization.rename procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["organizationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setLogo":{"post":{"operationId":"organization.setLogo","description":"Sets or clears the organization's logo URL. Refused with NOT_FOUND for an organization that does not exist. A logo naming a Wallet design image that is being or already deleted is refused with CONFLICT and refusal `mediaDraftImageExpired`, and stores nothing.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"logo":{"anyOf":[{"type":"string","maxLength":4096,"format":"uri"},{"type":"null"}]}},"required":["organizationId","logo"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setCurrency":{"post":{"operationId":"organization.setCurrency","description":"Runs the organization.setCurrency procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"currency":{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"}},"required":["organizationId","currency"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setCurrencySymbol":{"post":{"operationId":"organization.setCurrencySymbol","description":"Runs the organization.setCurrencySymbol procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"showCurrencySymbol":{"type":"boolean"}},"required":["organizationId","showCurrencySymbol"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setMultiLogin":{"post":{"operationId":"organization.setMultiLogin","summary":"Legacy business-wide switching; set it per location with updateLocation instead.","description":"Runs the organization.setMultiLogin procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"multiLoginEnabled":{"type":"boolean"}},"required":["organizationId","multiLoginEnabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"multiLoginEnabled":{"type":"boolean"}},"required":["id","multiLoginEnabled"]}}}}}}},"/api/public/v1/organization/saveProfile":{"post":{"operationId":"organization.saveProfile","description":"Runs the organization.saveProfile procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"region":{"not":{}},"tradeName":{"anyOf":[{"type":"string"},{"type":"null"}]},"taxId":{"anyOf":[{"type":"string"},{"type":"null"}]},"licenseNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"legalType":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"emirate":{"anyOf":[{"not":{}},{"type":"null"}]},"legalName":{"anyOf":[{"type":"string"},{"type":"null"}]},"province":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"city":{"anyOf":[{"type":"string"},{"type":"null"}]},"district":{"anyOf":[{"type":"string"},{"type":"null"}]},"taxRegime":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"vatNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"incomeTaxId":{"anyOf":[{"type":"string"},{"type":"null"}]},"eInvoicingStatus":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"establishmentNumber":{"anyOf":[{"type":"string"},{"type":"null"}]},"vatRate":{"anyOf":[{"not":{}},{"type":"null"}]}},"required":["organizationId","region","tradeName","taxId","licenseNumber","legalType","vatRate"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/createLocation":{"post":{"operationId":"organization.createLocation","description":"Adds a Location, its menu address derived from the name. Refused with FORBIDDEN and refusal `locationLimitReached` when the plan states a `locations` limit that is reached and limits are enforced. In a region that lists its time zones (Russia today), a `timeZone` outside that list is refused with BAD_REQUEST and refusal `timeZoneNotOffered`, and a Location created without one starts on the region's default zone. An `ownerPhone` without a calling code is read in the first country the caller's regions dial; one dialled in a country none of them offer is refused with BAD_REQUEST and refusal `phoneCountryNotOffered`. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"addressLine":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"category":{"enum":["restaurant","coffee_shop","cafeteria","bakery_sweets","bistro","fast_street_food","bar"],"type":"string"},"businessHours":{"type":"array","maxItems":7,"items":{"type":"object","properties":{"day":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"openedAt":{"anyOf":[{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},{"type":"null"}]},"closedAt":{"anyOf":[{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},{"type":"null"}]}},"required":["day","openedAt","closedAt"]}},"phone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":280},{"type":"null"}]},"website":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"menuUrl":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"googleMenuRemoved":{"type":"boolean"},"placeId":{"type":"string","minLength":1,"maxLength":400},"ownerPhone":{"type":"string","minLength":1},"timeZone":{"type":"string"}},"required":["organizationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setOrganizationSlug":{"post":{"operationId":"organization.setOrganizationSlug","description":"Runs the organization.setOrganizationSlug procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"slug":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])$"}},"required":["organizationId","slug"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/renameLocation":{"post":{"operationId":"organization.renameLocation","description":"Runs the organization.renameLocation procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120}},"required":["locationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/setLocationSlug":{"post":{"operationId":"organization.setLocationSlug","description":"Runs the organization.setLocationSlug procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"slug":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])$"}},"required":["locationId","slug"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/updateLocation":{"post":{"operationId":"organization.updateLocation","description":"Writes every editable field of one Location, so a caller sends the untouched ones too. In a region that lists its time zones (Russia today), a `timeZone` outside that list is refused with BAD_REQUEST and refusal `timeZoneNotOffered` unless it is the zone the Location already reads, `UTC` for one without a zone.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"anyOf":[{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])$"},{"type":"null"}]},"addressLine":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"description":{"anyOf":[{"type":"string","maxLength":280},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"labels":{"type":"array","maxItems":12,"items":{"type":"string","minLength":1,"maxLength":32}},"businessHours":{"anyOf":[{"type":"array","maxItems":7,"items":{"type":"object","properties":{"day":{"enum":["sun","mon","tue","wed","thu","fri","sat"],"type":"string"},"openedAt":{"anyOf":[{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},{"type":"null"}]},"closedAt":{"anyOf":[{"type":"string","pattern":"^([01]?\\d|2[0-3]):[0-5]\\d$"},{"type":"null"}]}},"required":["day","openedAt","closedAt"]}},{"type":"null"}]},"timeZone":{"type":"string"},"isTwentyFourHourClock":{"type":"boolean"},"requestStartingCashBalance":{"type":"boolean"},"multiLoginEnabled":{"type":"boolean"},"autoLogoutEnabled":{"type":"boolean"}},"required":["locationId","name","slug","addressLine","description","phone","labels","businessHours","timeZone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/moveLocation":{"post":{"operationId":"organization.moveLocation","description":"Runs the organization.moveLocation procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"position":{"type":"number","minimum":-1000000,"maximum":1000000}},"required":["locationId","position"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/archiveLocation":{"post":{"operationId":"organization.archiveLocation","description":"Runs the organization.archiveLocation procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/organization/unarchiveLocation":{"post":{"operationId":"organization.unarchiveLocation","description":"Restores an archived Location with the slug and position it had; a Location that is already active is left as it is. Refused with FORBIDDEN and refusal `locationLimitReached` when restoring would pass an explicit `locations` limit that is enforced. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/recentDrafts":{"post":{"operationId":"orders.recentDrafts","summary":"List the caller's resumable drafts on a shift","description":"Returns the caller's own resumable drafts at the venue on the named shift, most recently updated first: unpaid, unarchived orders still in new status on an open shift, excluding any another device currently holds for payment. Each row carries its draft number, table, line count, first two line titles and quoted total in minor units. Use orders.shiftDrafts for every participant's drafts on the shift. A caller without order:readAllShifts must be an active participant of the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1}},"required":["locationId","shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/shiftDrafts":{"post":{"operationId":"orders.shiftDrafts","summary":"List every unsettled draft on a shift","description":"Returns every unsettled draft on the shift whoever created it (unpaid, unarchived, in new status), payment-locked drafts included, most recently updated first, with the creator's id and name beside each draft number. These are the drafts closing the shift retires or a leaving participant hands over. Use orders.recentDrafts for the caller's own resumable drafts. A caller without order:readAllShifts must be an active participant of the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1}},"required":["shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/types":{"post":{"operationId":"orders.types","summary":"Read the order types a venue offers","description":"Returns the venue's current order configuration: types (the order types the organization enables and the venue has not opted out of), the delivery channels enabled there, and whether tables and pagers are switched on. Use it to choose a valid orderType before creating or typing an order. It describes configuration, not orders; orders.listTypes returns the types present among a venue's orders. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/hasEverSold":{"post":{"operationId":"orders.hasEverSold","summary":"Check whether the organization ever took a payment","description":"Returns true when any order of the organization has ever recorded a payment, refunded payments included, and false otherwise. It is a yes-or-no signal only; use query_financial_sales for sales figures.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/collections":{"post":{"operationId":"orders.collections","summary":"Summarize money collected at a venue by method","description":"Returns, per currency, the money collected, refunded and retained at the venue over dateRange, broken down by payment type and method, plus tips by receipt method. dateRange is an inclusive pair of venue-local calendar dates resolved in the venue's time zone: payments count by when they were received, refunds and tips by their posting date. An imported Fortis payment counts when its sale's accepted source payment parts proved full settlement (the latest acceptance, so every tender of a split sale shares that date), never its import time or the sale's paidAt; imported collections without that evidence, and refunds with no posting date, are reported separately as undated amounts, in total and by method in undatedMethods, and are not limited by the range. Undated means no proven date, not unpaid. It reads every matching order with no row cap and is cash collected, not recognized revenue; use query_financial_sales for sales. A caller with order:readAllShifts may omit shiftId to read every shift or name one; any other caller must name a shift they actively take part in (BAD_REQUEST when omitted, FORBIDDEN otherwise). A shift-scoped read counts only orders carrying that shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1},"dateRange":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"]}},"required":["locationId","dateRange"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"collectedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"retainedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"currency":{"type":"string"},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedCollectionCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedMethods":{"type":"array","items":{"type":"object","properties":{"paymentType":{"type":"string"},"paymentMethodName":{"anyOf":[{"type":"string"},{"type":"null"}]},"undatedCollectionCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"undatedRefundCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["paymentType","paymentMethodName","undatedCollectionCents","undatedRefundCents"]}},"methods":{"type":"array","items":{"type":"object","properties":{"collectedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"retainedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paymentType":{"type":"string"},"paymentMethodName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["collectedCents","refundedCents","retainedCents","paymentType","paymentMethodName"]}},"tips":{"type":"array","items":{"type":"object","properties":{"receiptMethod":{"anyOf":[{"anyOf":[{"enum":["cash","card","wallet","mixed","other","points"],"type":"string"},{"anyOf":[{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"},{"not":{}}]}]},{"type":"null"}]},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["receiptMethod","tipCents"]}}},"required":["collectedCents","refundedCents","retainedCents","currency","undatedRefundCents","undatedCollectionCents","undatedMethods","methods","tips"]}}}}}}}},"/api/public/v1/orders/listTypes":{"post":{"operationId":"orders.listTypes","summary":"List the order types present among a venue's orders","description":"Returns { open, closed }: the distinct order types found among the orders orders.list would match with the same input, before its types filter and row cap, split by whether the order is still open (unpaid and in new or in_progress status). It returns type facets, not orders; use orders.list for the orders and orders.types for the types the venue offers. Shift scoping matches orders.list. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1},"exactShift":{"const":true},"tableId":{"type":"string","minLength":1},"status":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["new","in_progress","done","cancelled"],"type":"string"}},"types":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["dine_in","takeaway","delivery","shipment"],"type":"string"}},"createdAfter":{"type":"string","format":"date"},"dateRange":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"]}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/board":{"post":{"operationId":"orders.board","summary":"Read the kitchen board's orders","description":"Returns the kitchen board's view of a venue: every open order plus terminal orders whose activation time (creation time when never activated) is on or after 00:00 UTC on createdAfter, a UTC calendar date. With kitchenPendingOnly true, only orders holding at least one kitchen ticket still received are returned, cancelled ones included, which is what the Kitchen Desk renders; omitted or false returns the full set. Refused with FORBIDDEN and refusal `featureNotEntitled` when the plan lacks the Kitchen Desk at the venue and it is enforced. Each order carries only lines already sent to the kitchen and not voided, and its kitchen tickets; at most 1,000 orders are returned, open orders first, in board position order. A caller with order:readAllShifts always sees every shift and shiftId is ignored; any other caller must name a shift they actively take part in. Use orders.list for the full order list. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1},"createdAfter":{"type":"string","format":"date"},"kitchenPendingOnly":{"type":"boolean"}},"required":["locationId","createdAfter"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders":{"get":{"operationId":"orders.list","summary":"List a venue's orders","description":"Returns a venue's unarchived orders with their unvoided lines, kitchen tickets, payments and remaining amount: an operational list, not a sales aggregate, so use query_financial_sales for revenue. Open orders are always included; createdAfter, a UTC calendar date, limits terminal orders to those activated (or, never activated, created) from 00:00 UTC that day, and sending neither status nor createdAfter applies a 90-day default. dateRange is an inclusive pair of venue-local dates in the venue's time zone applied to every status; status, types and tableId narrow further. At most 1,000 orders are returned, open first and then most recent, in board position order, with no pagination. A caller with order:readAllShifts may omit shiftId to read every shift or name one; any other caller must name a shift they actively take part in (BAD_REQUEST when omitted, FORBIDDEN otherwise). A shift-scoped read also includes open guest orders from the QR menu that carry no shift, unless exactShift is true. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["orders"],"parameters":[{"name":"locationId","in":"query","required":true,"schema":{"type":"string","minLength":1},"allowEmptyValue":true,"allowReserved":true},{"name":"shiftId","in":"query","required":false,"schema":{"type":"string","minLength":1},"allowEmptyValue":true,"allowReserved":true},{"name":"exactShift","in":"query","required":false,"schema":{"const":true},"allowEmptyValue":true,"allowReserved":true},{"name":"tableId","in":"query","required":false,"schema":{"type":"string","minLength":1},"allowEmptyValue":true,"allowReserved":true},{"name":"status","in":"query","required":false,"schema":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["new","in_progress","done","cancelled"],"type":"string"}},"style":"deepObject","explode":true,"allowEmptyValue":true,"allowReserved":true},{"name":"types","in":"query","required":false,"schema":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["dine_in","takeaway","delivery","shipment"],"type":"string"}},"style":"deepObject","explode":true,"allowEmptyValue":true,"allowReserved":true},{"name":"createdAfter","in":"query","required":false,"schema":{"type":"string","format":"date"},"allowEmptyValue":true,"allowReserved":true},{"name":"dateRange","in":"query","required":false,"schema":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"]},"style":"deepObject","explode":true,"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}},"post":{"operationId":"orders.create","summary":"Create an order","description":"Creates a new draft order at the venue under shiftId, optionally seated at tableId, with the given lines, and returns its id; each call creates another order. Lines are stored by name, quantity and notes only, without a catalog link or price, and the order has no order type, so use orders.createDraft followed by orders.addLine for a priced till order. Seating it at a table claims that table's current booking. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with BAD_REQUEST when tableId names no table at the venue or the shift is at another venue, and NOT_FOUND for an unknown shift. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["orders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1},"tableId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"tableNumber":{"anyOf":[{"type":"integer","minimum":1,"maximum":999999999},{"type":"null"}]},"notes":{"type":"string","maxLength":500},"items":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"quantity":{"type":"integer","minimum":1,"maximum":99},"notes":{"type":"string","maxLength":500},"catalogItemId":{"type":"string","minLength":1},"priceCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["name","quantity"]}}},"required":["locationId","shiftId","items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}},"patch":{"operationId":"orders.update","summary":"Update an order's table, notes or lines","description":"Refused with CONFLICT `orderPartPaid` when the write would move a part-paid order to another table, off its table or onto one, and `guestPaymentUnderWay` when guests hold shares of its table's bill from the QR menu. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["orders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"tableId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"tableNumber":{"anyOf":[{"type":"integer","minimum":1,"maximum":999999999},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},"required":["id","notes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/listTableHeaders":{"post":{"operationId":"orders.listTableHeaders","summary":"List a venue's order headers","description":"Returns the orders orders.list would return for the same input, in the same order and with the same shift scoping, refusals and row cap, but only each order's id, table, number, status, notes, currency, total, paid time and creation time: no lines, kitchen tickets, payments or remaining amount. Use orders.get for one order's contents and orders.list for the full rows. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1},"exactShift":{"const":true},"tableId":{"type":"string","minLength":1},"status":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["new","in_progress","done","cancelled"],"type":"string"}},"types":{"type":"array","minItems":1,"maxItems":4,"items":{"enum":["dine_in","takeaway","delivery","shipment"],"type":"string"}},"createdAfter":{"type":"string","format":"date"},"dateRange":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"]}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"tableId":{"anyOf":[{"type":"string"},{"type":"null"}]},"tablePrefix":{"type":"string"},"tableNumber":{"anyOf":[{"type":"number"},{"type":"null"}]},"tableSectionName":{"anyOf":[{"type":"string"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"number"},{"type":"null"}]},"status":{"not":{}},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"totalCents":{"type":"number"},"paidAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","tableId","tablePrefix","tableNumber","tableSectionName","orderNumber","status","notes","currency","totalCents","paidAt","createdAt"]}}}}}}}},"/api/public/v1/orders/listOpenByTable":{"post":{"operationId":"orders.listOpenByTable","summary":"List open orders occupying a venue's tables","description":"Returns one { tableId, orderId } row for each unpaid, non-cancelled, unarchived order seated at a table in the venue, across every shift, so a table with several open orders appears several times. Use it to tell which tables are occupied; use orders.list with tableId for the orders themselves. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/listPendingGuest":{"post":{"operationId":"orders.listPendingGuest","summary":"List guest QR-menu orders waiting for staff","description":"Returns the venue's guest-submitted QR-menu orders that staff have not yet sent to the kitchen, across every shift and day, oldest submission first, each with its table and the time the guest first submitted. Unlike orders.list it applies no shift or date bound, so no waiting guest order is missed. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/createDraft":{"post":{"operationId":"orders.createDraft","description":"Refused with CONFLICT `orderIdTaken` when the client-minted `id` belongs to an order at another location. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"locationId":{"type":"string","minLength":1},"shiftId":{"type":"string","minLength":1},"orderType":{"enum":["dine_in","takeaway","delivery","shipment"],"type":"string"},"tableId":{"type":"string","minLength":1},"guestCount":{"type":"integer","minimum":1,"maximum":20}},"required":["locationId","shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/{id}":{"get":{"operationId":"orders.get","summary":"Read one order with its lines, tickets and payments","description":"Returns one order with its lines (voided ones included), options, kitchen tickets and payments, plus shiftEditBlocked and canChangeCustomer. Archived orders are still returned. Reading a draft on an open shift as a caller who may update orders first reprices lines whose catalog price has changed, so the answer shows current catalog prices. A caller without order:readAllShifts sees only orders of a shift they actively take part in, plus guest QR-menu orders; any other order answers NOT_FOUND. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["orders"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/events":{"post":{"operationId":"orders.events","summary":"Read an order's lifecycle events","description":"Returns { events }: the order's append-only lifecycle in the order it happened, each with event type, source, metadata, occurredAt (UTC) and the acting user's id and name. Visibility matches orders.get, so an order hidden from a shift-restricted caller answers NOT_FOUND. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/lines":{"post":{"operationId":"orders.addLine","summary":"Add a line to an order","description":"Adds one catalog line to an order, priced from that item at the order's venue. A resend of an accepted add answers as before. A pass sells on its own order, one of it at quantity 1: adding a pass to an order with other lines or an order discount, adding a line to an order holding a pass, and raising a pass line's quantity are refused with BAD_REQUEST as `passOwnOrder`. Refused with CONFLICT and the refusal orderShipped once a supplier's shipment order has shipped: what shipped is never changed. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["orders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"quantity":{"type":"integer","minimum":1,"maximum":99},"notes":{"type":"string","maxLength":500},"catalogItemId":{"type":"string","minLength":1},"priceCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"orderId":{"type":"string","minLength":1},"idempotencyKey":{"type":"string","minLength":1,"maxLength":64},"skipMerge":{"type":"boolean"},"itemVariationId":{"type":"string","minLength":1},"modifierIds":{"type":"array","maxItems":12,"items":{"type":"string","minLength":1}},"modifierQuantities":{"type":"array","maxItems":12,"items":{"type":"integer","minimum":1,"maximum":99}}},"required":["name","quantity","orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/updateLine":{"post":{"operationId":"orders.updateLine","description":"Changes one line's quantity, price, notes or options. Refused with CONFLICT `lineClaimed` when a line it changes is held by a By items part — paid at the till, or claimed by a guest from the QR menu — and `totalBelowPaid` when it would take the order's total below what is already paid. A pass sells on its own order, one of it at quantity 1: adding a pass to an order with other lines or an order discount, adding a line to an order holding a pass, and raising a pass line's quantity are refused with BAD_REQUEST as `passOwnOrder`. A discount on a pass line or on an order holding a pass is refused with BAD_REQUEST as `passNoDiscount`; clearing one is not. A discount, or clearing one, on a line a pass redeems is refused with BAD_REQUEST as `passRedeemedLine`: the server writes the pass's discount, and the cashier charges the line at full price with `orders.declinePassRedemption`. A raised quantity, an added or raised modifier, or another variation sells more and is refused for a suspended business; a replay, a removal, a lowered count, notes and a discount are not: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with CONFLICT and the refusal orderShipped once a supplier's shipment order has shipped: what shipped is never changed. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemId":{"type":"string","minLength":1},"modifierQuantityChange":{"type":"object","properties":{"modifierId":{"type":"string","minLength":1},"quantity":{"type":"integer","minimum":0,"maximum":99}},"required":["modifierId","quantity"]},"quantity":{"type":"integer","minimum":1,"maximum":99},"notes":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"discountPresetId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"discountPercent":{"type":"integer","minimum":0,"maximum":100},"discountAmountCents":{"type":"integer","minimum":0,"maximum":2147483647},"itemVariationId":{"type":"string","minLength":1},"modifierIds":{"type":"array","maxItems":12,"items":{"type":"string","minLength":1}},"modifierQuantities":{"type":"array","maxItems":12,"items":{"type":"integer","minimum":1,"maximum":99}}},"required":["itemId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/removeLine":{"post":{"operationId":"orders.removeLine","description":"Deletes one line the kitchen has not been sent; a fired line leaves through orders.voidLine instead. Refused with CONFLICT `lineClaimed` when a line it changes is held by a By items part — paid at the till, or claimed by a guest from the QR menu — and `totalBelowPaid` when it would take the order's total below what is already paid. Refused with CONFLICT and the refusal orderShipped once a supplier's shipment order has shipped: what shipped is never changed. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemId":{"type":"string","minLength":1}},"required":["itemId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/voidLine":{"post":{"operationId":"orders.voidLine","description":"Takes a fired line off its order and records the reason on the order's event log. Needs `order:void`. Refused with CONFLICT `lineClaimed` when a line it changes is held by a By items part — paid at the till, or claimed by a guest from the QR menu — and `totalBelowPaid` when it would take the order's total below what is already paid. Refused with CONFLICT and the refusal orderShipped once a supplier's shipment order has shipped: what shipped is never changed. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemId":{"type":"string","minLength":1},"reason":{"enum":["customer_changed_mind","entered_by_mistake","kitchen_unable_to_fulfill","already_prepared","other"],"type":"string"}},"required":["itemId","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/setType":{"post":{"operationId":"orders.setType","description":"Refused with CONFLICT `orderPartPaid` when the write would move a part-paid order to another table, off its table or onto one, and `guestPaymentUnderWay` when guests hold shares of its table's bill from the QR menu. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"orderType":{"enum":["dine_in","takeaway","delivery","shipment"],"type":"string"},"tableId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"tableNumber":{"anyOf":[{"type":"integer","minimum":1,"maximum":999999999},{"type":"null"}]},"guestCount":{"type":"integer","minimum":1,"maximum":20}},"required":["orderId","orderType"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/buyerLocations":{"post":{"operationId":"orders.buyerLocations","summary":"List the locations a supplier ships to","description":"Returns the locations a shipment order at this supplier location may ship to, each with its business: every live location shared with the enterprise the supplier is private to, never the supplier's own. Empty while the supplier is public, or no longer shares a location with that enterprise. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"organizationId":{"type":"string"},"organizationName":{"type":"string"}},"required":["id","name","organizationId","organizationName"]}}}}}}}},"/api/public/v1/orders/setBuyerLocation":{"post":{"operationId":"orders.setBuyerLocation","summary":"Choose the location a shipment order ships to","description":"Stores the buyer location a supplier's shipment order ships to, or clears it with null, and returns the order id. Refused with CONFLICT and the refusal notShipmentOrder for an order of another type, orderShipped once the order shipped, and buyerLocationNotEligible for a location orders.buyerLocations does not list. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"buyerLocationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["orderId","buyerLocationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}}}}},"/api/public/v1/orders/setDelivery":{"post":{"operationId":"orders.setDelivery","description":"Refused with CONFLICT `orderPartPaid` when the write would move a part-paid order to another table, off its table or onto one, and `guestPaymentUnderWay` when guests hold shares of its table's bill from the QR menu. On an own-rider delivery whose order names no customer, saving also makes the recipient the order's customer: the customer already holding the number, else a new one, when the number reads in the organization's region; The response's createdCustomer is the new one's name and phone, null when none was made. A saved address also joins that customer's addresses when the recipient is the customer. A member attached to an order already paid earns its loyalty points, unless the business takes no new Loyalty work (its own switch is off, or its plan restricts or lacks Loyalty). Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"deliveryChannel":{"anyOf":[{"enum":["own_rider","talabat","deliveroo","careem","noon","yandex_eats","delivery_club","doordash","uber_eats","grubhub","rappi","didi_food","glovo"],"type":"string"},{"type":"null"}],"default":null},"deliveryOrderNo":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"default":null},"deliveryName":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"default":null},"deliveryPhone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"default":null},"deliveryAddress":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}],"default":null},"deliveryArea":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"default":null},"deliveryCity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"default":null},"deliveryNotes":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"default":null}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/setComment":{"post":{"operationId":"orders.setComment","description":"Sets the order's sale comment and records each value on the order's event ledger. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"comment":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},"required":["orderId","comment"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/clearCart":{"post":{"operationId":"orders.clearCart","description":"Deletes every line the kitchen has not been sent and leaves the order open; fired lines stay. Refused with CONFLICT `lineClaimed` when a line it changes is held by a By items part — paid at the till, or claimed by a guest from the QR menu — and `totalBelowPaid` when it would take the order's total below what is already paid. Refused with CONFLICT and the refusal orderShipped once a supplier's shipment order has shipped: what shipped is never changed. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/cancel":{"post":{"operationId":"orders.cancel","summary":"Cancel an order","description":"Cancels an order not yet done; a retried cancel changes nothing. Refused with CONFLICT and the refusal orderShipped once a supplier's shipment order has shipped: what shipped is never changed. A prepaid order — one a guest paid through MyFatoorah before it was sent — is refunded by the cancel itself: all that is left of its MyFatoorah payment is sent back to the guest's card as a real refund, once, after the cancel commits. The cancel stands whatever MyFatoorah answers; follow the refund with payments.providerRefundDetails. An order that sold or renewed a guest's pass is cancelled only within 14 days of the sale and while the pass is unused, else refused with BAD_REQUEST and refusal `passRefundLate` or `passRefundUsed`; the cancel voids the pass or takes the renewal back, and gives back the pass uses the order redeemed. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["orders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"reason":{"enum":["customer_changed_mind","kitchen_unable_to_fulfill","duplicate_order","payment_failed","other"],"type":"string"}},"required":["orderId","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/setOrderDiscount":{"post":{"operationId":"orders.setOrderDiscount","description":"Refused with CONFLICT `totalBelowPaid` when it would take the order's total below what is already paid. A discount on a pass line or on an order holding a pass is refused with BAD_REQUEST as `passNoDiscount`; clearing one is not. Refused with CONFLICT and the refusal orderShipped once a supplier's shipment order has shipped: what shipped is never changed. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"discountPresetId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"discountPercent":{"type":"integer","minimum":0,"maximum":100},"discountAmountCents":{"type":"integer","minimum":0,"maximum":2147483647}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/choosePassLine":{"post":{"operationId":"orders.choosePassLine","description":"Picks the line a pass the order's customer holds redeems when it covers several different items on the order, one of the lines `customers.tillPassRedemption` lists to choose from; the line takes the pass's discount, its default size's price off, named after the pass. A line not offered for a pick is refused with BAD_REQUEST as `passLineNotOffered`. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"itemId":{"type":"string","minLength":1}},"required":["orderId","itemId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/api/public/v1/orders/declinePassRedemption":{"post":{"operationId":"orders.declinePassRedemption","description":"Charges the order's lines a pass would redeem at full price, as when the guest's code is not given: no line of the order redeems a pass until another customer is attached or the charge is taken back. With declined false it is taken back, and the lines redeem again as the guest's passes allow. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"declined":{"type":"boolean"}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]}}}}}}},"/api/public/v1/orders/setCustomer":{"post":{"operationId":"orders.setCustomer","summary":"Attach, change or detach an order's customer","description":"Sets the order's customer, or clears it with a null customerId. A paid order earns its loyalty points for a member attached to it while the business takes new Loyalty work (its own switch is on, and its plan neither restricts nor lacks Loyalty). Once any loyalty ledger entry names the order (points earned, spent or reversed on it), a change or detach is refused with BAD_REQUEST and refusal customerLockedByLoyalty. Once the order's payment sold or renewed a pass, a change or detach is refused with BAD_REQUEST and refusal customerLockedByPass. On an order holding or redeeming a pass, a change or detach of the customer while a card terminal charge for it is live or a guest is paying it from the QR menu is refused with CONFLICT as `passChargeLive`: the charge was admitted for the customer it verified, and its settlement sells or redeems the pass for the customer on the order. A change of customer moves the order's pass discount to the line a pass the new customer holds covers, and lets a new customer redeem after the last was charged full price. orders.get answers canChangeCustomer beforehand. On an own-rider delivery order, attaching fills the recipient's blank name and phone from the customer and a blank address (Address, Area and City all empty) with the customer's default saved address; a recipient or address still holding the replaced customer's phone or default address is replaced. A paid order's address is never written, and detaching leaves the recipient and address as they are. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["orders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"customerId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["orderId","customerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/move":{"post":{"operationId":"orders.move","summary":"Reorder an order within its board column","description":"Sets an order's position within its current board column and returns its id; repeating it with the same position changes nothing. status must equal the order's current status, so it never changes status: use orders.send, orders.complete or orders.cancel for that. Refused with BAD_REQUEST when status differs from the current one. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"status":{"enum":["new","in_progress","done","cancelled"],"type":"string"},"position":{"type":"number"}},"required":["id","status","position"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/{id}/send":{"post":{"operationId":"orders.send","summary":"Send an order to the kitchen","description":"Sends the order's unsent lines to the kitchen. The first send activates a draft: it assigns the order number, fixes prices and VAT at the current catalog and stamps the sale time; later sends deliver only lines added since the previous round. Kitchen tickets are created when the venue runs a kitchen display and its plan includes the Kitchen Desk (a venue whose plan lacks it while the Kitchen Desk is enforced sends like a printer-only one, never refused) and print jobs are queued when it prints. When there is nothing to deliver the call changes nothing and returns alreadySent true, so a retry is safe. Every reply also carries order, the order as orders.get returns it to the caller after this send. A pass line is stamped sent but reaches no kitchen ticket, chit or print job, so a round of passes alone mints no ticket. On a supplier's shipment order the send is Ship: it activates the order, stamps its lines sent without any kitchen ticket or print, takes their stock as a sale and opens one shipment in transit to the order's buyer location, each line valued at what it charged net of VAT, and payment follows it. A shipment order already shipped answers alreadySent true and changes nothing. Ship is refused with CONFLICT and the refusal orderNotShippable once the order is done or cancelled, inventoryDisabled while the supplier's inventory is off, insufficientStock when a line asks more than is on hand (nothing is taken), buyerLocationRequired when no buyer location is set, and buyerLocationNotEligible for a location the supplier does not ship to now. Refused with BAD_REQUEST when a first send finds no order type set. When checkoutLocationId names the till's venue, it is also refused before any change: with BAD_REQUEST `checkoutOtherLocation` for an order of another venue, CONFLICT `checkoutPaymentLocked` while another device's payment lock is fresh, BAD_REQUEST `checkoutCancelled` for a cancelled order, and BAD_REQUEST `checkoutTypeRequired`, `checkoutDeliveryRequired` or `checkoutTableRequired` for an order still missing its type, its aggregator order number, or the table its venue requires. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["orders"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"checkoutLocationId":{"type":"string","minLength":1}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/{id}/complete":{"post":{"operationId":"orders.complete","summary":"Complete an order","description":"Moves an order to done, activating it first when it is still a draft, and returns its id; an order already done is left unchanged, so a retry is safe. It does not require payment: completing an unpaid order finishes its booking and settles its table's shared invoice. It is the manual completion for takeaway and aggregator-delivery orders; dine-in orders complete through payment and own-rider deliveries through orders.markDelivered. Refused with BAD_REQUEST for a cancelled order. Refused with CONFLICT and the refusal orderNotShipped for a supplier's shipment order that has not shipped yet: Ship it first. An unpaid order with a line a pass redeems is refused with BAD_REQUEST as `passRedemptionUnpaid`: take its payment, at AED 0 when the pass covers all of it, so the guest's code is asked and the use is counted. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["orders"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/markDelivered":{"post":{"operationId":"orders.markDelivered","summary":"Mark an own-rider delivery as delivered","description":"Records that an own-rider delivery order was delivered, activating it if needed and completing it, and returns its id. An order already marked delivered is left unchanged, so a retry is safe. Refused with BAD_REQUEST for an order that is not an own-rider delivery, or one that is cancelled. An unpaid order with a line a pass redeems is refused with BAD_REQUEST as `passRedemptionUnpaid`: take its payment, at AED 0 when the pass covers all of it, so the guest's code is asked and the use is counted. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/activateForPayment":{"post":{"operationId":"orders.activateForPayment","summary":"Activate an order before taking payment","description":"Activates a draft before payment so the amount to charge is final: assigns its order number, fixes prices and VAT and stamps the sale time, then returns { id, orderNumber, order, tillPoints }, where order is the order as orders.get returns it to the caller after this activation, and tillPoints is what customers.tillPoints answers for it afterwards, omitted when the caller may not read that or it could not be read. An order already active is returned unchanged, so a retry is safe. Refused with BAD_REQUEST when the order is done or cancelled, or when a draft has no order type. Refused with CONFLICT and the refusal orderNotShipped for a supplier's shipment order that has not shipped yet: Ship it first. An order holding a pass without a guest attached is refused with BAD_REQUEST as `passNeedsGuest` before any money is taken. When checkoutLocationId names the till's venue, it is also refused before any change: with BAD_REQUEST `checkoutOtherLocation` for an order of another venue, CONFLICT `checkoutPaymentLocked` while another device's payment lock is fresh, BAD_REQUEST `checkoutCancelled` for a cancelled order, and BAD_REQUEST `checkoutTypeRequired`, `checkoutDeliveryRequired` or `checkoutTableRequired` for an order still missing its type, its aggregator order number, or the table its venue requires. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"checkoutLocationId":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/lockForPayment":{"post":{"operationId":"orders.lockForPayment","summary":"Hold an order's payment lock for a device","description":"Takes or refreshes the order's short-lived payment lock for deviceToken, so other devices show the order read-only while it is being paid; the lock lapses about 15 seconds after its last refresh. Calling again with the same token refreshes it, and the first acquisition records a payment-started event. Returns the order id. Refused with CONFLICT while another device's lock is still fresh, and with BAD_REQUEST when the order is done or cancelled. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"deviceToken":{"type":"string","minLength":1}},"required":["orderId","deviceToken"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/unlockPayment":{"post":{"operationId":"orders.unlockPayment","summary":"Release an order's payment lock","description":"Releases the order's payment lock only when deviceToken holds it, recording a payment-abandoned event, and returns the order id. Another device's token, an already released lock or one a payment resolved changes nothing, so the call is safe to repeat. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"deviceToken":{"type":"string","minLength":1}},"required":["orderId","deviceToken"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/toggleItem":{"post":{"operationId":"orders.toggleItem","summary":"Mark an order line ready or not ready","description":"Sets an order line's ready flag to isReady and returns the line id; setting the same value again changes nothing. It marks one line on the kitchen side and does not change the order's status. Refused with FORBIDDEN and refusal `featureNotEntitled` when the plan lacks the Kitchen Desk at the venue and it is enforced. While the venue admits no new kitchen ticket, only a line on a kitchen ticket still received can be marked, and a line on an older ticket that already holds isReady answers as an unchanged replay; any other line is refused with FORBIDDEN and refusal `kitchenDeskDisabled` when the Kitchen Desk is switched off, `featureRestrictedByPlan` when the plan's restriction policy takes it away and is enforced, or `featureNotEntitled` when the plan does not stand. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"itemId":{"type":"string","minLength":1},"isReady":{"type":"boolean"}},"required":["itemId","isReady"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/orders/remove":{"post":{"operationId":"orders.remove","summary":"Remove a same-day draft order","description":"Archives a draft order created on the current UTC date and still in new status, freeing any booking it held, and returns its id. The order disappears from lists but keeps its lines, payments and history and stays readable through orders.get; use orders.cancel for any other order. Refused with BAD_REQUEST for an order that is not a same-day draft or was already removed, with CONFLICT while it holds a pager that has not been returned, and with CONFLICT and refusal terminalPaymentLive while a terminal payment on it has not resolved. Refused with CONFLICT and the refusal orderShipped once a supplier's shipment order has shipped: what shipped is never changed. Refused with `shiftClosed` once the order's shift has closed (FORBIDDEN; BAD_REQUEST when creating under it) and with FORBIDDEN `notShiftParticipant` for a caller not taking part in the shift. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/pagers/getConfig":{"post":{"operationId":"pagers.getConfig","description":"Reads the pagers.getConfig procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pagerCount":{"type":"integer","minimum":1,"maximum":999},"enabled":{"type":"boolean"},"tablesEnabled":{"type":"boolean"}},"required":["pagerCount","enabled","tablesEnabled"]}}}}}}},"/api/public/v1/pagers/updateCount":{"post":{"operationId":"pagers.updateCount","description":"Runs the pagers.updateCount procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"pagerCount":{"type":"integer","minimum":1,"maximum":999}},"required":["locationId","pagerCount"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pagerCount":{"type":"integer","minimum":1,"maximum":999}},"required":["pagerCount"]}}}}}}},"/api/public/v1/pagers/availability":{"post":{"operationId":"pagers.availability","description":"Reads the pagers.availability procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pagerCount":{"type":"integer","minimum":1,"maximum":999},"enabled":{"type":"boolean"},"tablesEnabled":{"type":"boolean"},"reservations":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string"},"orderNumber":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"pagerNumber":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},{"type":"null"}]}},"required":["orderId","orderNumber","pagerNumber"]}}},"required":["pagerCount","enabled","tablesEnabled","reservations"]}}}}}}},"/api/public/v1/pagers/assign":{"post":{"operationId":"pagers.assign","description":"Refused with CONFLICT `orderPartPaid` when the write would move a part-paid order to another table, off its table or onto one, and `guestPaymentUnderWay` when guests hold shares of its table's bill from the QR menu. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"deviceToken":{"type":"string","minLength":1},"pagerNumber":{"anyOf":[{"type":"integer","minimum":1,"maximum":999},{"type":"null"}]}},"required":["orderId","pagerNumber"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}}}}},"/api/public/v1/pagers/assignTable":{"post":{"operationId":"pagers.assignTable","description":"Refused with CONFLICT `orderPartPaid` when the write would move a part-paid order to another table, off its table or onto one, and `guestPaymentUnderWay` when guests hold shares of its table's bill from the QR menu. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"deviceToken":{"type":"string","minLength":1},"tableId":{"type":"string","minLength":1}},"required":["orderId","tableId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}}}}},"/api/public/v1/pagers/returnPager":{"post":{"operationId":"pagers.returnPager","description":"Runs the pagers.returnPager procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"deviceToken":{"type":"string","minLength":1}},"required":["orderId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1}},"required":["orderId"]}}}}}}},"/api/public/v1/paywall/gate":{"post":{"operationId":"paywall.gate","description":"Reads the paywall.gate procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"state":{"enum":["none","soft","hard"],"type":"string"},"ordersTaken":{"type":"integer","minimum":0,"maximum":9007199254740991},"canPurchase":{"type":"boolean"}},"required":["state","ordersTaken","canPurchase"]}}}}}}},"/api/public/v1/paywall/dismiss":{"post":{"operationId":"paywall.dismiss","description":"Runs the paywall.dismiss procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/paywall/shown":{"post":{"operationId":"paywall.shown","description":"Runs the paywall.shown procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/paywall/startPurchase":{"post":{"operationId":"paywall.startPurchase","description":"Saves the plan and period a Paywall card names on the caller's live purchase for the business and selects it, answering the `choiceRevision` the purchase review continues from at /auth/purchase. A purchase frozen for an unpaid Checkout has its sessions closed in Stripe first, and is refused `checkoutCheckFailed` when Stripe cannot confirm one closed, `checkoutAlreadyPaid` for one the business's standing subscription paid, leaving the Checkout as it was. Refused with FORBIDDEN as `paywallClosed` unless the merchant Paywall shows in the business and the caller may buy for it, or the business is suspended after its subscription ended (`billing.getStanding` recovery `purchase`) and the caller may manage its billing, and otherwise as purchase.startFromPricing refuses: `organizationNotEligible`, `subscriptionExists`, `previousPaymentPending`, `offerChanged`, `checkoutInProgress`, `checkoutPaymentPending` and `selectionChanged`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"planCode":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"interval":{"enum":["month","year"],"type":"string"},"intervalCount":{"type":"integer","minimum":1,"maximum":3,"default":1},"addons":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"code":{"type":"string","pattern":"^[a-z][a-z0-9-]{0,39}$"},"quantity":{"type":"integer","minimum":1,"maximum":100,"default":1}},"required":["code"],"additionalProperties":false},"default":[]},"quoteId":{"type":"string","minLength":1,"maxLength":128},"startKey":{"type":"string","format":"uuid"}},"required":["organizationId","interval","quoteId","startKey"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"choiceRevision":{"type":"number"}},"required":["choiceRevision"],"additionalProperties":false}}}}}}},"/api/public/v1/marketModes/list":{"post":{"operationId":"marketModes.list","description":"Reads the marketModes.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"brandId":{"type":"string"},"regionId":{"type":"string"},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mode":{"enum":["legacyOpen","commercial"],"type":"string"}},"required":["brandId","regionId","revision","mode"]}}}}}}}},"/api/public/v1/marketModes/history":{"post":{"operationId":"marketModes.history","description":"Reads the marketModes.history procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"brandId":{"type":"string"},"regionId":{"type":"string"}},"required":["brandId","regionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"brandId":{"type":"string"},"regionId":{"type":"string"},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mode":{"enum":["legacyOpen","commercial"],"type":"string"},"actorUserId":{"type":"string"},"reason":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["brandId","regionId","revision","mode","actorUserId","reason","createdAt"]}}}}}}}},"/api/public/v1/marketModes/update":{"post":{"operationId":"marketModes.update","description":"Runs the marketModes.update procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"brandId":{"type":"string"},"regionId":{"type":"string"},"mode":{"enum":["legacyOpen","commercial"],"type":"string"},"expectedRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"reason":{"type":"string","minLength":1,"maxLength":500}},"required":["brandId","regionId","mode","expectedRevision","reason"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"brandId":{"type":"string"},"regionId":{"type":"string"},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mode":{"enum":["legacyOpen","commercial"],"type":"string"},"actorUserId":{"type":"string"},"reason":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["brandId","regionId","revision","mode","actorUserId","reason","createdAt"]}}}}}}},"/api/public/v1/planGrants/list":{"post":{"operationId":"planGrants.list","description":"Reads the planGrants.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"locationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"planCode":{"enum":["starter","essential"],"type":"string"},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"expiresAt":{"type":"string","format":"date-time","x-native-type":"date"},"issuedByUserId":{"type":"string"},"issueReason":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"revokedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"revokeReason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","organizationId","locationId","planCode","startsAt","expiresAt","issuedByUserId","issueReason","createdAt","revokedAt","revokedByUserId","revokeReason"]}}}}}}}},"/api/public/v1/planGrants/summary":{"post":{"operationId":"planGrants.summary","description":"Reads the planGrants.summary procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"now":{"type":"string","format":"date-time","x-native-type":"date"},"paid":{"anyOf":[{"type":"object","properties":{"environment":{"enum":["live","sandbox"],"type":"string"},"status":{"enum":["trialing","active","past_due"],"type":"string"},"planCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"planVersion":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["environment","status","planCode","planVersion"]},{"type":"null"}]},"grantedPlan":{"anyOf":[{"type":"object","properties":{"planCode":{"enum":["starter","essential"],"type":"string"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"},"next":{"anyOf":[{"type":"object","properties":{"planCode":{"enum":["starter","essential"],"type":"string"},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"endsAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["planCode","startsAt","endsAt"]},{"type":"null"}]}},"required":["planCode","endsAt","next"]},{"type":"null"}]}},"required":["now","paid","grantedPlan"]}}}}}}},"/api/public/v1/planGrants/directoryStatuses":{"post":{"operationId":"planGrants.directoryStatuses","description":"Reads the planGrants.directoryStatuses procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"asOf":{"type":"string","format":"date-time","x-native-type":"date"},"organizations":{"type":"array","items":{"type":"object","properties":{"organizationId":{"type":"string"},"stripe":{"type":"object","properties":{"current":{"anyOf":[{"type":"object","properties":{"status":{"enum":["trialing","active","past_due"],"type":"string"},"planCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"planVersion":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["status","planCode","planVersion"]},{"type":"null"}]},"latestStatus":{"anyOf":[{"enum":["trialing","active","past_due","canceled","incomplete","incomplete_expired","unpaid","paused"],"type":"string"},{"type":"null"}]},"latestSandboxStatus":{"anyOf":[{"enum":["trialing","active","past_due","canceled","incomplete","incomplete_expired","unpaid","paused"],"type":"string"},{"type":"null"}]}},"required":["current","latestStatus","latestSandboxStatus"]},"grants":{"type":"object","properties":{"active":{"type":"boolean"},"scheduled":{"type":"boolean"},"expired":{"type":"boolean"},"revoked":{"type":"boolean"},"activePlanCodes":{"type":"array","items":{"enum":["starter","essential"],"type":"string"}}},"required":["active","scheduled","expired","revoked","activePlanCodes"]},"presentation":{"type":"object","properties":{"tier":{"enum":["starter","essential","advanced","legacy","unknown","none"],"type":"string"},"source":{"enum":["stripe","grant","none"],"type":"string"},"endsAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]}},"required":["tier","source","endsAt"]}},"required":["organizationId","stripe","grants","presentation"]}}},"required":["asOf","organizations"]}}}}}}},"/api/public/v1/planGrants/issue":{"post":{"operationId":"planGrants.issue","description":"Runs the planGrants.issue procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"default":null},"planCode":{"enum":["starter","essential"],"type":"string"},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"expiresAt":{"type":"string","format":"date-time","x-native-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":500}},"required":["organizationId","planCode","expiresAt","reason"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"locationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"planCode":{"enum":["starter","essential"],"type":"string"},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"expiresAt":{"type":"string","format":"date-time","x-native-type":"date"},"issuedByUserId":{"type":"string"},"issueReason":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"revokedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"revokeReason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","organizationId","locationId","planCode","startsAt","expiresAt","issuedByUserId","issueReason","createdAt","revokedAt","revokedByUserId","revokeReason"]}}}}}}},"/api/public/v1/planGrants/revoke":{"post":{"operationId":"planGrants.revoke","description":"Runs the planGrants.revoke procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"reason":{"type":"string","minLength":1,"maxLength":500}},"required":["id","reason"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"locationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"planCode":{"enum":["starter","essential"],"type":"string"},"startsAt":{"type":"string","format":"date-time","x-native-type":"date"},"expiresAt":{"type":"string","format":"date-time","x-native-type":"date"},"issuedByUserId":{"type":"string"},"issueReason":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"},"revokedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"revokedByUserId":{"anyOf":[{"type":"string"},{"type":"null"}]},"revokeReason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","organizationId","locationId","planCode","startsAt","expiresAt","issuedByUserId","issueReason","createdAt","revokedAt","revokedByUserId","revokeReason"]}}}}}}},"/api/public/v1/planRestrictions/list":{"post":{"operationId":"planRestrictions.list","description":"Reads the planRestrictions.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"planCode":{"type":"string"},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"restrictedFeatures":{"type":"array","items":{"type":"string"},"readOnly":true}},"required":["planCode","revision","restrictedFeatures"]}}}}}}}},"/api/public/v1/planRestrictions/history":{"post":{"operationId":"planRestrictions.history","description":"Reads the planRestrictions.history procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planCode":{"type":"string"}},"required":["planCode"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"planCode":{"type":"string"},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"restrictedFeatures":{"type":"array","items":{"type":"string"},"readOnly":true},"actorUserId":{"type":"string"},"reason":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["planCode","revision","restrictedFeatures","actorUserId","reason","createdAt"]}}}}}}}},"/api/public/v1/planRestrictions/update":{"post":{"operationId":"planRestrictions.update","description":"Runs the planRestrictions.update procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planCode":{"type":"string"},"expectedRevision":{"type":"integer","minimum":0,"maximum":9007199254740991},"reason":{"type":"string","minLength":1,"maxLength":500},"change":{"anyOf":[{"type":"object","properties":{"replace":{"type":"array","maxItems":32,"items":{"type":"string"}}},"required":["replace"],"additionalProperties":false},{"type":"object","properties":{"add":{"type":"array","minItems":1,"maxItems":32,"items":{"type":"string"}}},"required":["add"],"additionalProperties":false},{"type":"object","properties":{"remove":{"type":"array","minItems":1,"maxItems":32,"items":{"type":"string"}}},"required":["remove"],"additionalProperties":false}]}},"required":["planCode","expectedRevision","reason","change"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"planCode":{"type":"string"},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"restrictedFeatures":{"type":"array","items":{"type":"string"},"readOnly":true},"actorUserId":{"type":"string"},"reason":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["planCode","revision","restrictedFeatures","actorUserId","reason","createdAt"]}}}}}}},"/api/public/v1/paymentProviders/availableProviders":{"post":{"operationId":"paymentProviders.availableProviders","description":"Reads the paymentProviders.availableProviders procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/paymentProviders/listConnections":{"post":{"operationId":"paymentProviders.listConnections","description":"Reads the paymentProviders.listConnections procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/paymentProviders/refreshMyFatoorahStatus":{"post":{"operationId":"paymentProviders.refreshMyFatoorahStatus","description":"Runs the paymentProviders.refreshMyFatoorahStatus procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/paymentProviders/connectGeidea":{"post":{"operationId":"paymentProviders.connectGeidea","description":"Runs the paymentProviders.connectGeidea procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/paymentProviders/connectMyFatoorah":{"post":{"operationId":"paymentProviders.connectMyFatoorah","description":"Runs the paymentProviders.connectMyFatoorah procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"supplierName":{"type":"string","minLength":1,"maxLength":200},"mobile":{"type":"string","pattern":"^\\+?[0-9]{6,15}$"},"email":{"type":"string","maxLength":200,"format":"email"}},"required":["organizationId","supplierName","mobile","email"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/places/autocomplete":{"post":{"operationId":"places.autocomplete","description":"Reads the places.autocomplete procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":2,"maxLength":100},"sessionToken":{"type":"string","format":"uuid"},"lat":{"type":"number","minimum":-90,"maximum":90},"lng":{"type":"number","minimum":-180,"maximum":180},"lang":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string","default":"en"},"cursor":{"anyOf":[{"type":"string","maxLength":8000},{"type":"null"}]},"direction":{"enum":["forward","backward"],"type":"string"}},"required":["query"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/places/autocompleteAddress":{"post":{"operationId":"places.autocompleteAddress","description":"Reads the places.autocompleteAddress procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":2,"maxLength":100},"sessionToken":{"type":"string","format":"uuid"},"lat":{"type":"number","minimum":-90,"maximum":90},"lng":{"type":"number","minimum":-180,"maximum":180},"lang":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string","default":"en"}},"required":["query"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/places/details":{"post":{"operationId":"places.details","description":"Reads the places.details procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"placeId":{"type":"string","minLength":1,"maxLength":400},"sessionToken":{"type":"string","format":"uuid"},"lang":{"enum":["en","ru","ar","hy","es-MX","es"],"type":"string","default":"en"}},"required":["placeId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/placeMenu/saved":{"post":{"operationId":"placeMenu.saved","description":"Reads the placeMenu.saved procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"menuUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"googleMenu":{"anyOf":[{"type":"object","properties":{"categories":{"type":"integer","minimum":0,"maximum":9007199254740991},"items":{"type":"integer","minimum":0,"maximum":9007199254740991},"photos":{"type":"integer","minimum":0,"maximum":9007199254740991},"preview":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"price":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["title","description","price"],"additionalProperties":false}}},"required":["title","items"],"additionalProperties":false}},"photoUrls":{"type":"array","items":{"type":"string"}},"thumbnailUrls":{"type":"array","items":{"type":"string"}}},"required":["categories","items","photos","preview","photoUrls","thumbnailUrls"],"additionalProperties":false},{"type":"null"}]}},"required":["menuUrl","googleMenu"],"additionalProperties":false}}}}}}},"/api/public/v1/placeMenu/importUrl":{"post":{"operationId":"placeMenu.importUrl","description":"Imports the menu a link leads to into the catalog, opening its catalog import before the walk starts. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"url":{"type":"string","maxLength":2048,"format":"uri"}},"required":["organizationId","url"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"importId":{"type":"string","format":"uuid"}},"required":["importId"],"additionalProperties":false}}}}}}},"/api/public/v1/placeMenu/importGoogle":{"post":{"operationId":"placeMenu.importGoogle","description":"Imports the Google menu the search saved into the catalog, opening its catalog import first. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"importId":{"type":"string","format":"uuid"}},"required":["importId"],"additionalProperties":false}}}}}}},"/api/public/v1/placeMenu/find":{"post":{"operationId":"placeMenu.find","description":"Reads the chosen venue's Google Maps menu for the confirm step; each lookup is billed. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"placeId":{"type":"string","minLength":1,"maxLength":400}},"required":["organizationId","placeId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"state":{"const":"found"},"menuUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"categories":{"type":"integer","minimum":0,"maximum":9007199254740991},"items":{"type":"integer","minimum":0,"maximum":9007199254740991},"photos":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["state","menuUrl","categories","items","photos"],"additionalProperties":false},{"type":"object","properties":{"state":{"const":"notFound"}},"required":["state"],"additionalProperties":false}]}}}}}}},"/api/public/v1/placeMenu/progress":{"post":{"operationId":"placeMenu.progress","description":"Reads the placeMenu.progress procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"importId":{"type":"string","format":"uuid"}},"required":["organizationId","importId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/platformDashboard/overview":{"post":{"operationId":"platformDashboard.overview","description":"Reads the platformDashboard.overview procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"period":{"enum":["today","yesterday","last7","thisMonth","custom"],"type":"string","default":"today"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/paymentHistory/list":{"post":{"operationId":"paymentHistory.list","summary":"List an organization's payments","description":"Returns one page of payments, one row per payment initiation, from the open venues of organizationId at which the caller holds payment:read; naming any other venue in locationIds is FORBIDDEN. Each row carries the original principal and the tip apart, the principal and tip returned by succeeded refunds, a status derived from confirmed outcomes, the count of declined or technically failed payment attempts, and the latest attempt's safe card details. startedOn is an inclusive pair of venue-local dates, each read in its own venue's time zone. search matches an RRN, last four digits or authorization code exactly. Filters and the sort apply to every matching payment before the page is cut; ties break by id. Not an order or sales read. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["payments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":200},"locationIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":200}},"statuses":{"type":"array","minItems":1,"items":{"enum":["succeeded","partiallyRefunded","refunded","needsVerification","processing","failed","canceled"],"type":"string"}},"methods":{"type":"array","minItems":1,"items":{"enum":["card","points"],"type":"string"}},"startedOn":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"],"additionalProperties":false},"minAmountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxAmountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"terminalIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":200}},"hasFailedPaymentAttempts":{"type":"boolean"},"search":{"type":"string","minLength":1,"maxLength":64},"sort":{"enum":["startedAt","updatedAt","amount"],"type":"string","default":"startedAt"},"direction":{"enum":["asc","desc"],"type":"string","default":"desc"},"page":{"type":"integer","minimum":1,"maximum":9007199254740991,"default":1},"pageSize":{"type":"integer","minimum":1,"maximum":100,"default":25}},"required":["organizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"locationId":{"type":"string"},"venueName":{"type":"string"},"currency":{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"},"source":{"enum":["myfatoorah","geidea","points","terminal"],"type":"string"},"method":{"enum":["card","points"],"type":"string"},"principalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedPrincipalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["succeeded","partiallyRefunded","refunded","needsVerification","processing","failed","canceled"],"type":"string"},"failedPaymentAttempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"latestOperation":{"anyOf":[{"type":"object","properties":{"kind":{"enum":["payment","refund"],"type":"string"},"method":{"enum":["card","points"],"type":"string"},"cardBrand":{"anyOf":[{"type":"string"},{"type":"null"}]},"cardLast4":{"anyOf":[{"type":"string"},{"type":"null"}]},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}]},"authCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"terminalId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","method","cardBrand","cardLast4","rrn","authCode","terminalId"]},{"type":"null"}]},"isFixture":{"type":"boolean"},"startedAt":{"type":"string","format":"date-time","x-native-type":"date"},"lastUpdatedAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","organizationId","locationId","venueName","currency","source","method","principalCents","tipCents","refundedPrincipalCents","refundedTipCents","status","failedPaymentAttempts","latestOperation","isFixture","startedAt","lastUpdatedAt"]}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pageSize":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["items","total","page","pageSize"]}}}}}}},"/api/public/v1/paymentHistory/totals":{"post":{"operationId":"paymentHistory.totals","summary":"Total an organization's payments per currency","description":"Returns, for every payment list matches under the same filters, venues and grant, one row per currency: the count of payments in each status; gross volume, the principal plus tip of payments with a succeeded payment attempt before refunds, and the tip within it; refunds, the principal plus tip succeeded refunds of those payments returned whenever they happened; net volume, gross volume minus refunds; and gross volume by payment source. Amounts are minor units of that currency and are never summed across currencies. Disputes and fees are not in payment history, so net volume does not reflect them. Not an order or sales read. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["payments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":200},"locationIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":200}},"statuses":{"type":"array","minItems":1,"items":{"enum":["succeeded","partiallyRefunded","refunded","needsVerification","processing","failed","canceled"],"type":"string"}},"methods":{"type":"array","minItems":1,"items":{"enum":["card","points"],"type":"string"}},"startedOn":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"],"additionalProperties":false},"minAmountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"maxAmountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"terminalIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":200}},"hasFailedPaymentAttempts":{"type":"boolean"},"search":{"type":"string","minLength":1,"maxLength":64}},"required":["organizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"currencies":{"type":"array","items":{"type":"object","properties":{"currency":{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"},"paymentsByStatus":{"type":"object","propertyNames":{"enum":["succeeded","partiallyRefunded","refunded","needsVerification","processing","failed","canceled"],"type":"string"},"additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"grossVolumeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"grossVolumeTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundsCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"netVolumeCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"grossVolumeBySourceCents":{"type":"object","propertyNames":{"enum":["myfatoorah","geidea","points","terminal"],"type":"string"},"additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}},"required":["currency","paymentsByStatus","grossVolumeCents","grossVolumeTipCents","refundsCents","netVolumeCents","grossVolumeBySourceCents"]}}},"required":["currencies"]}}}}}}},"/api/public/v1/paymentHistory/get":{"post":{"operationId":"paymentHistory.get","summary":"Read one payment with its attempt and refund timeline","description":"Returns one payment as list shapes it, with every payment and refund attempt and every refund, oldest first, including outcomes, normalized reasons and provider references. A payment at an archived venue, or at a venue where the caller lacks payment:read, answers NOT_FOUND, exactly as a missing one does. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["payments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200}},"required":["id"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organizationId":{"type":"string"},"locationId":{"type":"string"},"venueName":{"type":"string"},"currency":{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"},"source":{"enum":["myfatoorah","geidea","points","terminal"],"type":"string"},"method":{"enum":["card","points"],"type":"string"},"principalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedPrincipalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refundedTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"enum":["succeeded","partiallyRefunded","refunded","needsVerification","processing","failed","canceled"],"type":"string"},"failedPaymentAttempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"latestOperation":{"anyOf":[{"type":"object","properties":{"kind":{"enum":["payment","refund"],"type":"string"},"method":{"enum":["card","points"],"type":"string"},"cardBrand":{"anyOf":[{"type":"string"},{"type":"null"}]},"cardLast4":{"anyOf":[{"type":"string"},{"type":"null"}]},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}]},"authCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"terminalId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","method","cardBrand","cardLast4","rrn","authCode","terminalId"]},{"type":"null"}]},"isFixture":{"type":"boolean"},"startedAt":{"type":"string","format":"date-time","x-native-type":"date"},"lastUpdatedAt":{"type":"string","format":"date-time","x-native-type":"date"},"attempts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"enum":["payment","refund"],"type":"string"},"refundId":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"enum":["pending","succeeded","declined","canceled","technicalFailure","unresolved"],"type":"string"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"method":{"enum":["card","points"],"type":"string"},"cardBrand":{"anyOf":[{"type":"string"},{"type":"null"}]},"cardLast4":{"anyOf":[{"type":"string"},{"type":"null"}]},"rrn":{"anyOf":[{"type":"string"},{"type":"null"}]},"authCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"terminalId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerPaymentId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerInvoiceId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerErrorCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerErrorMessage":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"enum":["unknown","noProviderAnswer","sessionExpired","insufficientBalance","confirmedNotCharged"],"type":"string"},{"type":"null"}]},"isUnapplied":{"type":"boolean"},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","kind","refundId","outcome","amountCents","tipCents","method","cardBrand","cardLast4","rrn","authCode","terminalId","providerPaymentId","providerInvoiceId","providerErrorCode","providerErrorMessage","reason","isUnapplied","resolvedAt","createdAt"]}},"refunds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"enum":["requested","pending","succeeded","failed","canceled","unresolved"],"type":"string"},"requestedPrincipalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"requestedTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"returnedPrincipalCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"returnedTipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"providerRefundId":{"anyOf":[{"type":"string"},{"type":"null"}]},"providerErrorMessage":{"anyOf":[{"type":"string"},{"type":"null"}]},"reason":{"anyOf":[{"enum":["unknown","noProviderAnswer","sessionExpired","insufficientBalance","confirmedNotCharged"],"type":"string"},{"type":"null"}]},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-native-type":"date"}},"required":["id","status","requestedPrincipalCents","requestedTipCents","returnedPrincipalCents","returnedTipCents","providerRefundId","providerErrorMessage","reason","resolvedAt","createdAt"]}}},"required":["id","organizationId","locationId","venueName","currency","source","method","principalCents","tipCents","refundedPrincipalCents","refundedTipCents","status","failedPaymentAttempts","latestOperation","isFixture","startedAt","lastUpdatedAt","attempts","refunds"]}}}}}}},"/api/public/v1/paymentHistory/filterOptions":{"post":{"operationId":"paymentHistory.filterOptions","summary":"List the values the payments list can filter by","description":"Returns the open venues of organizationId at which the caller holds payment:read, and the statuses, methods, terminal ids and currencies payments at those venues carry, or only at the venues locationIds names; naming any other venue is FORBIDDEN. Nothing is drawn from a venue the caller cannot read. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["payments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":200},"locationIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":200}}},"required":["organizationId"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"venues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"statuses":{"type":"array","items":{"enum":["succeeded","partiallyRefunded","refunded","needsVerification","processing","failed","canceled"],"type":"string"},"readOnly":true},"methods":{"type":"array","items":{"enum":["card","points"],"type":"string"}},"terminalIds":{"type":"array","items":{"type":"string"}},"currencies":{"type":"array","items":{"enum":["AED","USD","MXN","RUB","AMD","OMR","JOD","EUR"],"type":"string"}}},"required":["venues","statuses","methods","terminalIds","currencies"]}}}}}}},"/api/public/v1/payments/methods":{"post":{"operationId":"payments.methods","description":"Reads the payments.methods procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/payments/confirmers":{"post":{"operationId":"payments.confirmers","description":"Reads the payments.confirmers procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"}}},"required":["names"]}}}}}}},"/api/public/v1/payments/pay":{"post":{"operationId":"payments.pay","description":"Records one payment against an order, the whole balance or a part of it. An order holding a pass without a guest attached is refused with BAD_REQUEST as `passNeedsGuest` before any money is taken. While the organization asks for the guest's WhatsApp code when selling a pass, an order holding a pass whose customer has not verified it with `customers.verifyPassSaleCode` is refused with FORBIDDEN as `passCodeRequired` before any money is taken. An unpaid order whose pass discount no longer holds (the pass's allowance was used on another order, or the pass ended, was voided or is not on sale at this Location) is refused with CONFLICT as `passRedemptionChanged` before any money is taken, and the order is repriced without it: read the order again for the new total. While the organization asks for the guest's WhatsApp code when redeeming a pass, an unpaid order with a line a pass redeems whose customer has not verified it (with `customers.verifyPassRedemptionCode`, or any other code that verifies the order's guest) is refused with FORBIDDEN as `passRedemptionCodeRequired` before any money is taken. A `pointsCents` on such an order is refused with BAD_REQUEST as `passNoPoints`. A covering payment completes it whatever its order type, and it earns no points. Refused with CONFLICT `terminalPaymentLive` while a card terminal payment is in progress or unresolved on the order, until it settles, is declined or cancelled, or a re-check resolves it. While the order's bill is split equally (a payment sent `equalSplit`), refused with CONFLICT `splitWaysMismatch` for a part under another number of people, `equalSlotClaimed` for a part already paid or being paid, `splitModeMismatch` for a partial payment without `equalSplit`, and `equalSplitUnavailable` when a guest split held from the QR menu rules Split equally out. A By items part (a payment sent `claimedItems`) is refused with BAD_REQUEST `itemNotOnBill` for a line not on the order, and CONFLICT `itemAlreadyClaimed` for a quantity already paid or being paid, `itemsShareChanged` for an amount other than the lines' share, and `itemsSplitUnavailable` while the bill is split another way; a partial payment without `claimedItems`, an equal part included, is refused `splitModeMismatch` while items are claimed. A payment of the whole balance is never refused for the split. An optional `tipCents` rides beside `amountCents`, never inside it: it covers nothing on the bill, cash must cover both, and it is refused with BAD_REQUEST `tipsOff` where the venue's POS tips are off. An optional `pointsCents` spends the attached member's loyalty points first, as a payment of its own whose `paymentType` is `points`, and `amountCents` pays the rest (zero records the points alone, or with a tip a zero-amount payment of `paymentType` that carries it and its cash tender, since points never pay a tip); it is refused with PRECONDITION_FAILED `pointsUnavailable` when the business takes no new Loyalty work (its own switch is off, or its plan restricts or lacks Loyalty), the program is not live or the order has no unarchived member, FORBIDDEN `pointsCodeRequired` while the organization asks for the guest's WhatsApp code before points pay and `customers.verifyPointsCode` has not verified the order for its customer, CONFLICT `guestPaying` while a guest pays the table from the QR menu, and BAD_REQUEST `pointsOverLimit` beyond the balance or the program's share of the bill, or while the balance is under the program's minimum balance to redeem. An optional `simulatedCard: true`, sent by a till's simulated card steps on an approval, also records a card payment in payment history as a succeeded `terminal` fixture, only in a demo business with the `payments` flag on; elsewhere it is ignored. Beside it, an optional `continuesAttemptId` names the declined or unanswered simulated attempt this approval retried, so history records both as one payment. A covering payment answers `loyaltyEarn`, what the order earned its member and their balance after it, or null; with the plan lacking Loyalty under enforcement, the order earns nothing. Refused with CONFLICT and the refusal orderNotShipped for a supplier's shipment order that has not shipped yet: Ship it first. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"paymentType":{"anyOf":[{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"}]},"amountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tenderedCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":0,"maximum":2147483647},"pointsCents":{"type":"integer","minimum":1,"maximum":2147483647},"idempotencyKey":{"type":"string","minLength":1},"simulatedCard":{"const":true},"continuesAttemptId":{"type":"string","format":"uuid"},"expectedRemainingCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"equalSplit":{"type":"object","properties":{"ways":{"type":"integer","minimum":2,"maximum":20},"part":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["ways","part"]},"claimedItems":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":1,"maximum":99}}},"required":["orderId","paymentType","amountCents","idempotencyKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/payments/recordSimulatedCardAttempt":{"post":{"operationId":"payments.recordSimulatedCardAttempt","description":"Runs the payments.recordSimulatedCardAttempt procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"attemptId":{"type":"string","format":"uuid"},"outcome":{"enum":["declined","unresolved"],"type":"string"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0},"tipCents":{"type":"integer","minimum":0,"maximum":2147483647},"continuesAttemptId":{"type":"string","format":"uuid"}},"required":["orderId","attemptId","outcome","amountCents"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/payments/refundDetails":{"post":{"operationId":"payments.refundDetails","description":"Reads the payments.refundDetails procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string"},"remainingCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"unpostedHistoricalCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"canRecord":{"type":"boolean"},"blockedReason":{"anyOf":[{"enum":["imported","unpaid"],"type":"string"},{"type":"null"}]},"basis":{"type":"object","properties":{"lines":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"orderItemId":{"type":"string"},"name":{"type":"string"},"saleCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"municipalityFeeCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"serviceFeeCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"serviceFeeVatCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"taxAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"refundedSaleCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundedFeeCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundedServiceFeeCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundedServiceFeeVatCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["orderItemId","name","saleCents","municipalityFeeCents","serviceFeeCents","serviceFeeVatCents","taxAmountCents","refundedSaleCents","refundedFeeCents","refundedServiceFeeCents","refundedServiceFeeVatCents"]}},{"type":"null"}]}},"required":["lines"]},"redeemedLines":{"type":"array","items":{"type":"object","properties":{"orderItemId":{"type":"string"},"passName":{"type":"string"}},"required":["orderItemId","passName"]}},"payments":{"type":"array","items":{"type":"object","properties":{"paymentType":{"type":"string"},"amountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"refundedAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"saleCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"refundedSaleCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"municipalityFeeCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"refundedFeeCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"serviceFeeCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"refundedServiceFeeCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"serviceFeeVatCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"refundedServiceFeeVatCents":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["paymentType","amountCents","refundedAmountCents","saleCents","refundedSaleCents","municipalityFeeCents","refundedFeeCents","serviceFeeCents","refundedServiceFeeCents","serviceFeeVatCents","refundedServiceFeeVatCents"]}},"methods":{"type":"array","items":{"type":"object","properties":{"key":{"anyOf":[{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"},{"not":{}}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["key","name"]}},"history":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"amountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"saleCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"municipalityFeeCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"serviceFeeCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"serviceFeeVatCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"taxAmountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"tipReturnedCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"timeZone":{"type":"string"},"postedAt":{"type":"string","format":"date-time","x-native-type":"date"},"paymentTypes":{"type":"array","items":{"type":"string"}},"paymentMethods":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["key","name"]}}},"required":["id","amountCents","saleCents","municipalityFeeCents","serviceFeeCents","serviceFeeVatCents","taxAmountCents","reason","tipReturnedCents","timeZone","postedAt","paymentTypes","paymentMethods"]}},"passUsesReturned":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"occurredAt":{"type":"string","format":"date-time","x-native-type":"date"},"timeZone":{"type":"string"},"itemName":{"type":"string"},"passName":{"type":"string"},"actorName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","occurredAt","timeZone","itemName","passName","actorName"]}}},"required":["currency","remainingCents","tipCents","unpostedHistoricalCents","canRecord","blockedReason","basis","redeemedLines","payments","methods","history","passUsesReturned"]}}}}}}},"/api/public/v1/payments/providerRefundDetails":{"post":{"operationId":"payments.providerRefundDetails","summary":"Read an order's payment provider refunds","description":"Each of the order's guest payments taken through a payment provider (MyFatoorah today) with what is left to refund and its QR tip and what is left of that, its items for a payment made by items, the order's other payments, and every provider refund request with its status and any attention it needs. Read only; no provider is called. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string"},"payments":{"type":"array","items":{"type":"object","properties":{"paymentId":{"type":"string"},"amountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"remainingCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tipLeftCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"mode":{"enum":["full","equal","items","custom","prepay"],"type":"string"},"paidAt":{"type":"string","format":"date-time","x-native-type":"date"},"items":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"orderItemId":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"number"},"amountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["orderItemId","name","quantity","amountCents"]}},{"type":"null"}]},"inDoubt":{"type":"boolean"}},"required":["paymentId","amountCents","remainingCents","tipCents","tipLeftCents","mode","paidAt","items","inDoubt"]}},"hasOtherPayments":{"type":"boolean"},"requests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"paymentId":{"type":"string"},"amountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"returnedCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"status":{"enum":["requested","scheduled","pending","refunded","canceled","failed","unknown","released","withdrawn"],"type":"string"},"attention":{"anyOf":[{"enum":["stillScheduled","stillPending","released","lookupFailing","lateConfirmed","amountMismatch","unpostable"],"type":"string"},{"type":"null"}]},"requestedAt":{"type":"string","format":"date-time","x-native-type":"date"},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","paymentId","amountCents","tipCents","returnedCents","status","attention","requestedAt","lastError"]}}},"required":["currency","payments","hasOtherPayments","requests"]}}}}}}},"/api/public/v1/payments/myFatoorahRefundDetails":{"post":{"operationId":"payments.myFatoorahRefundDetails","summary":"Legacy name of payments.providerRefundDetails; read that instead.","description":"Reads the payments.myFatoorahRefundDetails procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string"},"payments":{"type":"array","items":{"type":"object","properties":{"paymentId":{"type":"string"},"amountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"remainingCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tipLeftCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"mode":{"enum":["full","equal","items","custom","prepay"],"type":"string"},"paidAt":{"type":"string","format":"date-time","x-native-type":"date"},"items":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"orderItemId":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"number"},"amountCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["orderItemId","name","quantity","amountCents"]}},{"type":"null"}]},"inDoubt":{"type":"boolean"}},"required":["paymentId","amountCents","remainingCents","tipCents","tipLeftCents","mode","paidAt","items","inDoubt"]}},"hasOtherPayments":{"type":"boolean"},"requests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"paymentId":{"type":"string"},"amountCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"tipCents":{"type":"integer","minimum":0,"maximum":9007199254740991},"returnedCents":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"status":{"enum":["requested","scheduled","pending","refunded","canceled","failed","unknown","released","withdrawn"],"type":"string"},"attention":{"anyOf":[{"enum":["stillScheduled","stillPending","released","lookupFailing","lateConfirmed","amountMismatch","unpostable"],"type":"string"},{"type":"null"}]},"requestedAt":{"type":"string","format":"date-time","x-native-type":"date"},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","paymentId","amountCents","tipCents","returnedCents","status","attention","requestedAt","lastError"]}}},"required":["currency","payments","hasOtherPayments","requests"]}}}}}}},"/api/public/v1/payments/setTip":{"post":{"operationId":"payments.setTip","description":"Sets a paid order's tip after payment; zero removes it. `tipCents` is the order's whole tip: the difference is posted as signed tip rows shared over the tenders not wholly refunded that were tipped — a cut in proportion to their tips now, never taking one below zero; a raise in proportion to what each was tipped — so lowering and restoring a tip puts each tender back where it was. `receiptMethod` (`card` or `cash`) records how the guest left the whole tip, whatever paid the order: the tip already standing moves onto that method first, so a method alone is a change too. What no such tender can take lands on the latest tender not wholly refunded. The response names the tender the change was posted on, the newest when it is shared over several. Refused with BAD_REQUEST `tipWindowClosed` once the order's shift has closed or for an order with no shift, `tipsOff` where the venue's POS tips are off, `orderCancelled` for a cancelled order, `orderNotPaid` before the order is fully paid, `noStandingPayment` when every tender was refunded, and `qrTipped` for an order a guest tipped through the QR menu, since that tip rode their MyFatoorah charge. Changing a tip already set, or any tip on a done order, needs `order:adjustTip`. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"tipCents":{"type":"integer","minimum":0,"maximum":2147483647},"receiptMethod":{"enum":["card","cash"],"type":"string"}},"required":["orderId","tipCents"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"paymentId":{"type":"string"},"tipCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["paymentId","tipCents"]}}}}}}},"/api/public/v1/payments/changePaymentType":{"post":{"operationId":"payments.changePaymentType","summary":"Change a payment's type","description":"Moves one payment of a fully paid order onto another method the venue's till may tender now, with a reason (`wrong_method_selected`, `guest_paid_differently`, or `other` with a `note`). Only the method changes: amount, time and the order stay as they are, and leaving cash drops the cash handed over and the change given. Each change is recorded with the method before and after, the reason, who and when; reports and dashboards read the current method. The order's shift plays no part: a closed or shift-less order is corrected too, by anyone holding the grant. Refused with BAD_REQUEST `orderCancelled`, `orderNotPaid` before the order is fully paid, `importedOrder` for an order Fortis recorded, `integratedPayment` for a payment taken on an NI terminal, online by the guest, or in loyalty points, `paymentRefunded` for a payment refunded in whole or part, `methodNotOffered` for a method the till may not tender — MyFatoorah included, since a provider's method charges only online — and `samePaymentType` when the payment already carries it. Needs `order:changePaymentType`. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"paymentId":{"type":"string","minLength":1},"paymentType":{"anyOf":[{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"}]},"reason":{"enum":["wrong_method_selected","guest_paid_differently","other"],"type":"string"},"note":{"type":"string","maxLength":500}},"required":["orderId","paymentId","paymentType","reason"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"paymentId":{"type":"string"},"paymentType":{"anyOf":[{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"},{"not":{}}]}},"required":["paymentId","paymentType"]}}}}}}},"/api/public/v1/payments/refund":{"post":{"operationId":"payments.refund","summary":"Record a refund of an order","description":"Records money already returned to the guest outside this app (cash, card terminal, a till's own tenders); no payment provider is called, and imported orders are refused for Fortis to record. A guest's online payment through a payment provider is never recorded here: it is refunded through payments.refundProviderPayment. Refused with BAD_REQUEST and refusal `refundThroughMyFatoorah` when such a payment still has money to refund and the request names no amount, asks for more than the order's other payments hold, or sends an expectedRemainingCents that counts that payment. Each refunded payment's tip goes back with it, in the share of that payment refunded, posted as negative tip rows; the refunds that empty a payment return exactly the tip paid on it. An order that sold or renewed a guest's pass is refunded only whole, within 14 days of the sale and while the pass is unused; anything else is refused with BAD_REQUEST and refusal `passRefundPartial`, `passRefundLate` or `passRefundUsed` before any money moves, and an allowed refund voids the pass or takes the renewal back. A whole refund, or one whose `lineIds` name the line a pass redeemed, gives that use back, even at no money. Needs `order:refund`. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"paymentType":{"anyOf":[{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"}]},"lineIds":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"string","minLength":1}},"reason":{"type":"string","maxLength":500},"idempotencyKey":{"type":"string","minLength":1,"maxLength":200},"expectedRemainingCents":{"type":"integer","minimum":0,"maximum":2147483647}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/payments/equalSplit":{"post":{"operationId":"payments.equalSplit","description":"Reads the payments.equalSplit procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ways":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"parts":{"type":"array","items":{"type":"object","properties":{"part":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paymentType":{"anyOf":[{"anyOf":[{"enum":["cash","card","wallet","mixed","other","points"],"type":"string"},{"anyOf":[{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"},{"not":{}}]}]},{"type":"null"}]},"paid":{"type":"boolean"}},"required":["part","amountCents","paymentType","paid"]}},"reservedCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"guestSplitConflict":{"type":"boolean"},"claimedItems":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"paidBy":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"anyOf":[{"enum":["cash","card","wallet","mixed","other","points"],"type":"string"},{"anyOf":[{"enum":["cash","card","voucher","gift_card","staff","bank_transfer","payment_link","zomato_pay","careem_pay","myfatoorah","geidea"],"type":"string"},{"not":{}}]}]}}},"paidItems":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"itemsSplitConflict":{"type":"boolean"}},"required":["ways","parts","reservedCents","guestSplitConflict","claimedItems","paidBy","paidItems","itemsSplitConflict"]}}}}}}},"/api/public/v1/payments/cancelProviderRefund":{"post":{"operationId":"payments.cancelProviderRefund","summary":"Cancel a scheduled payment provider refund","description":"Withdraws a refund the payment's provider refused for insufficient balance and that waits to be sent again daily: no refund exists on the provider's side, so its amount is freed. A refund the provider accepted can't be canceled through its API. Refused with CONFLICT and refusal `notScheduled` when the refund is no longer scheduled. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"refundId":{"type":"string","minLength":1}},"required":["orderId","refundId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"refundId":{"type":"string"},"status":{"enum":["requested","scheduled","pending","refunded","canceled","failed","unknown","released","withdrawn"],"type":"string"}},"required":["refundId","status"]}}}}}}},"/api/public/v1/payments/cancelMyFatoorahRefund":{"post":{"operationId":"payments.cancelMyFatoorahRefund","summary":"Legacy name of payments.cancelProviderRefund; call that instead.","description":"Runs the payments.cancelMyFatoorahRefund procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"refundId":{"type":"string","minLength":1}},"required":["orderId","refundId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"refundId":{"type":"string"},"status":{"enum":["requested","scheduled","pending","refunded","canceled","failed","unknown","released","withdrawn"],"type":"string"}},"required":["refundId","status"]}}}}}}},"/api/public/v1/payments/refundProviderPayment":{"post":{"operationId":"payments.refundProviderPayment","summary":"Refund a guest's payment provider payment","description":"Sends a real refund to the guest's card through the payment provider that took the payment (MyFatoorah today), even if the business has since switched providers: all that is left of the payment, `amountCents` of it, or the `itemIds` a payment made by items paid for, plus the guest's QR tip on it in the share of the payment refunded, given back as a negative tip row once the provider returns it. Answers `pending` once the provider accepted it, `scheduled` when its balance can't fund it yet (sent again daily), or `unknown` when it never answered (looked up before anything is resent). Refused with BAD_REQUEST and refusal `notMyFatoorah` for a payment not made through a payment provider, BAD_REQUEST and refusal `overLimit` for more than is left of it, CONFLICT and refusal `inDoubt` while its last refund is still unconfirmed, and PRECONDITION_FAILED when the business has no connection to that provider. A retried `idempotencyKey` returns the same refund. An order that sold or renewed a guest's pass is refunded only whole, within 14 days of the sale and while the pass is unused; anything else is refused with BAD_REQUEST and refusal `passRefundPartial`, `passRefundLate` or `passRefundUsed` before the provider is asked, and an allowed refund voids the pass or takes the renewal back. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"paymentId":{"type":"string","minLength":1},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"itemIds":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"string","minLength":1}},"reason":{"type":"string","maxLength":500},"idempotencyKey":{"type":"string","minLength":1,"maxLength":200}},"required":["orderId","paymentId","idempotencyKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"refundId":{"type":"string"},"status":{"enum":["requested","scheduled","pending","refunded","canceled","failed","unknown","released","withdrawn"],"type":"string"}},"required":["refundId","status"]}}}}}}},"/api/public/v1/payments/refundMyFatoorah":{"post":{"operationId":"payments.refundMyFatoorah","summary":"Legacy name of payments.refundProviderPayment; call that instead.","description":"Runs the payments.refundMyFatoorah procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","deprecated":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","minLength":1},"paymentId":{"type":"string","minLength":1},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},"itemIds":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"string","minLength":1}},"reason":{"type":"string","maxLength":500},"idempotencyKey":{"type":"string","minLength":1,"maxLength":200}},"required":["orderId","paymentId","idempotencyKey"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"refundId":{"type":"string"},"status":{"enum":["requested","scheduled","pending","refunded","canceled","failed","unknown","released","withdrawn"],"type":"string"}},"required":["refundId","status"]}}}}}}},"/api/public/v1/payments/guestPaymentLock":{"post":{"operationId":"payments.guestPaymentLock","description":"Reads the payments.guestPaymentLock procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/preferences/update":{"post":{"operationId":"preferences.update","description":"Runs the preferences.update procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"enum":["light","dark","system"],"type":"string"},"posLayout":{"enum":["catalog-first","cart-first"],"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/preferences/finishOnboardingGuide":{"post":{"operationId":"preferences.finishOnboardingGuide","description":"Runs the preferences.finishOnboardingGuide procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/preferences/contactPhone":{"post":{"operationId":"preferences.contactPhone","description":"Reads the preferences.contactPhone procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["phone"]}}}}}}},"/api/public/v1/preferences/setContactPhone":{"post":{"operationId":"preferences.setContactPhone","description":"Sets the caller's private contact number. A number without a calling code is read in the first country the caller's regions dial; one dialled in a country none of them offer is refused with BAD_REQUEST and refusal `phoneCountryNotOffered`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","minLength":1}},"required":["phone"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"not":{}}]}}}}}}},"/api/public/v1/printerScan/printerScanTargets":{"post":{"operationId":"printerScan.printerScanTargets","description":"Reads the printerScan.printerScanTargets procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"installId":{"type":"string"},"device":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"platform":{"enum":["android","ios","macos","windows","linux"],"type":"string"},"instanceId":{"type":"string"}},"required":["name","platform","instanceId"]},{"type":"null"}]}},"required":["installId","device"]}}}}}}}},"/api/public/v1/printerScan/requestPrinterScan":{"post":{"operationId":"printerScan.requestPrinterScan","description":"Runs the printerScan.requestPrinterScan procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"installId":{"type":"string","minLength":1,"maxLength":64}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"scanId":{"type":"string"}},"required":["scanId"]}}}}}}},"/api/public/v1/printerScan/claimPrinterScan":{"post":{"operationId":"printerScan.claimPrinterScan","description":"Runs the printerScan.claimPrinterScan procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"installId":{"type":"string","minLength":1,"maxLength":64}},"required":["locationId","installId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"scanId":{"type":"string"},"deadlineInMs":{"type":"number"}},"required":["scanId","deadlineInMs"]},{"type":"null"}]}}}}}}},"/api/public/v1/printerScan/reportPrinterScan":{"post":{"operationId":"printerScan.reportPrinterScan","description":"Runs the printerScan.reportPrinterScan procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scanId":{"type":"string","minLength":1,"maxLength":64},"installId":{"type":"string","minLength":1,"maxLength":64},"paired":{"type":"object","properties":{"printers":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"kind":{"enum":["serial","ble","usb"],"type":"string"},"path":{"type":"string","minLength":1,"maxLength":255},"label":{"type":"string","maxLength":255},"connected":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"model":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}]}},"required":["kind","path","label","connected","model"]}},"error":{"type":"string"}},"required":["printers"]},"network":{"anyOf":[{"type":"array","maxItems":200,"items":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255},"port":{"type":"integer","minimum":1,"maximum":65535},"label":{"type":"string","minLength":1,"maxLength":255},"source":{"enum":["mdns","scan"],"type":"string"},"model":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"identity":{"type":"object","properties":{"serial":{"type":"string","minLength":1,"maxLength":64},"model":{"type":"string","minLength":1,"maxLength":64},"mdnsInstance":{"type":"string","minLength":1,"maxLength":255}},"required":["serial"]},"mdnsInstance":{"type":"string","minLength":1,"maxLength":255}},"required":["host","port","label","source","model"]}},{"type":"null"}]},"error":{"type":"string"}},"required":["scanId","installId","paired","network"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"settled":{"type":"boolean"}},"required":["settled"]}}}}}}},"/api/public/v1/printerScan/printerScanResults":{"post":{"operationId":"printerScan.printerScanResults","description":"Reads the printerScan.printerScanResults procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scanId":{"type":"string","minLength":1,"maxLength":64}},"required":["scanId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"live":{"type":"boolean"},"finished":{"type":"boolean"},"deadlineInMs":{"type":"number"},"devices":{"type":"array","items":{"type":"object","properties":{"installId":{"type":"string"},"device":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"platform":{"enum":["android","ios","macos","windows","linux"],"type":"string"},"instanceId":{"type":"string"}},"required":["name","platform","instanceId"]},{"type":"null"}]},"status":{"enum":["running","completed","failed","waiting","noAnswer"],"type":"string"},"paired":{"anyOf":[{"type":"object","properties":{"printers":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"kind":{"enum":["serial","ble","usb"],"type":"string"},"path":{"type":"string","minLength":1,"maxLength":255},"label":{"type":"string","maxLength":255},"connected":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"model":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}]}},"required":["kind","path","label","connected","model"]}},"error":{}},"required":["printers"]},{"type":"null"}]},"network":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255},"port":{"type":"integer","minimum":1,"maximum":65535},"label":{"type":"string","minLength":1,"maxLength":255},"source":{"enum":["mdns","scan"],"type":"string"},"model":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}]},"identity":{"type":"object","properties":{"serial":{"type":"string","minLength":1,"maxLength":64},"model":{"type":"string","minLength":1,"maxLength":64},"mdnsInstance":{"type":"string","minLength":1,"maxLength":255}},"required":["serial"]},"mdnsInstance":{"type":"string","minLength":1,"maxLength":255}},"required":["host","port","label","source","model"]}},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["installId","device","status","paired","network","error"]}}},"required":["live","finished","deadlineInMs","devices"]}}}}}}},"/api/public/v1/printing/listPrinters":{"post":{"operationId":"printing.listPrinters","description":"Reads the printing.listPrinters procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/savePrinter":{"post":{"operationId":"printing.savePrinter","summary":"Register or update a printer","description":"Registers a printer at a venue (printerId null) or rewrites one with its whole station link set; an update keeps the printer's id, stations, roles and job history. Answers CONFLICT when the identity's serial belongs to another printer of the venue, and CONFLICT with refusal `addressTaken` when an update moves the printer to a transport another printer of the venue holds. A new non-null ownerInstallId must name an installation of the venue, or the save answers PRECONDITION_FAILED with refusal `pinUnknownDevice`; a registration carrying `savedFrom` records that installation's link first, so it may pin the printer to itself. With `foundBy`, the pin and a device link follow the installation whose search answer reported the printer, and an answer that did not report it is refused with BAD_REQUEST. With `serialDecision`, a registration whose serial another location of the organization holds answers CONFLICT with refusal `serialElsewhere` for `ask`, deletes that printer there for `move` (which needs the settings-update permission on that location), and registers it here as well for `share`; without `serialDecision` it registers as before.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"printerId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":64},"transport":{"anyOf":[{"anyOf":[{"type":"object","properties":{"kind":{"const":"network"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]},{"type":"object","properties":{"kind":{"const":"serial"},"path":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\/dev\\/[A-Za-z0-9._-]+$"}},"required":["kind","path"]},{"type":"object","properties":{"kind":{"const":"ble"},"name":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","name"]},{"type":"object","properties":{"kind":{"const":"usb"},"device":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","device"]}]},{"type":"object","properties":{"kind":{"const":"wifi"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]}]},"paperWidth":{"enum":[58,80]},"ownerInstallId":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"null"}]},"printShiftReport":{"type":"boolean"},"beepSound":{"type":"boolean"},"autoPrintGuestBill":{"type":"boolean"},"stationIds":{"type":"array","maxItems":50,"items":{"type":"string","minLength":1}},"identity":{"type":"object","properties":{"serial":{"type":"string","minLength":1,"maxLength":64},"model":{"type":"string","minLength":1,"maxLength":64},"mdnsInstance":{"type":"string","minLength":1,"maxLength":255}},"required":["serial"]},"foundBy":{"type":"object","properties":{"scanId":{"type":"string","minLength":1,"maxLength":64},"installId":{"type":"string","minLength":1,"maxLength":64}},"required":["scanId","installId"]},"savedFrom":{"type":"string","minLength":1,"maxLength":64},"serialDecision":{"enum":["ask","move","share"],"type":"string"}},"required":["locationId","printerId","name","transport","paperWidth","ownerInstallId","stationIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/deletePrinter":{"post":{"operationId":"printing.deletePrinter","description":"Runs the printing.deletePrinter procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printerId":{"type":"string","minLength":1}},"required":["printerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/setReceiptPrinter":{"post":{"operationId":"printing.setReceiptPrinter","description":"Runs the printing.setReceiptPrinter procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"printerId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"document":{"enum":["bill","invoice"],"type":"string"}},"required":["locationId","printerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/setCashDrawer":{"post":{"operationId":"printing.setCashDrawer","description":"Runs the printing.setCashDrawer procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printerId":{"type":"string","minLength":1},"opensCashDrawer":{"type":"boolean"}},"required":["printerId","opensCashDrawer"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"opensCashDrawer":{"type":"boolean"}},"required":["opensCashDrawer"]}}}}}}},"/api/public/v1/printing/createPrintJob":{"post":{"operationId":"printing.createPrintJob","description":"Runs the printing.createPrintJob procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printerId":{"type":"string","minLength":1},"document":{"type":"object","properties":{"kind":{"const":"test"}},"required":["kind"]}},"required":["printerId","document"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/onQueueChanged":{"post":{"operationId":"printing.onQueueChanged","description":"Runs the printing.onQueueChanged procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"installId":{"type":"string","minLength":1,"maxLength":64}},"required":["locationId","installId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/claimPrintJobs":{"post":{"operationId":"printing.claimPrintJobs","description":"Runs the printing.claimPrintJobs procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"installId":{"type":"string","minLength":1,"maxLength":64},"limit":{"type":"integer","minimum":1,"maximum":10,"default":5},"exceptPrinterIds":{"type":"array","items":{"type":"string","minLength":1},"default":[]},"supportsShiftReport":{"type":"boolean","default":false},"supportsCashDrawer":{"type":"boolean","default":false}},"required":["locationId","installId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/reportPrintJobResult":{"post":{"operationId":"printing.reportPrintJobResult","description":"Runs the printing.reportPrintJobResult procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","minLength":1},"installId":{"type":"string","minLength":1,"maxLength":64},"outcome":{"enum":["sent","accepted","failed","unknown","undelivered","expired"],"type":"string"},"error":{"type":"string","maxLength":500},"release":{"type":"boolean"},"status":{"type":"integer","minimum":0,"maximum":255},"identity":{"type":"object","properties":{"serial":{"type":"string","minLength":1,"maxLength":64},"model":{"type":"string","minLength":1,"maxLength":64},"mdnsInstance":{"type":"string","minLength":1,"maxLength":255}},"required":["serial"]}},"required":["jobId","installId","outcome"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/reportPrinterLiveness":{"post":{"operationId":"printing.reportPrinterLiveness","description":"Runs the printing.reportPrinterLiveness procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"installId":{"type":"string","minLength":1,"maxLength":64},"observations":{"type":"array","maxItems":50,"items":{"type":"object","properties":{"printerId":{"type":"string","minLength":1},"reachable":{"type":"boolean"}},"required":["printerId","reachable"]}}},"required":["locationId","installId","observations"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/rebindPrinter":{"post":{"operationId":"printing.rebindPrinter","description":"Runs the printing.rebindPrinter procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printerId":{"type":"string","minLength":1},"from":{"anyOf":[{"anyOf":[{"type":"object","properties":{"kind":{"const":"network"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]},{"type":"object","properties":{"kind":{"const":"serial"},"path":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\/dev\\/[A-Za-z0-9._-]+$"}},"required":["kind","path"]},{"type":"object","properties":{"kind":{"const":"ble"},"name":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","name"]},{"type":"object","properties":{"kind":{"const":"usb"},"device":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","device"]}]},{"type":"object","properties":{"kind":{"const":"wifi"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]}]},"to":{"anyOf":[{"anyOf":[{"type":"object","properties":{"kind":{"const":"network"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]},{"type":"object","properties":{"kind":{"const":"serial"},"path":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\/dev\\/[A-Za-z0-9._-]+$"}},"required":["kind","path"]},{"type":"object","properties":{"kind":{"const":"ble"},"name":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","name"]},{"type":"object","properties":{"kind":{"const":"usb"},"device":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","device"]}]},{"type":"object","properties":{"kind":{"const":"wifi"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]}]},"serial":{"type":"string","minLength":1,"maxLength":64},"mdnsInstance":{"type":"string","minLength":1,"maxLength":255}},"required":["printerId","from","to"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"rebound":{"type":"boolean"}},"required":["rebound"]}}}}}}},"/api/public/v1/printing/flagPrinterRebind":{"post":{"operationId":"printing.flagPrinterRebind","description":"Runs the printing.flagPrinterRebind procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printerId":{"type":"string","minLength":1},"from":{"anyOf":[{"anyOf":[{"type":"object","properties":{"kind":{"const":"network"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]},{"type":"object","properties":{"kind":{"const":"serial"},"path":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\/dev\\/[A-Za-z0-9._-]+$"}},"required":["kind","path"]},{"type":"object","properties":{"kind":{"const":"ble"},"name":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","name"]},{"type":"object","properties":{"kind":{"const":"usb"},"device":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","device"]}]},{"type":"object","properties":{"kind":{"const":"wifi"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]}]}},"required":["printerId","from"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"flagged":{"const":true}},"required":["flagged"]}}}}}}},"/api/public/v1/printing/pendingJobs":{"post":{"operationId":"printing.pendingJobs","description":"Reads the printing.pendingJobs procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/printing/recentJobs":{"post":{"operationId":"printing.recentJobs","description":"Reads the printing.recentJobs procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printerId":{"type":"string","minLength":1}},"required":["printerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"enum":["pending","claimed","sent","accepted","failed","unknown","expired"],"type":"string"},"kind":{"anyOf":[{"const":"shift_report"},{"const":"kitchen"},{"const":"pager_assignment"},{"const":"bill"},{"const":"invoice"},{"const":"cash_drawer"},{"const":"test"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time"},"claimedById":{"anyOf":[{"type":"string"},{"type":"null"}]},"device":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"platform":{"enum":["android","ios","macos","windows","linux"],"type":"string"},"instanceId":{"type":"string"}},"required":["name","platform","instanceId"]},{"type":"null"}]}},"required":["id","status","kind","error","createdAt","claimedById","device"]}}}}}}}},"/api/public/v1/printing/printerLinks":{"post":{"operationId":"printing.printerLinks","description":"Reads the printing.printerLinks procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printerId":{"type":"string","minLength":1}},"required":["printerId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"installId":{"type":"string"},"reached":{"type":"boolean"},"checkedAgoSeconds":{"type":"number"},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]},"device":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"platform":{"enum":["android","ios","macos","windows","linux"],"type":"string"},"instanceId":{"type":"string"}},"required":["name","platform","instanceId"]},{"type":"null"}]}},"required":["installId","reached","checkedAgoSeconds","lastError","device"]}}}}}}}},"/api/public/v1/printing/serialHolder":{"post":{"operationId":"printing.serialHolder","description":"Reads the printing.serialHolder procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"serial":{"type":"string","minLength":1,"maxLength":64}},"required":["locationId","serial"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"printerId":{"type":"string"},"printerName":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"},"queuedJobs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"canMove":{"type":"boolean"}},"required":["printerId","printerName","locationId","locationName","queuedJobs","canMove"]},{"type":"null"}]}}}}}}},"/api/public/v1/printing/testJobStatus":{"post":{"operationId":"printing.testJobStatus","description":"Reads the printing.testJobStatus procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","minLength":1}},"required":["jobId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":["pending","claimed","sent","accepted","failed","unknown","expired"],"type":"string"},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]},"claimedById":{"anyOf":[{"type":"string"},{"type":"null"}]},"claimedBy":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"platform":{"enum":["android","ios","macos","windows","linux"],"type":"string"},"instanceId":{"type":"string"}},"required":["name","platform","instanceId"]},{"type":"null"}]}},"required":["status","lastError","claimedById","claimedBy"]}}}}}}},"/api/public/v1/printing/stalledQueue":{"post":{"operationId":"printing.stalledQueue","description":"Reads the printing.stalledQueue procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"jobCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"waitedMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"printerNames":{"type":"array","items":{"type":"string"}}},"required":["jobCount","waitedMinutes","printerNames"]},{"type":"null"}]}}}}}}},"/api/public/v1/printing/whoPrints":{"post":{"operationId":"printing.whoPrints","description":"Reads the printing.whoPrints procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"installId":{"type":"string"},"pinned":{"type":"boolean"},"online":{"type":"boolean"},"checkedAgoSeconds":{"anyOf":[{"type":"number"},{"type":"null"}]},"device":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"platform":{"enum":["android","ios","macos","windows","linux"],"type":"string"},"instanceId":{"type":"string"},"foreground":{"type":"boolean"},"locationId":{"type":"string"},"locationName":{"type":"string"}},"required":["name","platform","instanceId","foreground","locationId","locationName"]},{"type":"null"}]}},"required":["installId","pinned","online","checkedAgoSeconds","device"]}}}}}}}},"/api/public/v1/cashDrawer/settings":{"post":{"operationId":"cashDrawer.settings","description":"Reads the cashDrawer.settings procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"autoOpen":{"type":"boolean"},"cashOffered":{"type":"boolean"}},"required":["autoOpen","cashOffered"]}}}}}}},"/api/public/v1/cashDrawer/setAutoOpen":{"post":{"operationId":"cashDrawer.setAutoOpen","description":"Runs the cashDrawer.setAutoOpen procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"autoOpen":{"type":"boolean"}},"required":["locationId","autoOpen"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"autoOpen":{"type":"boolean"}},"required":["autoOpen"]}}}}}}},"/api/public/v1/cashDrawer/open":{"post":{"operationId":"cashDrawer.open","description":"Runs the cashDrawer.open procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"attemptId":{"type":"string","format":"uuid"}},"required":["id","attemptId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["jobId"]}}}}}}},"/api/public/v1/cashDrawer/openForStartingCash":{"post":{"operationId":"cashDrawer.openForStartingCash","description":"Runs the cashDrawer.openForStartingCash procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"enum":["queued","repeated","off","noInvoicePrinter"],"type":"string"}},"required":["jobId","outcome"]}}}}}}},"/api/public/v1/cashDrawer/testOpen":{"post":{"operationId":"cashDrawer.testOpen","description":"Runs the cashDrawer.testOpen procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"attemptId":{"type":"string","format":"uuid"}},"required":["locationId","attemptId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"anyOf":[{"type":"string"},{"type":"null"}]},"outcome":{"enum":["queued","repeated","off","noInvoicePrinter"],"type":"string"}},"required":["jobId","outcome"]}}}}}}},"/api/public/v1/receipts/printability":{"post":{"operationId":"receipts.printability","description":"Reads the receipts.printability procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/receipts/queuePrint":{"post":{"operationId":"receipts.queuePrint","description":"Queues the order's Guest Bill or its issued invoice on the printer its venue nominated for that document, else on the one nominated for the other guest document. A bill may carry the loyalty points the Pay screen applies, refused with BAD_REQUEST refusal `pointsOverLimit` where a payment could not spend them, which includes the plan lacking Loyalty under enforcement; nothing is debited. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"kind":{"enum":["bill","invoice"],"type":"string"},"pointsCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0}},"required":["id","kind"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/receipts/printJobStatus":{"post":{"operationId":"receipts.printJobStatus","description":"Reads the receipts.printJobStatus procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","minLength":1}},"required":["jobId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/receipts/kitchenSlips":{"post":{"operationId":"receipts.kitchenSlips","description":"Reads the receipts.kitchenSlips procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"printerName":{"type":"string"},"stationName":{"type":"string"},"firedAtIso":{"type":"string"},"isFirstRound":{"type":"boolean"},"isReprint":{"type":"boolean"},"status":{"enum":["pending","claimed","sent","accepted","failed","unknown","expired"],"type":"string"},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]},"isDelayed":{"type":"boolean"},"canReprint":{"type":"boolean"}},"required":["id","printerName","stationName","firedAtIso","isFirstRound","isReprint","status","lastError","isDelayed","canReprint"]}}}}}}}},"/api/public/v1/receipts/reprintKitchenSlip":{"post":{"operationId":"receipts.reprintKitchenSlip","description":"Runs the receipts.reprintKitchenSlip procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","minLength":1}},"required":["jobId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string"}},"required":["jobId"]}}}}}}},"/api/public/v1/receipts/document":{"post":{"operationId":"receipts.document","description":"Everything one print of the order's Guest Bill or invoice needs, printer config included, for the till printing on its own connection. The bill may carry the loyalty points the Pay screen applies, refused with BAD_REQUEST refusal `pointsOverLimit` where a payment could not spend them, which includes the plan lacking Loyalty under enforcement; nothing is debited. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1},"pointsCents":{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0}},"required":["id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/receipts/printJobDocument":{"post":{"operationId":"receipts.printJobDocument","description":"The guest document a claimed print job prints, composed for the device carrying it out. A bill queued with loyalty points composes them, unless the plan lacks Loyalty under enforcement, when `bill.points` is null. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","minLength":1},"installId":{"type":"string","minLength":1,"maxLength":64}},"required":["jobId","installId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/regions/deployment":{"post":{"operationId":"regions.deployment","description":"Reads the regions.deployment procedure, the same operation the app performs. The credential's live venue permissions bound it.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/roles/list":{"post":{"operationId":"roles.list","description":"Reads the roles.list procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/roles/create":{"post":{"operationId":"roles.create","description":"Creates a custom role from a level per access area (`permissions`), from the actions granted per area (`grants`), or from levels with `grants` naming the areas that differ from them. `orderReach` says whether its order read covers the member's own joined shift or every shift; left out, it follows the levels, or the `readAllShifts` action in `grants`. A request naming `grants` may give only actions the caller holds across the organization, else FORBIDDEN `grantNotHeld`. The answer carries the role's actions per area as `grants`; `permissions` holds the level of each area a level describes and leaves out an area whose actions no level makes.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":50},"permissions":{"type":"object","properties":{"order":{"enum":["full","viewOnly","none"],"type":"string"},"staff":{"enum":["full","viewOnly","none"],"type":"string"},"report":{"enum":["full","viewOnly","none"],"type":"string"},"menu":{"enum":["full","viewOnly","none"],"type":"string"},"shift":{"enum":["full","viewOnly","none"],"type":"string"},"settings":{"enum":["full","viewOnly","none"],"type":"string"},"customer":{"enum":["full","viewOnly","none"],"type":"string"},"organization":{"enum":["full","viewOnly","none"],"type":"string"},"loyalty":{"enum":["full","viewOnly","none"],"type":"string"},"location":{"enum":["full","viewOnly","none"],"type":"string"},"billing":{"enum":["full","viewOnly","none"],"type":"string"},"table":{"enum":["full","viewOnly","none"],"type":"string"},"role":{"enum":["full","viewOnly","none"],"type":"string"},"paymentSetup":{"enum":["full","viewOnly","none"],"type":"string"},"locationPricing":{"enum":["full","viewOnly","none"],"type":"string"},"locationFeatures":{"enum":["full","viewOnly","none"],"type":"string"},"booking":{"enum":["full","viewOnly","none"],"type":"string","default":"none"},"payment":{"enum":["full","viewOnly","none"],"type":"string","default":"none"},"inventory":{"enum":["full","viewOnly","none"],"type":"string","default":"none"},"inventoryCost":{"enum":["full","viewOnly","none"],"type":"string","default":"none"},"enterpriseEvents":{"enum":["full","viewOnly","none"],"type":"string","default":"none"},"enterpriseTerminals":{"enum":["full","viewOnly","none"],"type":"string","default":"none"},"enterpriseMerchants":{"enum":["full","viewOnly","none"],"type":"string","default":"none"}},"required":["order","staff","report","menu","shift","settings","customer","organization","loyalty"]},"grants":{"type":"object","properties":{"order":{"type":"array","maxItems":17,"items":{"type":"string"},"readOnly":true,"description":"Any of: create, read, readSummary, readAllShifts, update, applyDiscount, void, advance, complete, cancel, confirmPayment, refund, print, toggleItem, delete, adjustTip, changePaymentType."},"staff":{"type":"array","items":{"type":"string"},"readOnly":true,"description":"Any of: invite, read, updateRole, suspend, remove, deleteAuthenticator. `list` is read as `read`."},"report":{"type":"array","maxItems":1,"items":{"type":"string"},"readOnly":true,"description":"Any of: read."},"menu":{"type":"array","maxItems":5,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, archive, delete."},"shift":{"type":"array","maxItems":7,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, open, close, join, manageParticipants, overrideClosed, viewSummary."},"settings":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"customer":{"type":"array","items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, archive. `list` is read as `read`."},"organization":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"location":{"type":"array","maxItems":4,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, archive."},"billing":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."},"table":{"type":"array","maxItems":4,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, delete."},"role":{"type":"array","maxItems":4,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, delete."},"paymentSetup":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."},"locationPricing":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"locationFeatures":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"loyalty":{"type":"array","maxItems":3,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, configure, adjust."},"booking":{"type":"array","maxItems":3,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update."},"payment":{"type":"array","maxItems":1,"items":{"type":"string"},"readOnly":true,"description":"Any of: read."},"inventory":{"type":"array","maxItems":3,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, post, manage."},"inventoryCost":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"enterpriseEvents":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."},"enterpriseTerminals":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."},"enterpriseMerchants":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."}}},"orderReach":{"enum":["ownShift","allShifts"],"type":"string"}},"required":["organizationId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/roles/update":{"post":{"operationId":"roles.update","description":"Changes a role's name and the access areas the request names, by level in `permissions` or by action in `grants`; an area named in both takes its `grants`. An area left out keeps what the role held, so a caller that does not know an area or an action neither grants nor revokes it, and an empty list in `grants` takes an area away. A reach left out stays as chosen, or follows the levels where none was ever chosen. A request naming `grants`, or changing a role built action by action, may add only actions the caller holds across the organization, else FORBIDDEN `grantNotHeld`. In the answer `permissions` leaves out an area whose actions no level makes, so writing it back keeps that area.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":50},"permissions":{"type":"object","properties":{"order":{"enum":["full","viewOnly","none"],"type":"string"},"staff":{"enum":["full","viewOnly","none"],"type":"string"},"report":{"enum":["full","viewOnly","none"],"type":"string"},"menu":{"enum":["full","viewOnly","none"],"type":"string"},"shift":{"enum":["full","viewOnly","none"],"type":"string"},"settings":{"enum":["full","viewOnly","none"],"type":"string"},"customer":{"enum":["full","viewOnly","none"],"type":"string"},"organization":{"enum":["full","viewOnly","none"],"type":"string"},"location":{"enum":["full","viewOnly","none"],"type":"string"},"billing":{"enum":["full","viewOnly","none"],"type":"string"},"table":{"enum":["full","viewOnly","none"],"type":"string"},"role":{"enum":["full","viewOnly","none"],"type":"string"},"paymentSetup":{"enum":["full","viewOnly","none"],"type":"string"},"locationPricing":{"enum":["full","viewOnly","none"],"type":"string"},"locationFeatures":{"enum":["full","viewOnly","none"],"type":"string"},"loyalty":{"enum":["full","viewOnly","none"],"type":"string"},"booking":{"enum":["full","viewOnly","none"],"type":"string"},"payment":{"enum":["full","viewOnly","none"],"type":"string"},"inventory":{"enum":["full","viewOnly","none"],"type":"string"},"inventoryCost":{"enum":["full","viewOnly","none"],"type":"string"},"enterpriseEvents":{"enum":["full","viewOnly","none"],"type":"string"},"enterpriseTerminals":{"enum":["full","viewOnly","none"],"type":"string"},"enterpriseMerchants":{"enum":["full","viewOnly","none"],"type":"string"}}},"grants":{"type":"object","properties":{"order":{"type":"array","maxItems":17,"items":{"type":"string"},"readOnly":true,"description":"Any of: create, read, readSummary, readAllShifts, update, applyDiscount, void, advance, complete, cancel, confirmPayment, refund, print, toggleItem, delete, adjustTip, changePaymentType."},"staff":{"type":"array","items":{"type":"string"},"readOnly":true,"description":"Any of: invite, read, updateRole, suspend, remove, deleteAuthenticator. `list` is read as `read`."},"report":{"type":"array","maxItems":1,"items":{"type":"string"},"readOnly":true,"description":"Any of: read."},"menu":{"type":"array","maxItems":5,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, archive, delete."},"shift":{"type":"array","maxItems":7,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, open, close, join, manageParticipants, overrideClosed, viewSummary."},"settings":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"customer":{"type":"array","items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, archive. `list` is read as `read`."},"organization":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"location":{"type":"array","maxItems":4,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, archive."},"billing":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."},"table":{"type":"array","maxItems":4,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, delete."},"role":{"type":"array","maxItems":4,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update, delete."},"paymentSetup":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."},"locationPricing":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"locationFeatures":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"loyalty":{"type":"array","maxItems":3,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, configure, adjust."},"booking":{"type":"array","maxItems":3,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, create, update."},"payment":{"type":"array","maxItems":1,"items":{"type":"string"},"readOnly":true,"description":"Any of: read."},"inventory":{"type":"array","maxItems":3,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, post, manage."},"inventoryCost":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, update."},"enterpriseEvents":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."},"enterpriseTerminals":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."},"enterpriseMerchants":{"type":"array","maxItems":2,"items":{"type":"string"},"readOnly":true,"description":"Any of: read, manage."}}},"orderReach":{"enum":["ownShift","allShifts"],"type":"string"}},"required":["organizationId","id","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/roles/delete":{"post":{"operationId":"roles.delete","description":"Refused with CONFLICT `roleInUse` while a member holds the role or a pending invitation offers it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"id":{"type":"string","minLength":1}},"required":["organizationId","id"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/get":{"post":{"operationId":"settings.get","description":"Reads the settings.get procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/update":{"post":{"operationId":"settings.update","description":"Runs the settings.update procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"orderWarningMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":1440,"exclusiveMinimum":0},"orderOverdueMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":1440,"exclusiveMinimum":0}},"required":["locationId","orderWarningMinutes","orderOverdueMinutes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/getBookingRules":{"post":{"operationId":"settings.getBookingRules","description":"One Location's booking rules, a rule it never set read as the platform default. It answers while the location's Bookings or Tables switch is off, so bookings already made keep the rules they follow.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"visitMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tableDisplay":{"enum":["seated","left"],"type":"string"},"autoCancelEnabled":{"type":"boolean"},"autoCancelMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lookAheadMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reminderEnabled":{"type":"boolean"},"reminderMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["visitMinutes","tableDisplay","autoCancelEnabled","autoCancelMinutes","lookAheadMinutes","reminderEnabled","reminderMinutes"]}}}}}}},"/api/public/v1/settings/updateBookingRules":{"post":{"operationId":"settings.updateBookingRules","description":"Replaces all of a Location's booking rules; saved bookings keep the end they were made with. Refused with FORBIDDEN as `bookingsDisabled` while the location's Bookings or Tables switch is off. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"visitMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tableDisplay":{"enum":["seated","left"],"type":"string"},"autoCancelEnabled":{"type":"boolean"},"autoCancelMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lookAheadMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reminderEnabled":{"type":"boolean"},"reminderMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["locationId","visitMinutes","tableDisplay","autoCancelEnabled","autoCancelMinutes","lookAheadMinutes","reminderEnabled","reminderMinutes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"visitMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"tableDisplay":{"enum":["seated","left"],"type":"string"},"autoCancelEnabled":{"type":"boolean"},"autoCancelMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lookAheadMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reminderEnabled":{"type":"boolean"},"reminderMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["visitMinutes","tableDisplay","autoCancelEnabled","autoCancelMinutes","lookAheadMinutes","reminderEnabled","reminderMinutes"]}}}}}}},"/api/public/v1/settings/getReceiptSettings":{"post":{"operationId":"settings.getReceiptSettings","description":"Reads the settings.getReceiptSettings procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/updateReceiptConnection":{"post":{"operationId":"settings.updateReceiptConnection","description":"Runs the settings.updateReceiptConnection procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"transport":{"anyOf":[{"anyOf":[{"anyOf":[{"type":"object","properties":{"kind":{"const":"network"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]},{"type":"object","properties":{"kind":{"const":"serial"},"path":{"type":"string","minLength":1,"maxLength":255,"pattern":"^\\/dev\\/[A-Za-z0-9._-]+$"}},"required":["kind","path"]},{"type":"object","properties":{"kind":{"const":"ble"},"name":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","name"]},{"type":"object","properties":{"kind":{"const":"usb"},"device":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","device"]}]},{"type":"object","properties":{"kind":{"const":"wifi"},"host":{"type":"string","minLength":1,"maxLength":253,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*$"},"port":{"type":"integer","minimum":1,"maximum":65535}},"required":["kind","host","port"]}]},{"type":"null"}]},"paperWidth":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"default":80},"language":{"enum":["en","ar","mixed","ru"],"type":"string","default":"en"},"printOnSend":{"type":"boolean","default":false}},"required":["locationId","transport"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/updateReceiptCustomisation":{"post":{"operationId":"settings.updateReceiptCustomisation","description":"Runs the settings.updateReceiptCustomisation procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"merchantDisplayName":{"type":"string","minLength":1,"maxLength":48},"footerText":{"type":"string","maxLength":192}},"required":["locationId","merchantDisplayName","footerText"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/getLocationFeatures":{"post":{"operationId":"settings.getLocationFeatures","description":"Reads the settings.getLocationFeatures procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/updateLocationFeatures":{"post":{"operationId":"settings.updateLocationFeatures","description":"Replaces the venue's capability toggles with the given set. Newly switching the Kitchen Desk on is refused with FORBIDDEN and refusal `featureNotEntitled` when the plan lacks it and it is enforced; switching it off and saving other toggles never is. Newly switching online payment on is refused with BAD_REQUEST until the business's online payment provider is connected and approved. Newly switching any capability on is a new offering: Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn. Switching capabilities off never is.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"features":{"type":"object","properties":{"kds":{"type":"boolean","default":true},"eMenu":{"type":"object","properties":{"menu":{"type":"boolean","default":true},"ordering":{"type":"boolean","default":true},"orderFlow":{"enum":["staffApproval","directToKitchen"],"type":"string","default":"staffApproval"},"payments":{"type":"boolean","default":false},"paymentTiming":{"enum":["before","after"],"type":"string","default":"after"}},"default":{"menu":true,"ordering":true,"orderFlow":"staffApproval","payments":false,"paymentTiming":"after"}},"tables":{"type":"boolean","default":true},"bookings":{"type":"boolean","default":true},"pagers":{"type":"boolean","default":false},"printing":{"type":"boolean","default":true},"orderTypes":{"type":"object","properties":{"ownDelivery":{"type":"boolean","default":true},"aggregatorDelivery":{"type":"boolean","default":true}},"default":{"ownDelivery":true,"aggregatorDelivery":true}}}}},"required":["locationId","features"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/getVatPricing":{"post":{"operationId":"settings.getVatPricing","description":"Reads the settings.getVatPricing procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"vatExclusive":{"type":"boolean"}},"required":["vatExclusive"]}}}}}}},"/api/public/v1/settings/updateVatPricing":{"post":{"operationId":"settings.updateVatPricing","description":"Sets whether the venue's draft prices are entered excluding VAT. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"vatExclusive":{"type":"boolean"}},"required":["locationId","vatExclusive"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"vatExclusive":{"type":"boolean"}},"required":["vatExclusive"]}}}}}}},"/api/public/v1/settings/getMunicipalityFee":{"post":{"operationId":"settings.getMunicipalityFee","description":"Reads the settings.getMunicipalityFee procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/updateMunicipalityFee":{"post":{"operationId":"settings.updateMunicipalityFee","description":"Sets the venue's municipality fee rate in basis points, the rate every stamped and quoted fee is derived from. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"municipalityFeeBasisPoints":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":2500,"exclusiveMinimum":0},{"type":"null"}]}},"required":["locationId","municipalityFeeBasisPoints"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/settings/getServiceFee":{"post":{"operationId":"settings.getServiceFee","description":"Reads the settings.getServiceFee procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"serviceFeeBasisPoints":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["serviceFeeBasisPoints"]}}}}}}},"/api/public/v1/settings/updateServiceFee":{"post":{"operationId":"settings.updateServiceFee","description":"Runs the settings.updateServiceFee procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"serviceFeeBasisPoints":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":2147483647,"exclusiveMinimum":0},{"type":"null"}]}},"required":["locationId","serviceFeeBasisPoints"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"serviceFeeBasisPoints":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["serviceFeeBasisPoints"]}}}}}}},"/api/public/v1/settings/getLocationTips":{"post":{"operationId":"settings.getLocationTips","description":"Reads the settings.getLocationTips procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tips":{"type":"object","properties":{"pos":{"type":"object","properties":{"enabled":{"type":"boolean"},"presets":{"type":"array","maxItems":4,"items":{"anyOf":[{"type":"object","properties":{"kind":{"const":"percent"},"basisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","basisPoints"]},{"type":"object","properties":{"kind":{"const":"fixed"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}}},"required":["enabled","presets"]},"qr":{"type":"object","properties":{"enabled":{"type":"boolean"},"presets":{"type":"array","maxItems":4,"items":{"anyOf":[{"type":"object","properties":{"kind":{"const":"percent"},"basisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","basisPoints"]},{"type":"object","properties":{"kind":{"const":"fixed"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}}},"required":["enabled","presets"]}},"required":["pos","qr"]}},"required":["tips"]}}}}}}},"/api/public/v1/settings/updateLocationTips":{"post":{"operationId":"settings.updateLocationTips","description":"Saves both of the venue's tip channels as one set, last write wins; a channel switched off keeps its presets. Refused with FORBIDDEN and refusal `billingReadOnly` once an overdue subscription's grace has run out, and `subscriptionEnded` once the business's verified base plan has ended with no eligible base in its place. Either refusal is lifted for this operation's category by an active plan grant whose plan allows it, or while `billing-standing-enforcement` is off for the business; the suspended operation policy may also relax `subscriptionEnded`, never `billingReadOnly`, for the category. None of them changes the subscription's own standing. A category relaxed to `warn` answers as it would for a business in standing, with the same result and status, and records the warning; `billing.getSuspensionNotice` (MCP `billing_getSuspensionNotice`), readable by every member, names the categories that warn.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"tips":{"type":"object","properties":{"pos":{"type":"object","properties":{"enabled":{"type":"boolean"},"presets":{"type":"array","maxItems":4,"items":{"anyOf":[{"type":"object","properties":{"kind":{"const":"percent"},"basisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","basisPoints"]},{"type":"object","properties":{"kind":{"const":"fixed"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}}},"required":["enabled","presets"]},"qr":{"type":"object","properties":{"enabled":{"type":"boolean"},"presets":{"type":"array","maxItems":4,"items":{"anyOf":[{"type":"object","properties":{"kind":{"const":"percent"},"basisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","basisPoints"]},{"type":"object","properties":{"kind":{"const":"fixed"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}}},"required":["enabled","presets"]}},"required":["pos","qr"]}},"required":["locationId","tips"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tips":{"type":"object","properties":{"pos":{"type":"object","properties":{"enabled":{"type":"boolean"},"presets":{"type":"array","maxItems":4,"items":{"anyOf":[{"type":"object","properties":{"kind":{"const":"percent"},"basisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","basisPoints"]},{"type":"object","properties":{"kind":{"const":"fixed"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}}},"required":["enabled","presets"]},"qr":{"type":"object","properties":{"enabled":{"type":"boolean"},"presets":{"type":"array","maxItems":4,"items":{"anyOf":[{"type":"object","properties":{"kind":{"const":"percent"},"basisPoints":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","basisPoints"]},{"type":"object","properties":{"kind":{"const":"fixed"},"amountCents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"exclusiveMinimum":0}},"required":["kind","amountCents"]}]}}},"required":["enabled","presets"]}},"required":["pos","qr"]}},"required":["tips"]}}}}}}},"/api/public/v1/settings/getMcpSettings":{"post":{"operationId":"settings.getMcpSettings","description":"Reads the business's own MCP connector switch (`mcpEnabled`, on unless the business turned it off), one value for every venue of the business. `planRestriction` says what the plan withholds regardless of the switch: `featureRestrictedByPlan` when its policy restricts MCP, `featureNotEntitled` when the plan has none, `null` when the plan lets MCP act at the business. Requires `organization:read` across the whole business.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mcpEnabled":{"type":"boolean"},"planRestriction":{"anyOf":[{"enum":["featureRestrictedByPlan","featureNotEntitled"],"type":"string"},{"type":"null"}]}},"required":["mcpEnabled","planRestriction"]}}}}}}},"/api/public/v1/settings/updateMcpSettings":{"post":{"operationId":"settings.updateMcpSettings","description":"Turns the business's MCP connector on or off for every venue of the business. Off refuses MCP at the business from the next call on, as refusal `mcpDisabled`, for API keys and OAuth tokens already issued too, without revoking them; the REST API is unaffected. On grants nothing the plan withholds. Requires `organization:update` across the whole business.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"mcpEnabled":{"type":"boolean"}},"required":["organizationId","mcpEnabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mcpEnabled":{"type":"boolean"}},"required":["mcpEnabled"]}}}}}}},"/api/public/v1/settings/getLoyaltySwitch":{"post":{"operationId":"settings.getLoyaltySwitch","description":"Reads the business's own Loyalty switch (`loyaltyEnabled`, on unless the business turned it off), one value for every venue of the business. `availability` says whether the business takes new Loyalty work now: `null` when it does, `loyaltyDisabled` while the switch is off, `featureRestrictedByPlan` while its plan's policy restricts Loyalty, `featureNotEntitled` while its plan lacks Loyalty, and `billingReadOnly` or `subscriptionEnded` while its billing standing admits no new commitment. Refused with NOT_FOUND for an archived business. Requires `organization:read` across the whole business.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"loyaltyEnabled":{"type":"boolean"},"availability":{"anyOf":[{"enum":["loyaltyDisabled","featureRestrictedByPlan","featureNotEntitled","billingReadOnly","subscriptionEnded"],"type":"string"},{"type":"null"}]}},"required":["loyaltyEnabled","availability"]}}}}}}},"/api/public/v1/settings/updateLoyaltySwitch":{"post":{"operationId":"settings.updateLoyaltySwitch","description":"Turns Loyalty on or off for every venue of the business. Off refuses new Loyalty work from the next call on, as refusal `loyaltyDisabled`: launching, running or configuring the program, its sign-up kit, enrolling, adjusting, accruing, spending points and the codes they send. It leaves the program's status, members, balances, ledger, tiers and point expiry untouched, and payments already accepted settle, refund and reverse as before. On restarts no program and grants nothing the plan or the billing standing withholds. Refused with NOT_FOUND for an archived business. Requires `organization:update` across the whole business.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"loyaltyEnabled":{"type":"boolean"}},"required":["organizationId","loyaltyEnabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"loyaltyEnabled":{"type":"boolean"}},"required":["loyaltyEnabled"]}}}}}}},"/api/public/v1/shifts/openingInfo":{"post":{"operationId":"shifts.openingInfo","description":"Reads the shifts.openingInfo procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"requestStartingCashBalance":{"type":"boolean"},"currency":{"type":"string"}},"required":["requestStartingCashBalance","currency"]}}}}}}},"/api/public/v1/shifts/current":{"post":{"operationId":"shifts.current","description":"Reads the shifts.current procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/list":{"post":{"operationId":"shifts.list","description":"Reads the shifts.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"range":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"}},"required":["from","to"]}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/get":{"post":{"operationId":"shifts.get","description":"Reads the shifts.get procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1}},"required":["shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/assignable":{"post":{"operationId":"shifts.assignable","description":"Reads the shifts.assignable procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1}},"required":["shiftId","locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/summary":{"post":{"operationId":"shifts.summary","description":"Reads the shifts.summary procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1}},"required":["shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/open":{"post":{"operationId":"shifts.open","description":"Opens the location's shared shift and joins the caller. Read shifts.openingInfo for the current cash-count policy and business currency. When the location requires a count, omitting startingCashCents is refused with BAD_REQUEST and refusal startingCashRequired. Submit startingCashCents in minor units (zero is valid) together with startingCashCurrency. A submitted currency that no longer matches the business is refused with CONFLICT and refusal startingCashCurrencyChanged; read openingInfo again and recount in that currency. An existing open shift is refused with CONFLICT and refusal shiftAlreadyOpen; join it instead. An archived location is refused with PRECONDITION_FAILED and refusal locationArchived. Locations not requiring a count still accept opening without these optional fields. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startingCashCents":{"type":"integer","minimum":0,"maximum":2147483647},"startingCashCurrency":{"type":"string","minLength":1},"locationId":{"type":"string","minLength":1}},"required":["locationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/close":{"post":{"operationId":"shifts.close","description":"Closes the location's open shift, ending every participation and archiving its unpaid drafts. Refused with UNPROCESSABLE_CONTENT while an order is still in progress, and with UNPROCESSABLE_CONTENT and refusal terminalPaymentLive while a terminal payment on one of its orders has not resolved; finish or re-check that payment first. An already closed shift is refused with BAD_REQUEST. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1}},"required":["shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/printReport":{"post":{"operationId":"shifts.printReport","description":"Runs the shifts.printReport procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1}},"required":["shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"jobIds":{"type":"array","minItems":1,"items":{"type":"string"}}},"required":["jobIds"]}}}}}}},"/api/public/v1/shifts/listParticipants":{"post":{"operationId":"shifts.listParticipants","description":"Reads the shifts.listParticipants procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1}},"required":["shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/join":{"post":{"operationId":"shifts.join","description":"Runs the shifts.join procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1}},"required":["shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/addParticipant":{"post":{"operationId":"shifts.addParticipant","description":"Runs the shifts.addParticipant procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1},"userId":{"type":"string","minLength":1}},"required":["shiftId","userId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/leave":{"post":{"operationId":"shifts.leave","description":"Runs the shifts.leave procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1},"drafts":{"anyOf":[{"type":"object","properties":{"action":{"const":"transfer"},"toUserId":{"type":"string","minLength":1}},"required":["action","toUserId"]},{"type":"object","properties":{"action":{"const":"archive"}},"required":["action"]}]}},"required":["shiftId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/shifts/removeParticipant":{"post":{"operationId":"shifts.removeParticipant","description":"Runs the shifts.removeParticipant procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shiftId":{"type":"string","minLength":1},"userId":{"type":"string","minLength":1}},"required":["shiftId","userId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables":{"get":{"operationId":"tables.listTables","summary":"List a venue's tables with their QR codes","description":"Returns every table at the venue with id, prefix, number, label, mode, capacity, sectionId and publicCode (the table's oldest live printed code, or null), unprefixed tables first and then by prefix and number. Readable with table read, order create or order update permission. Use tables.listSections for section names and orders.listOpenByTable for occupancy. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["tables"],"parameters":[{"name":"locationId","in":"query","required":true,"schema":{"type":"string","minLength":1},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}},"post":{"operationId":"tables.createTable","summary":"Create a table in a section","description":"Creates a table numbered from the smallest free number of the section's band, or with a prefix (Latin letters, upper-cased) from the smallest number free within the section and prefix, with its QR code and a spot on the section's floor plan. Refused with CONFLICT as sectionFull when the band has no free number, as planFull when no placement is given and the plan has no free cell, and as numberTaken when a concurrent write took the number. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["tables"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"sectionId":{"type":"string","minLength":1},"prefix":{"type":"string","maxLength":10,"pattern":"^[A-Z]*$","default":""},"capacity":{"type":"integer","minimum":1,"maximum":20,"default":4},"label":{"type":"string","maxLength":60},"mode":{"enum":["menu_only","menu_pay_after","menu_tips","menu_order_pay_after"],"type":"string"},"placement":{"type":"object","properties":{"shape":{"enum":["round","square","rectangle","oval"],"type":"string"},"x":{"type":"number","minimum":0,"maximum":100},"y":{"type":"number","minimum":0,"maximum":100},"rotationDeg":{"anyOf":[{"const":0},{"const":45},{"const":90},{"const":135},{"const":180},{"const":225},{"const":270},{"const":315}]},"rectShort":{"type":"integer","minimum":1,"maximum":6},"rectLong":{"type":"integer","minimum":1,"maximum":6}},"required":["shape","x","y","rotationDeg"]}},"required":["locationId","sectionId","mode"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/bulkCreateTables":{"post":{"operationId":"tables.bulkCreateTables","summary":"Create several tables in a section","description":"Creates count tables, all or nothing, numbered from the smallest free numbers of the section's band, or with a prefix from the smallest numbers free within the section and prefix; listSections' remainingTables says how many unprefixed tables still fit. Refused with CONFLICT as sectionFull when no number is free, as bandExhausted when fewer than count are, as planFull when no placements are given and the plan has too few free cells, and as numberTaken when a concurrent write took a number. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"sectionId":{"type":"string","minLength":1},"count":{"type":"integer","minimum":1,"maximum":99},"prefix":{"type":"string","maxLength":10,"pattern":"^[A-Z]*$","default":""},"capacity":{"type":"integer","minimum":1,"maximum":20,"default":4},"mode":{"enum":["menu_only","menu_pay_after","menu_tips","menu_order_pay_after"],"type":"string"},"placements":{"type":"array","items":{"type":"object","properties":{"shape":{"enum":["round","square","rectangle","oval"],"type":"string"},"x":{"type":"number","minimum":0,"maximum":100},"y":{"type":"number","minimum":0,"maximum":100},"rotationDeg":{"anyOf":[{"const":0},{"const":45},{"const":90},{"const":135},{"const":180},{"const":225},{"const":270},{"const":315}]},"rectShort":{"type":"integer","minimum":1,"maximum":6},"rectLong":{"type":"integer","minimum":1,"maximum":6}},"required":["shape","x","y","rotationDeg"]}},"rows":{"type":"array","items":{"type":"object","properties":{"capacity":{"type":"integer","minimum":1,"maximum":20},"mode":{"enum":["menu_only","menu_pay_after","menu_tips","menu_order_pay_after"],"type":"string"},"label":{"type":"string","maxLength":60},"prefix":{"type":"string","maxLength":10,"pattern":"^[A-Z]*$"}},"required":["capacity","mode"]}}},"required":["locationId","sectionId","count","mode"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/updateTable":{"post":{"operationId":"tables.updateTable","summary":"Edit a table or move it to another section","description":"Updates only supplied fields on this table. sectionId moves the table to another section of the same venue, keeping its prefix and number and carrying its place to that section's floor plan; prefix changes the identifier's prefix and keeps the number. Returns CONFLICT with refusal numberTaken when a table of the section it ends in already holds the prefix and number it ends with, and with refusal planFull when the target section's floor plan has no free cell. Returns BAD_REQUEST with refusal sectionRequired when sectionId is null: a table always stays in a section, so pass the target section's id instead; and with refusal prefixNeedsSection when a prefix would land on a table with no section, so pass sectionId with the prefix. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tableId":{"type":"string","minLength":1},"prefix":{"type":"string","maxLength":10,"pattern":"^[A-Z]*$"},"number":{"type":"integer","minimum":1,"maximum":999999999},"capacity":{"type":"integer","minimum":1,"maximum":20},"sectionId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"label":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}]},"mode":{"enum":["menu_only","menu_pay_after","menu_tips","menu_order_pay_after"],"type":"string"}},"required":["tableId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/updateTableCapacities":{"post":{"operationId":"tables.updateTableCapacities","summary":"Set several tables' seats","description":"Sets each named table's seats, all or nothing. Returns NOT_FOUND, changing none, when any named table is not at the location. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"tables":{"type":"array","minItems":1,"maxItems":99,"items":{"type":"object","properties":{"tableId":{"type":"string","minLength":1},"capacity":{"type":"integer","minimum":1,"maximum":20}},"required":["tableId","capacity"]}}},"required":["locationId","tables"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"prefix":{"type":"string"},"number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"mode":{"enum":["menu_only","menu_pay_after","menu_tips","menu_order_pay_after"],"type":"string"},"capacity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sectionId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","prefix","number","label","mode","capacity","sectionId"]}}}}}}}},"/api/public/v1/tables/deleteTable":{"post":{"operationId":"tables.deleteTable","summary":"Delete a table","description":"Deletes the table, so its number returns to the section's band. Refused with CONFLICT as tableHasOpenOrder while the table has an open order, and as tableHasBooking while a Booked or Seated booking holds it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tableId":{"type":"string","minLength":1}},"required":["tableId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/deleteTables":{"post":{"operationId":"tables.deleteTables","summary":"Delete several tables of a section","description":"Deletes the named tables of the section, all or nothing, so their numbers return to its band. Returns NOT_FOUND when the section or any named table is not there, CONFLICT as tableHasOpenOrder while any of them has an open order, and CONFLICT as tableHasBooking while a Booked or Seated booking holds any of them; either way none is deleted. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"sectionId":{"type":"string","minLength":1},"tableIds":{"type":"array","minItems":1,"maxItems":99,"items":{"type":"string","minLength":1}}},"required":["locationId","sectionId","tableIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"sectionUpdatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]},"previousSceneUpdatedAt":{"anyOf":[{"type":"string","format":"date-time","x-native-type":"date"},{"type":"null"}]}},"required":["ids","sectionUpdatedAt","previousSceneUpdatedAt"]}}}}}}},"/api/public/v1/tables/rotateCode":{"post":{"operationId":"tables.rotateCode","summary":"Replace a table's QR code with a new one","description":"Archives every live printed code on the table and issues a fresh one, returning { id, publicCode }. Stickers carrying the old codes stop working, and each call issues another new code, so it is not idempotent. Use emenu.reassignCode to move an existing sticker instead. Requires table update permission and the venue's QR menu switched on. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tableId":{"type":"string","minLength":1}},"required":["tableId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/sections":{"get":{"operationId":"tables.listSections","summary":"List a venue's floor sections","description":"Lists the venue's live sections in display order. remainingTables is how many more tables createTable and bulkCreateTables can still number in that section: its band code*100+1 .. code*100+99 less the numbers its tables hold. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","tags":["tables"],"parameters":[{"name":"locationId","in":"query","required":true,"schema":{"type":"string","minLength":1},"allowEmptyValue":true,"allowReserved":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/createSection":{"post":{"operationId":"tables.createSection","summary":"Create a floor section","description":"Adds a section whose code numbers its tables code*100+1 .. code*100+99. A code another section of the venue already holds is refused with CONFLICT as sectionCodeTaken. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":60},"code":{"type":"integer","minimum":1,"maximum":98}},"required":["locationId","name","code"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/updateSection":{"post":{"operationId":"tables.updateSection","summary":"Rename a floor section","description":"Renames a floor section and returns its id; repeating it is safe. Only the name changes: the section's code, its tables' numbers and its floor plan stay as they are, and names need not be unique. Use tables.reorderSections to change display order. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sectionId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":60}},"required":["sectionId","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/reorderSections":{"post":{"operationId":"tables.reorderSections","summary":"Reorder a venue's floor sections","description":"Sets each live section's display position from its index in orderedIds. orderedIds must name every live section of the venue exactly once; a list that repeats a section, leaves one out or names another venue's is refused as sectionOrderMismatch. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"string","minLength":1},"orderedIds":{"type":"array","items":{"type":"string","minLength":1}}},"required":["locationId","orderedIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/deleteSection":{"post":{"operationId":"tables.deleteSection","summary":"Delete a floor section","description":"Deletes the section and every table in it. Refused with CONFLICT as tableHasOpenOrder while any of its tables has an open order, as tableHasBooking while a Booked or Seated booking holds any of them, and with BAD_REQUEST for the venue's default section. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sectionId":{"type":"string","minLength":1}},"required":["sectionId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/emptySection":{"post":{"operationId":"tables.emptySection","summary":"Remove every table from a floor section","description":"Deletes every table in the section and resets its floor plan, keeping the section. Refused with CONFLICT as tableHasOpenOrder while any of its tables has an open order, and as tableHasBooking while a Booked or Seated booking holds any of them. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sectionId":{"type":"string","minLength":1}},"required":["sectionId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/getScene":{"post":{"operationId":"tables.getScene","summary":"Read a section's floor plan","description":"Returns { scene, updatedAt }: the section's floor plan document, or an empty default plan when none is stored, and the plan's version. Pass updatedAt as expectedUpdatedAt to tables.saveScene. Readable with table read or order create permission. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sectionId":{"type":"string","minLength":1}},"required":["sectionId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/tables/saveScene":{"post":{"operationId":"tables.saveScene","summary":"Save a section's floor plan","description":"Replaces the section's floor plan, which must place every table of the section. Refused with CONFLICT as planStale when expectedUpdatedAt is not the plan's current version: another save landed first, so read the plan again before saving. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"sectionId":{"type":"string","minLength":1},"expectedUpdatedAt":{"type":"string","format":"date-time","x-native-type":"date"},"scene":{"type":"object","properties":{"elements":{"type":"array","items":{"type":"object","properties":{"tableId":{"type":"string","minLength":1},"shape":{"enum":["round","square","rectangle","oval"],"type":"string"},"x":{"type":"number","minimum":0,"maximum":100},"y":{"type":"number","minimum":0,"maximum":100},"rotationDeg":{"anyOf":[{"const":0},{"const":45},{"const":90},{"const":135},{"const":180},{"const":225},{"const":270},{"const":315}]},"rectShort":{"type":"integer","minimum":1,"maximum":6},"rectLong":{"type":"integer","minimum":1,"maximum":6}},"required":["tableId","shape","x","y","rotationDeg"]}}},"required":["elements"]}},"required":["sectionId","expectedUpdatedAt","scene"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/employees/list":{"post":{"operationId":"employees.list","description":"Reads the employees.list procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["organizationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/employees/assignRole":{"post":{"operationId":"employees.assignRole","description":"Runs the employees.assignRole procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"userEmail":{"type":"string","format":"email"},"title":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},"required":["organizationId","userEmail"]},{"type":"object","properties":{"role":{"enum":["owner","manager","lineStaff","financialManager"],"type":"string"},"customRoleId":{"type":"string","minLength":1}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/employees/invite":{"post":{"operationId":"employees.invite","description":"Refused with NOT_FOUND when a custom role the invitation offers no longer exists.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"userEmail":{"type":"string","format":"email"},"title":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]}},"required":["organizationId","userEmail"]},{"type":"object","properties":{"role":{"enum":["owner","manager","lineStaff","financialManager"],"type":"string"},"customRoleId":{"type":"string","minLength":1}}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/employees/resendInvitation":{"post":{"operationId":"employees.resendInvitation","description":"Refused with NOT_FOUND when a custom role the invitation offers no longer exists.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"userId":{"type":"string","minLength":1}},"required":["organizationId","userId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/employees/setLocation":{"post":{"operationId":"employees.setLocation","description":"Runs the employees.setLocation procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"membershipId":{"type":"string","minLength":1},"newLocationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["organizationId","membershipId","newLocationId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/employees/setSuspended":{"post":{"operationId":"employees.setSuspended","description":"Runs the employees.setSuspended procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"userId":{"type":"string","minLength":1},"suspended":{"type":"boolean"}},"required":["organizationId","userId","suspended"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/employees/remove":{"post":{"operationId":"employees.remove","description":"Runs the employees.remove procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"userId":{"type":"string","minLength":1}},"required":["organizationId","userId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/employees/deleteAuthenticator":{"post":{"operationId":"employees.deleteAuthenticator","description":"Runs the employees.deleteAuthenticator procedure, the same operation the app performs. The credential's live venue permissions bound it.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"locationId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"userId":{"type":"string","minLength":1}},"required":["organizationId","userId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string"}},"required":["userId"]}}}}}}},"/api/public/v1/users/list":{"post":{"operationId":"users.list","description":"Reads the users.list procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"type":"string","maxLength":200}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/users/invite":{"post":{"operationId":"users.invite","description":"Runs the users.invite procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userEmail":{"type":"string","format":"email"}},"required":["userEmail"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/users/setRole":{"post":{"operationId":"users.setRole","description":"Runs the users.setRole procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","minLength":1},"role":{"enum":["admin","user"],"type":"string"}},"required":["userId","role"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/users/setBanned":{"post":{"operationId":"users.setBanned","description":"Runs the users.setBanned procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","minLength":1},"banned":{"type":"boolean"},"banReason":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},"required":["userId","banned"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/users/remove":{"post":{"operationId":"users.remove","description":"Runs the users.remove procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","minLength":1}},"required":["userId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/api/public/v1/writeQueue/applyBatch":{"post":{"operationId":"writeQueue.applyBatch","description":"Runs the writeQueue.applyBatch procedure, the same operation the app performs. The credential's live venue permissions bound it. Refused with FORBIDDEN as `paywallLocked` when the caller is an Owner or Manager of a business the merchant Paywall locks: one with no verified subscription that has taken 5 orders while the Paywall's rollout reaches it, an order counting from its first saved line, whether or not it is paid or completed, until it is archived or cancelled before activation. Nothing is read or written; a verified subscription lifts the lock.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ops":{"type":"array","minItems":1,"maxItems":30,"items":{"type":"object","properties":{"procedure":{"enum":["catalog.createCategory","catalog.updateCategory","catalog.archiveCategory","catalog.restoreCategory","catalog.addCatalogItem","catalog.updateCatalogItem","catalog.archiveCatalogItem","catalog.restoreCatalogItem","catalog.setCatalogItemAvailability","catalog.setCategoryAvailability","catalog.createModifierGroup","catalog.updateModifierGroup","catalog.archiveModifierGroup","catalog.createModifier","catalog.updateModifier","catalog.archiveModifier","catalog.archiveModifierRows","catalog.setModifierRowsAvailability","catalog.moveModifierRows","catalog.repositionModifierRows","catalog.attachModifierToCatalogItem","catalog.detachModifierFromCatalogItem","catalog.setItemModifierAvailability","catalog.detachModifierGroupFromCatalogItem","catalog.reorderCatalogItemModifiers","catalog.attachModifierGroupToCatalogItem","catalog.setItemModifierGroupAvailability","catalog.createItemVariation","catalog.updateItemVariation","catalog.archiveItemVariation","catalog.restoreItemVariation","catalog.duplicateCatalogItem","catalog.duplicateCategory","catalog.archiveCatalogRows","catalog.restoreCatalogRows","catalog.moveCatalogRows","catalog.setCatalogRowsAvailability","catalog.createStation","catalog.updateStation","catalog.deleteStation","catalog.createCatalogLabel","orders.createDraft","orders.addLine","orders.updateLine","orders.removeLine","orders.setComment","orders.setOrderDiscount","orders.setType","orders.setBuyerLocation","orders.clearCart","orders.setCustomer"],"type":"string"},"input":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"responseIds":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"requestIds":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["procedure","input"]}}},"required":["ops"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"status":{"const":"ok"},"reply":{}},"required":["status"]},{"type":"object","properties":{"status":{"const":"failed"},"code":{"type":"string"},"httpStatus":{"type":"number"},"message":{"type":"string"},"refusal":{"type":"string"}},"required":["status","code","httpStatus","message"]},{"type":"object","properties":{"status":{"const":"skipped"},"causeIndex":{"type":"number"}},"required":["status","causeIndex"]},{"type":"object","properties":{"status":{"const":"notRun"}},"required":["status"]}]}}},"required":["results"]}}}}}}},"/api/exports/v1/{report}/{format}":{"get":{"operationId":"downloadReportExport","summary":"Download an authorized merchant report","description":"Requires report:read and live venue authority. Custom periods require ordered from/to dates within the configured maximum span. The format selects CSV or PDF; locale affects PDF labels only.","security":[{"session":[]},{"secureSession":[]}],"parameters":[{"name":"report","in":"path","required":true,"schema":{"type":"string","enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails"]}},{"name":"format","in":"path","required":true,"schema":{"type":"string","enum":["csv","pdf"]}},{"name":"locationId","in":"query","required":true,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"period","in":"query","required":false,"style":"form","explode":true,"schema":{"default":"today","type":"string","enum":["today","yesterday","last7","thisMonth","custom"]}},{"name":"from","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"locationMode","in":"query","required":false,"style":"form","explode":true,"schema":{"default":"single","type":"string","enum":["single","all"]}},{"name":"paymentTypes","in":"query","required":false,"style":"form","explode":true,"schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["cash","card","wallet","mixed","other","points"]}}},{"name":"locale","in":"query","schema":{"type":"string"},"description":"PDF label locale; unsupported values use the application default."}],"responses":{"200":{"description":"Complete report with provenance and attachment filename.","headers":{"Content-Disposition":{"schema":{"type":"string"}}},"content":{"text/csv":{"schema":{"type":"string"}},"application/pdf":{"schema":{}}}},"400":{"description":"Invalid filter.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"A signed-in session is required.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"403":{"description":"The session cannot read this report or venue scope, or the merchant Paywall locks the business.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"Unknown report, format or venue.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"413":{"description":"Export exceeds the CSV or PDF row limit; narrow its scope.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Export processing failed.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"504":{"description":"Database deadline reached; narrow the requested scope.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/exports/v2/{report}/{format}":{"get":{"operationId":"downloadFinancialReportExport","summary":"Download an authorized merchant report","description":"Recognized sales and independently posted refunds, using stored venue-local dates. Currency rows never combine amounts. Coverage distinguishes known partial history; n/a means unavailable. Order details remains an operational ledger with explicitly pre-refund order amounts and requires a single currency. Payment previews do not narrow financial exports.","security":[{"session":[]},{"secureSession":[]}],"parameters":[{"name":"report","in":"path","required":true,"schema":{"type":"string","enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails"]}},{"name":"format","in":"path","required":true,"schema":{"type":"string","enum":["csv","pdf"]}},{"name":"locationId","in":"query","required":true,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"period","in":"query","required":false,"style":"form","explode":true,"schema":{"default":"today","type":"string","enum":["today","yesterday","last7","thisMonth","custom"]}},{"name":"from","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"locationMode","in":"query","required":false,"style":"form","explode":true,"schema":{"default":"single","type":"string","enum":["single","all"]}},{"name":"paymentTypes","in":"query","required":false,"style":"form","explode":true,"schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["cash","card","wallet","mixed","other","points"]}}},{"name":"locale","in":"query","schema":{"type":"string"},"description":"PDF label locale; unsupported values use the application default."}],"responses":{"200":{"description":"Complete report with provenance and attachment filename.","headers":{"Content-Disposition":{"schema":{"type":"string"}}},"content":{"text/csv":{"schema":{"type":"string"}},"application/pdf":{"schema":{}}}},"400":{"description":"Invalid filter.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"A signed-in session is required.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"403":{"description":"The session cannot read this report or venue scope, or the merchant Paywall locks the business.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"Unknown report, format or venue.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"413":{"description":"Export exceeds the CSV or PDF row limit; narrow its scope.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Export processing failed.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"504":{"description":"Database deadline reached; narrow the requested scope.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/exports/v3/{report}/{format}":{"get":{"operationId":"downloadDetailedReportExport","summary":"Download an authorized merchant report","description":"Hierarchical reports on recognized sales and posted refund events. Sales reports keep sale-time amounts after refunds, selected by stored venue-local sale dates; Refunds lists each posted event by actual return method and posting date; Order details lists every traded order with its payment and refund history. Every row names its currency and each currency has its own Grand Total. Payment previews do not narrow these exports.","security":[{"session":[]},{"secureSession":[]}],"parameters":[{"name":"report","in":"path","required":true,"schema":{"type":"string","enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails"]}},{"name":"format","in":"path","required":true,"schema":{"type":"string","enum":["csv","pdf"]}},{"name":"locationId","in":"query","required":true,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"period","in":"query","required":false,"style":"form","explode":true,"schema":{"default":"today","type":"string","enum":["today","yesterday","last7","thisMonth","custom"]}},{"name":"from","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"locationMode","in":"query","required":false,"style":"form","explode":true,"schema":{"default":"single","type":"string","enum":["single","all"]}},{"name":"paymentTypes","in":"query","required":false,"style":"form","explode":true,"schema":{"minItems":1,"type":"array","items":{"type":"string","enum":["cash","card","wallet","mixed","other","points"]}}},{"name":"locale","in":"query","schema":{"type":"string"},"description":"PDF label locale; unsupported values use the application default."}],"responses":{"200":{"description":"Complete report with provenance and attachment filename.","headers":{"Content-Disposition":{"schema":{"type":"string"}}},"content":{"text/csv":{"schema":{"type":"string"}},"application/pdf":{"schema":{}}}},"400":{"description":"Invalid filter.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"A signed-in session is required.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"403":{"description":"The session cannot read this report or venue scope, or the merchant Paywall locks the business.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"Unknown report, format or venue.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"413":{"description":"Export exceeds the CSV or PDF row limit; narrow its scope.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Export processing failed.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"504":{"description":"Database deadline reached; narrow the requested scope.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/enterprise-exports/v1/{report}/{format}":{"get":{"operationId":"downloadEnterpriseReportExport","summary":"Download an authorized enterprise report","description":"Requires report:read in the session's enterprise; Sales by event and any eventId also require enterpriseEvents:read. The seven detailed reports add a Merchant name column; merchants and events are settlement reports from the enterprise dashboard's financial snapshot. One currency per file; locale affects PDF labels only.","security":[{"session":[]},{"secureSession":[]}],"parameters":[{"name":"report","in":"path","required":true,"schema":{"type":"string","enum":["summary","items","locations","employees","paymentTypes","refunds","orderDetails","merchants","events"]}},{"name":"format","in":"path","required":true,"schema":{"type":"string","enum":["csv","pdf"]}},{"name":"period","in":"query","required":false,"style":"form","explode":true,"schema":{"default":"today","type":"string","enum":["today","yesterday","last7","thisMonth","custom"]}},{"name":"from","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"to","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"}},{"name":"merchantId","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"locationId","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"eventId","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","minLength":1}},{"name":"currency","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","pattern":"^[A-Z]{3}$"}},{"name":"locale","in":"query","schema":{"type":"string"},"description":"PDF label locale; unsupported values use the application default."}],"responses":{"200":{"description":"Complete report with provenance and attachment filename.","headers":{"Content-Disposition":{"schema":{"type":"string"}}},"content":{"text/csv":{"schema":{"type":"string"}},"application/pdf":{"schema":{}}}},"400":{"description":"Invalid filter.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"401":{"description":"A signed-in session is required.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"403":{"description":"The session cannot read this report or venue scope, or the merchant Paywall locks the business.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"404":{"description":"Unknown report, format or venue.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"413":{"description":"Export exceeds the CSV or PDF row limit; narrow its scope.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"500":{"description":"Export processing failed.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}},"504":{"description":"Database deadline reached; narrow the requested scope.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}}}},"/api/myfatoorah-documents/v1/upload":{"post":{"operationId":"uploadMyFatoorahDocument","summary":"Upload one MyFatoorah KYC document","description":"Forwards a base64-encoded KYC document to the organization's connected MyFatoorah account and records the upload marker. Requires a signed-in session with payment-provider rights for that organization.","security":[{"sessionCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"fileType":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"fileName":{"type":"string","minLength":1,"maxLength":255},"contentType":{"type":"string","enum":["image/jpeg","image/png","image/bmp","image/gif","application/pdf","application/msword","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.ms-excel","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"]},"buffer":{"type":"string","minLength":1}},"required":["organizationId","fileType","fileName","contentType","buffer"],"additionalProperties":false}}}},"responses":{"200":{"description":"MyFatoorah accepted the document and the marker was recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"fileType":{"type":"number"},"uploadedAt":{"type":"string"}},"required":["fileType","uploadedAt"]}}}},"400":{"description":"That upload request is not valid, or MyFatoorah rejected the file.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"401":{"description":"Sign in to upload a document.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"403":{"description":"You cannot upload MyFatoorah documents, or the merchant Paywall locks this business.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"409":{"description":"Connect MyFatoorah before uploading documents.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"412":{"description":"MyFatoorah is not configured.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"413":{"description":"That file exceeds MyFatoorah's 5 MB limit.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"500":{"description":"MyFatoorah accepted the document, but saving it here failed.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"502":{"description":"MyFatoorah could not accept that document.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}}}}},"/api/myfatoorah-documents/v2/upload":{"post":{"operationId":"uploadMyFatoorahDocumentV2","summary":"Upload one MyFatoorah KYC document","description":"Forwards the request body, the document's raw bytes under its own MIME type, to the organization's connected MyFatoorah account and records the upload marker. Requires a signed-in session with payment-provider rights for that organization.","security":[{"sessionCookie":[]}],"parameters":[{"name":"organizationId","in":"query","required":true,"schema":{"type":"string","minLength":1}},{"name":"fileType","in":"query","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"x-file-name","in":"header","required":true,"description":"The file's name, percent-encoded.","schema":{"type":"string","minLength":1,"maxLength":255}}],"requestBody":{"required":true,"content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}},"image/bmp":{"schema":{"type":"string","format":"binary"}},"image/gif":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/msword":{"schema":{"type":"string","format":"binary"}},"application/vnd.openxmlformats-officedocument.wordprocessingml.document":{"schema":{"type":"string","format":"binary"}},"application/vnd.ms-excel":{"schema":{"type":"string","format":"binary"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"MyFatoorah accepted the document and the marker was recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"fileType":{"type":"number"},"uploadedAt":{"type":"string"}},"required":["fileType","uploadedAt"]}}}},"400":{"description":"That upload request is not valid, or MyFatoorah rejected the file.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"401":{"description":"Sign in to upload a document.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"403":{"description":"You cannot upload MyFatoorah documents, or the merchant Paywall locks this business.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"409":{"description":"Connect MyFatoorah before uploading documents.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"412":{"description":"MyFatoorah is not configured.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"413":{"description":"That file exceeds MyFatoorah's 5 MB limit.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"415":{"description":"That file type is not accepted.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"500":{"description":"MyFatoorah accepted the document, but saving it here failed.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"502":{"description":"MyFatoorah could not accept that document.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}},"504":{"description":"MyFatoorah took too long to accept that document — try again.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string","description":"MyFatoorah's own reason, present only when it rejected the document."}},"required":["message"]}}}}}}}}}