Read the canonical order and payment projection for a cart
Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.
GET
/
locations
/
{locationId}
/
carts
/
{cartId}
/
commerce-projection
Read the canonical order and payment projection for a cart
curl --request GET \ --url https://sandbox-api.craveup.com/api/v1/locations/{locationId}/carts/{cartId}/commerce-projection \ --header 'X-API-Key: <api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Crave Cloud Documentation","description":"Developer documentation for Crave Cloud, Crave.js, Storefront APIs, and restaurant franchise integrations.","colors":{"primary":"#133B2F","light":"#1F5A49","dark":"#0B1F19"},"logo":{"light":"https://mintcdn.com/craveup-1493c4c7/P4icpH7dO6tjC3GV/logo/crave-wordmark.png?fit=max\u0026auto=format\u0026n=P4icpH7dO6tjC3GV\u0026q=85\u0026s=c6965caeaa3bfbd9e84cf5416bbf2576","dark":"https://mintcdn.com/craveup-1493c4c7/P4icpH7dO6tjC3GV/logo/crave-wordmark-dark.svg?fit=max\u0026auto=format\u0026n=P4icpH7dO6tjC3GV\u0026q=85\u0026s=d379668f5b2407f7092bbc4603c403bc","href":"https://developer.craveup.com"},"favicon":"https://mintcdn.com/craveup-1493c4c7/Nv2UkyJdWuAjqtql/favicon.svg?fit=max\u0026auto=format\u0026n=Nv2UkyJdWuAjqtql\u0026q=85\u0026s=7a4dc1dfa23901b208e854d9b64f0448","navbar":{"links":[{"href":"mailto:hello@craveup.com","label":"Support"},{"icon":"slack","href":"https://join.slack.com/t/cravejscommunity/shared_invite/zt-3hfr081io-aYuLC3n6gBFKQuho0HrTng","label":""}],"primary":{"type":"button","label":"Developer Console","href":"https://developer.craveup.com/console"}},"footer":{"socials":{"github":"https://github.com/crave-up","linkedin":"https://www.linkedin.com/company/craveup","x":"https://twitter.com/craveupcom"}},"search":{},"seo":{"metatags":{"canonical":"https://docs.craveup.com"}},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode",{"title":"Open in T3 Chat","description":"Open this page in T3 Chat","icon":"message-circle","href":"https://t3.chat/new?q=Read+this+documentation+page+and+help+me+implement+it:+$page"},{"title":"Open in Zed","description":"Open this page in Zed","icon":"terminal","href":"zed://docs?url=$page"}],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"craveup-1493c4c7","hasAudioNarration":false,"actualSubdomain":"craveup-1493c4c7","customDomains":["docs.craveup.com"],"gitSource":{"type":"github","owner":"craveup","repo":"craveup-turborepo","deployBranch":"main","contentDirectory":"apps/api-docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae427cf5917815ea7f4c717","collectionId":"d8545f6b-d64e-4d42-a6dc-f7ad2e3e4729","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae427cf5917815ea7f4c717"},"entitlements":{},"buildId":"6ae42ed740afc677620a1b02","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":113},{"language":"default","tag":"API Endpoints","count":88},{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"Components","count":26},{"language":"default","tag":"Checkout","count":16},{"language":"default","tag":"Carts","count":15},{"language":"default","tag":"Catering","count":13},{"language":"default","tag":"Customers","count":12},{"language":"default","tag":"Staff Menu Manager authoring","count":8},{"language":"default","tag":"Loyalty","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"#navbar a[aria-label=\"Join the Crave Slack community\"]{display:inline-flex;align-items:center;justify-content:center;width:2rem;height:2rem;padding:0;overflow:hidden;white-space:nowrap;gap:0}#navbar a[aria-label=\"Join the Crave Slack community\"] svg{width:1.125rem;height:1.125rem}.preview-device{width:100%}.preview-device-toggle{display:inline-flex;gap:.25rem;margin-bottom:.75rem;padding:.25rem;border:1px solid #d8ded9;border-radius:6px;background:#fff}.preview-device-toggle button{min-width:5.5rem;min-height:2rem;padding:.375rem .75rem;border:0;border-radius:4px;color:inherit;background:0 0;cursor:pointer}.preview-device-toggle button.is-active{color:#fff;background:#133b2f}.preview-device-stage{width:100%;overflow:hidden;border:1px solid var(--border-color);border-radius:6px;background:#f6f1e9}.preview-device-stage.is-mobile{max-width:430px;margin-inline:auto}.preview-device-stage.is-mobile.is-local-mobile{position:relative;aspect-ratio:var(--preview-mobile-ratio, 430 / 560);container-type:inline-size}.preview-device-stage iframe{display:block;width:100%;border:0}.preview-device-stage.is-mobile.is-local-mobile iframe{position:absolute;inset:0;width:430px;height:var(--preview-mobile-height, 560px);transform:scale(calc(100cqw/430));transform-origin:top left}"}],"page":{"pagePath":"api-reference/read-the-canonical-order-and-payment-projection-for-a-cart","slug":"/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart","pageMetadata":{"title":"Read the canonical order and payment projection for a cart","description":"Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.","deprecated":null,"version":null,"openapi":"/generated/integration.openapi.json get /locations/{locationId}/carts/{cartId}/commerce-projection","href":"/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Read the canonical order and payment projection for a cart","description":"Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.","deprecated":null,"version":null,"openapi":"/generated/integration.openapi.json get /locations/{locationId}/carts/{cartId}/commerce-projection","href":"/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"integrationGetOrderCommerceProjection","summary":"Read the canonical order and payment projection for a cart","description":"Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.","security":["a961e374-040f-4141-98cd-6f7500bbae4b"],"x-crave-required-api-key-scope":"orders:read","parameters":["edd1252c-de27-49d3-95d1-7e5e5ffe6b70","83195174-0252-4a3a-8b43-21719877f37b"],"responses":{"200":"5e512b4c-6599-4a21-ac3f-ab96710acc5e","400":"196b645b-432c-414c-80f2-b178f5ced6e0","401":"15f12c0c-4ba4-4620-a6d7-94823f4e978e","403":"b5367de2-c49d-48ab-affc-4c576264a2a5","404":"bbc38e6b-e814-431a-bb8f-4a82ad3adefd","429":"d0417fc3-734c-42cb-8732-5e1b75f6530c","500":"3a1f364b-944e-4e97-bb5d-1a8c893a4833","503":"f93b059e-435b-4b99-ab58-a2ac5ee9e811"},"method":"get","type":"path","servers":["5b083f72-9364-4a2d-8866-cf5ae7146ad8","0458dfc8-ba5b-4694-bca2-bb6fb5d4a65b"],"path":"/locations/{locationId}/carts/{cartId}/commerce-projection","baseUrlOptions":["https://sandbox-api.craveup.com/api/v1","https://api.craveup.com/api/v1"],"title":"Read the canonical order and payment projection for a cart","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"edd1252c-de27-49d3-95d1-7e5e5ffe6b70":{"name":"locationId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}},"83195174-0252-4a3a-8b43-21719877f37b":{"name":"cartId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"5e512b4c-6599-4a21-ac3f-ab96710acc5e":{"description":"Current canonical projection. Cache-Control: private, no-store.","headers":{"Cache-Control":{"schema":{"type":"string","enum":["private, no-store"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"cartId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"cartId","typeLabel":"string\u003cuuid>"},"checkout":{"type":"object","properties":{"attemptId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"checkout.attemptId","typeLabel":"string\u003cuuid>"},"collectionMode":{"type":"string","enum":["ONLINE","PAY_AT_STORE"],"isRequired":true,"uniqueKey":"checkout.collectionMode","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["PREPARING","ORDER_CREATED","AWAITING_CUSTOMER_ACTION","SUBMITTING","SUCCEEDED","FAILED","EXPIRED","ACTION_REQUIRED"],"isRequired":true,"uniqueKey":"checkout.status","typeLabel":"enum\u003cstring>"}},"required":["attemptId","collectionMode","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"checkout","typeLabel":"object"},"order":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"order.id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","minLength":1,"maxLength":64,"isRequired":true,"uniqueKey":"order.status","typeLabel":"string"}},"required":["id","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"order","typeLabel":"object"},"payment":{"type":"object","properties":{"reconciliationStatus":{"type":"string","enum":["CURRENT","RECONCILING","ACTION_REQUIRED"],"isRequired":true,"uniqueKey":"payment.reconciliationStatus","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["NO_PAYMENT_REQUIRED","DUE","PARTIALLY_PAID","PAID","PARTIALLY_REFUNDED","REFUNDED","CANCELED"],"isRequired":true,"uniqueKey":"payment.status","typeLabel":"enum\u003cstring>"}},"required":["reconciliationStatus","status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"payment","typeLabel":"object"}},"required":["cartId","checkout","order","payment"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"cartId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","checkout":{"attemptId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","collectionMode":"ONLINE","status":"PREPARING"},"order":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"\u003cstring>"},"payment":{"reconciliationStatus":"CURRENT","status":"NO_PAYMENT_REQUIRED"}}}},"exampleType":"generated"}},"exampleType":"generated"},"196b645b-432c-414c-80f2-b178f5ced6e0":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"data":{"type":"object","additionalProperties":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>","code":"\u003cstring>","data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"15f12c0c-4ba4-4620-a6d7-94823f4e978e":{"description":"Organization API key missing, invalid, or for a different environment.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"data":{"type":"object","additionalProperties":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>","code":"\u003cstring>","data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"b5367de2-c49d-48ab-affc-4c576264a2a5":{"description":"Key scope or location assignment denied.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"data":{"type":"object","additionalProperties":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>","code":"\u003cstring>","data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"bbc38e6b-e814-431a-bb8f-4a82ad3adefd":{"description":"No matching scoped cart/order projection is available.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"data":{"type":"object","additionalProperties":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>","code":"\u003cstring>","data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"d0417fc3-734c-42cb-8732-5e1b75f6530c":{"description":"Baseline API rate limit exceeded before route authentication.","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"integer","enum":[429],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":429,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3a1f364b-944e-4e97-bb5d-1a8c893a4833":{"description":"Projection could not be read. No payment or order mutation is performed.","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"data":{"type":"object","additionalProperties":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>","code":"\u003cstring>","data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"f93b059e-435b-4b99-ab58-a2ac5ee9e811":{"description":"Rate-limit storage unavailable; request denied before the route handler.","headers":{"Retry-After":{"schema":{"type":"string","enum":["1"]}}},"content":{"application/json":{"schema":{"type":"object","required":["status","code","message"],"properties":{"status":{"type":"integer","enum":[503],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"code":{"type":"string","enum":["RATE_LIMIT_STORE_UNAVAILABLE"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":503,"code":"RATE_LIMIT_STORE_UNAVAILABLE","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a961e374-040f-4141-98cd-6f7500bbae4b":{"OrganizationApiKey":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"OrganizationApiKey"}}},"servers":{"5b083f72-9364-4a2d-8866-cf5ae7146ad8":{"url":"https://sandbox-api.craveup.com/api/v1","description":"Sandbox"},"0458dfc8-ba5b-4694-bca2-bb6fb5d4a65b":{"url":"https://api.craveup.com/api/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"OrganizationApiKey"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"OrganizationApiKey","name":"X-API-Key"}],"title":"OrganizationApiKey"}]},"originalFileLocation":"generated/integration.openapi.json"},"subdomain":"craveup-1493c4c7","siteName":"Crave Cloud Documentation","title":"Read the canonical order and payment projection for a cart - Crave Cloud Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T05:15:06.601Z","originalFileLocation":"api-reference/read-the-canonical-order-and-payment-projection-for-a-cart.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Crave Cloud Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read the canonical order and payment projection for a cart - Crave Cloud Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Crave Cloud Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://craveup-1493c4c7.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Read+the+canonical+order+and+payment+projection+for+a+cart\u0026amp;description=Requires+an+organization+API+key+with+orders%3Aread+and+access+to+the+requested+location.+Guest+cart+capabilities+and+merchant+sessions+do+not+authorize+this+oper\u0026amp;theme=b98c5e909d3955315eca9dcf\u0026amp;signature=9197115d6f26bb214530482b050c61e356b8c6f2a3540041b66f51ae2263d128\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Read the canonical order and payment projection for a cart - Crave Cloud Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://craveup-1493c4c7.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Read+the+canonical+order+and+payment+projection+for+a+cart\u0026amp;description=Requires+an+organization+API+key+with+orders%3Aread+and+access+to+the+requested+location.+Guest+cart+capabilities+and+merchant+sessions+do+not+authorize+this+oper\u0026amp;theme=b98c5e909d3955315eca9dcf\u0026amp;signature=9197115d6f26bb214530482b050c61e356b8c6f2a3540041b66f51ae2263d128\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/craveup-1493c4c7/xHUpRIXxnvFKaY61/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Crave Cloud Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#133B2F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.craveup.com/#organization\",\"name\":\"Crave Cloud Documentation\",\"url\":\"https://docs.craveup.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/craveup-1493c4c7/P4icpH7dO6tjC3GV/logo/crave-wordmark.png?fit=max\u0026auto=format\u0026n=P4icpH7dO6tjC3GV\u0026q=85\u0026s=c6965caeaa3bfbd9e84cf5416bbf2576\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.craveup.com#website\",\"name\":\"Crave Cloud Documentation\",\"url\":\"https://docs.craveup.com\",\"publisher\":{\"@id\":\"https://docs.craveup.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart#webpage\",\"url\":\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart\",\"name\":\"Read the canonical order and payment projection for a cart\",\"description\":\"Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.\",\"dateModified\":\"2026-10-30T05:15:06.601Z\",\"isPartOf\":{\"@id\":\"https://docs.craveup.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Server-to-Server Integration API\",\"item\":\"https://docs.craveup.com/api-reference/list-the-locations-this-key-can-read\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.craveup.com/api-reference/list-the-locations-this-key-can-read\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Read the canonical order and payment projection for a cart\",\"item\":\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart#apireference\",\"headline\":\"Read the canonical order and payment projection for a cart\",\"name\":\"Read the canonical order and payment projection for a cart\",\"description\":\"Requires an organization API key with orders:read and access to the requested location. Guest cart capabilities and merchant sessions do not authorize this operation. Returns the minimal current aggregate, not customer details or provider payment payloads. A successful read does not authorize a checkout retry.\",\"url\":\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.craveup.com/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart#webpage\"},\"dateModified\":\"2026-10-30T05:15:06.601Z\",\"publisher\":{\"@id\":\"https://docs.craveup.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.craveup.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Crave Cloud Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Crave Cloud Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/guides/crave-cloud-overview"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"SDK Reference","icon":"book-open","pages":[{"title":"API Overview","href":"/api-reference/overview/api-overview"},{"title":"Core Concepts","href":"/api-reference/overview/core-concepts"}]},{"group":"API Endpoints","icon":"route","pages":[{"group":"Customer Auth","pages":[{"title":"Read eligible customer sign-in channels","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /merchant/{merchantSlug}/auth/config","href":"/api-reference/customer-auth/read-eligible-customer-sign-in-channels"},{"title":"Prepare a merchant-bound customer code challenge","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /merchant/{merchantSlug}/auth/challenges","href":"/api-reference/customer-auth/prepare-a-merchant-bound-customer-code-challenge"},{"title":"Replace an owned code challenge","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /merchant/{merchantSlug}/auth/challenges/{challengeId}/resend","href":"/api-reference/customer-auth/replace-an-owned-code-challenge"},{"title":"Consume a fresh code proof for a customer session","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /merchant/{merchantSlug}/auth/challenges/{challengeId}/verify","href":"/api-reference/customer-auth/consume-a-fresh-code-proof-for-a-customer-session"},{"title":"Rotate one customer session generation","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /merchant/{merchantSlug}/auth/session/refresh","href":"/api-reference/customer-auth/rotate-one-customer-session-generation"},{"title":"Read the current customer session identity","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /merchant/{merchantSlug}/auth/session","href":"/api-reference/customer-auth/read-the-current-customer-session-identity"},{"title":"Revoke the owned local customer session family","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json delete /merchant/{merchantSlug}/auth/session","href":"/api-reference/customer-auth/revoke-the-owned-local-customer-session-family"}]},{"group":"Catering","pages":[{"title":"Read an event-bound catering proposal","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/catering/events/{eventId}/live-cart","href":"/api-reference/catering/read-an-event-bound-catering-proposal"},{"title":"Suggest catering catalog quantities and preferences","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json put /locations/{locationId}/catering/events/{eventId}/live-cart","href":"/api-reference/catering/suggest-catering-catalog-quantities-and-preferences"},{"title":"View a customer catering event","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/catering/events/{eventId}","href":"/api-reference/catering/view-a-customer-catering-event"},{"title":"Accept the current catering offer","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/catering/events/{eventId}/accept","href":"/api-reference/catering/accept-the-current-catering-offer"},{"title":"Decline the current catering quote","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/catering/events/{eventId}/decline","href":"/api-reference/catering/decline-the-current-catering-quote"},{"title":"Review immutable proposed changes to an accepted catering booking","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/catering/events/{eventId}/amendments","href":"/api-reference/catering/review-immutable-proposed-changes-to-an-accepted-catering-booking"},{"title":"Explicitly accept or decline the exact proposed catering version","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/catering/events/{eventId}/amendments/decision","href":"/api-reference/catering/explicitly-accept-or-decline-the-exact-proposed-catering-version"},{"title":"Read a customer's cancellation request without changing the booking","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/catering/events/{eventId}/cancellation-request","href":"/api-reference/catering/read-a-customers-cancellation-request-without-changing-the-booking"},{"title":"Request restaurant review of cancellation; never cancels or refunds","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/catering/events/{eventId}/cancellation-request","href":"/api-reference/catering/request-restaurant-review-of-cancellation;-never-cancels-or-refunds"},{"title":"Pay the remaining balance of an accepted catering job","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/catering/events/{eventId}/balance-payment","href":"/api-reference/catering/pay-the-remaining-balance-of-an-accepted-catering-job"},{"title":"Show a location's public catering inquiry form","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/catering/inquiry-form","href":"/api-reference/catering/show-a-locations-public-catering-inquiry-form"},{"title":"Read a location's published catering menu","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/catering/menu","href":"/api-reference/catering/read-a-locations-published-catering-menu"},{"title":"Send a catering inquiry from a website","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/catering/inquiries","href":"/api-reference/catering/send-a-catering-inquiry-from-a-website"}]},{"group":"Loyalty","pages":[{"title":"Get the customer loyalty account, tier, membership, and wallet","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/locations/{locationId}/loyalty/account","href":"/api-reference/loyalty/get-the-customer-loyalty-account-tier-membership-and-wallet"},{"title":"Get loyalty earning and reward options","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}/loyalty/quote","href":"/api-reference/loyalty/get-loyalty-earning-and-reward-options"},{"title":"Join the checkout's authoritative loyalty program","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/loyalty/enrollment","href":"/api-reference/loyalty/join-the-checkouts-authoritative-loyalty-program"},{"title":"Reserve and apply a loyalty reward","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/loyalty/redeem","href":"/api-reference/loyalty/reserve-and-apply-a-loyalty-reward"},{"title":"Remove the applied loyalty reward","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json delete /locations/{locationId}/carts/{cartId}/loyalty/redeem","href":"/api-reference/loyalty/remove-the-applied-loyalty-reward"},{"title":"Get customer loyalty balances and ledger","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/locations/{locationId}/loyalty/ledger","href":"/api-reference/loyalty/get-customer-loyalty-balances-and-ledger"},{"title":"List customer loyalty claims","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/loyalty/claims","href":"/api-reference/loyalty/list-customer-loyalty-claims"},{"title":"Submit a loyalty claim","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /customer/loyalty/claims","href":"/api-reference/loyalty/submit-a-loyalty-claim"}]},{"group":"Merchants","pages":[{"title":"Get a published merchant and its locations","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /merchant/{merchantSlug}","href":"/api-reference/merchants/get-a-published-merchant-and-its-locations"},{"title":"Resolve an exact active custom storefront hostname","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /domain-bootstrap/{hostname}","href":"/api-reference/merchants/resolve-an-exact-active-custom-storefront-hostname"}]},{"group":"Locations","pages":[{"title":"Get a published location","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationSlugOrId}","href":"/api-reference/locations/get-a-published-location"},{"title":"Calculate distance to a location","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/distance","href":"/api-reference/locations/calculate-distance-to-a-location"},{"title":"Get available order times","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/time-intervals","href":"/api-reference/locations/get-available-order-times"},{"title":"Read a location menu using an expiring merchant-issued preview capability","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/preview","href":"/api-reference/locations/read-a-location-menu-using-an-expiring-merchant-issued-preview-capability"},{"title":"Get gratuity configuration","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/gratuity","href":"/api-reference/locations/get-gratuity-configuration"},{"title":"Redirect to the hosted location storefront","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/redirect","href":"/api-reference/locations/redirect-to-the-hosted-location-storefront"}]},{"group":"Ordering Sessions","pages":[{"title":"Check ordering availability without creating a cart","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/ordering-readiness","href":"/api-reference/ordering-sessions/check-ordering-availability-without-creating-a-cart"},{"title":"Create or resume an ordering session","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/ordering-sessions","href":"/api-reference/ordering-sessions/create-or-resume-an-ordering-session"}]},{"group":"Menus","pages":[{"title":"List the published menu bundle","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/menus","href":"/api-reference/menus/list-the-published-menu-bundle"}]},{"group":"Products","pages":[{"title":"Get a published product","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/products/{productId}","href":"/api-reference/products/get-a-published-product"},{"title":"Preview an accepted configuration within a released menu","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/products/{productId}/configuration-preview","href":"/api-reference/products/preview-an-accepted-configuration-within-a-released-menu"}]},{"group":"Carts","pages":[{"title":"Persist session preferences and recalculate cart food advice","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json put /locations/{locationId}/carts/{cartId}/dietary-preferences","href":"/api-reference/carts/persist-session-preferences-and-recalculate-cart-food-advice"},{"title":"Get an authorized cart","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}","href":"/api-reference/carts/get-an-authorized-cart"},{"title":"Expire a cart","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json delete /locations/{locationId}/carts/{cartId}","href":"/api-reference/carts/expire-a-cart"},{"title":"Update cart fields","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json patch /locations/{locationId}/carts/{cartId}","href":"/api-reference/carts/update-cart-fields"},{"title":"Stream authorized cart revision events","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}/events","href":"/api-reference/carts/stream-authorized-cart-revision-events"},{"title":"Accept the current authoritative cart changes","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/catalog-revalidation/accept","href":"/api-reference/carts/accept-the-current-authoritative-cart-changes"},{"title":"Start a cart at another merchant location","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/location-switches","href":"/api-reference/carts/start-a-cart-at-another-merchant-location"},{"title":"List cart recommendations","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}/products","href":"/api-reference/carts/list-cart-recommendations"},{"title":"Update the DoorDash courier tip","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json put /locations/{locationId}/carts/{cartId}/courier-tip","href":"/api-reference/carts/update-the-doordash-courier-tip"},{"title":"Update cart gratuity","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json put /locations/{locationId}/carts/{cartId}/gratuity","href":"/api-reference/carts/update-cart-gratuity"},{"title":"Set cart delivery address","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json put /locations/{locationId}/carts/{cartId}/set-delivery","href":"/api-reference/carts/set-cart-delivery-address"},{"title":"Set table service details","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json put /locations/{locationId}/carts/{cartId}/set-table","href":"/api-reference/carts/set-table-service-details"},{"title":"Set room service details","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json put /locations/{locationId}/carts/{cartId}/set-room","href":"/api-reference/carts/set-room-service-details"},{"title":"Update cart order time","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json put /locations/{locationId}/carts/{cartId}/update-order-time","href":"/api-reference/carts/update-cart-order-time"},{"title":"Claim a guest cart for the signed-in customer","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/claim","href":"/api-reference/carts/claim-a-guest-cart-for-the-signed-in-customer"}]},{"group":"Analytics","pages":[{"title":"Record an allowlisted Storefront analytics event","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/analytics-events","href":"/api-reference/analytics/record-an-allowlisted-storefront-analytics-event"}]},{"group":"Checkout","pages":[{"title":"Validate checkout and update customer contact details","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json put /locations/{locationId}/carts/{cartId}/validate-and-update","href":"/api-reference/checkout/validate-checkout-and-update-customer-contact-details"},{"title":"Get server-evaluated checkout collection choices","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}/collection-options","href":"/api-reference/checkout/get-server-evaluated-checkout-collection-choices"},{"title":"Create a one-time checkout handoff","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/checkout-handoffs","href":"/api-reference/checkout/create-a-one-time-checkout-handoff"},{"title":"Exchange a one-time checkout handoff","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/checkout-handoffs/exchange","href":"/api-reference/checkout/exchange-a-one-time-checkout-handoff"},{"title":"Prepare hosted checkout with separate read-only return authority","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/checkout-observers","href":"/api-reference/checkout/prepare-hosted-checkout-with-separate-read-only-return-authority"},{"title":"Read persisted hosted checkout state without payment reconciliation","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}/checkout-result","href":"/api-reference/checkout/read-persisted-hosted-checkout-state-without-payment-reconciliation"},{"title":"Create or replay an order-first checkout submission","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/submissions","href":"/api-reference/checkout/create-or-replay-an-order-first-checkout-submission"},{"title":"Get a stable order-first submission outcome","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}/submissions/{attemptId}","href":"/api-reference/checkout/get-a-stable-order-first-submission-outcome"},{"title":"Resolve a submission by attempt, cart, or payment intent","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}/submission-lookup","href":"/api-reference/checkout/resolve-a-submission-by-attempt-cart-or-payment-intent"},{"title":"Submit a rating after successful payment","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/rating","href":"/api-reference/checkout/submit-a-rating-after-successful-payment"}]},{"group":"Cart Items","pages":[{"title":"Add an item to a cart","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/items","href":"/api-reference/cart-items/add-an-item-to-a-cart"},{"title":"Remove an item from a cart","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json delete /locations/{locationId}/carts/{cartId}/items/{itemId}","href":"/api-reference/cart-items/remove-an-item-from-a-cart"},{"title":"Update a cart item quantity","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json patch /locations/{locationId}/carts/{cartId}/items/{itemId}","href":"/api-reference/cart-items/update-a-cart-item-quantity"}]},{"group":"Discounts","pages":[{"title":"Apply a discount code","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /locations/{locationId}/carts/{cartId}/discount","href":"/api-reference/discounts/apply-a-discount-code"},{"title":"Remove the applied discount","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json delete /locations/{locationId}/carts/{cartId}/discount","href":"/api-reference/discounts/remove-the-applied-discount"}]},{"group":"Customers","pages":[{"title":"Get the signed-in customer profile","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer","href":"/api-reference/customers/get-the-signed-in-customer-profile"},{"title":"Request deletion of the signed-in customer account","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json delete /customer","href":"/api-reference/customers/request-deletion-of-the-signed-in-customer-account"},{"title":"Export the signed-in customer's organization data","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/data-export","href":"/api-reference/customers/export-the-signed-in-customers-organization-data"},{"title":"Get signed-in customer deletion progress","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/privacy-operations/{operationId}","href":"/api-reference/customers/get-signed-in-customer-deletion-progress"},{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/addresses","href":"/api-reference/customers/list-customer-addresses"},{"title":"Create a customer address","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /customer/addresses","href":"/api-reference/customers/create-a-customer-address"},{"title":"Delete a customer address","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json delete /customer/addresses/{addressId}","href":"/api-reference/customers/delete-a-customer-address"},{"title":"Update a customer address","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json patch /customer/addresses/{addressId}","href":"/api-reference/customers/update-a-customer-address"},{"title":"List saved payment methods","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/locations/{locationId}/saved-payments","href":"/api-reference/customers/list-saved-payment-methods"},{"title":"Delete a saved payment method","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json delete /customer/locations/{locationId}/saved-payments/{paymentId}","href":"/api-reference/customers/delete-a-saved-payment-method"},{"title":"Create a Stripe saved-card setup session","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /customer/locations/{locationId}/saved-payment-setups","href":"/api-reference/customers/create-a-stripe-saved-card-setup-session"},{"title":"Get an authoritative Stripe saved-card setup status","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/locations/{locationId}/saved-payment-setups/{setupIntentId}","href":"/api-reference/customers/get-an-authoritative-stripe-saved-card-setup-status"}]},{"group":"Orders","pages":[{"title":"List customer orders","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/orders","href":"/api-reference/orders/list-customer-orders"},{"title":"Claim an eligible guest order with verified customer contact","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json post /customer/order-claims","href":"/api-reference/orders/claim-an-eligible-guest-order-with-verified-customer-contact"},{"title":"Get customer order details","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /customer/orders/{orderId}","href":"/api-reference/orders/get-customer-order-details"},{"title":"Get an authorized public receipt","deprecated":null,"version":null,"openapi":"/generated/storefront.openapi.json get /receipts/{receiptId}","href":"/api-reference/orders/get-an-authorized-public-receipt"}]}]},{"group":"Staff Menu Manager authoring","icon":"utensils","pages":[{"group":"API Reference","pages":[{"title":"Review all structural and recipe uses of a shared record","deprecated":null,"version":null,"openapi":"/generated/catalog-workspace.openapi.json get /api/v1/catalog/workspace/entities/{canonicalId}/usage","href":"/api-reference/review-all-structural-and-recipe-uses-of-a-shared-record"},{"title":"Replace one ordered parent list without deleting library records","deprecated":null,"version":null,"openapi":"/generated/catalog-workspace.openapi.json put /api/v1/catalog/workspace/relationships","href":"/api-reference/replace-one-ordered-parent-list-without-deleting-library-records"},{"title":"Review explicit menu/location/channel targets and retained releases","deprecated":null,"version":null,"openapi":"/generated/catalog-workspace.openapi.json post /api/v1/catalog/workspace/publication-review","href":"/api-reference/review-explicit-menulocationchannel-targets-and-retained-releases"},{"title":"Preview one selected menu at one location/channel/time from its draft revision or an active release","deprecated":null,"version":null,"openapi":"/generated/catalog-workspace.openapi.json post /api/v1/catalog/workspace/preview","href":"/api-reference/preview-one-selected-menu-at-one-locationchanneltime-from-its-draft-revision-or-an-active-release"},{"title":"Evaluate a configured item's food from the same draft or released source as the menu preview","deprecated":null,"version":null,"openapi":"/generated/catalog-workspace.openapi.json post /api/v1/catalog/workspace/configuration-preview","href":"/api-reference/evaluate-a-configured-items-food-from-the-same-draft-or-released-source-as-the-menu-preview"},{"title":"Save or withdraw existing revisioned catering commercial facts","deprecated":null,"version":null,"openapi":"/generated/catalog-workspace.openapi.json put /api/v1/catalog/workspace/commercial-facts","href":"/api-reference/save-or-withdraw-existing-revisioned-catering-commercial-facts"},{"title":"Read draft commercial facts for a granted location","deprecated":null,"version":null,"openapi":"/generated/catalog-workspace.openapi.json get /api/v1/locations/{locationId}/catalog/commercial-facts","href":"/api-reference/read-draft-commercial-facts-for-a-granted-location"},{"title":"Change immediate location availability using the operational owner","deprecated":null,"version":null,"openapi":"/generated/catalog-workspace.openapi.json patch /api/v1/locations/{locationId}/catalog/products/{productId}/availability","href":"/api-reference/change-immediate-location-availability-using-the-operational-owner"}]}]},{"group":"Server-to-Server Integration API","icon":"server","pages":[{"group":"API Reference","pages":[{"title":"List the locations this key can read","deprecated":null,"version":null,"openapi":"/generated/integration.openapi.json get /locations","href":"/api-reference/list-the-locations-this-key-can-read"},{"title":"Read a location's identity, hours and current open state","description":"Requires an organization API key with merchant:read and access to the requested location. Answers what an integration needs to speak for a restaurant in one read: its name, address, timezone, opening hours, whether it is open at the moment of the request, and which fulfillment methods it accepts. isOpenNow is evaluated server-side against the location's own timezone so that callers do not each reimplement the rule and disagree at opening and closing minutes. scheduleSource distinguishes hours nobody has set (unconfirmed) from a restaurant that is closed right now. Carries no fee rates, provider metadata or internal settings.","deprecated":null,"version":null,"openapi":"/generated/integration.openapi.json get /locations/{locationId}/profile","href":"/api-reference/read-a-locations-identity-hours-and-current-open-state"},{"title":"Read the canonical order and payment projection for a cart","deprecated":null,"version":null,"openapi":"/generated/integration.openapi.json get /locations/{locationId}/carts/{cartId}/commerce-projection","href":"/api-reference/read-the-canonical-order-and-payment-projection-for-a-cart"}]}]},{"group":"Error Codes","icon":"triangle-alert","pages":[{"title":"Error Codes","description":"Handle public Storefront API errors without leaking credentials or replaying unsafe writes.","href":"/guides/error-codes"}]}]},{"tab":"Components","icon":"puzzle","pages":[{"title":"Components","href":"/components/overview"}]},{"tab":"Changelog","icon":"clock","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Read the canonical order and payment projection for a cart - Crave Cloud Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}