A working copy of one resource, as text. Edit it with updateWorkspace, check diagnostics, then save it with commitWorkspace. Expires 7 days after its last change.
query { workspace(id: "...") { document expiresAt id resourceId resourceType revision stale }}
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Redo","colors":{"primary":"#FF4405","light":"#FF4405","dark":"#1b1b1b"},"logo":{"light":"https://mintcdn.com/redo-44af351d/KtmWeYG860C3iLpm/docs/logo/light.svg?fit=max\u0026auto=format\u0026n=KtmWeYG860C3iLpm\u0026q=85\u0026s=d7d25c69bed7e16ea3f3ad1334492765","dark":"https://mintcdn.com/redo-44af351d/KtmWeYG860C3iLpm/docs/logo/dark.svg?fit=max\u0026auto=format\u0026n=KtmWeYG860C3iLpm\u0026q=85\u0026s=20a39501a0e50b6d8040a4d1c6b5bf1c"},"favicon":"https://mintcdn.com/redo-44af351d/bJ_qKygAPDy-o3KA/docs/favicon.ico?fit=max\u0026auto=format\u0026n=bJ_qKygAPDy-o3KA\u0026q=85\u0026s=cbe6e872979f1e3bedec3eabcd7d5641","api":{"openapi":"api-schema/openapi.yaml"},"background":{"decoration":"windows"},"navbar":{"links":[{"href":"https://app.getredo.com","label":"Dashboard"}],"primary":{"type":"button","label":"Get a Demo","href":"https://redo.com/en/demo"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/redo-tech","website":"https://redo.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"redo-44af351d","hasAudioNarration":false,"actualSubdomain":"redo-44af351d","customDomains":["developers.redo.com"],"gitSource":{"type":"gitlab","owner":"redo/redoapp/product","repo":"developer-docs-site","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":87173070,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad95331fd83de2802b63bd3","collectionId":"7f8a72fa-f635-49b1-88f8-7b4fb8be4f7a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad95331fd83de2802b63bd3"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ada439ad19cb6ae78561fdb","clientVersion":"0.0.3926","searchFilterCounts":[{"language":"default","tag":"API Reference","count":521},{"language":"default","tag":"Reference","count":450},{"language":"default","tag":"Objects","count":279},{"language":"default","tag":"Marketing","count":195},{"language":"default","tag":"Queries","count":89},{"language":"default","tag":"Mutations","count":79},{"language":"default","tag":"Integrations","count":60},{"language":"default","tag":"Endpoints","count":60},{"language":"default","tag":"Return Integrations","count":52},{"language":"default","tag":"Returns","count":51}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"vite-origin","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":"editor-agent-model-picker","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"docs/api-reference/v3/reference/automations/queries/workspace","slug":"/docs/api-reference/v3/reference/automations/queries/workspace","pageMetadata":{"title":"workspace","description":"Read a workspace. Null if it doesn't exist or expired.","href":"/docs/api-reference/v3/reference/automations/queries/workspace"},"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: \"Read a workspace. Null if it doesn’t exist or expired.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Required scopes:`}),` `,_jsx(_components.a,{href:`/docs/api-reference/v3/reference/scopes#scope-automations_read`,children:_jsx(_components.code,{children:`automations_read`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`arguments`,children:`Arguments`}),`\n`,_jsx(ResponseField,{name:`id`,type:`ID!`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`The workspace’s id.`})}),`\n`,_jsx(Heading,{level:`2`,id:`returns`,children:`Returns`}),`\n`,_jsxs(ResponseField,{name:`workspace`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/automations/workspace`,children:`Workspace`}),id:`param-workspace`,children:[_jsxs(_components.p,{children:[`A working copy of one resource, as text. Edit it with `,_jsx(_components.code,{children:`updateWorkspace`}),`, check `,_jsx(_components.code,{children:`diagnostics`}),`, then save it with `,_jsx(_components.code,{children:`commitWorkspace`}),`. Expires 7 days after its last change.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsxs(ResponseField,{name:`diagnostics`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/automations/diagnostic`,children:`[Diagnostic!]!`}),required:true,id:`param-diagnostics`,children:[_jsxs(_components.p,{children:[`Problems in the current text. Commit refuses while any is an ERROR. Apply a fix by passing its `,_jsx(_components.code,{children:`edits`}),` to `,_jsx(_components.code,{children:`updateWorkspace`}),`.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`code`,type:`String!`,required:true,id:`param-code`,children:_jsx(_components.p,{children:`A stable code, such as E0101.`})}),_jsx(ResponseField,{name:`column`,type:`Int`,id:`param-column`,children:_jsx(_components.p,{children:`1-based column on that line.`})}),_jsxs(ResponseField,{name:`fixes`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/automations/diagnostic-fix`,children:`[DiagnosticFix!]!`}),required:true,id:`param-fixes`,children:[_jsx(_components.p,{children:`Suggested fixes, best first.`}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`edits`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/automations/text-edit`,children:`[TextEdit!]!`}),required:true,id:`param-edits`,children:_jsx(_components.p,{children:`The edits, in order.`})}),_jsx(ResponseField,{name:`needsInput`,type:`Boolean!`,required:true,id:`param-needs-input`,children:_jsx(_components.p,{children:`True when the edits insert a placeholder you must fill in before committing.`})}),_jsx(ResponseField,{name:`title`,type:`String!`,required:true,id:`param-title`,children:_jsx(_components.p,{children:`What the fix does.`})})]})]}),_jsx(ResponseField,{name:`line`,type:`Int`,id:`param-line`,children:_jsx(_components.p,{children:`1-based line in the document, when it has one.`})}),_jsx(ResponseField,{name:`message`,type:`String!`,required:true,id:`param-message`,children:_jsx(_components.p,{children:`What is wrong.`})}),_jsx(ResponseField,{name:`severity`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/automations/diagnostic-severity`,children:`DiagnosticSeverity!`}),required:true,id:`param-severity`,children:_jsx(_components.p,{children:`How much it matters.`})})]})]}),_jsxs(ResponseField,{name:`document`,type:`String!`,required:true,id:`param-document`,children:[_jsxs(_components.p,{children:[`The working copy’s text. Pass `,_jsx(_components.code,{children:`startLine`}),` and `,_jsx(_components.code,{children:`endLine`}),` (1-based, inclusive) to read part of it.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Arguments`})}),_jsx(ResponseField,{name:`endLine`,type:`Int`,id:`param-end-line`,children:_jsx(_components.p,{children:`Last line.`})}),_jsx(ResponseField,{name:`startLine`,type:`Int`,id:`param-start-line`,children:_jsx(_components.p,{children:`First line.`})})]})]}),_jsx(ResponseField,{name:`expiresAt`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/date-time`,children:`DateTime!`}),required:true,id:`param-expires-at`,children:_jsx(_components.p,{children:`When the workspace expires unless changed again.`})}),_jsx(ResponseField,{name:`id`,type:`ID!`,required:true,id:`param-id-1`,children:_jsx(_components.p,{children:`The workspace’s id.`})}),_jsx(ResponseField,{name:`resourceId`,type:`ID`,id:`param-resource-id`,children:_jsx(_components.p,{children:`The resource it edits; null until a new resource is first committed.`})}),_jsx(ResponseField,{name:`resourceType`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/automations/workspace-resource-type`,children:`WorkspaceResourceType!`}),required:true,id:`param-resource-type`,children:_jsx(_components.p,{children:`What kind of resource it edits.`})}),_jsx(ResponseField,{name:`revision`,type:`String!`,required:true,id:`param-revision`,children:_jsxs(_components.p,{children:[`The workspace’s current revision. Opaque; pass it as `,_jsx(_components.code,{children:`expectedRevision`}),` to `,_jsx(_components.code,{children:`updateWorkspace`}),` and `,_jsx(_components.code,{children:`commitWorkspace`}),`.`]})}),_jsx(ResponseField,{name:`stale`,type:`Boolean!`,required:true,id:`param-stale`,children:_jsx(_components.p,{children:`True when the resource changed since this workspace started, so commit will return STALE. Start a new workspace and redo your edits.`})})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Example`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`11`,language:`graphql`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`graphql`,children:_jsxs(_components.code,{language:`graphql`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`query`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` workspace`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`id`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"...\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` document`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` expiresAt`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` id`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` resourceId`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` resourceType`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` revision`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` stale`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"workspace","description":"Read a workspace. Null if it doesn't exist or expired.","href":"/docs/api-reference/v3/reference/automations/queries/workspace"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Arguments","slug":"arguments","depth":2,"children":[]},{"title":"Returns","slug":"returns","depth":2,"children":[]},{"title":"Example","slug":"example","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"redo-44af351d","siteName":"Redo","title":"workspace - Redo","navMaps":{"firstHrefInVersion":{"v2 (REST)":{"href":"/docs/api-reference/introduction","matchLevel":3},"v3 (GraphQL)":{"href":"/docs/api-reference/v3/reference/automations/queries/workspace","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T17:11:14.156Z","originalFileLocation":"docs/api-reference/v3/reference/automations/queries/workspace.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=\"Read a workspace. Null if it doesn\u0026#x27;t exist or expired.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Redo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"workspace - Redo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read a workspace. Null if it doesn\u0026#x27;t exist or expired.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Redo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://redo-44af351d.mintlify.app/_mintlify/api/og/v2?division=Queries\u0026amp;title=workspace\u0026amp;description=Read+a+workspace.+Null+if+it+doesn%27t+exist+or+expired.\u0026amp;theme=bf6b5e549173a23170ad717f\u0026amp;signature=5fd8db25d2682be717db22c385e8a34681057962e8ea8c05c9e57c1de5a3a2d7\">\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=\"workspace - Redo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read a workspace. Null if it doesn\u0026#x27;t exist or expired.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://redo-44af351d.mintlify.app/_mintlify/api/og/v2?division=Queries\u0026amp;title=workspace\u0026amp;description=Read+a+workspace.+Null+if+it+doesn%27t+exist+or+expired.\u0026amp;theme=bf6b5e549173a23170ad717f\u0026amp;signature=5fd8db25d2682be717db22c385e8a34681057962e8ea8c05c9e57c1de5a3a2d7\">\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/redo-44af351d/EQY-0EZG4e-KYhl3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Redo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF4405\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/v3/reference/automations/queries/workspace.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.redo.com/#organization\",\"name\":\"Redo\",\"url\":\"https://developers.redo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/redo-44af351d/KtmWeYG860C3iLpm/docs/logo/light.svg?fit=max\u0026auto=format\u0026n=KtmWeYG860C3iLpm\u0026q=85\u0026s=d7d25c69bed7e16ea3f3ad1334492765\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.redo.com#website\",\"name\":\"Redo\",\"url\":\"https://developers.redo.com\",\"publisher\":{\"@id\":\"https://developers.redo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace#webpage\",\"url\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace\",\"name\":\"workspace\",\"description\":\"Read a workspace. Null if it doesn't exist or expired.\",\"dateModified\":\"2026-10-22T17:11:14.156Z\",\"isPartOf\":{\"@id\":\"https://developers.redo.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/automation\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Automations\",\"item\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Queries\",\"item\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/automation\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"workspace\",\"item\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace#article\",\"headline\":\"workspace\",\"name\":\"workspace\",\"description\":\"Read a workspace. Null if it doesn't exist or expired.\",\"url\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace\",\"mainEntityOfPage\":{\"@id\":\"https://developers.redo.com/docs/api-reference/v3/reference/automations/queries/workspace#webpage\"},\"dateModified\":\"2026-10-22T17:11:14.156Z\",\"publisher\":{\"@id\":\"https://developers.redo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.redo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Redo\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Redo","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/docs"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/guides/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/docs/integrations/introduction"}]},{"tab":"API Reference","versions":[{"version":"v2 (REST)","default":true,"pages":[{"title":"v2 (REST)","href":"/docs/api-reference/introduction"}]},{"version":"v3 (GraphQL)","tag":"Beta","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","icon":"hand-wave","href":"/docs/api-reference/v3/introduction"},{"title":"Authentication","icon":"key","href":"/docs/api-reference/v3/authentication"},{"title":"Queries \u0026 mutations","icon":"code","href":"/docs/api-reference/v3/queries-mutations"},{"title":"Pagination","icon":"list","href":"/docs/api-reference/v3/pagination"},{"title":"Rate limiting","icon":"gauge-high","href":"/docs/api-reference/v3/rate-limiting"},{"title":"Errors","icon":"triangle-exclamation","href":"/docs/api-reference/v3/errors"}]},{"group":"Guides","pages":[{"title":"Reconciling payouts","icon":"wallet","href":"/docs/api-reference/v3/reconciling-payouts"}]},{"group":"Reference","pages":[{"group":"Automations","root":{"title":"Automations","href":"/docs/api-reference/v3/reference/automations/overview"},"pages":[{"group":"Queries","pages":[{"title":"automation","href":"/docs/api-reference/v3/reference/automations/queries/automation"},{"title":"automationCatalog","href":"/docs/api-reference/v3/reference/automations/queries/automation-catalog"},{"title":"automationRun","href":"/docs/api-reference/v3/reference/automations/queries/automation-run"},{"title":"automations","href":"/docs/api-reference/v3/reference/automations/queries/automations"},{"title":"testAutomation","description":"Run the workspace's current, uncommitted automation once against a scenario and return what happened. Nothing is stored and nothing real happens: no messages are sent and no records change. Null if the workspace doesn't exist. INVALID while the document has an ERROR diagnostic or can't run; INVALID_SCENARIO, with the failing fields, for a scenario that doesn't match `schemas/scenario` in `automationCatalog`.","href":"/docs/api-reference/v3/reference/automations/queries/test-automation"},{"title":"workspace","href":"/docs/api-reference/v3/reference/automations/queries/workspace"}]},{"group":"Mutations","pages":[{"title":"commitWorkspace","description":"Save a workspace to its resource. STALE if the resource changed since the workspace started; INVALID while an ERROR diagnostic remains. The workspace stays open. For an automation, publish with `publishAutomation` next. Null if the workspace is gone.","href":"/docs/api-reference/v3/reference/automations/mutations/commit-workspace"},{"title":"createWorkspace","href":"/docs/api-reference/v3/reference/automations/mutations/create-workspace"},{"title":"deleteAutomation","href":"/docs/api-reference/v3/reference/automations/mutations/delete-automation"},{"title":"deleteWorkspace","href":"/docs/api-reference/v3/reference/automations/mutations/delete-workspace"},{"title":"publishAutomation","href":"/docs/api-reference/v3/reference/automations/mutations/publish-automation"},{"title":"updateAutomation","href":"/docs/api-reference/v3/reference/automations/mutations/update-automation"},{"title":"updateWorkspace","href":"/docs/api-reference/v3/reference/automations/mutations/update-workspace"}]},{"group":"Objects","pages":[{"title":"Automation","href":"/docs/api-reference/v3/reference/automations/automation"},{"title":"AutomationCatalogEntry","href":"/docs/api-reference/v3/reference/automations/automation-catalog-entry"},{"title":"AutomationCatalogListing","href":"/docs/api-reference/v3/reference/automations/automation-catalog-listing"},{"title":"AutomationPublishImpact","href":"/docs/api-reference/v3/reference/automations/automation-publish-impact"},{"title":"AutomationRisk","href":"/docs/api-reference/v3/reference/automations/automation-risk"},{"title":"AutomationRun","href":"/docs/api-reference/v3/reference/automations/automation-run"},{"title":"AutomationRunFailure","href":"/docs/api-reference/v3/reference/automations/automation-run-failure"},{"title":"AutomationStepRecord","href":"/docs/api-reference/v3/reference/automations/automation-step-record"},{"title":"AutomationTestRun","href":"/docs/api-reference/v3/reference/automations/automation-test-run"},{"title":"AutomationVersion","href":"/docs/api-reference/v3/reference/automations/automation-version"},{"title":"AutomationVersionRunCount","href":"/docs/api-reference/v3/reference/automations/automation-version-run-count"},{"title":"Diagnostic","href":"/docs/api-reference/v3/reference/automations/diagnostic"},{"title":"DiagnosticFix","href":"/docs/api-reference/v3/reference/automations/diagnostic-fix"},{"title":"TextEdit","href":"/docs/api-reference/v3/reference/automations/text-edit"},{"title":"Workspace","href":"/docs/api-reference/v3/reference/automations/workspace"}]}]},{"group":"Billing","root":{"title":"Billing","href":"/docs/api-reference/v3/reference/billing/overview"},"pages":[{"group":"Queries","pages":[{"title":"billingBill","href":"/docs/api-reference/v3/reference/billing/queries/billing-bill"},{"title":"billingBills","href":"/docs/api-reference/v3/reference/billing/queries/billing-bills"},{"title":"billingCharges","href":"/docs/api-reference/v3/reference/billing/queries/billing-charges"},{"title":"billingTransactions","href":"/docs/api-reference/v3/reference/billing/queries/billing-transactions"}]},{"group":"Objects","pages":[{"title":"BillingBill","href":"/docs/api-reference/v3/reference/billing/billing-bill"},{"title":"BillingBillCharge","href":"/docs/api-reference/v3/reference/billing/billing-bill-charge"},{"title":"BillingBillDetail","href":"/docs/api-reference/v3/reference/billing/billing-bill-detail"},{"title":"BillingBillLine","href":"/docs/api-reference/v3/reference/billing/billing-bill-line"},{"title":"BillingBillTotals","href":"/docs/api-reference/v3/reference/billing/billing-bill-totals"},{"title":"BillingBillTransaction","href":"/docs/api-reference/v3/reference/billing/billing-bill-transaction"}]}]},{"group":"Catalog","root":{"title":"Catalog","href":"/docs/api-reference/v3/reference/catalog/overview"},"pages":[{"group":"Queries","pages":[{"title":"product","href":"/docs/api-reference/v3/reference/catalog/queries/product"},{"title":"productFamilies","href":"/docs/api-reference/v3/reference/catalog/queries/product-families"},{"title":"productFamily","href":"/docs/api-reference/v3/reference/catalog/queries/product-family"},{"title":"products","href":"/docs/api-reference/v3/reference/catalog/queries/products"}]},{"group":"Mutations","pages":[{"title":"createProductFamily","href":"/docs/api-reference/v3/reference/catalog/mutations/create-product-family"},{"title":"deleteProduct","href":"/docs/api-reference/v3/reference/catalog/mutations/delete-product"},{"title":"deleteProductFamily","href":"/docs/api-reference/v3/reference/catalog/mutations/delete-product-family"},{"title":"syncSalesChannelVariants","href":"/docs/api-reference/v3/reference/catalog/mutations/sync-sales-channel-variants"}]},{"group":"Objects","pages":[{"title":"Attribute","href":"/docs/api-reference/v3/reference/catalog/attribute"},{"title":"Dimensions","href":"/docs/api-reference/v3/reference/catalog/dimensions"},{"title":"Product","href":"/docs/api-reference/v3/reference/catalog/product"},{"title":"ProductFamily","href":"/docs/api-reference/v3/reference/catalog/product-family"},{"title":"ProductFamilyImage","href":"/docs/api-reference/v3/reference/catalog/product-family-image"},{"title":"ProductFamilyOption","href":"/docs/api-reference/v3/reference/catalog/product-family-option"},{"title":"ProductImage","href":"/docs/api-reference/v3/reference/catalog/product-image"},{"title":"ProductOptionValue","href":"/docs/api-reference/v3/reference/catalog/product-option-value"},{"title":"SyncedVariant","href":"/docs/api-reference/v3/reference/catalog/synced-variant"},{"title":"Weight","href":"/docs/api-reference/v3/reference/catalog/weight"}]}]},{"group":"Checkout","root":{"title":"Checkout","href":"/docs/api-reference/v3/reference/checkout/overview"},"pages":[{"group":"Queries","pages":[{"title":"checkoutExperience","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-experience"},{"title":"checkoutExperiences","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-experiences"}]},{"group":"Mutations","pages":[{"title":"createCheckoutExperience","href":"/docs/api-reference/v3/reference/checkout/mutations/create-checkout-experience"},{"title":"createShippingMethod","href":"/docs/api-reference/v3/reference/checkout/mutations/create-shipping-method"},{"title":"deleteCheckoutExperience","href":"/docs/api-reference/v3/reference/checkout/mutations/delete-checkout-experience"},{"title":"deleteShippingMethod","href":"/docs/api-reference/v3/reference/checkout/mutations/delete-shipping-method"},{"title":"duplicateCheckoutExperience","href":"/docs/api-reference/v3/reference/checkout/mutations/duplicate-checkout-experience"},{"title":"setAutoSelectedShippingMethods","href":"/docs/api-reference/v3/reference/checkout/mutations/set-auto-selected-shipping-methods"},{"title":"updateCheckoutExperience","href":"/docs/api-reference/v3/reference/checkout/mutations/update-checkout-experience"},{"title":"updateShippingMethod","href":"/docs/api-reference/v3/reference/checkout/mutations/update-shipping-method"}]},{"group":"Objects","pages":[{"title":"CheckoutExperience","href":"/docs/api-reference/v3/reference/checkout/checkout-experience"},{"title":"CheckoutExperienceSummary","href":"/docs/api-reference/v3/reference/checkout/checkout-experience-summary"},{"title":"ShippingMethod","href":"/docs/api-reference/v3/reference/checkout/shipping-method"},{"title":"ShippingMethodCarrierService","href":"/docs/api-reference/v3/reference/checkout/shipping-method-carrier-service"},{"title":"ShippingMethodCarrierServiceMarkup","href":"/docs/api-reference/v3/reference/checkout/shipping-method-carrier-service-markup"},{"title":"ShippingMethodCondition","href":"/docs/api-reference/v3/reference/checkout/shipping-method-condition"},{"title":"ShippingMethodCoverageTypes","href":"/docs/api-reference/v3/reference/checkout/shipping-method-coverage-types"},{"title":"ShippingMethodDiscountRule","href":"/docs/api-reference/v3/reference/checkout/shipping-method-discount-rule"},{"title":"ShippingMethodMarkup","href":"/docs/api-reference/v3/reference/checkout/shipping-method-markup"},{"title":"ShippingMethodMarkupAmount","href":"/docs/api-reference/v3/reference/checkout/shipping-method-markup-amount"},{"title":"ShippingMethodPriceBounds","href":"/docs/api-reference/v3/reference/checkout/shipping-method-price-bounds"},{"title":"ShippingMethodPriceConstraints","href":"/docs/api-reference/v3/reference/checkout/shipping-method-price-constraints"},{"title":"ShippingMethodPriceInequality","href":"/docs/api-reference/v3/reference/checkout/shipping-method-price-inequality"},{"title":"ShippingMethodRate","href":"/docs/api-reference/v3/reference/checkout/shipping-method-rate"},{"title":"ShippingMethodSummary","href":"/docs/api-reference/v3/reference/checkout/shipping-method-summary"}]}]},{"group":"Commerce Agent","root":{"title":"Commerce Agent","href":"/docs/api-reference/v3/reference/commerce-agent/overview"},"pages":[{"group":"Queries","pages":[{"title":"calendarEvent","href":"/docs/api-reference/v3/reference/commerce-agent/queries/calendar-event"},{"title":"calendarEventCatalog","href":"/docs/api-reference/v3/reference/commerce-agent/queries/calendar-event-catalog"},{"title":"calendarEvents","href":"/docs/api-reference/v3/reference/commerce-agent/queries/calendar-events"},{"title":"knowledgeArticle","href":"/docs/api-reference/v3/reference/commerce-agent/queries/knowledge-article"},{"title":"knowledgeArticles","href":"/docs/api-reference/v3/reference/commerce-agent/queries/knowledge-articles"},{"title":"searchKnowledgeArticles","href":"/docs/api-reference/v3/reference/commerce-agent/queries/search-knowledge-articles"}]},{"group":"Mutations","pages":[{"title":"createCalendarEvent","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/create-calendar-event"},{"title":"createKnowledgeArticle","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/create-knowledge-article"},{"title":"deleteCalendarEvent","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/delete-calendar-event"},{"title":"deleteKnowledgeArticle","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/delete-knowledge-article"},{"title":"updateCalendarEvent","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/update-calendar-event"},{"title":"updateKnowledgeArticle","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/update-knowledge-article"}]},{"group":"Objects","pages":[{"title":"CalendarDetectedPromotion","href":"/docs/api-reference/v3/reference/commerce-agent/calendar-detected-promotion"},{"title":"CalendarEvent","href":"/docs/api-reference/v3/reference/commerce-agent/calendar-event"},{"title":"CalendarEventAgendaItem","href":"/docs/api-reference/v3/reference/commerce-agent/calendar-event-agenda-item"},{"title":"CalendarEventCatalog","href":"/docs/api-reference/v3/reference/commerce-agent/calendar-event-catalog"},{"title":"CalendarEventCatalogAgendaItemKind","href":"/docs/api-reference/v3/reference/commerce-agent/calendar-event-catalog-agenda-item-kind"},{"title":"CalendarEventCatalogEventType","href":"/docs/api-reference/v3/reference/commerce-agent/calendar-event-catalog-event-type"},{"title":"CalendarPromotionAgendaItem","href":"/docs/api-reference/v3/reference/commerce-agent/calendar-promotion-agenda-item"},{"title":"CalendarUnknownAgendaItem","href":"/docs/api-reference/v3/reference/commerce-agent/calendar-unknown-agenda-item"},{"title":"KnowledgeArticle","href":"/docs/api-reference/v3/reference/commerce-agent/knowledge-article"}]}]},{"group":"Common","root":{"title":"Common","href":"/docs/api-reference/v3/reference/common/overview"},"pages":[{"group":"Queries","pages":[{"title":"node","href":"/docs/api-reference/v3/reference/common/queries/node"}]},{"group":"Objects","pages":[{"title":"MailingAddress","href":"/docs/api-reference/v3/reference/common/mailing-address"},{"title":"Money","href":"/docs/api-reference/v3/reference/common/money"},{"title":"Node","href":"/docs/api-reference/v3/reference/common/node"}]}]},{"group":"Consolidations","root":{"title":"Consolidations","href":"/docs/api-reference/v3/reference/consolidations/overview"},"pages":[{"group":"Queries","pages":[{"title":"consolidation","href":"/docs/api-reference/v3/reference/consolidations/queries/consolidation"},{"title":"consolidations","href":"/docs/api-reference/v3/reference/consolidations/queries/consolidations"}]},{"group":"Objects","pages":[{"title":"Consolidation","href":"/docs/api-reference/v3/reference/consolidations/consolidation"},{"title":"ConsolidationCarton","href":"/docs/api-reference/v3/reference/consolidations/consolidation-carton"},{"title":"ConsolidationEndpoint","href":"/docs/api-reference/v3/reference/consolidations/consolidation-endpoint"},{"title":"ConsolidationItem","href":"/docs/api-reference/v3/reference/consolidations/consolidation-item"},{"title":"ConsolidationTracking","href":"/docs/api-reference/v3/reference/consolidations/consolidation-tracking"}]}]},{"group":"Events","root":{"title":"Events","href":"/docs/api-reference/v3/reference/events/overview"},"pages":[{"group":"Mutations","pages":[{"title":"createCustomerEvent","href":"/docs/api-reference/v3/reference/events/mutations/create-customer-event"},{"title":"createCustomerEvents","href":"/docs/api-reference/v3/reference/events/mutations/create-customer-events"}]},{"group":"Objects","pages":[{"title":"CustomerEventAck","href":"/docs/api-reference/v3/reference/events/customer-event-ack"}]}]},{"group":"HSA Payments","root":{"title":"HSA Payments","href":"/docs/api-reference/v3/reference/payments/overview"},"pages":[{"group":"Queries","pages":[{"title":"paymentTransactions","href":"/docs/api-reference/v3/reference/payments/queries/payment-transactions"},{"title":"payoutBreakdown","href":"/docs/api-reference/v3/reference/payments/queries/payout-breakdown"},{"title":"payoutReport","href":"/docs/api-reference/v3/reference/payments/queries/payout-report"},{"title":"payouts","href":"/docs/api-reference/v3/reference/payments/queries/payouts"}]},{"group":"Objects","pages":[{"title":"PaymentMethod","href":"/docs/api-reference/v3/reference/payments/payment-method"},{"title":"PaymentTransaction","href":"/docs/api-reference/v3/reference/payments/payment-transaction"},{"title":"PaymentTransactionPayout","href":"/docs/api-reference/v3/reference/payments/payment-transaction-payout"},{"title":"Payout","href":"/docs/api-reference/v3/reference/payments/payout"},{"title":"PayoutBreakdown","href":"/docs/api-reference/v3/reference/payments/payout-breakdown"},{"title":"PayoutLine","href":"/docs/api-reference/v3/reference/payments/payout-line"},{"title":"PayoutReport","href":"/docs/api-reference/v3/reference/payments/payout-report"}]}]},{"group":"Inventory","root":{"title":"Inventory","href":"/docs/api-reference/v3/reference/inventory/overview"},"pages":[{"group":"Queries","pages":[{"title":"binInventoryLevel","href":"/docs/api-reference/v3/reference/inventory/queries/bin-inventory-level"},{"title":"binInventoryLevels","href":"/docs/api-reference/v3/reference/inventory/queries/bin-inventory-levels"},{"title":"inventoryItem","href":"/docs/api-reference/v3/reference/inventory/queries/inventory-item"},{"title":"inventoryItems","href":"/docs/api-reference/v3/reference/inventory/queries/inventory-items"},{"title":"inventoryLevel","href":"/docs/api-reference/v3/reference/inventory/queries/inventory-level"},{"title":"inventoryLevelLedgerEntries","href":"/docs/api-reference/v3/reference/inventory/queries/inventory-level-ledger-entries"},{"title":"inventoryLevelLedgerEntry","href":"/docs/api-reference/v3/reference/inventory/queries/inventory-level-ledger-entry"},{"title":"location","href":"/docs/api-reference/v3/reference/inventory/queries/location"},{"title":"locations","href":"/docs/api-reference/v3/reference/inventory/queries/locations"},{"title":"searchReplenishmentReports","href":"/docs/api-reference/v3/reference/inventory/queries/search-replenishment-reports"},{"title":"storageLocation","href":"/docs/api-reference/v3/reference/inventory/queries/storage-location"},{"title":"storageLocations","href":"/docs/api-reference/v3/reference/inventory/queries/storage-locations"}]},{"group":"Objects","pages":[{"title":"BinInventoryLevel","href":"/docs/api-reference/v3/reference/inventory/bin-inventory-level"},{"title":"InventoryItem","href":"/docs/api-reference/v3/reference/inventory/inventory-item"},{"title":"InventoryLevelLedgerEntry","href":"/docs/api-reference/v3/reference/inventory/inventory-level-ledger-entry"},{"title":"InventoryProduct","href":"/docs/api-reference/v3/reference/inventory/inventory-product"},{"title":"Location","href":"/docs/api-reference/v3/reference/inventory/location"},{"title":"LocationInventoryLevel","href":"/docs/api-reference/v3/reference/inventory/location-inventory-level"},{"title":"ReplenishmentReport","href":"/docs/api-reference/v3/reference/inventory/replenishment-report"},{"title":"ReplenishmentReportBin","href":"/docs/api-reference/v3/reference/inventory/replenishment-report-bin"},{"title":"StorageLocation","href":"/docs/api-reference/v3/reference/inventory/storage-location"}]}]},{"group":"Marketing","root":{"title":"Marketing","href":"/docs/api-reference/v3/reference/marketing/overview"},"pages":[{"group":"Queries","pages":[{"title":"campaign","href":"/docs/api-reference/v3/reference/marketing/queries/campaign"},{"title":"campaigns","href":"/docs/api-reference/v3/reference/marketing/queries/campaigns"},{"title":"commerceAgentStrategies","href":"/docs/api-reference/v3/reference/marketing/queries/commerce-agent-strategies"},{"title":"commerceAgentStrategy","href":"/docs/api-reference/v3/reference/marketing/queries/commerce-agent-strategy"},{"title":"customerTag","href":"/docs/api-reference/v3/reference/marketing/queries/customer-tag"},{"title":"customerTags","href":"/docs/api-reference/v3/reference/marketing/queries/customer-tags"},{"title":"discountCode","href":"/docs/api-reference/v3/reference/marketing/queries/discount-code"},{"title":"discountCodes","href":"/docs/api-reference/v3/reference/marketing/queries/discount-codes"},{"title":"emailAddresses","href":"/docs/api-reference/v3/reference/marketing/queries/email-addresses"},{"title":"emailTemplate","href":"/docs/api-reference/v3/reference/marketing/queries/email-template"},{"title":"emailTemplates","href":"/docs/api-reference/v3/reference/marketing/queries/email-templates"},{"title":"emailTemplateVariableCatalog","href":"/docs/api-reference/v3/reference/marketing/queries/email-template-variable-catalog"},{"title":"marketingAutomation","href":"/docs/api-reference/v3/reference/marketing/queries/marketing-automation"},{"title":"marketingAutomationCatalog","href":"/docs/api-reference/v3/reference/marketing/queries/marketing-automation-catalog"},{"title":"marketingAutomations","href":"/docs/api-reference/v3/reference/marketing/queries/marketing-automations"},{"title":"productFilter","href":"/docs/api-reference/v3/reference/marketing/queries/product-filter"},{"title":"productFilterCollection","href":"/docs/api-reference/v3/reference/marketing/queries/product-filter-collection"},{"title":"productFilterCollections","href":"/docs/api-reference/v3/reference/marketing/queries/product-filter-collections"},{"title":"productFilterMetafields","href":"/docs/api-reference/v3/reference/marketing/queries/product-filter-metafields"},{"title":"productFilters","href":"/docs/api-reference/v3/reference/marketing/queries/product-filters"},{"title":"segment","href":"/docs/api-reference/v3/reference/marketing/queries/segment"},{"title":"segmentConditionCatalog","href":"/docs/api-reference/v3/reference/marketing/queries/segment-condition-catalog"},{"title":"segments","href":"/docs/api-reference/v3/reference/marketing/queries/segments"},{"title":"segmentTokenFieldOptions","href":"/docs/api-reference/v3/reference/marketing/queries/segment-token-field-options"},{"title":"smsTemplate","href":"/docs/api-reference/v3/reference/marketing/queries/sms-template"},{"title":"smsTemplates","href":"/docs/api-reference/v3/reference/marketing/queries/sms-templates"}]},{"group":"Mutations","pages":[{"title":"cancelCampaign","href":"/docs/api-reference/v3/reference/marketing/mutations/cancel-campaign"},{"title":"createCampaign","href":"/docs/api-reference/v3/reference/marketing/mutations/create-campaign"},{"title":"createCommerceAgentStrategy","href":"/docs/api-reference/v3/reference/marketing/mutations/create-commerce-agent-strategy"},{"title":"createCustomerTag","href":"/docs/api-reference/v3/reference/marketing/mutations/create-customer-tag"},{"title":"createDiscountCode","href":"/docs/api-reference/v3/reference/marketing/mutations/create-discount-code"},{"title":"createDynamicSegment","href":"/docs/api-reference/v3/reference/marketing/mutations/create-dynamic-segment"},{"title":"createEmailTemplate","href":"/docs/api-reference/v3/reference/marketing/mutations/create-email-template"},{"title":"createMarketingAutomation","href":"/docs/api-reference/v3/reference/marketing/mutations/create-marketing-automation"},{"title":"createMarketingImageUpload","href":"/docs/api-reference/v3/reference/marketing/mutations/create-marketing-image-upload"},{"title":"createProductFilter","href":"/docs/api-reference/v3/reference/marketing/mutations/create-product-filter"},{"title":"createSmsTemplate","href":"/docs/api-reference/v3/reference/marketing/mutations/create-sms-template"},{"title":"deleteCampaign","href":"/docs/api-reference/v3/reference/marketing/mutations/delete-campaign"},{"title":"deleteDiscountCode","href":"/docs/api-reference/v3/reference/marketing/mutations/delete-discount-code"},{"title":"deleteEmailTemplate","href":"/docs/api-reference/v3/reference/marketing/mutations/delete-email-template"},{"title":"deleteMarketingAutomation","href":"/docs/api-reference/v3/reference/marketing/mutations/delete-marketing-automation"},{"title":"deleteProductFilter","href":"/docs/api-reference/v3/reference/marketing/mutations/delete-product-filter"},{"title":"deleteSegment","href":"/docs/api-reference/v3/reference/marketing/mutations/delete-segment"},{"title":"deleteSmsTemplate","href":"/docs/api-reference/v3/reference/marketing/mutations/delete-sms-template"},{"title":"updateCampaign","href":"/docs/api-reference/v3/reference/marketing/mutations/update-campaign"},{"title":"updateCommerceAgentStrategy","href":"/docs/api-reference/v3/reference/marketing/mutations/update-commerce-agent-strategy"},{"title":"updateCustomerTag","href":"/docs/api-reference/v3/reference/marketing/mutations/update-customer-tag"},{"title":"updateDiscountCode","href":"/docs/api-reference/v3/reference/marketing/mutations/update-discount-code"},{"title":"updateDynamicSegment","href":"/docs/api-reference/v3/reference/marketing/mutations/update-dynamic-segment"},{"title":"updateEmailTemplate","href":"/docs/api-reference/v3/reference/marketing/mutations/update-email-template"},{"title":"updateMarketingAutomation","href":"/docs/api-reference/v3/reference/marketing/mutations/update-marketing-automation"},{"title":"updateProductFilter","href":"/docs/api-reference/v3/reference/marketing/mutations/update-product-filter"},{"title":"updateSmsTemplate","href":"/docs/api-reference/v3/reference/marketing/mutations/update-sms-template"},{"title":"uploadMarketingImage","href":"/docs/api-reference/v3/reference/marketing/mutations/upload-marketing-image"}]},{"group":"Objects","pages":[{"title":"AddedToCartProductFilter","href":"/docs/api-reference/v3/reference/marketing/added-to-cart-product-filter"},{"title":"AmountOffDiscountSettings","href":"/docs/api-reference/v3/reference/marketing/amount-off-discount-settings"},{"title":"BestSellersProductFilter","href":"/docs/api-reference/v3/reference/marketing/best-sellers-product-filter"},{"title":"BuyXGetYDiscountSettings","href":"/docs/api-reference/v3/reference/marketing/buy-x-get-y-discount-settings"},{"title":"Campaign","href":"/docs/api-reference/v3/reference/marketing/campaign"},{"title":"CampaignAnalytics","href":"/docs/api-reference/v3/reference/marketing/campaign-analytics"},{"title":"CampaignEmailVariant","href":"/docs/api-reference/v3/reference/marketing/campaign-email-variant"},{"title":"CampaignFollowUpConfig","href":"/docs/api-reference/v3/reference/marketing/campaign-follow-up-config"},{"title":"CampaignMessagingAnalytics","href":"/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics"},{"title":"CampaignSmsVariant","href":"/docs/api-reference/v3/reference/marketing/campaign-sms-variant"},{"title":"CollectionProductFilter","href":"/docs/api-reference/v3/reference/marketing/collection-product-filter"},{"title":"CommerceAgentStrategy","href":"/docs/api-reference/v3/reference/marketing/commerce-agent-strategy"},{"title":"CustomerTag","href":"/docs/api-reference/v3/reference/marketing/customer-tag"},{"title":"DiscountBxgyCustomerBuys","href":"/docs/api-reference/v3/reference/marketing/discount-bxgy-customer-buys"},{"title":"DiscountBxgyCustomerGets","href":"/docs/api-reference/v3/reference/marketing/discount-bxgy-customer-gets"},{"title":"DiscountCatalogItem","href":"/docs/api-reference/v3/reference/marketing/discount-catalog-item"},{"title":"DiscountCode","href":"/docs/api-reference/v3/reference/marketing/discount-code"},{"title":"DiscountCodeExpiration","href":"/docs/api-reference/v3/reference/marketing/discount-code-expiration"},{"title":"DiscountCombinesWith","href":"/docs/api-reference/v3/reference/marketing/discount-combines-with"},{"title":"DiscountMinRequirement","href":"/docs/api-reference/v3/reference/marketing/discount-min-requirement"},{"title":"DynamicRangeDiscountSettings","href":"/docs/api-reference/v3/reference/marketing/dynamic-range-discount-settings"},{"title":"DynamicRangeRelativeExpiration","href":"/docs/api-reference/v3/reference/marketing/dynamic-range-relative-expiration"},{"title":"EmailAddress","href":"/docs/api-reference/v3/reference/marketing/email-address"},{"title":"EmailSender","href":"/docs/api-reference/v3/reference/marketing/email-sender"},{"title":"EmailTemplate","href":"/docs/api-reference/v3/reference/marketing/email-template"},{"title":"EmailTemplateBrandKitButtonBorder","href":"/docs/api-reference/v3/reference/marketing/email-template-brand-kit-button-border"},{"title":"EmailTemplateBrandKitButtonOverride","href":"/docs/api-reference/v3/reference/marketing/email-template-brand-kit-button-override"},{"title":"EmailTemplateBrandKitEmailButton","href":"/docs/api-reference/v3/reference/marketing/email-template-brand-kit-email-button"},{"title":"EmailTemplateBrandKitFont","href":"/docs/api-reference/v3/reference/marketing/email-template-brand-kit-font"},{"title":"EmailTemplateBrandKitStroke","href":"/docs/api-reference/v3/reference/marketing/email-template-brand-kit-stroke"},{"title":"EmailTemplateButtonSection","href":"/docs/api-reference/v3/reference/marketing/email-template-button-section"},{"title":"EmailTemplateChromeDinoSection","href":"/docs/api-reference/v3/reference/marketing/email-template-chrome-dino-section"},{"title":"EmailTemplateColumnSection","href":"/docs/api-reference/v3/reference/marketing/email-template-column-section"},{"title":"EmailTemplateColumnSlot","href":"/docs/api-reference/v3/reference/marketing/email-template-column-slot"},{"title":"EmailTemplateContextObject","href":"/docs/api-reference/v3/reference/marketing/email-template-context-object"},{"title":"EmailTemplateDelayOption","href":"/docs/api-reference/v3/reference/marketing/email-template-delay-option"},{"title":"EmailTemplateDiscountSection","href":"/docs/api-reference/v3/reference/marketing/email-template-discount-section"},{"title":"EmailTemplateFooterSection","href":"/docs/api-reference/v3/reference/marketing/email-template-footer-section"},{"title":"EmailTemplateHeaderSection","href":"/docs/api-reference/v3/reference/marketing/email-template-header-section"},{"title":"EmailTemplateHtmlSection","href":"/docs/api-reference/v3/reference/marketing/email-template-html-section"},{"title":"EmailTemplateImageSection","href":"/docs/api-reference/v3/reference/marketing/email-template-image-section"},{"title":"EmailTemplateInlineButton","href":"/docs/api-reference/v3/reference/marketing/email-template-inline-button"},{"title":"EmailTemplateLineSection","href":"/docs/api-reference/v3/reference/marketing/email-template-line-section"},{"title":"EmailTemplateManualProduct","href":"/docs/api-reference/v3/reference/marketing/email-template-manual-product"},{"title":"EmailTemplateMenuItem","href":"/docs/api-reference/v3/reference/marketing/email-template-menu-item"},{"title":"EmailTemplateMenuSection","href":"/docs/api-reference/v3/reference/marketing/email-template-menu-section"},{"title":"EmailTemplatePadding","href":"/docs/api-reference/v3/reference/marketing/email-template-padding"},{"title":"EmailTemplatePreview","href":"/docs/api-reference/v3/reference/marketing/email-template-preview"},{"title":"EmailTemplateProductCardContent","href":"/docs/api-reference/v3/reference/marketing/email-template-product-card-content"},{"title":"EmailTemplateProductsSection","href":"/docs/api-reference/v3/reference/marketing/email-template-products-section"},{"title":"EmailTemplateQrCodeSection","href":"/docs/api-reference/v3/reference/marketing/email-template-qr-code-section"},{"title":"EmailTemplateScratchToRevealSection","href":"/docs/api-reference/v3/reference/marketing/email-template-scratch-to-reveal-section"},{"title":"EmailTemplateShoppableProductsSection","href":"/docs/api-reference/v3/reference/marketing/email-template-shoppable-products-section"},{"title":"EmailTemplateSocialLink","href":"/docs/api-reference/v3/reference/marketing/email-template-social-link"},{"title":"EmailTemplateSocialsSection","href":"/docs/api-reference/v3/reference/marketing/email-template-socials-section"},{"title":"EmailTemplateSpacerSection","href":"/docs/api-reference/v3/reference/marketing/email-template-spacer-section"},{"title":"EmailTemplateSubscriptionAddToOrderSection","href":"/docs/api-reference/v3/reference/marketing/email-template-subscription-add-to-order-section"},{"title":"EmailTemplateSubscriptionChargeDate","href":"/docs/api-reference/v3/reference/marketing/email-template-subscription-charge-date"},{"title":"EmailTemplateSubscriptionSkipInitialPage","href":"/docs/api-reference/v3/reference/marketing/email-template-subscription-skip-initial-page"},{"title":"EmailTemplateSubscriptionSkipOption","href":"/docs/api-reference/v3/reference/marketing/email-template-subscription-skip-option"},{"title":"EmailTemplateSubscriptionSkipOrDelaySection","href":"/docs/api-reference/v3/reference/marketing/email-template-subscription-skip-or-delay-section"},{"title":"EmailTemplateSubscriptionSwapProductSection","href":"/docs/api-reference/v3/reference/marketing/email-template-subscription-swap-product-section"},{"title":"EmailTemplateTableCellBinding","href":"/docs/api-reference/v3/reference/marketing/email-template-table-cell-binding"},{"title":"EmailTemplateTableCollection","href":"/docs/api-reference/v3/reference/marketing/email-template-table-collection"},{"title":"EmailTemplateTableColumn","href":"/docs/api-reference/v3/reference/marketing/email-template-table-column"},{"title":"EmailTemplateTableImageCell","href":"/docs/api-reference/v3/reference/marketing/email-template-table-image-cell"},{"title":"EmailTemplateTableRow","href":"/docs/api-reference/v3/reference/marketing/email-template-table-row"},{"title":"EmailTemplateTableSection","href":"/docs/api-reference/v3/reference/marketing/email-template-table-section"},{"title":"EmailTemplateTableTextCell","href":"/docs/api-reference/v3/reference/marketing/email-template-table-text-cell"},{"title":"EmailTemplateTextSection","href":"/docs/api-reference/v3/reference/marketing/email-template-text-section"},{"title":"EmailTemplateTitleSubtitle","href":"/docs/api-reference/v3/reference/marketing/email-template-title-subtitle"},{"title":"EmailTemplateTrackableSummarySection","href":"/docs/api-reference/v3/reference/marketing/email-template-trackable-summary-section"},{"title":"EmailTemplateTrackingInfoSection","href":"/docs/api-reference/v3/reference/marketing/email-template-tracking-info-section"},{"title":"EmailTemplateUnknownSection","href":"/docs/api-reference/v3/reference/marketing/email-template-unknown-section"},{"title":"EmailTemplateUrlKey","href":"/docs/api-reference/v3/reference/marketing/email-template-url-key"},{"title":"EmailTemplateVariable","href":"/docs/api-reference/v3/reference/marketing/email-template-variable"},{"title":"EmailTemplateVariableCatalog","href":"/docs/api-reference/v3/reference/marketing/email-template-variable-catalog"},{"title":"FreeShippingDiscountSettings","href":"/docs/api-reference/v3/reference/marketing/free-shipping-discount-settings"},{"title":"MarketingAutomation","href":"/docs/api-reference/v3/reference/marketing/marketing-automation"},{"title":"MarketingAutomationAbTestStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-ab-test-step"},{"title":"MarketingAutomationAbTestVariant","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-ab-test-variant"},{"title":"MarketingAutomationAnalytics","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-analytics"},{"title":"MarketingAutomationCatalog","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-catalog"},{"title":"MarketingAutomationCatalogStepKind","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-catalog-step-kind"},{"title":"MarketingAutomationCatalogTrigger","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-catalog-trigger"},{"title":"MarketingAutomationCommerceAgentChannel","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-commerce-agent-channel"},{"title":"MarketingAutomationConditionStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-condition-step"},{"title":"MarketingAutomationEndStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-end-step"},{"title":"MarketingAutomationEntryCondition","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-entry-condition"},{"title":"MarketingAutomationEntryConditions","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-entry-conditions"},{"title":"MarketingAutomationExistingSegmentCondition","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-existing-segment-condition"},{"title":"MarketingAutomationFrequencyCap","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-frequency-cap"},{"title":"MarketingAutomationInlineSegmentCondition","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-inline-segment-condition"},{"title":"MarketingAutomationManageCustomerTagsStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-manage-customer-tags-step"},{"title":"MarketingAutomationManageStaticSegmentStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-manage-static-segment-step"},{"title":"MarketingAutomationMessagingAnalytics","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-messaging-analytics"},{"title":"MarketingAutomationSendEmailStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-send-email-step"},{"title":"MarketingAutomationSendSmsStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-send-sms-step"},{"title":"MarketingAutomationSendWebhookHeader","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-send-webhook-header"},{"title":"MarketingAutomationSendWebhookOAuth2Config","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-send-webhook-o-auth2-config"},{"title":"MarketingAutomationSendWebhookStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-send-webhook-step"},{"title":"MarketingAutomationSkipCondition","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-skip-condition"},{"title":"MarketingAutomationSkipConditions","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-skip-conditions"},{"title":"MarketingAutomationStartAgentConversationStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-start-agent-conversation-step"},{"title":"MarketingAutomationTriggerDataCondition","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-trigger-data-condition"},{"title":"MarketingAutomationTriggerStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-trigger-step"},{"title":"MarketingAutomationUnknownStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-unknown-step"},{"title":"MarketingAutomationUnsupportedCondition","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-unsupported-condition"},{"title":"MarketingAutomationWaitForEventStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-wait-for-event-step"},{"title":"MarketingAutomationWaitStep","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-wait-step"},{"title":"MarketingImageUpload","href":"/docs/api-reference/v3/reference/marketing/marketing-image-upload"},{"title":"MessageAnalytics","href":"/docs/api-reference/v3/reference/marketing/message-analytics"},{"title":"MessageAnalyticsPoint","href":"/docs/api-reference/v3/reference/marketing/message-analytics-point"},{"title":"MessageAnalyticsTotals","href":"/docs/api-reference/v3/reference/marketing/message-analytics-totals"},{"title":"MessageChannelAnalytics","href":"/docs/api-reference/v3/reference/marketing/message-channel-analytics"},{"title":"MetafieldProductFilter","href":"/docs/api-reference/v3/reference/marketing/metafield-product-filter"},{"title":"ProductFilter","href":"/docs/api-reference/v3/reference/marketing/product-filter"},{"title":"ProductFilterCollection","href":"/docs/api-reference/v3/reference/marketing/product-filter-collection"},{"title":"ProductFilterCollectionConstraint","href":"/docs/api-reference/v3/reference/marketing/product-filter-collection-constraint"},{"title":"ProductFilterExcludePurchasedConstraint","href":"/docs/api-reference/v3/reference/marketing/product-filter-exclude-purchased-constraint"},{"title":"ProductFilterInventoryConstraint","href":"/docs/api-reference/v3/reference/marketing/product-filter-inventory-constraint"},{"title":"ProductFilterMetafieldConstraint","href":"/docs/api-reference/v3/reference/marketing/product-filter-metafield-constraint"},{"title":"ProductFilterMetafieldDefinition","href":"/docs/api-reference/v3/reference/marketing/product-filter-metafield-definition"},{"title":"ProductFilterMetafieldRef","href":"/docs/api-reference/v3/reference/marketing/product-filter-metafield-ref"},{"title":"ProductFilterPriceConstraint","href":"/docs/api-reference/v3/reference/marketing/product-filter-price-constraint"},{"title":"ProductFilterTagConstraint","href":"/docs/api-reference/v3/reference/marketing/product-filter-tag-constraint"},{"title":"ProductFilterTimeframe","href":"/docs/api-reference/v3/reference/marketing/product-filter-timeframe"},{"title":"ProviderRecommendationsProductFilter","href":"/docs/api-reference/v3/reference/marketing/provider-recommendations-product-filter"},{"title":"Segment","href":"/docs/api-reference/v3/reference/marketing/segment"},{"title":"SegmentCatalogActivity","href":"/docs/api-reference/v3/reference/marketing/segment-catalog-activity"},{"title":"SegmentCatalogCustomEvent","href":"/docs/api-reference/v3/reference/marketing/segment-catalog-custom-event"},{"title":"SegmentCatalogField","href":"/docs/api-reference/v3/reference/marketing/segment-catalog-field"},{"title":"SegmentConditionCatalog","href":"/docs/api-reference/v3/reference/marketing/segment-condition-catalog"},{"title":"SegmentOperatorSet","href":"/docs/api-reference/v3/reference/marketing/segment-operator-set"},{"title":"SegmentTokenFieldOptions","href":"/docs/api-reference/v3/reference/marketing/segment-token-field-options"},{"title":"SegmentTokenOption","href":"/docs/api-reference/v3/reference/marketing/segment-token-option"},{"title":"SmsTemplate","href":"/docs/api-reference/v3/reference/marketing/sms-template"},{"title":"SmsTemplateImage","href":"/docs/api-reference/v3/reference/marketing/sms-template-image"},{"title":"TagProductFilter","href":"/docs/api-reference/v3/reference/marketing/tag-product-filter"},{"title":"UploadedMarketingImage","href":"/docs/api-reference/v3/reference/marketing/uploaded-marketing-image"},{"title":"ViewedProductsProductFilter","href":"/docs/api-reference/v3/reference/marketing/viewed-products-product-filter"}]}]},{"group":"Markets","root":{"title":"Markets","href":"/docs/api-reference/v3/reference/markets/overview"},"pages":[{"group":"Queries","pages":[{"title":"market","href":"/docs/api-reference/v3/reference/markets/queries/market"},{"title":"markets","href":"/docs/api-reference/v3/reference/markets/queries/markets"}]},{"group":"Mutations","pages":[{"title":"upsertMarket","href":"/docs/api-reference/v3/reference/markets/mutations/upsert-market"}]},{"group":"Objects","pages":[{"title":"Market","href":"/docs/api-reference/v3/reference/markets/market"},{"title":"MarketBreakdownLabels","href":"/docs/api-reference/v3/reference/markets/market-breakdown-labels"},{"title":"MarketCountry","href":"/docs/api-reference/v3/reference/markets/market-country"}]}]},{"group":"Orders","root":{"title":"Orders","href":"/docs/api-reference/v3/reference/orders/overview"},"pages":[{"group":"Queries","pages":[{"title":"order","href":"/docs/api-reference/v3/reference/orders/queries/order"},{"title":"orders","href":"/docs/api-reference/v3/reference/orders/queries/orders"},{"title":"tracker","href":"/docs/api-reference/v3/reference/orders/queries/tracker"},{"title":"trackers","href":"/docs/api-reference/v3/reference/orders/queries/trackers"}]},{"group":"Objects","pages":[{"title":"Order","href":"/docs/api-reference/v3/reference/orders/order"},{"title":"OrderCustomer","href":"/docs/api-reference/v3/reference/orders/order-customer"},{"title":"OrderFulfillment","href":"/docs/api-reference/v3/reference/orders/order-fulfillment"},{"title":"OrderFulfillmentLineItem","href":"/docs/api-reference/v3/reference/orders/order-fulfillment-line-item"},{"title":"OrderLineItem","href":"/docs/api-reference/v3/reference/orders/order-line-item"},{"title":"OrderProtection","href":"/docs/api-reference/v3/reference/orders/order-protection"},{"title":"OrderShipping","href":"/docs/api-reference/v3/reference/orders/order-shipping"},{"title":"OrderTrackingEvent","href":"/docs/api-reference/v3/reference/orders/order-tracking-event"},{"title":"OrderTrackingEventLocation","href":"/docs/api-reference/v3/reference/orders/order-tracking-event-location"},{"title":"Tracker","href":"/docs/api-reference/v3/reference/orders/tracker"},{"title":"TrackerOrder","href":"/docs/api-reference/v3/reference/orders/tracker-order"},{"title":"TrackerScan","href":"/docs/api-reference/v3/reference/orders/tracker-scan"}]}]},{"group":"Procurement","root":{"title":"Procurement","href":"/docs/api-reference/v3/reference/procurement/overview"},"pages":[{"group":"Queries","pages":[{"title":"inboundShipment","href":"/docs/api-reference/v3/reference/procurement/queries/inbound-shipment"},{"title":"inboundShipments","href":"/docs/api-reference/v3/reference/procurement/queries/inbound-shipments"},{"title":"purchaseOrder","href":"/docs/api-reference/v3/reference/procurement/queries/purchase-order"},{"title":"purchaseOrders","href":"/docs/api-reference/v3/reference/procurement/queries/purchase-orders"},{"title":"supplier","href":"/docs/api-reference/v3/reference/procurement/queries/supplier"},{"title":"suppliers","href":"/docs/api-reference/v3/reference/procurement/queries/suppliers"}]},{"group":"Mutations","pages":[{"title":"cancelPurchaseOrder","href":"/docs/api-reference/v3/reference/procurement/mutations/cancel-purchase-order"},{"title":"createInboundShipment","href":"/docs/api-reference/v3/reference/procurement/mutations/create-inbound-shipment"},{"title":"createPurchaseOrder","href":"/docs/api-reference/v3/reference/procurement/mutations/create-purchase-order"},{"title":"updateInboundShipment","href":"/docs/api-reference/v3/reference/procurement/mutations/update-inbound-shipment"},{"title":"updateInboundShipmentItems","href":"/docs/api-reference/v3/reference/procurement/mutations/update-inbound-shipment-items"},{"title":"updatePurchaseOrder","href":"/docs/api-reference/v3/reference/procurement/mutations/update-purchase-order"}]},{"group":"Objects","pages":[{"title":"InboundShipment","href":"/docs/api-reference/v3/reference/procurement/inbound-shipment"},{"title":"InboundShipmentItem","href":"/docs/api-reference/v3/reference/procurement/inbound-shipment-item"},{"title":"PurchaseOrder","href":"/docs/api-reference/v3/reference/procurement/purchase-order"},{"title":"PurchaseOrderItem","href":"/docs/api-reference/v3/reference/procurement/purchase-order-item"},{"title":"Supplier","href":"/docs/api-reference/v3/reference/procurement/supplier"},{"title":"SupplierContact","href":"/docs/api-reference/v3/reference/procurement/supplier-contact"}]}]},{"group":"Returns","root":{"title":"Returns","href":"/docs/api-reference/v3/reference/returns/overview"},"pages":[{"group":"Queries","pages":[{"title":"return","href":"/docs/api-reference/v3/reference/returns/queries/return"},{"title":"returnActionRun","href":"/docs/api-reference/v3/reference/returns/queries/return-action-run"},{"title":"returns","href":"/docs/api-reference/v3/reference/returns/queries/returns"}]},{"group":"Mutations","pages":[{"title":"approveReturns","href":"/docs/api-reference/v3/reference/returns/mutations/approve-returns"},{"title":"closeReturns","href":"/docs/api-reference/v3/reference/returns/mutations/close-returns"},{"title":"flagReturns","href":"/docs/api-reference/v3/reference/returns/mutations/flag-returns"},{"title":"processReturns","href":"/docs/api-reference/v3/reference/returns/mutations/process-returns"},{"title":"rejectReturns","href":"/docs/api-reference/v3/reference/returns/mutations/reject-returns"},{"title":"resetReturns","href":"/docs/api-reference/v3/reference/returns/mutations/reset-returns"},{"title":"tagReturn","href":"/docs/api-reference/v3/reference/returns/mutations/tag-return"},{"title":"tagReturns","href":"/docs/api-reference/v3/reference/returns/mutations/tag-returns"},{"title":"unflagReturns","href":"/docs/api-reference/v3/reference/returns/mutations/unflag-returns"}]},{"group":"Objects","pages":[{"title":"ExchangeItem","href":"/docs/api-reference/v3/reference/returns/exchange-item"},{"title":"ExchangeItemPrice","href":"/docs/api-reference/v3/reference/returns/exchange-item-price"},{"title":"ExchangeOrder","href":"/docs/api-reference/v3/reference/returns/exchange-order"},{"title":"ExternalRef","href":"/docs/api-reference/v3/reference/returns/external-ref"},{"title":"ExternalReturnId","href":"/docs/api-reference/v3/reference/returns/external-return-id"},{"title":"ItemRefund","href":"/docs/api-reference/v3/reference/returns/item-refund"},{"title":"MultipleChoiceQuestion","href":"/docs/api-reference/v3/reference/returns/multiple-choice-question"},{"title":"PersonName","href":"/docs/api-reference/v3/reference/returns/person-name"},{"title":"ReasonConversation","href":"/docs/api-reference/v3/reference/returns/reason-conversation"},{"title":"ReasonConversationMessage","href":"/docs/api-reference/v3/reference/returns/reason-conversation-message"},{"title":"Return","href":"/docs/api-reference/v3/reference/returns/return"},{"title":"ReturnActionRun","href":"/docs/api-reference/v3/reference/returns/return-action-run"},{"title":"ReturnActionRunCounts","href":"/docs/api-reference/v3/reference/returns/return-action-run-counts"},{"title":"ReturnDropoff","href":"/docs/api-reference/v3/reference/returns/return-dropoff"},{"title":"ReturnExchange","href":"/docs/api-reference/v3/reference/returns/return-exchange"},{"title":"ReturnGiftCard","href":"/docs/api-reference/v3/reference/returns/return-gift-card"},{"title":"ReturnIntegration","href":"/docs/api-reference/v3/reference/returns/return-integration"},{"title":"ReturnItem","href":"/docs/api-reference/v3/reference/returns/return-item"},{"title":"ReturnItemExchangeItem","href":"/docs/api-reference/v3/reference/returns/return-item-exchange-item"},{"title":"ReturnNote","href":"/docs/api-reference/v3/reference/returns/return-note"},{"title":"ReturnProtection","href":"/docs/api-reference/v3/reference/returns/return-protection"},{"title":"ReturnRefund","href":"/docs/api-reference/v3/reference/returns/return-refund"},{"title":"ReturnShipment","href":"/docs/api-reference/v3/reference/returns/return-shipment"},{"title":"ReturnShipmentGroup","href":"/docs/api-reference/v3/reference/returns/return-shipment-group"},{"title":"ReturnSource","href":"/docs/api-reference/v3/reference/returns/return-source"},{"title":"ReturnTotals","href":"/docs/api-reference/v3/reference/returns/return-totals"}]}]},{"group":"Shipping","root":{"title":"Shipping","href":"/docs/api-reference/v3/reference/shipping/overview"},"pages":[{"group":"Queries","pages":[{"title":"carrierShipmentTracker","href":"/docs/api-reference/v3/reference/shipping/queries/carrier-shipment-tracker"},{"title":"carrierShipmentTrackers","href":"/docs/api-reference/v3/reference/shipping/queries/carrier-shipment-trackers"},{"title":"pickSession","href":"/docs/api-reference/v3/reference/shipping/queries/pick-session"},{"title":"pickSessions","href":"/docs/api-reference/v3/reference/shipping/queries/pick-sessions"},{"title":"warehouseTeamMemberProductivity","href":"/docs/api-reference/v3/reference/shipping/queries/warehouse-team-member-productivity"}]},{"group":"Mutations","pages":[{"title":"getShippingLabelQuotes","href":"/docs/api-reference/v3/reference/shipping/mutations/get-shipping-label-quotes"},{"title":"purchaseCarrierShipment","href":"/docs/api-reference/v3/reference/shipping/mutations/purchase-carrier-shipment"},{"title":"voidCarrierShipment","href":"/docs/api-reference/v3/reference/shipping/mutations/void-carrier-shipment"}]},{"group":"Objects","pages":[{"title":"CarrierShipment","href":"/docs/api-reference/v3/reference/shipping/carrier-shipment"},{"title":"CarrierShipmentTracker","href":"/docs/api-reference/v3/reference/shipping/carrier-shipment-tracker"},{"title":"CarrierShipmentTrackerScan","href":"/docs/api-reference/v3/reference/shipping/carrier-shipment-tracker-scan"},{"title":"OutboundRateMessage","href":"/docs/api-reference/v3/reference/shipping/outbound-rate-message"},{"title":"OutboundRateQuote","href":"/docs/api-reference/v3/reference/shipping/outbound-rate-quote"},{"title":"OutboundShipmentPackage","href":"/docs/api-reference/v3/reference/shipping/outbound-shipment-package"},{"title":"PickSession","href":"/docs/api-reference/v3/reference/shipping/pick-session"},{"title":"PickSessionItem","href":"/docs/api-reference/v3/reference/shipping/pick-session-item"},{"title":"WarehouseTeamMember","href":"/docs/api-reference/v3/reference/shipping/warehouse-team-member"},{"title":"WarehouseTeamMemberProductivity","href":"/docs/api-reference/v3/reference/shipping/warehouse-team-member-productivity"}]}]},{"group":"Webhooks","root":{"title":"Webhooks","href":"/docs/api-reference/v3/reference/webhooks/overview"},"pages":[{"group":"Queries","pages":[{"title":"webhookEndpoint","href":"/docs/api-reference/v3/reference/webhooks/queries/webhook-endpoint"},{"title":"webhookEndpoints","href":"/docs/api-reference/v3/reference/webhooks/queries/webhook-endpoints"}]},{"group":"Mutations","pages":[{"title":"activateWebhookEndpointSecret","href":"/docs/api-reference/v3/reference/webhooks/mutations/activate-webhook-endpoint-secret"},{"title":"createWebhookEndpoint","href":"/docs/api-reference/v3/reference/webhooks/mutations/create-webhook-endpoint"},{"title":"deleteWebhookEndpoint","href":"/docs/api-reference/v3/reference/webhooks/mutations/delete-webhook-endpoint"},{"title":"rotateWebhookEndpointSecret","href":"/docs/api-reference/v3/reference/webhooks/mutations/rotate-webhook-endpoint-secret"},{"title":"updateWebhookEndpoint","href":"/docs/api-reference/v3/reference/webhooks/mutations/update-webhook-endpoint"}]},{"group":"Objects","pages":[{"title":"WebhookEndpoint","href":"/docs/api-reference/v3/reference/webhooks/webhook-endpoint"}]}]},{"title":"Access scopes","href":"/docs/api-reference/v3/reference/scopes"}]}]}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/docs/mcp-server/introduction"}]}]},"title":"workspace - Redo","buildId":"dpl_9DauxEjb9gzCtcuhPQFbquJvx7FJ","deploymentId":"dpl_9DauxEjb9gzCtcuhPQFbquJvx7FJ","dynamics":[],"chunks":[]}
