uniqueClicks / delivered. Null when nothing was delivered.
Float
uniqueClicks / uniqueOpens. Null when nothing was opened, so null on SMS.
Float
orders / delivered. Null when nothing was delivered.
Int!
required
Messages the provider confirmed were delivered.
Float
delivered / sends. Null when nothing was sent.
Int!
required
Messages the delivery provider refused or gave up on, so they never reached a delivery attempt. Distinct from a bounce, which is a delivery that came back — these never left. Together with delivered they account for what sends became.
Int!
required
Attributed orders from customers with no earlier order over $0 that Redo has for the store, including $0 first orders and orders with no known customer. Complements returningCustomerOrders; the two sum to orders. Customers whose earlier orders fall outside the history Redo has synced are counted as new.
Attributed revenue from newCustomerOrders. Complements returningCustomerRevenue. The two sum to revenue before each is rounded to currency precision.
Float
uniqueOpens / delivered, over email deliveries only. Null when nothing measurable was delivered — including an SMS-only send, where opens do not exist and a rate of 0 would be misleading. For a continuously-sending automation this can exceed 1, since opens inside the range may belong to sends made before it.
Int!
required
Orders attributed to this send within the attribution window.
Int!
required
Distinct customers sent to.
Int!
required
Attributed orders from customers who already had an earlier order over $0 on this store. Complements newCustomerOrders; the two sum to orders.
revenue / sends — what a message returned, where revenuePerRecipient is what a customer returned. The two agree for a campaign, which sends to each recipient once, and diverge for a continuously-running automation that messages the same customer repeatedly over the range. This is the figure to compare against spend, which is also per message. Carries extra decimal places, since per-send revenue is routinely sub-cent. Null when nothing was sent.
What the store was billed to send these messages: its per-message rate plus any carrier fees. Always USD, unlike revenue, which is in the store’s own currency — Redo prices messaging in dollars. Convert before combining the two. Carries extra decimal places, since one message costs a fraction of a cent.
Int!
required
Messages clicked at least once, counted like uniqueOpens.
Int!
required
Messages opened at least once. A customer who opens two of an automation’s emails counts twice; opening one email again does not count again. Always 0 on SMS, which has no open tracking.
Float
unsubscribes / delivered. Rated against deliveries rather than sends, like the other engagement rates, so it answers what share of messages that arrived cost a subscriber. Null when nothing was delivered.
Int!
required
Customers who opted out of marketing off the back of this send. Only opt-outs Redo could attribute to a specific campaign or automation are counted, so these do not sum to the store’s total unsubscribes over the same period — an opt-out arriving without that attribution belongs to no send and is absent here.
Float
uniqueClicks / delivered. Null when nothing was delivered.
Float
uniqueClicks / uniqueOpens. Null when nothing was opened, so null on SMS.
Float
orders / delivered. Null when nothing was delivered.
The day these analytics cover, in the store’s timezone. Engagement counts are keyed to the day each event happened; orders and revenue to the day the order was placed. A rate combining the two — conversion rate, revenue per recipient, average order value — therefore relates figures from different days, and is most meaningful read over the whole range rather than per day.
Int!
required
Messages the provider confirmed were delivered.
Float
delivered / sends. Null when nothing was sent.
Int!
required
Messages the delivery provider refused or gave up on, so they never reached a delivery attempt. Distinct from a bounce, which is a delivery that came back — these never left. Together with delivered they account for what sends became.
Int!
required
Attributed orders from customers with no earlier order over $0 that Redo has for the store, including $0 first orders and orders with no known customer. Complements returningCustomerOrders; the two sum to orders. Customers whose earlier orders fall outside the history Redo has synced are counted as new.
The exact amount as a decimal string (e.g. “19.99”).
String!
required
ISO 4217 currency code (e.g. USD).
Float
uniqueOpens / delivered, over email deliveries only. Null when nothing measurable was delivered — including an SMS-only send, where opens do not exist and a rate of 0 would be misleading. For a continuously-sending automation this can exceed 1, since opens inside the range may belong to sends made before it.
Int!
required
Orders attributed to this send within the attribution window.
Int!
required
Distinct customers sent to.
Int!
required
Attributed orders from customers who already had an earlier order over $0 on this store. Complements newCustomerOrders; the two sum to orders.
revenue / sends — what a message returned, where revenuePerRecipient is what a customer returned. The two agree for a campaign, which sends to each recipient once, and diverge for a continuously-running automation that messages the same customer repeatedly over the range. This is the figure to compare against spend, which is also per message. Carries extra decimal places, since per-send revenue is routinely sub-cent. Null when nothing was sent.
What the store was billed to send these messages: its per-message rate plus any carrier fees. Always USD, unlike revenue, which is in the store’s own currency — Redo prices messaging in dollars. Convert before combining the two. Carries extra decimal places, since one message costs a fraction of a cent.
The exact amount as a decimal string (e.g. “19.99”).
String!
required
ISO 4217 currency code (e.g. USD).
Int!
required
Messages clicked at least once, counted like uniqueOpens.
Int!
required
Messages opened at least once. A customer who opens two of an automation’s emails counts twice; opening one email again does not count again. Always 0 on SMS, which has no open tracking.
Float
unsubscribes / delivered. Rated against deliveries rather than sends, like the other engagement rates, so it answers what share of messages that arrived cost a subscriber. Null when nothing was delivered.
Int!
required
Customers who opted out of marketing off the back of this send. Only opt-outs Redo could attribute to a specific campaign or automation are counted, so these do not sum to the store’s total unsubscribes over the same period — an opt-out arriving without that attribution belongs to no send and is absent here.
uniqueClicks / delivered. Null when nothing was delivered.
Float
uniqueClicks / uniqueOpens. Null when nothing was opened, so null on SMS.
Float
orders / delivered. Null when nothing was delivered.
Int!
required
Messages the provider confirmed were delivered.
Float
delivered / sends. Null when nothing was sent.
Int!
required
Messages the delivery provider refused or gave up on, so they never reached a delivery attempt. Distinct from a bounce, which is a delivery that came back — these never left. Together with delivered they account for what sends became.
Int!
required
Attributed orders from customers with no earlier order over $0 that Redo has for the store, including $0 first orders and orders with no known customer. Complements returningCustomerOrders; the two sum to orders. Customers whose earlier orders fall outside the history Redo has synced are counted as new.
Attributed revenue from newCustomerOrders. Complements returningCustomerRevenue. The two sum to revenue before each is rounded to currency precision.
Float
uniqueOpens / delivered, over email deliveries only. Null when nothing measurable was delivered — including an SMS-only send, where opens do not exist and a rate of 0 would be misleading. For a continuously-sending automation this can exceed 1, since opens inside the range may belong to sends made before it.
Int!
required
Orders attributed to this send within the attribution window.
Int!
required
Distinct customers sent to.
Int!
required
Attributed orders from customers who already had an earlier order over $0 on this store. Complements newCustomerOrders; the two sum to orders.
revenue / sends — what a message returned, where revenuePerRecipient is what a customer returned. The two agree for a campaign, which sends to each recipient once, and diverge for a continuously-running automation that messages the same customer repeatedly over the range. This is the figure to compare against spend, which is also per message. Carries extra decimal places, since per-send revenue is routinely sub-cent. Null when nothing was sent.
What the store was billed to send these messages: its per-message rate plus any carrier fees. Always USD, unlike revenue, which is in the store’s own currency — Redo prices messaging in dollars. Convert before combining the two. Carries extra decimal places, since one message costs a fraction of a cent.
Int!
required
Messages clicked at least once, counted like uniqueOpens.
Int!
required
Messages opened at least once. A customer who opens two of an automation’s emails counts twice; opening one email again does not count again. Always 0 on SMS, which has no open tracking.
Float
unsubscribes / delivered. Rated against deliveries rather than sends, like the other engagement rates, so it answers what share of messages that arrived cost a subscriber. Null when nothing was delivered.
Int!
required
Customers who opted out of marketing off the back of this send. Only opt-outs Redo could attribute to a specific campaign or automation are counted, so these do not sum to the store’s total unsubscribes over the same period — an opt-out arriving without that attribution belongs to no send and is absent here.
Float
uniqueClicks / delivered. Null when nothing was delivered.
Float
uniqueClicks / uniqueOpens. Null when nothing was opened, so null on SMS.
Float
orders / delivered. Null when nothing was delivered.
Int!
required
Messages the provider confirmed were delivered.
Float
delivered / sends. Null when nothing was sent.
Int!
required
Messages the delivery provider refused or gave up on, so they never reached a delivery attempt. Distinct from a bounce, which is a delivery that came back — these never left. Together with delivered they account for what sends became.
Int!
required
Attributed orders from customers with no earlier order over $0 that Redo has for the store, including $0 first orders and orders with no known customer. Complements returningCustomerOrders; the two sum to orders. Customers whose earlier orders fall outside the history Redo has synced are counted as new.
The exact amount as a decimal string (e.g. “19.99”).
String!
required
ISO 4217 currency code (e.g. USD).
Float
uniqueOpens / delivered, over email deliveries only. Null when nothing measurable was delivered — including an SMS-only send, where opens do not exist and a rate of 0 would be misleading. For a continuously-sending automation this can exceed 1, since opens inside the range may belong to sends made before it.
Int!
required
Orders attributed to this send within the attribution window.
Int!
required
Distinct customers sent to.
Int!
required
Attributed orders from customers who already had an earlier order over $0 on this store. Complements newCustomerOrders; the two sum to orders.
revenue / sends — what a message returned, where revenuePerRecipient is what a customer returned. The two agree for a campaign, which sends to each recipient once, and diverge for a continuously-running automation that messages the same customer repeatedly over the range. This is the figure to compare against spend, which is also per message. Carries extra decimal places, since per-send revenue is routinely sub-cent. Null when nothing was sent.
What the store was billed to send these messages: its per-message rate plus any carrier fees. Always USD, unlike revenue, which is in the store’s own currency — Redo prices messaging in dollars. Convert before combining the two. Carries extra decimal places, since one message costs a fraction of a cent.
The exact amount as a decimal string (e.g. “19.99”).
String!
required
ISO 4217 currency code (e.g. USD).
Int!
required
Messages clicked at least once, counted like uniqueOpens.
Int!
required
Messages opened at least once. A customer who opens two of an automation’s emails counts twice; opening one email again does not count again. Always 0 on SMS, which has no open tracking.
Float
unsubscribes / delivered. Rated against deliveries rather than sends, like the other engagement rates, so it answers what share of messages that arrived cost a subscriber. Null when nothing was delivered.
Int!
required
Customers who opted out of marketing off the back of this send. Only opt-outs Redo could attribute to a specific campaign or automation are counted, so these do not sum to the store’s total unsubscribes over the same period — an opt-out arriving without that attribution belongs to no send and is absent here.
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":true},"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":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6b00bb0cab6264437c45a8f4","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1267},{"language":"default","tag":"Reference","count":1196},{"language":"default","tag":"Objects","count":684},{"language":"default","tag":"Mutations","count":279},{"language":"default","tag":"Marketing","count":276},{"language":"default","tag":"Queries","count":230},{"language":"default","tag":"Checkout","count":168},{"language":"default","tag":"Support","count":160},{"language":"default","tag":"Shipping","count":91},{"language":"default","tag":"Returns","count":82}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"site-roles","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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"docs/api-reference/v3/reference/marketing/campaign-messaging-analytics","slug":"/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics","pageMetadata":{"title":"CampaignMessagingAnalytics","description":"Email and SMS performance for this campaign over a date range, at whichever grain you ask for.","href":"/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics"},"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: \"Email and SMS performance for this campaign over a date range, at whichever grain you ask for.\"\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`,strong:`strong`,..._provideComponents(),...props.components},{Expandable,ResponseField}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(ResponseField,{name:`series`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/marketing/message-analytics-point`,children:`[MessageAnalyticsPoint!]!`}),required:true,id:`param-series`,children:[_jsx(_components.p,{children:`One entry per day with activity, oldest first. Quiet days are omitted rather than reported as zero.`}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsxs(ResponseField,{name:`averageOrderValue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-average-order-value`,children:[_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / orders`}),`. Null when there were no orders.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsxs(ResponseField,{name:`byChannel`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/marketing/message-channel-analytics`,children:`[MessageChannelAnalytics!]!`}),required:true,id:`param-by-channel`,children:[_jsx(_components.p,{children:`The same analytics split by channel. A campaign sends on one channel; an automation whose steps include both an email and an SMS reports both.`}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`averageOrderValue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-average-order-value-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / orders`}),`. Null when there were no orders.`]})}),_jsx(ResponseField,{name:`channel`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/marketing/marketing-channel`,children:`MarketingChannel!`}),required:true,id:`param-channel`,children:_jsx(_components.p,{children:`The channel these analytics cover.`})}),_jsx(ResponseField,{name:`clickThroughRate`,type:`Float`,id:`param-click-through-rate`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueClicks / delivered`}),`. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`clickToOpenRate`,type:`Float`,id:`param-click-to-open-rate`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueClicks / uniqueOpens`}),`. Null when nothing was opened, so null on SMS.`]})}),_jsx(ResponseField,{name:`conversionRate`,type:`Float`,id:`param-conversion-rate`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`orders / delivered`}),`. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`delivered`,type:`Int!`,required:true,id:`param-delivered`,children:_jsx(_components.p,{children:`Messages the provider confirmed were delivered.`})}),_jsx(ResponseField,{name:`deliveryRate`,type:`Float`,id:`param-delivery-rate`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`delivered / sends`}),`. Null when nothing was sent.`]})}),_jsx(ResponseField,{name:`failures`,type:`Int!`,required:true,id:`param-failures`,children:_jsxs(_components.p,{children:[`Messages the delivery provider refused or gave up on, so they never reached a delivery attempt. Distinct from a bounce, which is a delivery that came back — these never left. Together with `,_jsx(_components.code,{children:`delivered`}),` they account for what `,_jsx(_components.code,{children:`sends`}),` became.`]})}),_jsx(ResponseField,{name:`newCustomerOrders`,type:`Int!`,required:true,id:`param-new-customer-orders`,children:_jsxs(_components.p,{children:[`Attributed orders from customers with no earlier order over `,`$0 that Redo has for the store, including $`,`0 first orders and orders with no known customer. Complements `,_jsx(_components.code,{children:`returningCustomerOrders`}),`; the two sum to `,_jsx(_components.code,{children:`orders`}),`. Customers whose earlier orders fall outside the history Redo has synced are counted as new.`]})}),_jsx(ResponseField,{name:`newCustomerRevenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-new-customer-revenue`,children:_jsxs(_components.p,{children:[`Attributed revenue from `,_jsx(_components.code,{children:`newCustomerOrders`}),`. Complements `,_jsx(_components.code,{children:`returningCustomerRevenue`}),`. The two sum to `,_jsx(_components.code,{children:`revenue`}),` before each is rounded to currency precision.`]})}),_jsx(ResponseField,{name:`openRate`,type:`Float`,id:`param-open-rate`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueOpens / delivered`}),`, over email deliveries only. Null when nothing measurable was delivered — including an SMS-only send, where opens do not exist and a rate of 0 would be misleading. For a continuously-sending automation this can exceed 1, since opens inside the range may belong to sends made before it.`]})}),_jsx(ResponseField,{name:`orders`,type:`Int!`,required:true,id:`param-orders`,children:_jsx(_components.p,{children:`Orders attributed to this send within the attribution window.`})}),_jsx(ResponseField,{name:`recipients`,type:`Int!`,required:true,id:`param-recipients`,children:_jsx(_components.p,{children:`Distinct customers sent to.`})}),_jsx(ResponseField,{name:`returningCustomerOrders`,type:`Int!`,required:true,id:`param-returning-customer-orders`,children:_jsxs(_components.p,{children:[`Attributed orders from customers who already had an earlier order over $0 on this store. Complements `,_jsx(_components.code,{children:`newCustomerOrders`}),`; the two sum to `,_jsx(_components.code,{children:`orders`}),`.`]})}),_jsx(ResponseField,{name:`returningCustomerRevenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-returning-customer-revenue`,children:_jsxs(_components.p,{children:[`Attributed revenue from `,_jsx(_components.code,{children:`returningCustomerOrders`}),`. Complements `,_jsx(_components.code,{children:`newCustomerRevenue`}),`. The two sum to `,_jsx(_components.code,{children:`revenue`}),` before each is rounded to currency precision.`]})}),_jsx(ResponseField,{name:`revenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-revenue`,children:_jsx(_components.p,{children:`Revenue attributed to this send.`})}),_jsx(ResponseField,{name:`revenuePerRecipient`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-revenue-per-recipient`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / recipients`}),`. Carries extra decimal places, since per-recipient revenue is routinely sub-cent. Null when nothing was sent.`]})}),_jsx(ResponseField,{name:`revenuePerSend`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-revenue-per-send`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / sends`}),` — what a message returned, where `,_jsx(_components.code,{children:`revenuePerRecipient`}),` is what a customer returned. The two agree for a campaign, which sends to each recipient once, and diverge for a continuously-running automation that messages the same customer repeatedly over the range. This is the figure to compare against `,_jsx(_components.code,{children:`spend`}),`, which is also per message. Carries extra decimal places, since per-send revenue is routinely sub-cent. Null when nothing was sent.`]})}),_jsx(ResponseField,{name:`sends`,type:`Int!`,required:true,id:`param-sends`,children:_jsx(_components.p,{children:`Messages handed to the delivery provider.`})}),_jsx(ResponseField,{name:`spend`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-spend`,children:_jsxs(_components.p,{children:[`What the store was billed to send these messages: its per-message rate plus any carrier fees. `,_jsx(_components.strong,{children:`Always USD`}),`, unlike `,_jsx(_components.code,{children:`revenue`}),`, which is in the store’s own currency — Redo prices messaging in dollars. Convert before combining the two. Carries extra decimal places, since one message costs a fraction of a cent.`]})}),_jsx(ResponseField,{name:`uniqueClicks`,type:`Int!`,required:true,id:`param-unique-clicks`,children:_jsxs(_components.p,{children:[`Messages clicked at least once, counted like `,_jsx(_components.code,{children:`uniqueOpens`}),`.`]})}),_jsx(ResponseField,{name:`uniqueOpens`,type:`Int!`,required:true,id:`param-unique-opens`,children:_jsx(_components.p,{children:`Messages opened at least once. A customer who opens two of an automation’s emails counts twice; opening one email again does not count again. Always 0 on SMS, which has no open tracking.`})}),_jsx(ResponseField,{name:`unsubscribeRate`,type:`Float`,id:`param-unsubscribe-rate`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`unsubscribes / delivered`}),`. Rated against deliveries rather than sends, like the other engagement rates, so it answers what share of messages that arrived cost a subscriber. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`unsubscribes`,type:`Int!`,required:true,id:`param-unsubscribes`,children:_jsxs(_components.p,{children:[`Customers who opted out of marketing off the back of this send. Only opt-outs Redo could attribute to a specific campaign or automation are counted, so these do `,_jsx(_components.strong,{children:`not`}),` sum to the store’s total unsubscribes over the same period — an opt-out arriving without that attribution belongs to no send and is absent here.`]})})]})]}),_jsx(ResponseField,{name:`clickThroughRate`,type:`Float`,id:`param-click-through-rate-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueClicks / delivered`}),`. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`clickToOpenRate`,type:`Float`,id:`param-click-to-open-rate-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueClicks / uniqueOpens`}),`. Null when nothing was opened, so null on SMS.`]})}),_jsx(ResponseField,{name:`conversionRate`,type:`Float`,id:`param-conversion-rate-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`orders / delivered`}),`. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`date`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/date`,children:`Date!`}),required:true,id:`param-date`,children:_jsx(_components.p,{children:`The day these analytics cover, in the store’s timezone. Engagement counts are keyed to the day each event happened; orders and revenue to the day the order was placed. A rate combining the two — conversion rate, revenue per recipient, average order value — therefore relates figures from different days, and is most meaningful read over the whole range rather than per day.`})}),_jsx(ResponseField,{name:`delivered`,type:`Int!`,required:true,id:`param-delivered-1`,children:_jsx(_components.p,{children:`Messages the provider confirmed were delivered.`})}),_jsx(ResponseField,{name:`deliveryRate`,type:`Float`,id:`param-delivery-rate-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`delivered / sends`}),`. Null when nothing was sent.`]})}),_jsx(ResponseField,{name:`failures`,type:`Int!`,required:true,id:`param-failures-1`,children:_jsxs(_components.p,{children:[`Messages the delivery provider refused or gave up on, so they never reached a delivery attempt. Distinct from a bounce, which is a delivery that came back — these never left. Together with `,_jsx(_components.code,{children:`delivered`}),` they account for what `,_jsx(_components.code,{children:`sends`}),` became.`]})}),_jsx(ResponseField,{name:`newCustomerOrders`,type:`Int!`,required:true,id:`param-new-customer-orders-1`,children:_jsxs(_components.p,{children:[`Attributed orders from customers with no earlier order over `,`$0 that Redo has for the store, including $`,`0 first orders and orders with no known customer. Complements `,_jsx(_components.code,{children:`returningCustomerOrders`}),`; the two sum to `,_jsx(_components.code,{children:`orders`}),`. Customers whose earlier orders fall outside the history Redo has synced are counted as new.`]})}),_jsxs(ResponseField,{name:`newCustomerRevenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-new-customer-revenue-1`,children:[_jsxs(_components.p,{children:[`Attributed revenue from `,_jsx(_components.code,{children:`newCustomerOrders`}),`. Complements `,_jsx(_components.code,{children:`returningCustomerRevenue`}),`. The two sum to `,_jsx(_components.code,{children:`revenue`}),` before each is rounded to currency precision.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-1`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-1`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsx(ResponseField,{name:`openRate`,type:`Float`,id:`param-open-rate-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueOpens / delivered`}),`, over email deliveries only. Null when nothing measurable was delivered — including an SMS-only send, where opens do not exist and a rate of 0 would be misleading. For a continuously-sending automation this can exceed 1, since opens inside the range may belong to sends made before it.`]})}),_jsx(ResponseField,{name:`orders`,type:`Int!`,required:true,id:`param-orders-1`,children:_jsx(_components.p,{children:`Orders attributed to this send within the attribution window.`})}),_jsx(ResponseField,{name:`recipients`,type:`Int!`,required:true,id:`param-recipients-1`,children:_jsx(_components.p,{children:`Distinct customers sent to.`})}),_jsx(ResponseField,{name:`returningCustomerOrders`,type:`Int!`,required:true,id:`param-returning-customer-orders-1`,children:_jsxs(_components.p,{children:[`Attributed orders from customers who already had an earlier order over $0 on this store. Complements `,_jsx(_components.code,{children:`newCustomerOrders`}),`; the two sum to `,_jsx(_components.code,{children:`orders`}),`.`]})}),_jsxs(ResponseField,{name:`returningCustomerRevenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-returning-customer-revenue-1`,children:[_jsxs(_components.p,{children:[`Attributed revenue from `,_jsx(_components.code,{children:`returningCustomerOrders`}),`. Complements `,_jsx(_components.code,{children:`newCustomerRevenue`}),`. The two sum to `,_jsx(_components.code,{children:`revenue`}),` before each is rounded to currency precision.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-2`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-2`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsxs(ResponseField,{name:`revenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-revenue-1`,children:[_jsx(_components.p,{children:`Revenue attributed to this send.`}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-3`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-3`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsxs(ResponseField,{name:`revenuePerRecipient`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-revenue-per-recipient-1`,children:[_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / recipients`}),`. Carries extra decimal places, since per-recipient revenue is routinely sub-cent. Null when nothing was sent.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-4`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-4`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsxs(ResponseField,{name:`revenuePerSend`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-revenue-per-send-1`,children:[_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / sends`}),` — what a message returned, where `,_jsx(_components.code,{children:`revenuePerRecipient`}),` is what a customer returned. The two agree for a campaign, which sends to each recipient once, and diverge for a continuously-running automation that messages the same customer repeatedly over the range. This is the figure to compare against `,_jsx(_components.code,{children:`spend`}),`, which is also per message. Carries extra decimal places, since per-send revenue is routinely sub-cent. Null when nothing was sent.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-5`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-5`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsx(ResponseField,{name:`sends`,type:`Int!`,required:true,id:`param-sends-1`,children:_jsx(_components.p,{children:`Messages handed to the delivery provider.`})}),_jsxs(ResponseField,{name:`spend`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-spend-1`,children:[_jsxs(_components.p,{children:[`What the store was billed to send these messages: its per-message rate plus any carrier fees. `,_jsx(_components.strong,{children:`Always USD`}),`, unlike `,_jsx(_components.code,{children:`revenue`}),`, which is in the store’s own currency — Redo prices messaging in dollars. Convert before combining the two. Carries extra decimal places, since one message costs a fraction of a cent.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-6`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-6`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsx(ResponseField,{name:`uniqueClicks`,type:`Int!`,required:true,id:`param-unique-clicks-1`,children:_jsxs(_components.p,{children:[`Messages clicked at least once, counted like `,_jsx(_components.code,{children:`uniqueOpens`}),`.`]})}),_jsx(ResponseField,{name:`uniqueOpens`,type:`Int!`,required:true,id:`param-unique-opens-1`,children:_jsx(_components.p,{children:`Messages opened at least once. A customer who opens two of an automation’s emails counts twice; opening one email again does not count again. Always 0 on SMS, which has no open tracking.`})}),_jsx(ResponseField,{name:`unsubscribeRate`,type:`Float`,id:`param-unsubscribe-rate-1`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`unsubscribes / delivered`}),`. Rated against deliveries rather than sends, like the other engagement rates, so it answers what share of messages that arrived cost a subscriber. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`unsubscribes`,type:`Int!`,required:true,id:`param-unsubscribes-1`,children:_jsxs(_components.p,{children:[`Customers who opted out of marketing off the back of this send. Only opt-outs Redo could attribute to a specific campaign or automation are counted, so these do `,_jsx(_components.strong,{children:`not`}),` sum to the store’s total unsubscribes over the same period — an opt-out arriving without that attribution belongs to no send and is absent here.`]})})]})]}),`\n`,_jsxs(ResponseField,{name:`totals`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/marketing/message-analytics-totals`,children:`MessageAnalyticsTotals!`}),required:true,id:`param-totals`,children:[_jsx(_components.p,{children:`Totals across the whole range. A campaign with no activity reports zero counts and null rates.`}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsxs(ResponseField,{name:`averageOrderValue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-average-order-value-2`,children:[_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / orders`}),`. Null when there were no orders.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-7`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-7`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsxs(ResponseField,{name:`byChannel`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/marketing/message-channel-analytics`,children:`[MessageChannelAnalytics!]!`}),required:true,id:`param-by-channel-1`,children:[_jsx(_components.p,{children:`The same analytics split by channel. A campaign sends on one channel; an automation whose steps include both an email and an SMS reports both.`}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`averageOrderValue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-average-order-value-3`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / orders`}),`. Null when there were no orders.`]})}),_jsx(ResponseField,{name:`channel`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/marketing/marketing-channel`,children:`MarketingChannel!`}),required:true,id:`param-channel-1`,children:_jsx(_components.p,{children:`The channel these analytics cover.`})}),_jsx(ResponseField,{name:`clickThroughRate`,type:`Float`,id:`param-click-through-rate-2`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueClicks / delivered`}),`. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`clickToOpenRate`,type:`Float`,id:`param-click-to-open-rate-2`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueClicks / uniqueOpens`}),`. Null when nothing was opened, so null on SMS.`]})}),_jsx(ResponseField,{name:`conversionRate`,type:`Float`,id:`param-conversion-rate-2`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`orders / delivered`}),`. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`delivered`,type:`Int!`,required:true,id:`param-delivered-2`,children:_jsx(_components.p,{children:`Messages the provider confirmed were delivered.`})}),_jsx(ResponseField,{name:`deliveryRate`,type:`Float`,id:`param-delivery-rate-2`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`delivered / sends`}),`. Null when nothing was sent.`]})}),_jsx(ResponseField,{name:`failures`,type:`Int!`,required:true,id:`param-failures-2`,children:_jsxs(_components.p,{children:[`Messages the delivery provider refused or gave up on, so they never reached a delivery attempt. Distinct from a bounce, which is a delivery that came back — these never left. Together with `,_jsx(_components.code,{children:`delivered`}),` they account for what `,_jsx(_components.code,{children:`sends`}),` became.`]})}),_jsx(ResponseField,{name:`newCustomerOrders`,type:`Int!`,required:true,id:`param-new-customer-orders-2`,children:_jsxs(_components.p,{children:[`Attributed orders from customers with no earlier order over `,`$0 that Redo has for the store, including $`,`0 first orders and orders with no known customer. Complements `,_jsx(_components.code,{children:`returningCustomerOrders`}),`; the two sum to `,_jsx(_components.code,{children:`orders`}),`. Customers whose earlier orders fall outside the history Redo has synced are counted as new.`]})}),_jsx(ResponseField,{name:`newCustomerRevenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-new-customer-revenue-2`,children:_jsxs(_components.p,{children:[`Attributed revenue from `,_jsx(_components.code,{children:`newCustomerOrders`}),`. Complements `,_jsx(_components.code,{children:`returningCustomerRevenue`}),`. The two sum to `,_jsx(_components.code,{children:`revenue`}),` before each is rounded to currency precision.`]})}),_jsx(ResponseField,{name:`openRate`,type:`Float`,id:`param-open-rate-2`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueOpens / delivered`}),`, over email deliveries only. Null when nothing measurable was delivered — including an SMS-only send, where opens do not exist and a rate of 0 would be misleading. For a continuously-sending automation this can exceed 1, since opens inside the range may belong to sends made before it.`]})}),_jsx(ResponseField,{name:`orders`,type:`Int!`,required:true,id:`param-orders-2`,children:_jsx(_components.p,{children:`Orders attributed to this send within the attribution window.`})}),_jsx(ResponseField,{name:`recipients`,type:`Int!`,required:true,id:`param-recipients-2`,children:_jsx(_components.p,{children:`Distinct customers sent to.`})}),_jsx(ResponseField,{name:`returningCustomerOrders`,type:`Int!`,required:true,id:`param-returning-customer-orders-2`,children:_jsxs(_components.p,{children:[`Attributed orders from customers who already had an earlier order over $0 on this store. Complements `,_jsx(_components.code,{children:`newCustomerOrders`}),`; the two sum to `,_jsx(_components.code,{children:`orders`}),`.`]})}),_jsx(ResponseField,{name:`returningCustomerRevenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-returning-customer-revenue-2`,children:_jsxs(_components.p,{children:[`Attributed revenue from `,_jsx(_components.code,{children:`returningCustomerOrders`}),`. Complements `,_jsx(_components.code,{children:`newCustomerRevenue`}),`. The two sum to `,_jsx(_components.code,{children:`revenue`}),` before each is rounded to currency precision.`]})}),_jsx(ResponseField,{name:`revenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-revenue-2`,children:_jsx(_components.p,{children:`Revenue attributed to this send.`})}),_jsx(ResponseField,{name:`revenuePerRecipient`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-revenue-per-recipient-2`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / recipients`}),`. Carries extra decimal places, since per-recipient revenue is routinely sub-cent. Null when nothing was sent.`]})}),_jsx(ResponseField,{name:`revenuePerSend`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-revenue-per-send-2`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / sends`}),` — what a message returned, where `,_jsx(_components.code,{children:`revenuePerRecipient`}),` is what a customer returned. The two agree for a campaign, which sends to each recipient once, and diverge for a continuously-running automation that messages the same customer repeatedly over the range. This is the figure to compare against `,_jsx(_components.code,{children:`spend`}),`, which is also per message. Carries extra decimal places, since per-send revenue is routinely sub-cent. Null when nothing was sent.`]})}),_jsx(ResponseField,{name:`sends`,type:`Int!`,required:true,id:`param-sends-2`,children:_jsx(_components.p,{children:`Messages handed to the delivery provider.`})}),_jsx(ResponseField,{name:`spend`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-spend-2`,children:_jsxs(_components.p,{children:[`What the store was billed to send these messages: its per-message rate plus any carrier fees. `,_jsx(_components.strong,{children:`Always USD`}),`, unlike `,_jsx(_components.code,{children:`revenue`}),`, which is in the store’s own currency — Redo prices messaging in dollars. Convert before combining the two. Carries extra decimal places, since one message costs a fraction of a cent.`]})}),_jsx(ResponseField,{name:`uniqueClicks`,type:`Int!`,required:true,id:`param-unique-clicks-2`,children:_jsxs(_components.p,{children:[`Messages clicked at least once, counted like `,_jsx(_components.code,{children:`uniqueOpens`}),`.`]})}),_jsx(ResponseField,{name:`uniqueOpens`,type:`Int!`,required:true,id:`param-unique-opens-2`,children:_jsx(_components.p,{children:`Messages opened at least once. A customer who opens two of an automation’s emails counts twice; opening one email again does not count again. Always 0 on SMS, which has no open tracking.`})}),_jsx(ResponseField,{name:`unsubscribeRate`,type:`Float`,id:`param-unsubscribe-rate-2`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`unsubscribes / delivered`}),`. Rated against deliveries rather than sends, like the other engagement rates, so it answers what share of messages that arrived cost a subscriber. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`unsubscribes`,type:`Int!`,required:true,id:`param-unsubscribes-2`,children:_jsxs(_components.p,{children:[`Customers who opted out of marketing off the back of this send. Only opt-outs Redo could attribute to a specific campaign or automation are counted, so these do `,_jsx(_components.strong,{children:`not`}),` sum to the store’s total unsubscribes over the same period — an opt-out arriving without that attribution belongs to no send and is absent here.`]})})]})]}),_jsx(ResponseField,{name:`clickThroughRate`,type:`Float`,id:`param-click-through-rate-3`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueClicks / delivered`}),`. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`clickToOpenRate`,type:`Float`,id:`param-click-to-open-rate-3`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueClicks / uniqueOpens`}),`. Null when nothing was opened, so null on SMS.`]})}),_jsx(ResponseField,{name:`conversionRate`,type:`Float`,id:`param-conversion-rate-3`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`orders / delivered`}),`. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`delivered`,type:`Int!`,required:true,id:`param-delivered-3`,children:_jsx(_components.p,{children:`Messages the provider confirmed were delivered.`})}),_jsx(ResponseField,{name:`deliveryRate`,type:`Float`,id:`param-delivery-rate-3`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`delivered / sends`}),`. Null when nothing was sent.`]})}),_jsx(ResponseField,{name:`failures`,type:`Int!`,required:true,id:`param-failures-3`,children:_jsxs(_components.p,{children:[`Messages the delivery provider refused or gave up on, so they never reached a delivery attempt. Distinct from a bounce, which is a delivery that came back — these never left. Together with `,_jsx(_components.code,{children:`delivered`}),` they account for what `,_jsx(_components.code,{children:`sends`}),` became.`]})}),_jsx(ResponseField,{name:`newCustomerOrders`,type:`Int!`,required:true,id:`param-new-customer-orders-3`,children:_jsxs(_components.p,{children:[`Attributed orders from customers with no earlier order over `,`$0 that Redo has for the store, including $`,`0 first orders and orders with no known customer. Complements `,_jsx(_components.code,{children:`returningCustomerOrders`}),`; the two sum to `,_jsx(_components.code,{children:`orders`}),`. Customers whose earlier orders fall outside the history Redo has synced are counted as new.`]})}),_jsxs(ResponseField,{name:`newCustomerRevenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-new-customer-revenue-3`,children:[_jsxs(_components.p,{children:[`Attributed revenue from `,_jsx(_components.code,{children:`newCustomerOrders`}),`. Complements `,_jsx(_components.code,{children:`returningCustomerRevenue`}),`. The two sum to `,_jsx(_components.code,{children:`revenue`}),` before each is rounded to currency precision.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-8`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-8`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsx(ResponseField,{name:`openRate`,type:`Float`,id:`param-open-rate-3`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`uniqueOpens / delivered`}),`, over email deliveries only. Null when nothing measurable was delivered — including an SMS-only send, where opens do not exist and a rate of 0 would be misleading. For a continuously-sending automation this can exceed 1, since opens inside the range may belong to sends made before it.`]})}),_jsx(ResponseField,{name:`orders`,type:`Int!`,required:true,id:`param-orders-3`,children:_jsx(_components.p,{children:`Orders attributed to this send within the attribution window.`})}),_jsx(ResponseField,{name:`recipients`,type:`Int!`,required:true,id:`param-recipients-3`,children:_jsx(_components.p,{children:`Distinct customers sent to.`})}),_jsx(ResponseField,{name:`returningCustomerOrders`,type:`Int!`,required:true,id:`param-returning-customer-orders-3`,children:_jsxs(_components.p,{children:[`Attributed orders from customers who already had an earlier order over $0 on this store. Complements `,_jsx(_components.code,{children:`newCustomerOrders`}),`; the two sum to `,_jsx(_components.code,{children:`orders`}),`.`]})}),_jsxs(ResponseField,{name:`returningCustomerRevenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-returning-customer-revenue-3`,children:[_jsxs(_components.p,{children:[`Attributed revenue from `,_jsx(_components.code,{children:`returningCustomerOrders`}),`. Complements `,_jsx(_components.code,{children:`newCustomerRevenue`}),`. The two sum to `,_jsx(_components.code,{children:`revenue`}),` before each is rounded to currency precision.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-9`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-9`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsxs(ResponseField,{name:`revenue`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-revenue-3`,children:[_jsx(_components.p,{children:`Revenue attributed to this send.`}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-10`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-10`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsxs(ResponseField,{name:`revenuePerRecipient`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-revenue-per-recipient-3`,children:[_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / recipients`}),`. Carries extra decimal places, since per-recipient revenue is routinely sub-cent. Null when nothing was sent.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-11`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-11`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsxs(ResponseField,{name:`revenuePerSend`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money`}),id:`param-revenue-per-send-3`,children:[_jsxs(_components.p,{children:[_jsx(_components.code,{children:`revenue / sends`}),` — what a message returned, where `,_jsx(_components.code,{children:`revenuePerRecipient`}),` is what a customer returned. The two agree for a campaign, which sends to each recipient once, and diverge for a continuously-running automation that messages the same customer repeatedly over the range. This is the figure to compare against `,_jsx(_components.code,{children:`spend`}),`, which is also per message. Carries extra decimal places, since per-send revenue is routinely sub-cent. Null when nothing was sent.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-12`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-12`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsx(ResponseField,{name:`sends`,type:`Int!`,required:true,id:`param-sends-3`,children:_jsx(_components.p,{children:`Messages handed to the delivery provider.`})}),_jsxs(ResponseField,{name:`spend`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/money`,children:`Money!`}),required:true,id:`param-spend-3`,children:[_jsxs(_components.p,{children:[`What the store was billed to send these messages: its per-message rate plus any carrier fees. `,_jsx(_components.strong,{children:`Always USD`}),`, unlike `,_jsx(_components.code,{children:`revenue`}),`, which is in the store’s own currency — Redo prices messaging in dollars. Convert before combining the two. Carries extra decimal places, since one message costs a fraction of a cent.`]}),_jsxs(Expandable,{title:`fields`,lazyRender:true,children:[_jsx(ResponseField,{name:`amount`,type:_jsx(_components.a,{href:`/docs/api-reference/v3/reference/common/decimal`,children:`Decimal!`}),required:true,id:`param-amount-13`,children:_jsx(_components.p,{children:`The exact amount as a decimal string (e.g. “19.99”).`})}),_jsx(ResponseField,{name:`currency`,type:`String!`,required:true,id:`param-currency-13`,children:_jsx(_components.p,{children:`ISO 4217 currency code (e.g. USD).`})})]})]}),_jsx(ResponseField,{name:`uniqueClicks`,type:`Int!`,required:true,id:`param-unique-clicks-3`,children:_jsxs(_components.p,{children:[`Messages clicked at least once, counted like `,_jsx(_components.code,{children:`uniqueOpens`}),`.`]})}),_jsx(ResponseField,{name:`uniqueOpens`,type:`Int!`,required:true,id:`param-unique-opens-3`,children:_jsx(_components.p,{children:`Messages opened at least once. A customer who opens two of an automation’s emails counts twice; opening one email again does not count again. Always 0 on SMS, which has no open tracking.`})}),_jsx(ResponseField,{name:`unsubscribeRate`,type:`Float`,id:`param-unsubscribe-rate-3`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`unsubscribes / delivered`}),`. Rated against deliveries rather than sends, like the other engagement rates, so it answers what share of messages that arrived cost a subscriber. Null when nothing was delivered.`]})}),_jsx(ResponseField,{name:`unsubscribes`,type:`Int!`,required:true,id:`param-unsubscribes-3`,children:_jsxs(_components.p,{children:[`Customers who opted out of marketing off the back of this send. Only opt-outs Redo could attribute to a specific campaign or automation are counted, so these do `,_jsx(_components.strong,{children:`not`}),` sum to the store’s total unsubscribes over the same period — an opt-out arriving without that attribution belongs to no send and is absent here.`]})})]})]})]})}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":"CampaignMessagingAnalytics","description":"Email and SMS performance for this campaign over a date range, at whichever grain you ask for.","href":"/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"redo-44af351d","siteName":"Redo","title":"CampaignMessagingAnalytics - Redo","navMaps":{"firstHrefInVersion":{"v3 (GraphQL)":{"href":"/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics","matchLevel":0},"v2 (REST)":{"href":"/docs/api-reference/introduction","matchLevel":3},"v1":{"href":"/docs/shopper-api/v1/overview","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-10-31T00:45:59.286Z","originalFileLocation":"docs/api-reference/v3/reference/marketing/campaign-messaging-analytics.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=\"Email and SMS performance for this campaign over a date range, at whichever grain you ask for.\">\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=\"CampaignMessagingAnalytics - Redo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Email and SMS performance for this campaign over a date range, at whichever grain you ask for.\">\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/marketing/campaign-messaging-analytics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://redo-44af351d.mintlify.site/_mintlify/api/og/v2?division=Objects\u0026amp;title=CampaignMessagingAnalytics\u0026amp;description=Email+and+SMS+performance+for+this+campaign+over+a+date+range%2C+at+whichever+grain+you+ask+for.\u0026amp;theme=811c1b99001e8a554631eff8\u0026amp;signature=c746c8daf16febeedb0c8c4a37844aa149fe2329b1abdee3a7e65f0b7145a3e6\">\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=\"CampaignMessagingAnalytics - Redo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Email and SMS performance for this campaign over a date range, at whichever grain you ask for.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://redo-44af351d.mintlify.site/_mintlify/api/og/v2?division=Objects\u0026amp;title=CampaignMessagingAnalytics\u0026amp;description=Email+and+SMS+performance+for+this+campaign+over+a+date+range%2C+at+whichever+grain+you+ask+for.\u0026amp;theme=811c1b99001e8a554631eff8\u0026amp;signature=c746c8daf16febeedb0c8c4a37844aa149fe2329b1abdee3a7e65f0b7145a3e6\">\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/marketing/campaign-messaging-analytics\">\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/marketing/campaign-messaging-analytics.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/marketing/campaign-messaging-analytics#webpage\",\"url\":\"https://developers.redo.com/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics\",\"name\":\"CampaignMessagingAnalytics\",\"description\":\"Email and SMS performance for this campaign over a date range, at whichever grain you ask for.\",\"dateModified\":\"2026-10-31T00:45:59.286Z\",\"isPartOf\":{\"@id\":\"https://developers.redo.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.redo.com/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.redo.com/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://developers.redo.com/docs/api-reference/v3/reference/account/queries/account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Marketing\",\"item\":\"https://developers.redo.com/docs/api-reference/v3/reference/marketing/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Objects\",\"item\":\"https://developers.redo.com/docs/api-reference/v3/reference/marketing/added-to-cart-product-filter\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"CampaignMessagingAnalytics\",\"item\":\"https://developers.redo.com/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developers.redo.com/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics#article\",\"headline\":\"CampaignMessagingAnalytics\",\"name\":\"CampaignMessagingAnalytics\",\"description\":\"Email and SMS performance for this campaign over a date range, at whichever grain you ask for.\",\"url\":\"https://developers.redo.com/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics\",\"mainEntityOfPage\":{\"@id\":\"https://developers.redo.com/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics#webpage\"},\"dateModified\":\"2026-10-31T00:45:59.286Z\",\"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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Redo\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics.md","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":"Shopper API","hidden":true,"versions":[{"version":"v1","groups":[{"group":"Getting started","pages":[{"title":"Shopper API","href":"/docs/shopper-api/v1/overview"}]},{"group":"Reference","pages":[{"group":"Common","root":{"title":"Common","href":"/docs/shopper-api/v1/reference/common/overview"},"pages":[{"group":"Queries","pages":[{"title":"shopperConfiguration","href":"/docs/shopper-api/v1/reference/common/queries/shopper-configuration"},{"title":"shopperSession","href":"/docs/shopper-api/v1/reference/common/queries/shopper-session"}]},{"group":"Mutations","pages":[{"title":"shopperOrderAuthenticate","href":"/docs/shopper-api/v1/reference/common/mutations/shopper-order-authenticate"},{"title":"shopperOrderSelect","href":"/docs/shopper-api/v1/reference/common/mutations/shopper-order-select"}]},{"group":"Objects","pages":[{"title":"Money","href":"/docs/shopper-api/v1/reference/common/money"},{"title":"Node","href":"/docs/shopper-api/v1/reference/common/node"},{"title":"ShopperConfiguration","href":"/docs/shopper-api/v1/reference/common/shopper-configuration"},{"title":"ShopperCredentials","href":"/docs/shopper-api/v1/reference/common/shopper-credentials"},{"title":"ShopperOrderAuthentication","href":"/docs/shopper-api/v1/reference/common/shopper-order-authentication"},{"title":"ShopperOrderChoice","href":"/docs/shopper-api/v1/reference/common/shopper-order-choice"},{"title":"ShopperOrderSelection","href":"/docs/shopper-api/v1/reference/common/shopper-order-selection"},{"title":"ShopperSession","href":"/docs/shopper-api/v1/reference/common/shopper-session"}]}]},{"group":"Orders","root":{"title":"Orders","href":"/docs/shopper-api/v1/reference/orders/overview"},"pages":[{"group":"Queries","pages":[{"title":"order","href":"/docs/shopper-api/v1/reference/orders/queries/order"},{"title":"orders","href":"/docs/shopper-api/v1/reference/orders/queries/orders"}]},{"group":"Objects","pages":[{"title":"MailingAddress","href":"/docs/shopper-api/v1/reference/orders/mailing-address"},{"title":"Order","href":"/docs/shopper-api/v1/reference/orders/order"},{"title":"OrderCoverage","href":"/docs/shopper-api/v1/reference/orders/order-coverage"},{"title":"OrderLineItem","href":"/docs/shopper-api/v1/reference/orders/order-line-item"}]}]},{"group":"Returns","root":{"title":"Returns","href":"/docs/shopper-api/v1/reference/returns/overview"},"pages":[{"group":"Queries","pages":[{"title":"return","href":"/docs/shopper-api/v1/reference/returns/queries/return"},{"title":"returnDraft","href":"/docs/shopper-api/v1/reference/returns/queries/return-draft"}]},{"group":"Mutations","pages":[{"title":"returnDraftAddExchangeItem","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-add-exchange-item"},{"title":"returnDraftAnswerQuestions","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-answer-questions"},{"title":"returnDraftClearItem","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-clear-item"},{"title":"returnDraftCreate","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-create"},{"title":"returnDraftRemoveExchangeItem","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-remove-exchange-item"},{"title":"returnDraftSelectCompensationMethod","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-select-compensation-method"},{"title":"returnDraftSelectItem","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-select-item"},{"title":"returnDraftSelectShippingMethod","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-select-shipping-method"},{"title":"returnDraftSetAddresses","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-set-addresses"},{"title":"returnDraftSubmit","href":"/docs/shopper-api/v1/reference/returns/mutations/return-draft-submit"}]},{"group":"Objects","pages":[{"title":"Return","href":"/docs/shopper-api/v1/reference/returns/return"},{"title":"ReturnCreationStatus","href":"/docs/shopper-api/v1/reference/returns/return-creation-status"},{"title":"ReturnDraft","href":"/docs/shopper-api/v1/reference/returns/return-draft"},{"title":"ReturnDraftAddress","href":"/docs/shopper-api/v1/reference/returns/return-draft-address"},{"title":"ReturnDraftAnswer","href":"/docs/shopper-api/v1/reference/returns/return-draft-answer"},{"title":"ReturnDraftAnswerQuestionsStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-answer-questions-step"},{"title":"ReturnDraftCompensationAdjustment","href":"/docs/shopper-api/v1/reference/returns/return-draft-compensation-adjustment"},{"title":"ReturnDraftCompensationOption","href":"/docs/shopper-api/v1/reference/returns/return-draft-compensation-option"},{"title":"ReturnDraftComponent","href":"/docs/shopper-api/v1/reference/returns/return-draft-component"},{"title":"ReturnDraftContactSupportStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-contact-support-step"},{"title":"ReturnDraftContinueInPortalStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-continue-in-portal-step"},{"title":"ReturnDraftExchangeItem","href":"/docs/shopper-api/v1/reference/returns/return-draft-exchange-item"},{"title":"ReturnDraftItem","href":"/docs/shopper-api/v1/reference/returns/return-draft-item"},{"title":"ReturnDraftItemIneligibilityReason","href":"/docs/shopper-api/v1/reference/returns/return-draft-item-ineligibility-reason"},{"title":"ReturnDraftItemReturnability","href":"/docs/shopper-api/v1/reference/returns/return-draft-item-returnability"},{"title":"ReturnDraftNextStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-next-step"},{"title":"ReturnDraftNextStepIneligibleItem","href":"/docs/shopper-api/v1/reference/returns/return-draft-next-step-ineligible-item"},{"title":"ReturnDraftNextStepQuestions","href":"/docs/shopper-api/v1/reference/returns/return-draft-next-step-questions"},{"title":"ReturnDraftQuestion","href":"/docs/shopper-api/v1/reference/returns/return-draft-question"},{"title":"ReturnDraftQuestionChoice","href":"/docs/shopper-api/v1/reference/returns/return-draft-question-choice"},{"title":"ReturnDraftRemoveIneligibleItemsStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-remove-ineligible-items-step"},{"title":"ReturnDraftSelectCompensationMethodStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-select-compensation-method-step"},{"title":"ReturnDraftSelectExchangeItemsStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-select-exchange-items-step"},{"title":"ReturnDraftSelectItemsStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-select-items-step"},{"title":"ReturnDraftSelectShippingMethodStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-select-shipping-method-step"},{"title":"ReturnDraftSetAddressesStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-set-addresses-step"},{"title":"ReturnDraftShippingChoice","href":"/docs/shopper-api/v1/reference/returns/return-draft-shipping-choice"},{"title":"ReturnDraftSubmitStep","href":"/docs/shopper-api/v1/reference/returns/return-draft-submit-step"},{"title":"ReturnItem","href":"/docs/shopper-api/v1/reference/returns/return-item"}]}]},{"group":"Shipping","root":{"title":"Shipping","href":"/docs/shopper-api/v1/reference/shipping/overview"},"pages":[{"group":"Queries","pages":[{"title":"shipment","href":"/docs/shopper-api/v1/reference/shipping/queries/shipment"}]},{"group":"Objects","pages":[{"title":"Shipment","href":"/docs/shopper-api/v1/reference/shipping/shipment"},{"title":"ShipmentItem","href":"/docs/shopper-api/v1/reference/shipping/shipment-item"},{"title":"TrackingEvent","href":"/docs/shopper-api/v1/reference/shipping/tracking-event"},{"title":"TrackingLocation","href":"/docs/shopper-api/v1/reference/shipping/tracking-location"}]}]},{"title":"Access scopes","href":"/docs/shopper-api/v1/reference/scopes"}]}]}]},{"tab":"API Reference","versions":[{"version":"v3 (GraphQL)","default":true,"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"},{"title":"Stability and deprecation","icon":"shield-check","href":"/docs/api-reference/v3/stability"},{"title":"Experimental fields","icon":"flask","href":"/docs/api-reference/v3/experimental"},{"title":"Changelog","icon":"rss","href":"/docs/api-reference/v3/changelog"}]},{"group":"Guides","pages":[{"title":"Reconciling payouts","icon":"wallet","href":"/docs/api-reference/v3/reconciling-payouts"}]},{"group":"Reference","pages":[{"group":"Account","root":{"title":"Account","href":"/docs/api-reference/v3/reference/account/overview"},"pages":[{"group":"Queries","pages":[{"title":"account","href":"/docs/api-reference/v3/reference/account/queries/account"}]},{"group":"Mutations","pages":[{"title":"accountAttributesSet","href":"/docs/api-reference/v3/reference/account/mutations/account-attributes-set"}]},{"group":"Objects","pages":[{"title":"Account","href":"/docs/api-reference/v3/reference/account/account"}]}]},{"group":"Analytics","root":{"title":"Analytics","href":"/docs/api-reference/v3/reference/analytics/overview"},"pages":[{"group":"Queries","pages":[{"title":"analyticsCatalogEntities","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-catalog-entities"},{"title":"analyticsCatalogEntityDetails","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-catalog-entity-details"},{"title":"analyticsCatalogSearch","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-catalog-search"},{"title":"analyticsFieldValues","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-field-values"},{"title":"analyticsQueryPlan","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-query-plan"},{"title":"analyticsQueryRows","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-query-rows"},{"title":"analyticsReport","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-report"},{"title":"analyticsReportExport","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-report-export"},{"title":"analyticsReportRows","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-report-rows"},{"title":"analyticsReports","href":"/docs/api-reference/v3/reference/analytics/queries/analytics-reports"}]},{"group":"Mutations","pages":[{"title":"analyticsReportCreateFromPlan","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-create-from-plan"},{"title":"analyticsReportDelete","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-delete"},{"title":"analyticsReportDuplicate","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-duplicate"},{"title":"analyticsReportEditFromPlan","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-edit-from-plan"},{"title":"analyticsReportEditPlan","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-edit-plan"},{"title":"analyticsReportExportStart","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-export-start"},{"title":"analyticsReportPlan","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-plan"},{"title":"analyticsReportRevisionRestore","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-revision-restore"},{"title":"analyticsReportScheduleRemove","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-schedule-remove"},{"title":"analyticsReportScheduleSet","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-schedule-set"},{"title":"analyticsReportUpdate","href":"/docs/api-reference/v3/reference/analytics/mutations/analytics-report-update"}]},{"group":"Objects","pages":[{"title":"AnalyticsCatalogDefinition","href":"/docs/api-reference/v3/reference/analytics/analytics-catalog-definition"},{"title":"AnalyticsCatalogEntity","href":"/docs/api-reference/v3/reference/analytics/analytics-catalog-entity"},{"title":"AnalyticsCatalogEntityDetail","href":"/docs/api-reference/v3/reference/analytics/analytics-catalog-entity-detail"},{"title":"AnalyticsCatalogEntityDetails","href":"/docs/api-reference/v3/reference/analytics/analytics-catalog-entity-details"},{"title":"AnalyticsCatalogField","href":"/docs/api-reference/v3/reference/analytics/analytics-catalog-field"},{"title":"AnalyticsCatalogMatch","href":"/docs/api-reference/v3/reference/analytics/analytics-catalog-match"},{"title":"AnalyticsCatalogRelationship","href":"/docs/api-reference/v3/reference/analytics/analytics-catalog-relationship"},{"title":"AnalyticsFieldValue","href":"/docs/api-reference/v3/reference/analytics/analytics-field-value"},{"title":"AnalyticsFieldValues","href":"/docs/api-reference/v3/reference/analytics/analytics-field-values"},{"title":"AnalyticsReport","href":"/docs/api-reference/v3/reference/analytics/analytics-report"},{"title":"AnalyticsReportCadence","href":"/docs/api-reference/v3/reference/analytics/analytics-report-cadence"},{"title":"AnalyticsReportColumn","href":"/docs/api-reference/v3/reference/analytics/analytics-report-column"},{"title":"AnalyticsReportCreator","href":"/docs/api-reference/v3/reference/analytics/analytics-report-creator"},{"title":"AnalyticsReportDefinition","href":"/docs/api-reference/v3/reference/analytics/analytics-report-definition"},{"title":"AnalyticsReportExport","href":"/docs/api-reference/v3/reference/analytics/analytics-report-export"},{"title":"AnalyticsReportFilterDescription","href":"/docs/api-reference/v3/reference/analytics/analytics-report-filter-description"},{"title":"AnalyticsReportPlan","href":"/docs/api-reference/v3/reference/analytics/analytics-report-plan"},{"title":"AnalyticsReportPlanColumn","href":"/docs/api-reference/v3/reference/analytics/analytics-report-plan-column"},{"title":"AnalyticsReportResultColumn","href":"/docs/api-reference/v3/reference/analytics/analytics-report-result-column"},{"title":"AnalyticsReportRevision","href":"/docs/api-reference/v3/reference/analytics/analytics-report-revision"},{"title":"AnalyticsReportRow","href":"/docs/api-reference/v3/reference/analytics/analytics-report-row"},{"title":"AnalyticsReportSchedule","href":"/docs/api-reference/v3/reference/analytics/analytics-report-schedule"},{"title":"AnalyticsReportSort","href":"/docs/api-reference/v3/reference/analytics/analytics-report-sort"}]}]},{"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":"automationCheck","href":"/docs/api-reference/v3/reference/automations/queries/automation-check"},{"title":"automationExecuteTest","href":"/docs/api-reference/v3/reference/automations/queries/automation-execute-test"},{"title":"automationKinds","href":"/docs/api-reference/v3/reference/automations/queries/automation-kinds"},{"title":"automationRun","href":"/docs/api-reference/v3/reference/automations/queries/automation-run"},{"title":"automations","href":"/docs/api-reference/v3/reference/automations/queries/automations"}]},{"group":"Mutations","pages":[{"title":"automationCreate","href":"/docs/api-reference/v3/reference/automations/mutations/automation-create"},{"title":"automationDelete","href":"/docs/api-reference/v3/reference/automations/mutations/automation-delete"},{"title":"automationDraftUpdate","href":"/docs/api-reference/v3/reference/automations/mutations/automation-draft-update"},{"title":"automationExecute","href":"/docs/api-reference/v3/reference/automations/mutations/automation-execute"},{"title":"automationPublish","href":"/docs/api-reference/v3/reference/automations/mutations/automation-publish"},{"title":"automationUpdate","href":"/docs/api-reference/v3/reference/automations/mutations/automation-update"}]},{"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":"AutomationCheck","href":"/docs/api-reference/v3/reference/automations/automation-check"},{"title":"AutomationDefinition","href":"/docs/api-reference/v3/reference/automations/automation-definition"},{"title":"AutomationDiagnostic","href":"/docs/api-reference/v3/reference/automations/automation-diagnostic"},{"title":"AutomationFix","href":"/docs/api-reference/v3/reference/automations/automation-fix"},{"title":"AutomationKindInfo","href":"/docs/api-reference/v3/reference/automations/automation-kind-info"},{"title":"AutomationNodePosition","href":"/docs/api-reference/v3/reference/automations/automation-node-position"},{"title":"AutomationPort","href":"/docs/api-reference/v3/reference/automations/automation-port"},{"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":"AutomationStep","href":"/docs/api-reference/v3/reference/automations/automation-step"},{"title":"AutomationStepAnalysis","href":"/docs/api-reference/v3/reference/automations/automation-step-analysis"},{"title":"AutomationStepAvailability","href":"/docs/api-reference/v3/reference/automations/automation-step-availability"},{"title":"AutomationStepRecord","href":"/docs/api-reference/v3/reference/automations/automation-step-record"},{"title":"AutomationTestRequest","href":"/docs/api-reference/v3/reference/automations/automation-test-request"},{"title":"AutomationTestRun","href":"/docs/api-reference/v3/reference/automations/automation-test-run"},{"title":"AutomationTrigger","href":"/docs/api-reference/v3/reference/automations/automation-trigger"},{"title":"AutomationVersion","href":"/docs/api-reference/v3/reference/automations/automation-version"},{"title":"AutomationVersionRunCount","href":"/docs/api-reference/v3/reference/automations/automation-version-run-count"}]}]},{"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":"billingLabelChargeBreakdown","href":"/docs/api-reference/v3/reference/billing/queries/billing-label-charge-breakdown"},{"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"},{"title":"BillingLabelChargeAdjustment","href":"/docs/api-reference/v3/reference/billing/billing-label-charge-adjustment"},{"title":"BillingLabelChargeBreakdown","href":"/docs/api-reference/v3/reference/billing/billing-label-charge-breakdown"}]}]},{"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":"productCustomsUpdateJob","href":"/docs/api-reference/v3/reference/catalog/queries/product-customs-update-job"},{"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":"productCustomsUpdate","href":"/docs/api-reference/v3/reference/catalog/mutations/product-customs-update"},{"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":"Manufacturer","href":"/docs/api-reference/v3/reference/catalog/manufacturer"},{"title":"Product","href":"/docs/api-reference/v3/reference/catalog/product"},{"title":"ProductCustomsRowPreview","href":"/docs/api-reference/v3/reference/catalog/product-customs-row-preview"},{"title":"ProductCustomsUpdate","href":"/docs/api-reference/v3/reference/catalog/product-customs-update"},{"title":"ProductCustomsUpdateJob","href":"/docs/api-reference/v3/reference/catalog/product-customs-update-job"},{"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":"Chargebacks","root":{"title":"Chargebacks","href":"/docs/api-reference/v3/reference/disputes/overview"},"pages":[{"group":"Queries","pages":[{"title":"chargebackSettings","href":"/docs/api-reference/v3/reference/disputes/queries/chargeback-settings"},{"title":"dispute","href":"/docs/api-reference/v3/reference/disputes/queries/dispute"},{"title":"disputePaymentDetails","href":"/docs/api-reference/v3/reference/disputes/queries/dispute-payment-details"},{"title":"disputes","href":"/docs/api-reference/v3/reference/disputes/queries/disputes"}]},{"group":"Mutations","pages":[{"title":"chargebackPaypalConnect","href":"/docs/api-reference/v3/reference/disputes/mutations/chargeback-paypal-connect"},{"title":"chargebackPaypalDisconnect","href":"/docs/api-reference/v3/reference/disputes/mutations/chargeback-paypal-disconnect"},{"title":"chargebackProfileUpdate","href":"/docs/api-reference/v3/reference/disputes/mutations/chargeback-profile-update"},{"title":"chargebacksDisable","href":"/docs/api-reference/v3/reference/disputes/mutations/chargebacks-disable"},{"title":"chargebacksEnable","href":"/docs/api-reference/v3/reference/disputes/mutations/chargebacks-enable"},{"title":"chargebackSettingsUpdate","href":"/docs/api-reference/v3/reference/disputes/mutations/chargeback-settings-update"},{"title":"disputeAutoEvidenceSet","href":"/docs/api-reference/v3/reference/disputes/mutations/dispute-auto-evidence-set"},{"title":"disputeEvidenceSubmit","href":"/docs/api-reference/v3/reference/disputes/mutations/dispute-evidence-submit"},{"title":"disputeEvidenceUpdate","href":"/docs/api-reference/v3/reference/disputes/mutations/dispute-evidence-update"}]},{"group":"Objects","pages":[{"title":"ChargebackPaypalConnection","href":"/docs/api-reference/v3/reference/disputes/chargeback-paypal-connection"},{"title":"ChargebackProfile","href":"/docs/api-reference/v3/reference/disputes/chargeback-profile"},{"title":"ChargebackProfileSources","href":"/docs/api-reference/v3/reference/disputes/chargeback-profile-sources"},{"title":"ChargebackSettings","href":"/docs/api-reference/v3/reference/disputes/chargeback-settings"},{"title":"Dispute","href":"/docs/api-reference/v3/reference/disputes/dispute"},{"title":"DisputeEvidence","href":"/docs/api-reference/v3/reference/disputes/dispute-evidence"},{"title":"DisputePaymentDetails","href":"/docs/api-reference/v3/reference/disputes/dispute-payment-details"}]}]},{"group":"Checkout","root":{"title":"Checkout","href":"/docs/api-reference/v3/reference/checkout/overview"},"pages":[{"group":"Queries","pages":[{"title":"checkoutAbTest","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-ab-test"},{"title":"checkoutAbTestQueue","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-ab-test-queue"},{"title":"checkoutAbTestResults","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-ab-test-results"},{"title":"checkoutAbTests","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-ab-tests"},{"title":"checkoutAbTestSegmentResults","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-ab-test-segment-results"},{"title":"checkoutDiscountRule","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-discount-rule"},{"title":"checkoutDiscountRules","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-discount-rules"},{"title":"checkoutExperience","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-experience"},{"title":"checkoutExperiences","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-experiences"},{"title":"checkoutTree","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-tree"},{"title":"checkoutTreeCatalog","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-tree-catalog"},{"title":"checkoutTreeCheck","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-tree-check"},{"title":"checkoutTreeRevision","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-tree-revision"},{"title":"checkoutTrees","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-trees"},{"title":"checkoutWidget","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-widget"},{"title":"checkoutWidgets","href":"/docs/api-reference/v3/reference/checkout/queries/checkout-widgets"},{"title":"customShippingMethodCode","href":"/docs/api-reference/v3/reference/checkout/queries/custom-shipping-method-code"},{"title":"postPurchaseAbTests","href":"/docs/api-reference/v3/reference/checkout/queries/post-purchase-ab-tests"},{"title":"postPurchaseFlow","href":"/docs/api-reference/v3/reference/checkout/queries/post-purchase-flow"},{"title":"postPurchaseFlowCheck","href":"/docs/api-reference/v3/reference/checkout/queries/post-purchase-flow-check"},{"title":"postPurchaseFlowRevision","href":"/docs/api-reference/v3/reference/checkout/queries/post-purchase-flow-revision"},{"title":"postPurchaseProviderStatus","href":"/docs/api-reference/v3/reference/checkout/queries/post-purchase-provider-status"},{"title":"shippingAiExperienceResults","href":"/docs/api-reference/v3/reference/checkout/queries/shipping-ai-experience-results"},{"title":"shippingAiResults","href":"/docs/api-reference/v3/reference/checkout/queries/shipping-ai-results"},{"title":"storefrontDeliveryEstimate","href":"/docs/api-reference/v3/reference/checkout/queries/storefront-delivery-estimate"},{"title":"storefrontProgressBar","href":"/docs/api-reference/v3/reference/checkout/queries/storefront-progress-bar"},{"title":"subscriptionDeliveryProfile","href":"/docs/api-reference/v3/reference/checkout/queries/subscription-delivery-profile"},{"title":"upsellPage","href":"/docs/api-reference/v3/reference/checkout/queries/upsell-page"},{"title":"upsellPages","href":"/docs/api-reference/v3/reference/checkout/queries/upsell-pages"}]},{"group":"Mutations","pages":[{"title":"checkoutAbTestConclude","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-ab-test-conclude"},{"title":"checkoutAbTestDelete","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-ab-test-delete"},{"title":"checkoutAbTestQueueReorder","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-ab-test-queue-reorder"},{"title":"checkoutAbTestSchedule","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-ab-test-schedule"},{"title":"checkoutAbTestStart","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-ab-test-start"},{"title":"checkoutDiscountRuleCreate","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-discount-rule-create"},{"title":"checkoutDiscountRuleDelete","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-discount-rule-delete"},{"title":"checkoutDiscountRuleSetActive","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-discount-rule-set-active"},{"title":"checkoutDiscountRulesReorder","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-discount-rules-reorder"},{"title":"checkoutDiscountRulesSetEnabled","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-discount-rules-set-enabled"},{"title":"checkoutDiscountRuleUpdate","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-discount-rule-update"},{"title":"checkoutExperienceUpsellPageSet","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-experience-upsell-page-set"},{"title":"checkoutExperienceWidgetsSet","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-experience-widgets-set"},{"title":"checkoutTreeCreate","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-tree-create"},{"title":"checkoutTreePublish","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-tree-publish"},{"title":"checkoutWidgetCreate","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-widget-create"},{"title":"checkoutWidgetDelete","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-widget-delete"},{"title":"checkoutWidgetDuplicate","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-widget-duplicate"},{"title":"checkoutWidgetUpdate","href":"/docs/api-reference/v3/reference/checkout/mutations/checkout-widget-update"},{"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":"postPurchaseAbTestConclude","href":"/docs/api-reference/v3/reference/checkout/mutations/post-purchase-ab-test-conclude"},{"title":"postPurchaseFlowPublish","href":"/docs/api-reference/v3/reference/checkout/mutations/post-purchase-flow-publish"},{"title":"setAutoSelectedShippingMethods","href":"/docs/api-reference/v3/reference/checkout/mutations/set-auto-selected-shipping-methods"},{"title":"storefrontDeliveryEstimateUpdate","href":"/docs/api-reference/v3/reference/checkout/mutations/storefront-delivery-estimate-update"},{"title":"storefrontProgressBarUpdate","href":"/docs/api-reference/v3/reference/checkout/mutations/storefront-progress-bar-update"},{"title":"subscriptionDeliveryProfileUpdate","href":"/docs/api-reference/v3/reference/checkout/mutations/subscription-delivery-profile-update"},{"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"},{"title":"upsellPageCreate","href":"/docs/api-reference/v3/reference/checkout/mutations/upsell-page-create"},{"title":"upsellPageDelete","href":"/docs/api-reference/v3/reference/checkout/mutations/upsell-page-delete"},{"title":"upsellPageDuplicate","href":"/docs/api-reference/v3/reference/checkout/mutations/upsell-page-duplicate"},{"title":"upsellPageUpdate","href":"/docs/api-reference/v3/reference/checkout/mutations/upsell-page-update"}]},{"group":"Objects","pages":[{"title":"CheckoutAbTest","href":"/docs/api-reference/v3/reference/checkout/checkout-ab-test"},{"title":"CheckoutAbTestMetricValue","href":"/docs/api-reference/v3/reference/checkout/checkout-ab-test-metric-value"},{"title":"CheckoutAbTestResults","href":"/docs/api-reference/v3/reference/checkout/checkout-ab-test-results"},{"title":"CheckoutAbTestSegment","href":"/docs/api-reference/v3/reference/checkout/checkout-ab-test-segment"},{"title":"CheckoutAbTestSegmentResults","href":"/docs/api-reference/v3/reference/checkout/checkout-ab-test-segment-results"},{"title":"CheckoutAbTestSegmentTreatment","href":"/docs/api-reference/v3/reference/checkout/checkout-ab-test-segment-treatment"},{"title":"CheckoutAbTestTreatment","href":"/docs/api-reference/v3/reference/checkout/checkout-ab-test-treatment"},{"title":"CheckoutDiscountRule","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule"},{"title":"CheckoutDiscountRuleCartTotalCondition","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-cart-total-condition"},{"title":"CheckoutDiscountRuleCollectionsCondition","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-collections-condition"},{"title":"CheckoutDiscountRuleConditionBlock","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-condition-block"},{"title":"CheckoutDiscountRuleConditions","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-conditions"},{"title":"CheckoutDiscountRuleCustomerOrderCountCondition","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-customer-order-count-condition"},{"title":"CheckoutDiscountRuleDeliveryOptionFilter","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-delivery-option-filter"},{"title":"CheckoutDiscountRuleFixedAmountDiscount","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-fixed-amount-discount"},{"title":"CheckoutDiscountRulePercentageDiscount","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-percentage-discount"},{"title":"CheckoutDiscountRuleProductsCondition","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-products-condition"},{"title":"CheckoutDiscountRules","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rules"},{"title":"CheckoutDiscountRulesEligibility","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rules-eligibility"},{"title":"CheckoutDiscountRuleShippingTarget","href":"/docs/api-reference/v3/reference/checkout/checkout-discount-rule-shipping-target"},{"title":"CheckoutExperience","href":"/docs/api-reference/v3/reference/checkout/checkout-experience"},{"title":"CheckoutExperienceSummary","href":"/docs/api-reference/v3/reference/checkout/checkout-experience-summary"},{"title":"CheckoutTree","href":"/docs/api-reference/v3/reference/checkout/checkout-tree"},{"title":"CheckoutTreeCatalogEntry","href":"/docs/api-reference/v3/reference/checkout/checkout-tree-catalog-entry"},{"title":"CheckoutTreeCatalogListing","href":"/docs/api-reference/v3/reference/checkout/checkout-tree-catalog-listing"},{"title":"CheckoutTreeDefinition","href":"/docs/api-reference/v3/reference/checkout/checkout-tree-definition"},{"title":"CheckoutTreeDiagnostic","href":"/docs/api-reference/v3/reference/checkout/checkout-tree-diagnostic"},{"title":"CheckoutTreeRisk","href":"/docs/api-reference/v3/reference/checkout/checkout-tree-risk"},{"title":"CheckoutTreeStep","href":"/docs/api-reference/v3/reference/checkout/checkout-tree-step"},{"title":"CheckoutTreeSummary","href":"/docs/api-reference/v3/reference/checkout/checkout-tree-summary"},{"title":"CheckoutWidget","href":"/docs/api-reference/v3/reference/checkout/checkout-widget"},{"title":"CheckoutWidgetAssignedExperience","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-assigned-experience"},{"title":"CheckoutWidgetCollectionSource","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-collection-source"},{"title":"CheckoutWidgetContentBlockConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-content-block-config"},{"title":"CheckoutWidgetContentSection","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-content-section"},{"title":"CheckoutWidgetFailedDiscountRescueConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-failed-discount-rescue-config"},{"title":"CheckoutWidgetFixedAmountDiscount","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-fixed-amount-discount"},{"title":"CheckoutWidgetFulfillmentCutoffConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-fulfillment-cutoff-config"},{"title":"CheckoutWidgetImageBlockConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-image-block-config"},{"title":"CheckoutWidgetLowProfileProductUpsellConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-low-profile-product-upsell-config"},{"title":"CheckoutWidgetPercentageDiscount","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-percentage-discount"},{"title":"CheckoutWidgetProductReviewsConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-product-reviews-config"},{"title":"CheckoutWidgetProductSource","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-product-source"},{"title":"CheckoutWidgetRedoAiSource","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-redo-ai-source"},{"title":"CheckoutWidgetReviewsDisplay","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-reviews-display"},{"title":"CheckoutWidgets","href":"/docs/api-reference/v3/reference/checkout/checkout-widgets"},{"title":"CheckoutWidgetsAvailability","href":"/docs/api-reference/v3/reference/checkout/checkout-widgets-availability"},{"title":"CheckoutWidgetShippingOptionContentConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-shipping-option-content-config"},{"title":"CheckoutWidgetShippingOptionImageConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-shipping-option-image-config"},{"title":"CheckoutWidgetShippingOptionProductUpsellConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-shipping-option-product-upsell-config"},{"title":"CheckoutWidgetTagsSource","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-tags-source"},{"title":"CheckoutWidgetThresholdUpsellConfig","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-threshold-upsell-config"},{"title":"CheckoutWidgetUpsellProgressBar","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-upsell-progress-bar"},{"title":"CheckoutWidgetUpsellStyling","href":"/docs/api-reference/v3/reference/checkout/checkout-widget-upsell-styling"},{"title":"CustomShippingMethodCode","href":"/docs/api-reference/v3/reference/checkout/custom-shipping-method-code"},{"title":"CustomShippingMethodSource","href":"/docs/api-reference/v3/reference/checkout/custom-shipping-method-source"},{"title":"PostPurchaseAbTest","href":"/docs/api-reference/v3/reference/checkout/post-purchase-ab-test"},{"title":"PostPurchaseAbTestTreatment","href":"/docs/api-reference/v3/reference/checkout/post-purchase-ab-test-treatment"},{"title":"PostPurchaseCustomerTagsCondition","href":"/docs/api-reference/v3/reference/checkout/post-purchase-customer-tags-condition"},{"title":"PostPurchaseFlow","href":"/docs/api-reference/v3/reference/checkout/post-purchase-flow"},{"title":"PostPurchaseFlowCheck","href":"/docs/api-reference/v3/reference/checkout/post-purchase-flow-check"},{"title":"PostPurchaseFlowDiagnostic","href":"/docs/api-reference/v3/reference/checkout/post-purchase-flow-diagnostic"},{"title":"PostPurchaseFlowRisk","href":"/docs/api-reference/v3/reference/checkout/post-purchase-flow-risk"},{"title":"PostPurchaseFlowSplit","href":"/docs/api-reference/v3/reference/checkout/post-purchase-flow-split"},{"title":"PostPurchaseFlowStep","href":"/docs/api-reference/v3/reference/checkout/post-purchase-flow-step"},{"title":"PostPurchaseMetafield","href":"/docs/api-reference/v3/reference/checkout/post-purchase-metafield"},{"title":"PostPurchaseOrderValueCondition","href":"/docs/api-reference/v3/reference/checkout/post-purchase-order-value-condition"},{"title":"PostPurchasePreviousOrderCountCondition","href":"/docs/api-reference/v3/reference/checkout/post-purchase-previous-order-count-condition"},{"title":"PostPurchaseProductCollectionsCondition","href":"/docs/api-reference/v3/reference/checkout/post-purchase-product-collections-condition"},{"title":"PostPurchaseProductMetafieldsCondition","href":"/docs/api-reference/v3/reference/checkout/post-purchase-product-metafields-condition"},{"title":"PostPurchaseProductsOrderedCondition","href":"/docs/api-reference/v3/reference/checkout/post-purchase-products-ordered-condition"},{"title":"PostPurchaseProductTagsCondition","href":"/docs/api-reference/v3/reference/checkout/post-purchase-product-tags-condition"},{"title":"PostPurchaseProviderStatus","href":"/docs/api-reference/v3/reference/checkout/post-purchase-provider-status"},{"title":"PostPurchaseSegment","href":"/docs/api-reference/v3/reference/checkout/post-purchase-segment"},{"title":"PostPurchaseSegmentBlock","href":"/docs/api-reference/v3/reference/checkout/post-purchase-segment-block"},{"title":"PostPurchaseVariantFilter","href":"/docs/api-reference/v3/reference/checkout/post-purchase-variant-filter"},{"title":"ShippingAiExperienceResults","href":"/docs/api-reference/v3/reference/checkout/shipping-ai-experience-results"},{"title":"ShippingAiMarginPoint","href":"/docs/api-reference/v3/reference/checkout/shipping-ai-margin-point"},{"title":"ShippingAiMethodResults","href":"/docs/api-reference/v3/reference/checkout/shipping-ai-method-results"},{"title":"ShippingAiPriceBucket","href":"/docs/api-reference/v3/reference/checkout/shipping-ai-price-bucket"},{"title":"ShippingAiResults","href":"/docs/api-reference/v3/reference/checkout/shipping-ai-results"},{"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"},{"title":"StorefrontDeliveryEstimate","href":"/docs/api-reference/v3/reference/checkout/storefront-delivery-estimate"},{"title":"StorefrontDeliveryEstimateRange","href":"/docs/api-reference/v3/reference/checkout/storefront-delivery-estimate-range"},{"title":"StorefrontProgressBar","href":"/docs/api-reference/v3/reference/checkout/storefront-progress-bar"},{"title":"StorefrontSelector","href":"/docs/api-reference/v3/reference/checkout/storefront-selector"},{"title":"SubscriptionDeliveryProfile","href":"/docs/api-reference/v3/reference/checkout/subscription-delivery-profile"},{"title":"UpsellPage","href":"/docs/api-reference/v3/reference/checkout/upsell-page"},{"title":"UpsellPageBanner","href":"/docs/api-reference/v3/reference/checkout/upsell-page-banner"},{"title":"UpsellPageProduct","href":"/docs/api-reference/v3/reference/checkout/upsell-page-product"},{"title":"UpsellPageTimer","href":"/docs/api-reference/v3/reference/checkout/upsell-page-timer"}]}]},{"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":"commerceAgentConfig","href":"/docs/api-reference/v3/reference/commerce-agent/queries/commerce-agent-config"},{"title":"commerceAgentConfigChanges","href":"/docs/api-reference/v3/reference/commerce-agent/queries/commerce-agent-config-changes"},{"title":"commerceAgentConversation","href":"/docs/api-reference/v3/reference/commerce-agent/queries/commerce-agent-conversation"},{"title":"commerceAgentConversations","href":"/docs/api-reference/v3/reference/commerce-agent/queries/commerce-agent-conversations"},{"title":"discountOffer","href":"/docs/api-reference/v3/reference/commerce-agent/queries/discount-offer"},{"title":"discountOffers","href":"/docs/api-reference/v3/reference/commerce-agent/queries/discount-offers"},{"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":"commerceAgentConfigDraftUpdate","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/commerce-agent-config-draft-update"},{"title":"commerceAgentConfigPublish","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/commerce-agent-config-publish"},{"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":"discountOfferCreate","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/discount-offer-create"},{"title":"discountOfferDelete","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/discount-offer-delete"},{"title":"discountOfferPause","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/discount-offer-pause"},{"title":"discountOffersReorder","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/discount-offers-reorder"},{"title":"discountOfferUnpause","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/discount-offer-unpause"},{"title":"discountOfferUpdate","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/discount-offer-update"},{"title":"knowledgeArticlePublish","href":"/docs/api-reference/v3/reference/commerce-agent/mutations/knowledge-article-publish"},{"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":"CommerceAgentConfig","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config"},{"title":"CommerceAgentConfigCapabilities","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-capabilities"},{"title":"CommerceAgentConfigCapabilityGuidance","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-capability-guidance"},{"title":"CommerceAgentConfigChange","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-change"},{"title":"CommerceAgentConfigChannel","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-channel"},{"title":"CommerceAgentConfigChannels","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-channels"},{"title":"CommerceAgentConfigDiscount","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-discount"},{"title":"CommerceAgentConfigEscalation","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-escalation"},{"title":"CommerceAgentConfigEscalationGuideline","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-escalation-guideline"},{"title":"CommerceAgentConfigReturnWindowGrace","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-return-window-grace"},{"title":"CommerceAgentConfigTone","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-config-tone"},{"title":"CommerceAgentConversation","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-conversation"},{"title":"CommerceAgentMessage","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-message"},{"title":"CommerceAgentOutreach","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-outreach"},{"title":"CommerceAgentToneRange","href":"/docs/api-reference/v3/reference/commerce-agent/commerce-agent-tone-range"},{"title":"DiscountOffer","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer"},{"title":"DiscountOfferCartCollectionsCondition","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-collections-condition"},{"title":"DiscountOfferCartConditionBlock","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-condition-block"},{"title":"DiscountOfferCartConditions","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-conditions"},{"title":"DiscountOfferCartDiscountCodeCondition","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-discount-code-condition"},{"title":"DiscountOfferCartDiscountPercentageCondition","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-discount-percentage-condition"},{"title":"DiscountOfferCartOutOfStockCondition","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-out-of-stock-condition"},{"title":"DiscountOfferCartProduct","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-product"},{"title":"DiscountOfferCartProductsCondition","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-products-condition"},{"title":"DiscountOfferCartProductTagsCondition","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-product-tags-condition"},{"title":"DiscountOfferCartQuantityCondition","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-quantity-condition"},{"title":"DiscountOfferCartSubtotalCondition","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-cart-subtotal-condition"},{"title":"DiscountOfferConditionsAudience","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-conditions-audience"},{"title":"DiscountOfferDiscount","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-discount"},{"title":"DiscountOfferEveryoneAudience","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-everyone-audience"},{"title":"DiscountOfferSegmentsAudience","href":"/docs/api-reference/v3/reference/commerce-agent/discount-offer-segments-audience"},{"title":"KnowledgeArticle","href":"/docs/api-reference/v3/reference/commerce-agent/knowledge-article"},{"title":"KnowledgeArticleChange","href":"/docs/api-reference/v3/reference/commerce-agent/knowledge-article-change"},{"title":"KnowledgeArticleDraft","href":"/docs/api-reference/v3/reference/commerce-agent/knowledge-article-draft"}]}]},{"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":"Mutations","pages":[{"title":"cartonManifestExport","href":"/docs/api-reference/v3/reference/common/mutations/carton-manifest-export"},{"title":"consolidationManifestExport","href":"/docs/api-reference/v3/reference/common/mutations/consolidation-manifest-export"},{"title":"inventoryContainerLabelExport","href":"/docs/api-reference/v3/reference/common/mutations/inventory-container-label-export"},{"title":"shopperSessionCreate","href":"/docs/api-reference/v3/reference/common/mutations/shopper-session-create"}]},{"group":"Objects","pages":[{"title":"ApiToken","href":"/docs/api-reference/v3/reference/common/api-token"},{"title":"GeneratedDocument","href":"/docs/api-reference/v3/reference/common/generated-document"},{"title":"GeoCoordinates","href":"/docs/api-reference/v3/reference/common/geo-coordinates"},{"title":"Job","href":"/docs/api-reference/v3/reference/common/job"},{"title":"JobError","href":"/docs/api-reference/v3/reference/common/job-error"},{"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"},{"title":"ShopperCredentials","href":"/docs/api-reference/v3/reference/common/shopper-credentials"},{"title":"ShopperSession","href":"/docs/api-reference/v3/reference/common/shopper-session"},{"title":"TeamMember","href":"/docs/api-reference/v3/reference/common/team-member"},{"title":"TimeBlock","href":"/docs/api-reference/v3/reference/common/time-block"}]}]},{"group":"Consolidations","root":{"title":"Consolidations","href":"/docs/api-reference/v3/reference/consolidations/overview"},"pages":[{"group":"Queries","pages":[{"title":"carton","href":"/docs/api-reference/v3/reference/consolidations/queries/carton"},{"title":"cartons","href":"/docs/api-reference/v3/reference/consolidations/queries/cartons"},{"title":"consolidation","href":"/docs/api-reference/v3/reference/consolidations/queries/consolidation"},{"title":"consolidationDocuments","href":"/docs/api-reference/v3/reference/consolidations/queries/consolidation-documents"},{"title":"consolidations","href":"/docs/api-reference/v3/reference/consolidations/queries/consolidations"}]},{"group":"Mutations","pages":[{"title":"consolidationCommercialInvoiceExport","href":"/docs/api-reference/v3/reference/consolidations/mutations/consolidation-commercial-invoice-export"}]},{"group":"Objects","pages":[{"title":"Carton","href":"/docs/api-reference/v3/reference/consolidations/carton"},{"title":"CommercialInvoiceExport","href":"/docs/api-reference/v3/reference/consolidations/commercial-invoice-export"},{"title":"CommercialInvoiceWarning","href":"/docs/api-reference/v3/reference/consolidations/commercial-invoice-warning"},{"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"},{"title":"DocumentOption","href":"/docs/api-reference/v3/reference/consolidations/document-option"}]}]},{"group":"Customers","root":{"title":"Customers","href":"/docs/api-reference/v3/reference/customers/overview"},"pages":[{"group":"Queries","pages":[{"title":"customer","href":"/docs/api-reference/v3/reference/customers/queries/customer"},{"title":"customers","href":"/docs/api-reference/v3/reference/customers/queries/customers"}]},{"group":"Mutations","pages":[{"title":"customerTagsAdd","href":"/docs/api-reference/v3/reference/customers/mutations/customer-tags-add"},{"title":"customerTagsRemove","href":"/docs/api-reference/v3/reference/customers/mutations/customer-tags-remove"}]},{"group":"Objects","pages":[{"title":"Customer","href":"/docs/api-reference/v3/reference/customers/customer"},{"title":"CustomerLocation","href":"/docs/api-reference/v3/reference/customers/customer-location"}]}]},{"group":"Developer","root":{"title":"Developer","href":"/docs/api-reference/v3/reference/developer/overview"},"pages":[{"group":"Queries","pages":[{"title":"developerConnection","href":"/docs/api-reference/v3/reference/developer/queries/developer-connection"},{"title":"developerConnections","href":"/docs/api-reference/v3/reference/developer/queries/developer-connections"},{"title":"developerLogEntries","href":"/docs/api-reference/v3/reference/developer/queries/developer-log-entries"},{"title":"developerLogEntry","href":"/docs/api-reference/v3/reference/developer/queries/developer-log-entry"},{"title":"inboundWebhook","href":"/docs/api-reference/v3/reference/developer/queries/inbound-webhook"},{"title":"inboundWebhooks","href":"/docs/api-reference/v3/reference/developer/queries/inbound-webhooks"},{"title":"redoFunction","href":"/docs/api-reference/v3/reference/developer/queries/redo-function"},{"title":"redoFunctions","href":"/docs/api-reference/v3/reference/developer/queries/redo-functions"}]},{"group":"Mutations","pages":[{"title":"developerConnectionAuthorize","href":"/docs/api-reference/v3/reference/developer/mutations/developer-connection-authorize"},{"title":"developerConnectionCreate","href":"/docs/api-reference/v3/reference/developer/mutations/developer-connection-create"},{"title":"developerConnectionDelete","href":"/docs/api-reference/v3/reference/developer/mutations/developer-connection-delete"},{"title":"developerConnectionSecretSet","href":"/docs/api-reference/v3/reference/developer/mutations/developer-connection-secret-set"},{"title":"developerConnectionTest","href":"/docs/api-reference/v3/reference/developer/mutations/developer-connection-test"},{"title":"developerConnectionUpdate","href":"/docs/api-reference/v3/reference/developer/mutations/developer-connection-update"},{"title":"inboundWebhookCreate","href":"/docs/api-reference/v3/reference/developer/mutations/inbound-webhook-create"},{"title":"inboundWebhookDelete","href":"/docs/api-reference/v3/reference/developer/mutations/inbound-webhook-delete"},{"title":"inboundWebhookSecretSet","href":"/docs/api-reference/v3/reference/developer/mutations/inbound-webhook-secret-set"},{"title":"inboundWebhookUpdate","href":"/docs/api-reference/v3/reference/developer/mutations/inbound-webhook-update"},{"title":"inboundWebhookUrlRotate","href":"/docs/api-reference/v3/reference/developer/mutations/inbound-webhook-url-rotate"}]},{"group":"Objects","pages":[{"title":"DeveloperConnection","href":"/docs/api-reference/v3/reference/developer/developer-connection"},{"title":"DeveloperConnectionAuthorization","href":"/docs/api-reference/v3/reference/developer/developer-connection-authorization"},{"title":"DeveloperLogApiRequest","href":"/docs/api-reference/v3/reference/developer/developer-log-api-request"},{"title":"DeveloperLogBody","href":"/docs/api-reference/v3/reference/developer/developer-log-body"},{"title":"DeveloperLogEntry","href":"/docs/api-reference/v3/reference/developer/developer-log-entry"},{"title":"DeveloperLogFunctionRun","href":"/docs/api-reference/v3/reference/developer/developer-log-function-run"},{"title":"DeveloperLogWebhookDelivery","href":"/docs/api-reference/v3/reference/developer/developer-log-webhook-delivery"},{"title":"HttpConnectionAuthorization","href":"/docs/api-reference/v3/reference/developer/http-connection-authorization"},{"title":"HttpDeveloperConnection","href":"/docs/api-reference/v3/reference/developer/http-developer-connection"},{"title":"HttpDeveloperConnectionCredential","href":"/docs/api-reference/v3/reference/developer/http-developer-connection-credential"},{"title":"HttpTokenEndpoint","href":"/docs/api-reference/v3/reference/developer/http-token-endpoint"},{"title":"HttpTokenRequestParameter","href":"/docs/api-reference/v3/reference/developer/http-token-request-parameter"},{"title":"InboundWebhook","href":"/docs/api-reference/v3/reference/developer/inbound-webhook"},{"title":"RedoFunction","href":"/docs/api-reference/v3/reference/developer/redo-function"},{"title":"RedoFunctionDeployment","href":"/docs/api-reference/v3/reference/developer/redo-function-deployment"}]}]},{"group":"Events","root":{"title":"Events","href":"/docs/api-reference/v3/reference/events/overview"},"pages":[{"group":"Queries","pages":[{"title":"customerEvents","href":"/docs/api-reference/v3/reference/events/queries/customer-events"}]},{"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":"CustomerEvent","href":"/docs/api-reference/v3/reference/events/customer-event"},{"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":"hsaPaymentSettings","href":"/docs/api-reference/v3/reference/payments/queries/hsa-payment-settings"},{"title":"paymentTransactions","href":"/docs/api-reference/v3/reference/payments/queries/payment-transactions"},{"title":"paymentTransactionsExport","href":"/docs/api-reference/v3/reference/payments/queries/payment-transactions-export"},{"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":"payoutReportSettings","href":"/docs/api-reference/v3/reference/payments/queries/payout-report-settings"},{"title":"payouts","href":"/docs/api-reference/v3/reference/payments/queries/payouts"}]},{"group":"Mutations","pages":[{"title":"hsaPaymentSettingsUpdate","href":"/docs/api-reference/v3/reference/payments/mutations/hsa-payment-settings-update"},{"title":"payoutReportSettingsUpdate","href":"/docs/api-reference/v3/reference/payments/mutations/payout-report-settings-update"}]},{"group":"Objects","pages":[{"title":"HsaPaymentSettings","href":"/docs/api-reference/v3/reference/payments/hsa-payment-settings"},{"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":"PaymentTransactionsExport","href":"/docs/api-reference/v3/reference/payments/payment-transactions-export"},{"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"},{"title":"PayoutReportSettings","href":"/docs/api-reference/v3/reference/payments/payout-report-settings"}]}]},{"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":"cycleCount","href":"/docs/api-reference/v3/reference/inventory/queries/cycle-count"},{"title":"cycleCounts","href":"/docs/api-reference/v3/reference/inventory/queries/cycle-counts"},{"title":"cycleCountsSearch","href":"/docs/api-reference/v3/reference/inventory/queries/cycle-counts-search"},{"title":"inventoryContainer","href":"/docs/api-reference/v3/reference/inventory/queries/inventory-container"},{"title":"inventoryContainers","href":"/docs/api-reference/v3/reference/inventory/queries/inventory-containers"},{"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"},{"title":"Transfer","href":"/docs/api-reference/v3/reference/inventory/queries/transfer"},{"title":"Transfers","href":"/docs/api-reference/v3/reference/inventory/queries/transfers"}]},{"group":"Mutations","pages":[{"title":"inventoryContainerAddItem","href":"/docs/api-reference/v3/reference/inventory/mutations/inventory-container-add-item"},{"title":"inventoryContainerCreate","href":"/docs/api-reference/v3/reference/inventory/mutations/inventory-container-create"},{"title":"inventoryContainerLabelPrint","href":"/docs/api-reference/v3/reference/inventory/mutations/inventory-container-label-print"},{"title":"inventoryContainerUndoAddItem","href":"/docs/api-reference/v3/reference/inventory/mutations/inventory-container-undo-add-item"}]},{"group":"Objects","pages":[{"title":"BinInventoryLevel","href":"/docs/api-reference/v3/reference/inventory/bin-inventory-level"},{"title":"CycleCount","href":"/docs/api-reference/v3/reference/inventory/cycle-count"},{"title":"CycleCountPlan","href":"/docs/api-reference/v3/reference/inventory/cycle-count-plan"},{"title":"InventoryContainer","href":"/docs/api-reference/v3/reference/inventory/inventory-container"},{"title":"InventoryContainerItem","href":"/docs/api-reference/v3/reference/inventory/inventory-container-item"},{"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"},{"title":"Transfer","href":"/docs/api-reference/v3/reference/inventory/transfer"},{"title":"Transfer item","href":"/docs/api-reference/v3/reference/inventory/transfer-item"}]}]},{"group":"Marketing","root":{"title":"Marketing","href":"/docs/api-reference/v3/reference/marketing/overview"},"pages":[{"group":"Queries","pages":[{"title":"attributionSettings","href":"/docs/api-reference/v3/reference/marketing/queries/attribution-settings"},{"title":"backInStockSubscriptions","href":"/docs/api-reference/v3/reference/marketing/queries/back-in-stock-subscriptions"},{"title":"campaign","href":"/docs/api-reference/v3/reference/marketing/queries/campaign"},{"title":"campaigns","href":"/docs/api-reference/v3/reference/marketing/queries/campaigns"},{"title":"campaignSendCheck","href":"/docs/api-reference/v3/reference/marketing/queries/campaign-send-check"},{"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":"customerCustomFieldDeclaration","href":"/docs/api-reference/v3/reference/marketing/queries/customer-custom-field-declaration"},{"title":"customerCustomFieldDeclarations","href":"/docs/api-reference/v3/reference/marketing/queries/customer-custom-field-declarations"},{"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":"emailDomain","href":"/docs/api-reference/v3/reference/marketing/queries/email-domain"},{"title":"emailDomains","href":"/docs/api-reference/v3/reference/marketing/queries/email-domains"},{"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":"generatedDiscountCodes","href":"/docs/api-reference/v3/reference/marketing/queries/generated-discount-codes"},{"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":"marketingEmailSettings","href":"/docs/api-reference/v3/reference/marketing/queries/marketing-email-settings"},{"title":"messageDecisions","href":"/docs/api-reference/v3/reference/marketing/queries/message-decisions"},{"title":"orderLookup","href":"/docs/api-reference/v3/reference/marketing/queries/order-lookup"},{"title":"popup","href":"/docs/api-reference/v3/reference/marketing/queries/popup"},{"title":"popups","href":"/docs/api-reference/v3/reference/marketing/queries/popups"},{"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":"smsKeyword","href":"/docs/api-reference/v3/reference/marketing/queries/sms-keyword"},{"title":"smsKeywords","href":"/docs/api-reference/v3/reference/marketing/queries/sms-keywords"},{"title":"smsTemplate","href":"/docs/api-reference/v3/reference/marketing/queries/sms-template"},{"title":"smsTemplates","href":"/docs/api-reference/v3/reference/marketing/queries/sms-templates"},{"title":"trackingPage","href":"/docs/api-reference/v3/reference/marketing/queries/tracking-page"},{"title":"trackingPageBlockSchema","href":"/docs/api-reference/v3/reference/marketing/queries/tracking-page-block-schema"},{"title":"trackingPages","href":"/docs/api-reference/v3/reference/marketing/queries/tracking-pages"}]},{"group":"Mutations","pages":[{"title":"attributionSettingsReset","href":"/docs/api-reference/v3/reference/marketing/mutations/attribution-settings-reset"},{"title":"attributionSettingsUpdate","href":"/docs/api-reference/v3/reference/marketing/mutations/attribution-settings-update"},{"title":"campaignSend","href":"/docs/api-reference/v3/reference/marketing/mutations/campaign-send"},{"title":"cancelCampaign","href":"/docs/api-reference/v3/reference/marketing/mutations/cancel-campaign"},{"title":"commerceAgentStrategyPublish","href":"/docs/api-reference/v3/reference/marketing/mutations/commerce-agent-strategy-publish"},{"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":"createSampledSegment","href":"/docs/api-reference/v3/reference/marketing/mutations/create-sampled-segment"},{"title":"createSmsTemplate","href":"/docs/api-reference/v3/reference/marketing/mutations/create-sms-template"},{"title":"customerCustomFieldDeclarationCreate","href":"/docs/api-reference/v3/reference/marketing/mutations/customer-custom-field-declaration-create"},{"title":"customerCustomFieldDeclarationDelete","href":"/docs/api-reference/v3/reference/marketing/mutations/customer-custom-field-declaration-delete"},{"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":"duplicateCampaign","href":"/docs/api-reference/v3/reference/marketing/mutations/duplicate-campaign"},{"title":"duplicateMarketingAutomation","href":"/docs/api-reference/v3/reference/marketing/mutations/duplicate-marketing-automation"},{"title":"emailDomainCreate","href":"/docs/api-reference/v3/reference/marketing/mutations/email-domain-create"},{"title":"emailDomainDelete","href":"/docs/api-reference/v3/reference/marketing/mutations/email-domain-delete"},{"title":"emailDomainMailFromSet","href":"/docs/api-reference/v3/reference/marketing/mutations/email-domain-mail-from-set"},{"title":"emailDomainVerify","href":"/docs/api-reference/v3/reference/marketing/mutations/email-domain-verify"},{"title":"emailSenderCreate","href":"/docs/api-reference/v3/reference/marketing/mutations/email-sender-create"},{"title":"emailSenderDelete","href":"/docs/api-reference/v3/reference/marketing/mutations/email-sender-delete"},{"title":"emailSenderSendVerification","href":"/docs/api-reference/v3/reference/marketing/mutations/email-sender-send-verification"},{"title":"emailSenderUpdate","href":"/docs/api-reference/v3/reference/marketing/mutations/email-sender-update"},{"title":"emailTemplateLocalizationSave","href":"/docs/api-reference/v3/reference/marketing/mutations/email-template-localization-save"},{"title":"emailTemplateSendTest","href":"/docs/api-reference/v3/reference/marketing/mutations/email-template-send-test"},{"title":"emailTemplateTranslate","href":"/docs/api-reference/v3/reference/marketing/mutations/email-template-translate"},{"title":"marketingContactsSuppress","href":"/docs/api-reference/v3/reference/marketing/mutations/marketing-contacts-suppress"},{"title":"marketingContactsUnsuppress","href":"/docs/api-reference/v3/reference/marketing/mutations/marketing-contacts-unsuppress"},{"title":"marketingEmailSettingsUpdate","href":"/docs/api-reference/v3/reference/marketing/mutations/marketing-email-settings-update"},{"title":"orderLookupCreate","href":"/docs/api-reference/v3/reference/marketing/mutations/order-lookup-create"},{"title":"productBackInStockNotify","href":"/docs/api-reference/v3/reference/marketing/mutations/product-back-in-stock-notify"},{"title":"revertMarketingAutomation","href":"/docs/api-reference/v3/reference/marketing/mutations/revert-marketing-automation"},{"title":"segmentsDelete","href":"/docs/api-reference/v3/reference/marketing/mutations/segments-delete"},{"title":"smsKeywordCreate","href":"/docs/api-reference/v3/reference/marketing/mutations/sms-keyword-create"},{"title":"smsKeywordDelete","href":"/docs/api-reference/v3/reference/marketing/mutations/sms-keyword-delete"},{"title":"smsKeywordUpdate","href":"/docs/api-reference/v3/reference/marketing/mutations/sms-keyword-update"},{"title":"trackingPageCreate","href":"/docs/api-reference/v3/reference/marketing/mutations/tracking-page-create"},{"title":"trackingPageDelete","href":"/docs/api-reference/v3/reference/marketing/mutations/tracking-page-delete"},{"title":"trackingPageDuplicate","href":"/docs/api-reference/v3/reference/marketing/mutations/tracking-page-duplicate"},{"title":"trackingPageSetDefault","href":"/docs/api-reference/v3/reference/marketing/mutations/tracking-page-set-default"},{"title":"trackingPageUpdate","href":"/docs/api-reference/v3/reference/marketing/mutations/tracking-page-update"},{"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":"AttributionEvidenceSetting","href":"/docs/api-reference/v3/reference/marketing/attribution-evidence-setting"},{"title":"AttributionSettings","href":"/docs/api-reference/v3/reference/marketing/attribution-settings"},{"title":"AttributionWindow","href":"/docs/api-reference/v3/reference/marketing/attribution-window"},{"title":"BackInStockSubscription","href":"/docs/api-reference/v3/reference/marketing/back-in-stock-subscription"},{"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","description":"Follow-up email settings when the merchant enabled one.","href":"/docs/api-reference/v3/reference/marketing/campaign-follow-up-config"},{"title":"CampaignMessagingAnalytics","href":"/docs/api-reference/v3/reference/marketing/campaign-messaging-analytics"},{"title":"CampaignQuietHours","description":"Whether an SMS send time falls outside texting hours, 8:00 to 20:00. With no known recipient time zone, that is judged in every continental US time zone.","href":"/docs/api-reference/v3/reference/marketing/campaign-quiet-hours"},{"title":"CampaignSendCheck","href":"/docs/api-reference/v3/reference/marketing/campaign-send-check"},{"title":"CampaignSmsVariant","href":"/docs/api-reference/v3/reference/marketing/campaign-sms-variant"},{"title":"CampaignVariantAnalytics","href":"/docs/api-reference/v3/reference/marketing/campaign-variant-analytics"},{"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":"CommerceAgentStrategyDraft","href":"/docs/api-reference/v3/reference/marketing/commerce-agent-strategy-draft"},{"title":"CustomerCustomFieldDeclaration","href":"/docs/api-reference/v3/reference/marketing/customer-custom-field-declaration"},{"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":"EmailDomain","href":"/docs/api-reference/v3/reference/marketing/email-domain"},{"title":"EmailDomainDnsRecord","href":"/docs/api-reference/v3/reference/marketing/email-domain-dns-record"},{"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":"EmailTemplateLocalization","href":"/docs/api-reference/v3/reference/marketing/email-template-localization"},{"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":"EmailTemplateTranslation","href":"/docs/api-reference/v3/reference/marketing/email-template-translation"},{"title":"EmailTemplateTranslationEntry","href":"/docs/api-reference/v3/reference/marketing/email-template-translation-entry"},{"title":"EmailTemplateTranslationText","href":"/docs/api-reference/v3/reference/marketing/email-template-translation-text"},{"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":"GeneratedDiscountCode","href":"/docs/api-reference/v3/reference/marketing/generated-discount-code"},{"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":"MarketingAutomationStepAnalytics","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-step-analytics"},{"title":"MarketingAutomationTriggerDataCondition","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-trigger-data-condition"},{"title":"MarketingAutomationTriggerDataElement","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-trigger-data-element"},{"title":"MarketingAutomationTriggerDataField","href":"/docs/api-reference/v3/reference/marketing/marketing-automation-trigger-data-field"},{"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":"MarketingContactSuppression","href":"/docs/api-reference/v3/reference/marketing/marketing-contact-suppression"},{"title":"MarketingEmailSettings","href":"/docs/api-reference/v3/reference/marketing/marketing-email-settings"},{"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":"MessageDecision","href":"/docs/api-reference/v3/reference/marketing/message-decision"},{"title":"MetafieldProductFilter","href":"/docs/api-reference/v3/reference/marketing/metafield-product-filter"},{"title":"OrderLookup","href":"/docs/api-reference/v3/reference/marketing/order-lookup"},{"title":"Popup","href":"/docs/api-reference/v3/reference/marketing/popup"},{"title":"PopupTrigger","href":"/docs/api-reference/v3/reference/marketing/popup-trigger"},{"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":"SmsKeyword","href":"/docs/api-reference/v3/reference/marketing/sms-keyword"},{"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":"TrackingPage","href":"/docs/api-reference/v3/reference/marketing/tracking-page"},{"title":"TrackingPageMetrics","href":"/docs/api-reference/v3/reference/marketing/tracking-page-metrics"},{"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":"importRestriction","href":"/docs/api-reference/v3/reference/markets/queries/import-restriction"},{"title":"importRestrictions","href":"/docs/api-reference/v3/reference/markets/queries/import-restrictions"},{"title":"market","href":"/docs/api-reference/v3/reference/markets/queries/market"},{"title":"marketCheckoutPreview","href":"/docs/api-reference/v3/reference/markets/queries/market-checkout-preview"},{"title":"marketListingExtensionCode","href":"/docs/api-reference/v3/reference/markets/queries/market-listing-extension-code"},{"title":"markets","href":"/docs/api-reference/v3/reference/markets/queries/markets"}]},{"group":"Mutations","pages":[{"title":"deleteMarket","href":"/docs/api-reference/v3/reference/markets/mutations/delete-market"},{"title":"importRestrictionReopen","href":"/docs/api-reference/v3/reference/markets/mutations/import-restriction-reopen"},{"title":"importRestrictionResolve","href":"/docs/api-reference/v3/reference/markets/mutations/import-restriction-resolve"},{"title":"productMarketPublishingRestore","href":"/docs/api-reference/v3/reference/markets/mutations/product-market-publishing-restore"},{"title":"productMarketPublishingSet","href":"/docs/api-reference/v3/reference/markets/mutations/product-market-publishing-set"},{"title":"upsertMarket","href":"/docs/api-reference/v3/reference/markets/mutations/upsert-market"}]},{"group":"Objects","pages":[{"title":"ImportRestriction","href":"/docs/api-reference/v3/reference/markets/import-restriction"},{"title":"Market","href":"/docs/api-reference/v3/reference/markets/market"},{"title":"MarketBreakdownLabels","href":"/docs/api-reference/v3/reference/markets/market-breakdown-labels"},{"title":"MarketCheckoutPreview","href":"/docs/api-reference/v3/reference/markets/market-checkout-preview"},{"title":"MarketCheckoutPreviewLine","href":"/docs/api-reference/v3/reference/markets/market-checkout-preview-line"},{"title":"MarketCountry","href":"/docs/api-reference/v3/reference/markets/market-country"},{"title":"MarketListingExtensionCode","href":"/docs/api-reference/v3/reference/markets/market-listing-extension-code"},{"title":"ProductImportRestriction","href":"/docs/api-reference/v3/reference/markets/product-import-restriction"},{"title":"ProductMarketPublishing","href":"/docs/api-reference/v3/reference/markets/product-market-publishing"}]}]},{"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":"carrierClaim","href":"/docs/api-reference/v3/reference/returns/queries/carrier-claim"},{"title":"customsCodeSettings","href":"/docs/api-reference/v3/reference/returns/queries/customs-code-settings"},{"title":"internationalCustomsSettings","href":"/docs/api-reference/v3/reference/returns/queries/international-customs-settings"},{"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":"returnResetSteps","href":"/docs/api-reference/v3/reference/returns/queries/return-reset-steps"},{"title":"returns","href":"/docs/api-reference/v3/reference/returns/queries/returns"},{"title":"returnShippingOptions","href":"/docs/api-reference/v3/reference/returns/queries/return-shipping-options"},{"title":"taxIds","href":"/docs/api-reference/v3/reference/returns/queries/tax-ids"}]},{"group":"Mutations","pages":[{"title":"approveReturns","href":"/docs/api-reference/v3/reference/returns/mutations/approve-returns"},{"title":"carrierClaimCreate","href":"/docs/api-reference/v3/reference/returns/mutations/carrier-claim-create"},{"title":"carrierClaimUploadCreate","href":"/docs/api-reference/v3/reference/returns/mutations/carrier-claim-upload-create"},{"title":"closeReturns","href":"/docs/api-reference/v3/reference/returns/mutations/close-returns"},{"title":"customsCodeSettingsUpdate","href":"/docs/api-reference/v3/reference/returns/mutations/customs-code-settings-update"},{"title":"flagReturns","href":"/docs/api-reference/v3/reference/returns/mutations/flag-returns"},{"title":"internationalCustomsSettingsUpdate","href":"/docs/api-reference/v3/reference/returns/mutations/international-customs-settings-update"},{"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":"returnCommentCreate","href":"/docs/api-reference/v3/reference/returns/mutations/return-comment-create"},{"title":"returnCommentDelete","href":"/docs/api-reference/v3/reference/returns/mutations/return-comment-delete"},{"title":"returnCommentImageUploadCreate","href":"/docs/api-reference/v3/reference/returns/mutations/return-comment-image-upload-create"},{"title":"returnCommentUpdate","href":"/docs/api-reference/v3/reference/returns/mutations/return-comment-update"},{"title":"returnContactUpdate","href":"/docs/api-reference/v3/reference/returns/mutations/return-contact-update"},{"title":"returnFlag","href":"/docs/api-reference/v3/reference/returns/mutations/return-flag"},{"title":"returnProcess","href":"/docs/api-reference/v3/reference/returns/mutations/return-process"},{"title":"returnProductCustomsUpdate","href":"/docs/api-reference/v3/reference/returns/mutations/return-product-customs-update"},{"title":"returnShippingOptionsUpdate","href":"/docs/api-reference/v3/reference/returns/mutations/return-shipping-options-update"},{"title":"returnUnflag","href":"/docs/api-reference/v3/reference/returns/mutations/return-unflag"},{"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":"taxIdDelete","href":"/docs/api-reference/v3/reference/returns/mutations/tax-id-delete"},{"title":"taxIdSave","href":"/docs/api-reference/v3/reference/returns/mutations/tax-id-save"},{"title":"unflagReturns","href":"/docs/api-reference/v3/reference/returns/mutations/unflag-returns"}]},{"group":"Objects","pages":[{"title":"CarrierClaim","href":"/docs/api-reference/v3/reference/returns/carrier-claim"},{"title":"CarrierClaimFile","href":"/docs/api-reference/v3/reference/returns/carrier-claim-file"},{"title":"CarrierClaimUpload","href":"/docs/api-reference/v3/reference/returns/carrier-claim-upload"},{"title":"CustomsCodeSettings","href":"/docs/api-reference/v3/reference/returns/customs-code-settings"},{"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":"InternationalCustomsSettings","href":"/docs/api-reference/v3/reference/returns/international-customs-settings"},{"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":"ReturnCommentImageUpload","href":"/docs/api-reference/v3/reference/returns/return-comment-image-upload"},{"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":"ReturnResetStep","href":"/docs/api-reference/v3/reference/returns/return-reset-step"},{"title":"ReturnShipment","href":"/docs/api-reference/v3/reference/returns/return-shipment"},{"title":"ReturnShipmentGroup","href":"/docs/api-reference/v3/reference/returns/return-shipment-group"},{"title":"ReturnShippingOptions","href":"/docs/api-reference/v3/reference/returns/return-shipping-options"},{"title":"ReturnSource","href":"/docs/api-reference/v3/reference/returns/return-source"},{"title":"ReturnTotals","href":"/docs/api-reference/v3/reference/returns/return-totals"},{"title":"ShopifyCustomsMetafieldMapping","href":"/docs/api-reference/v3/reference/returns/shopify-customs-metafield-mapping"},{"title":"TaxId","href":"/docs/api-reference/v3/reference/returns/tax-id"}]}]},{"group":"Service accounts","root":{"title":"Service accounts","href":"/docs/api-reference/v3/reference/service-users/overview"},"pages":[{"group":"Queries","pages":[{"title":"serviceUser","href":"/docs/api-reference/v3/reference/service-users/queries/service-user"},{"title":"serviceUsers","href":"/docs/api-reference/v3/reference/service-users/queries/service-users"}]},{"group":"Mutations","pages":[{"title":"serviceUserApiKeyCreate","href":"/docs/api-reference/v3/reference/service-users/mutations/service-user-api-key-create"},{"title":"serviceUserCreate","href":"/docs/api-reference/v3/reference/service-users/mutations/service-user-create"},{"title":"serviceUserCredentialDelete","href":"/docs/api-reference/v3/reference/service-users/mutations/service-user-credential-delete"},{"title":"serviceUserDelete","href":"/docs/api-reference/v3/reference/service-users/mutations/service-user-delete"},{"title":"serviceUserFederatedPolicyCreate","href":"/docs/api-reference/v3/reference/service-users/mutations/service-user-federated-policy-create"},{"title":"serviceUserPublicKeyCreate","href":"/docs/api-reference/v3/reference/service-users/mutations/service-user-public-key-create"},{"title":"serviceUserUpdate","href":"/docs/api-reference/v3/reference/service-users/mutations/service-user-update"}]},{"group":"Objects","pages":[{"title":"ServiceUser","href":"/docs/api-reference/v3/reference/service-users/service-user"},{"title":"ServiceUserApiKey","href":"/docs/api-reference/v3/reference/service-users/service-user-api-key"},{"title":"ServiceUserClaimCondition","href":"/docs/api-reference/v3/reference/service-users/service-user-claim-condition"},{"title":"ServiceUserCredential","href":"/docs/api-reference/v3/reference/service-users/service-user-credential"},{"title":"ServiceUserFederatedPolicy","href":"/docs/api-reference/v3/reference/service-users/service-user-federated-policy"},{"title":"ServiceUserPublicKey","href":"/docs/api-reference/v3/reference/service-users/service-user-public-key"}]}]},{"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":"fulfillmentAutomation","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-automation"},{"title":"fulfillmentAutomationCatalog","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-automation-catalog"},{"title":"fulfillmentAutomationCheck","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-automation-check"},{"title":"fulfillmentAutomationKinds","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-automation-kinds"},{"title":"fulfillmentAutomations","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-automations"},{"title":"fulfillmentBatch","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-batch"},{"title":"fulfillmentBatches","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-batches"},{"title":"fulfillmentGroup","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-group"},{"title":"fulfillmentGroupCustomFields","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-group-custom-fields"},{"title":"fulfillmentGroups","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-groups"},{"title":"fulfillmentGroupsSearch","href":"/docs/api-reference/v3/reference/shipping/queries/fulfillment-groups-search"},{"title":"overboxServices","href":"/docs/api-reference/v3/reference/shipping/queries/overbox-services"},{"title":"overboxShipment","href":"/docs/api-reference/v3/reference/shipping/queries/overbox-shipment"},{"title":"overboxShipments","href":"/docs/api-reference/v3/reference/shipping/queries/overbox-shipments"},{"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":"fulfillmentAutomationCreate","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-automation-create"},{"title":"fulfillmentAutomationDefinitionUpdate","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-automation-definition-update"},{"title":"fulfillmentAutomationsReorder","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-automations-reorder"},{"title":"fulfillmentAutomationUpdate","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-automation-update"},{"title":"fulfillmentGroupAddressVerify","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-group-address-verify"},{"title":"fulfillmentGroupCancel","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-group-cancel"},{"title":"fulfillmentGroupCreate","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-group-create"},{"title":"fulfillmentGroupHold","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-group-hold"},{"title":"fulfillmentGroupMarkFulfilled","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-group-mark-fulfilled"},{"title":"fulfillmentGroupMerge","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-group-merge"},{"title":"fulfillmentGroupReleaseHold","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-group-release-hold"},{"title":"fulfillmentGroupUpdate","href":"/docs/api-reference/v3/reference/shipping/mutations/fulfillment-group-update"},{"title":"getShippingLabelQuotes","href":"/docs/api-reference/v3/reference/shipping/mutations/get-shipping-label-quotes"},{"title":"overboxShipmentPurchase","href":"/docs/api-reference/v3/reference/shipping/mutations/overbox-shipment-purchase"},{"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":"AddressVerification","href":"/docs/api-reference/v3/reference/shipping/address-verification"},{"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":"CustomsDeclaration","href":"/docs/api-reference/v3/reference/shipping/customs-declaration"},{"title":"ExportFiling","href":"/docs/api-reference/v3/reference/shipping/export-filing"},{"title":"FulfillmentAutomation","href":"/docs/api-reference/v3/reference/shipping/fulfillment-automation"},{"title":"FulfillmentAutomationCatalogEntry","href":"/docs/api-reference/v3/reference/shipping/fulfillment-automation-catalog-entry"},{"title":"FulfillmentAutomationCatalogListing","href":"/docs/api-reference/v3/reference/shipping/fulfillment-automation-catalog-listing"},{"title":"FulfillmentAutomationDefinition","href":"/docs/api-reference/v3/reference/shipping/fulfillment-automation-definition"},{"title":"FulfillmentAutomationDiagnostic","href":"/docs/api-reference/v3/reference/shipping/fulfillment-automation-diagnostic"},{"title":"FulfillmentAutomationKind","href":"/docs/api-reference/v3/reference/shipping/fulfillment-automation-kind"},{"title":"FulfillmentAutomationStep","href":"/docs/api-reference/v3/reference/shipping/fulfillment-automation-step"},{"title":"FulfillmentBatch","href":"/docs/api-reference/v3/reference/shipping/fulfillment-batch"},{"title":"FulfillmentGroup","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group"},{"title":"FulfillmentGroupCustomField","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-custom-field"},{"title":"FulfillmentGroupCustoms","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-customs"},{"title":"FulfillmentGroupEvent","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-event"},{"title":"FulfillmentGroupFulfillmentOrder","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-fulfillment-order"},{"title":"FulfillmentGroupLabelPurchase","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-label-purchase"},{"title":"FulfillmentGroupLink","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-link"},{"title":"FulfillmentGroupNotes","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-notes"},{"title":"FulfillmentGroupParcel","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-parcel"},{"title":"FulfillmentGroupParcelLineItem","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-parcel-line-item"},{"title":"FulfillmentGroupRates","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-rates"},{"title":"FulfillmentGroupRequestedShipping","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-requested-shipping"},{"title":"FulfillmentGroupSelectedRate","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-selected-rate"},{"title":"FulfillmentGroupShippingOptions","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-shipping-options"},{"title":"FulfillmentGroupTag","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-tag"},{"title":"FulfillmentGroupTotals","href":"/docs/api-reference/v3/reference/shipping/fulfillment-group-totals"},{"title":"FulfillmentHold","href":"/docs/api-reference/v3/reference/shipping/fulfillment-hold"},{"title":"FulfillmentOrderLineItem","href":"/docs/api-reference/v3/reference/shipping/fulfillment-order-line-item"},{"title":"FulfillmentOrderLineItemBillOfMaterials","href":"/docs/api-reference/v3/reference/shipping/fulfillment-order-line-item-bill-of-materials"},{"title":"FulfillmentOrderLineItemComponent","href":"/docs/api-reference/v3/reference/shipping/fulfillment-order-line-item-component"},{"title":"FulfillmentOrderLineItemComponentBillOfMaterials","href":"/docs/api-reference/v3/reference/shipping/fulfillment-order-line-item-component-bill-of-materials"},{"title":"FulfillmentOrderLineItemLeftover","href":"/docs/api-reference/v3/reference/shipping/fulfillment-order-line-item-leftover"},{"title":"FulfillmentOrderLineItemSubcomponent","href":"/docs/api-reference/v3/reference/shipping/fulfillment-order-line-item-subcomponent"},{"title":"FulfillmentOrderOrderSummary","href":"/docs/api-reference/v3/reference/shipping/fulfillment-order-order-summary"},{"title":"LabelPurchaseError","href":"/docs/api-reference/v3/reference/shipping/label-purchase-error"},{"title":"LandedCostQuote","href":"/docs/api-reference/v3/reference/shipping/landed-cost-quote"},{"title":"LineItemAttribute","href":"/docs/api-reference/v3/reference/shipping/line-item-attribute"},{"title":"LineItemOption","href":"/docs/api-reference/v3/reference/shipping/line-item-option"},{"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":"OutboundShipmentPackageTracking","href":"/docs/api-reference/v3/reference/shipping/outbound-shipment-package-tracking"},{"title":"OverboxServiceOption","href":"/docs/api-reference/v3/reference/shipping/overbox-service-option"},{"title":"OverboxShipment","href":"/docs/api-reference/v3/reference/shipping/overbox-shipment"},{"title":"OverboxShipmentParcel","href":"/docs/api-reference/v3/reference/shipping/overbox-shipment-parcel"},{"title":"PickSession","href":"/docs/api-reference/v3/reference/shipping/pick-session"},{"title":"PickSessionItem","href":"/docs/api-reference/v3/reference/shipping/pick-session-item"},{"title":"RateSelection","href":"/docs/api-reference/v3/reference/shipping/rate-selection"},{"title":"ShipmentBilling","href":"/docs/api-reference/v3/reference/shipping/shipment-billing"},{"title":"ShippingAddress","href":"/docs/api-reference/v3/reference/shipping/shipping-address"},{"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":"Support","root":{"title":"Support","href":"/docs/api-reference/v3/reference/support/overview"},"pages":[{"group":"Queries","pages":[{"title":"message","href":"/docs/api-reference/v3/reference/support/queries/message"},{"title":"messageThread","href":"/docs/api-reference/v3/reference/support/queries/message-thread"},{"title":"supportAgents","href":"/docs/api-reference/v3/reference/support/queries/support-agents"},{"title":"supportBusinessHours","href":"/docs/api-reference/v3/reference/support/queries/support-business-hours"},{"title":"supportCsatResponseCount","href":"/docs/api-reference/v3/reference/support/queries/support-csat-response-count"},{"title":"supportCsatResponses","href":"/docs/api-reference/v3/reference/support/queries/support-csat-responses"},{"title":"supportDefaultRules","href":"/docs/api-reference/v3/reference/support/queries/support-default-rules"},{"title":"supportEmailLocate","href":"/docs/api-reference/v3/reference/support/queries/support-email-locate"},{"title":"supportIntegrations","href":"/docs/api-reference/v3/reference/support/queries/support-integrations"},{"title":"supportMacros","href":"/docs/api-reference/v3/reference/support/queries/support-macros"},{"title":"supportRuleOverlapWarnings","href":"/docs/api-reference/v3/reference/support/queries/support-rule-overlap-warnings"},{"title":"supportSettings","href":"/docs/api-reference/v3/reference/support/queries/support-settings"},{"title":"supportTagGroups","href":"/docs/api-reference/v3/reference/support/queries/support-tag-groups"},{"title":"supportTags","href":"/docs/api-reference/v3/reference/support/queries/support-tags"},{"title":"supportTicket","href":"/docs/api-reference/v3/reference/support/queries/support-ticket"},{"title":"supportTicketCount","href":"/docs/api-reference/v3/reference/support/queries/support-ticket-count"},{"title":"supportTickets","href":"/docs/api-reference/v3/reference/support/queries/support-tickets"},{"title":"supportTicketsUpdateRun","href":"/docs/api-reference/v3/reference/support/queries/support-tickets-update-run"},{"title":"supportTopicMatches","href":"/docs/api-reference/v3/reference/support/queries/support-topic-matches"},{"title":"supportTopics","href":"/docs/api-reference/v3/reference/support/queries/support-topics"},{"title":"supportUserGroups","href":"/docs/api-reference/v3/reference/support/queries/support-user-groups"},{"title":"supportViewFolders","href":"/docs/api-reference/v3/reference/support/queries/support-view-folders"},{"title":"supportViews","href":"/docs/api-reference/v3/reference/support/queries/support-views"}]},{"group":"Mutations","pages":[{"title":"supportAiDraftReplyDecline","href":"/docs/api-reference/v3/reference/support/mutations/support-ai-draft-reply-decline"},{"title":"supportBusinessHoursUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-business-hours-update"},{"title":"supportCommentDelete","href":"/docs/api-reference/v3/reference/support/mutations/support-comment-delete"},{"title":"supportCommentPrivateReply","href":"/docs/api-reference/v3/reference/support/mutations/support-comment-private-reply"},{"title":"supportCommentUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-comment-update"},{"title":"supportDefaultRuleUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-default-rule-update"},{"title":"supportRuleOverlapWarningUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-rule-overlap-warning-update"},{"title":"supportSettingsUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-settings-update"},{"title":"supportTagCreate","href":"/docs/api-reference/v3/reference/support/mutations/support-tag-create"},{"title":"supportTagDelete","href":"/docs/api-reference/v3/reference/support/mutations/support-tag-delete"},{"title":"supportTagGroupCreate","href":"/docs/api-reference/v3/reference/support/mutations/support-tag-group-create"},{"title":"supportTagGroupDelete","href":"/docs/api-reference/v3/reference/support/mutations/support-tag-group-delete"},{"title":"supportTagGroupUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-tag-group-update"},{"title":"supportTagUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-tag-update"},{"title":"supportTicketCreate","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-create"},{"title":"supportTicketDelete","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-delete"},{"title":"supportTicketHandOffFromAi","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-hand-off-from-ai"},{"title":"supportTicketMacroApply","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-macro-apply"},{"title":"supportTicketMerge","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-merge"},{"title":"supportTicketMergeUndo","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-merge-undo"},{"title":"supportTicketNoteCreate","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-note-create"},{"title":"supportTicketReply","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-reply"},{"title":"supportTicketSpamMark","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-spam-mark"},{"title":"supportTicketSpamUnmark","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-spam-unmark"},{"title":"supportTicketsUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-tickets-update"},{"title":"supportTicketUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-ticket-update"},{"title":"supportTopicCreate","href":"/docs/api-reference/v3/reference/support/mutations/support-topic-create"},{"title":"supportTopicDelete","href":"/docs/api-reference/v3/reference/support/mutations/support-topic-delete"},{"title":"supportTopicUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-topic-update"},{"title":"supportUserGroupCreate","href":"/docs/api-reference/v3/reference/support/mutations/support-user-group-create"},{"title":"supportUserGroupDelete","href":"/docs/api-reference/v3/reference/support/mutations/support-user-group-delete"},{"title":"supportUserGroupUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-user-group-update"},{"title":"supportViewCreate","href":"/docs/api-reference/v3/reference/support/mutations/support-view-create"},{"title":"supportViewDelete","href":"/docs/api-reference/v3/reference/support/mutations/support-view-delete"},{"title":"supportViewFolderCreate","href":"/docs/api-reference/v3/reference/support/mutations/support-view-folder-create"},{"title":"supportViewFolderDelete","href":"/docs/api-reference/v3/reference/support/mutations/support-view-folder-delete"},{"title":"supportViewFolderUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-view-folder-update"},{"title":"supportViewUpdate","href":"/docs/api-reference/v3/reference/support/mutations/support-view-update"}]},{"group":"Objects","pages":[{"title":"ChatMessage","href":"/docs/api-reference/v3/reference/support/chat-message"},{"title":"ChatThread","href":"/docs/api-reference/v3/reference/support/chat-thread"},{"title":"ContactFormField","href":"/docs/api-reference/v3/reference/support/contact-form-field"},{"title":"ContactFormMessage","href":"/docs/api-reference/v3/reference/support/contact-form-message"},{"title":"ContactFormThread","href":"/docs/api-reference/v3/reference/support/contact-form-thread"},{"title":"EmailDelivery","href":"/docs/api-reference/v3/reference/support/email-delivery"},{"title":"EmailMessage","href":"/docs/api-reference/v3/reference/support/email-message"},{"title":"EmailThread","href":"/docs/api-reference/v3/reference/support/email-thread"},{"title":"InternalNote","href":"/docs/api-reference/v3/reference/support/internal-note"},{"title":"Message","href":"/docs/api-reference/v3/reference/support/message"},{"title":"MessageAttachment","href":"/docs/api-reference/v3/reference/support/message-attachment"},{"title":"MessageEmailAddress","href":"/docs/api-reference/v3/reference/support/message-email-address"},{"title":"MessageThread","href":"/docs/api-reference/v3/reference/support/message-thread"},{"title":"SmsMessage","href":"/docs/api-reference/v3/reference/support/sms-message"},{"title":"SmsThread","href":"/docs/api-reference/v3/reference/support/sms-thread"},{"title":"SocialComment","href":"/docs/api-reference/v3/reference/support/social-comment"},{"title":"SocialMessage","href":"/docs/api-reference/v3/reference/support/social-message"},{"title":"SocialThread","href":"/docs/api-reference/v3/reference/support/social-thread"},{"title":"SupportAiAssignmentSettings","href":"/docs/api-reference/v3/reference/support/support-ai-assignment-settings"},{"title":"SupportAiDraftReply","href":"/docs/api-reference/v3/reference/support/support-ai-draft-reply"},{"title":"SupportAiReplyOnCustomerMessageRule","href":"/docs/api-reference/v3/reference/support/support-ai-reply-on-customer-message-rule"},{"title":"SupportAiReplySettings","href":"/docs/api-reference/v3/reference/support/support-ai-reply-settings"},{"title":"SupportArchiveBlockedSendersRule","href":"/docs/api-reference/v3/reference/support/support-archive-blocked-senders-rule"},{"title":"SupportAssignAiOnTicketCreatedRule","href":"/docs/api-reference/v3/reference/support/support-assign-ai-on-ticket-created-rule"},{"title":"SupportAssignOnCustomerMessageRule","href":"/docs/api-reference/v3/reference/support/support-assign-on-customer-message-rule"},{"title":"SupportAssignOnReplyRule","href":"/docs/api-reference/v3/reference/support/support-assign-on-reply-rule"},{"title":"SupportAutoMergeOpenTicketsRule","href":"/docs/api-reference/v3/reference/support/support-auto-merge-open-tickets-rule"},{"title":"SupportAutoMergeSettings","href":"/docs/api-reference/v3/reference/support/support-auto-merge-settings"},{"title":"SupportAutoSplitSendersRule","href":"/docs/api-reference/v3/reference/support/support-auto-split-senders-rule"},{"title":"SupportAutoSplitSettings","href":"/docs/api-reference/v3/reference/support/support-auto-split-settings"},{"title":"SupportBlockedSendersSettings","href":"/docs/api-reference/v3/reference/support/support-blocked-senders-settings"},{"title":"SupportBusinessHours","href":"/docs/api-reference/v3/reference/support/support-business-hours"},{"title":"SupportBusinessHoursDay","href":"/docs/api-reference/v3/reference/support/support-business-hours-day"},{"title":"SupportCsatResponse","href":"/docs/api-reference/v3/reference/support/support-csat-response"},{"title":"SupportCsatSurveyOnCloseRule","href":"/docs/api-reference/v3/reference/support/support-csat-survey-on-close-rule"},{"title":"SupportCsatSurveySettings","href":"/docs/api-reference/v3/reference/support/support-csat-survey-settings"},{"title":"SupportCustomEmailIntegration","href":"/docs/api-reference/v3/reference/support/support-custom-email-integration"},{"title":"SupportCustomerMessageAssignmentSettings","href":"/docs/api-reference/v3/reference/support/support-customer-message-assignment-settings"},{"title":"SupportDefaultRule","href":"/docs/api-reference/v3/reference/support/support-default-rule"},{"title":"SupportDraft","href":"/docs/api-reference/v3/reference/support/support-draft"},{"title":"SupportDuration","href":"/docs/api-reference/v3/reference/support/support-duration"},{"title":"SupportEmailCopy","href":"/docs/api-reference/v3/reference/support/support-email-copy"},{"title":"SupportEmailGmailCheck","href":"/docs/api-reference/v3/reference/support/support-email-gmail-check"},{"title":"SupportEmailInbox","href":"/docs/api-reference/v3/reference/support/support-email-inbox"},{"title":"SupportEmailLocation","href":"/docs/api-reference/v3/reference/support/support-email-location"},{"title":"SupportFacebookIntegration","href":"/docs/api-reference/v3/reference/support/support-facebook-integration"},{"title":"SupportIntegration","href":"/docs/api-reference/v3/reference/support/support-integration"},{"title":"SupportIntegrationInbound","href":"/docs/api-reference/v3/reference/support/support-integration-inbound"},{"title":"SupportIntegrationInboundFailure","href":"/docs/api-reference/v3/reference/support/support-integration-inbound-failure"},{"title":"SupportMacro","href":"/docs/api-reference/v3/reference/support/support-macro"},{"title":"SupportMacroAttachment","href":"/docs/api-reference/v3/reference/support/support-macro-attachment"},{"title":"SupportMacroFilledBody","href":"/docs/api-reference/v3/reference/support/support-macro-filled-body"},{"title":"SupportReply","href":"/docs/api-reference/v3/reference/support/support-reply"},{"title":"SupportReplyAssignmentSettings","href":"/docs/api-reference/v3/reference/support/support-reply-assignment-settings"},{"title":"SupportRuleOverlapRule","href":"/docs/api-reference/v3/reference/support/support-rule-overlap-rule"},{"title":"SupportRuleOverlapWarning","href":"/docs/api-reference/v3/reference/support/support-rule-overlap-warning"},{"title":"SupportSettings","href":"/docs/api-reference/v3/reference/support/support-settings"},{"title":"SupportShiftChange","href":"/docs/api-reference/v3/reference/support/support-shift-change"},{"title":"SupportShiftOverride","href":"/docs/api-reference/v3/reference/support/support-shift-override"},{"title":"SupportShiftStatus","href":"/docs/api-reference/v3/reference/support/support-shift-status"},{"title":"SupportStandardIntegration","href":"/docs/api-reference/v3/reference/support/support-standard-integration"},{"title":"SupportTag","href":"/docs/api-reference/v3/reference/support/support-tag"},{"title":"SupportTagGroup","href":"/docs/api-reference/v3/reference/support/support-tag-group"},{"title":"SupportTicket","href":"/docs/api-reference/v3/reference/support/support-ticket"},{"title":"SupportTicketAiSkippedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-ai-skipped-event"},{"title":"SupportTicketAssignedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-assigned-event"},{"title":"SupportTicketCommentModeratedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-comment-moderated-event"},{"title":"SupportTicketCreatedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-created-event"},{"title":"SupportTicketEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-event"},{"title":"SupportTicketHandedOffEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-handed-off-event"},{"title":"SupportTicketInsightsGeneratedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-insights-generated-event"},{"title":"SupportTicketMergedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-merged-event"},{"title":"SupportTicketMergeUndoneEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-merge-undone-event"},{"title":"SupportTicketMessageReceivedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-message-received-event"},{"title":"SupportTicketMessageSentEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-message-sent-event"},{"title":"SupportTicketPriorityChangedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-priority-changed-event"},{"title":"SupportTicketReadEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-read-event"},{"title":"SupportTicketRulesTriggeredEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-rules-triggered-event"},{"title":"SupportTicketStatusChangedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-status-changed-event"},{"title":"SupportTicketsUpdateCounts","href":"/docs/api-reference/v3/reference/support/support-tickets-update-counts"},{"title":"SupportTicketsUpdateRun","href":"/docs/api-reference/v3/reference/support/support-tickets-update-run"},{"title":"SupportTicketTagAddedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-tag-added-event"},{"title":"SupportTicketTagRemovedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-tag-removed-event"},{"title":"SupportTicketThreadCreatedEvent","href":"/docs/api-reference/v3/reference/support/support-ticket-thread-created-event"},{"title":"SupportTicketTriggeredRule","href":"/docs/api-reference/v3/reference/support/support-ticket-triggered-rule"},{"title":"SupportToggleDefaultRule","href":"/docs/api-reference/v3/reference/support/support-toggle-default-rule"},{"title":"SupportTopic","href":"/docs/api-reference/v3/reference/support/support-topic"},{"title":"SupportTopicMatch","href":"/docs/api-reference/v3/reference/support/support-topic-match"},{"title":"SupportTopicMatches","href":"/docs/api-reference/v3/reference/support/support-topic-matches"},{"title":"SupportUserGroup","href":"/docs/api-reference/v3/reference/support/support-user-group"},{"title":"SupportView","href":"/docs/api-reference/v3/reference/support/support-view"},{"title":"SupportViewFilters","href":"/docs/api-reference/v3/reference/support/support-view-filters"},{"title":"SupportViewFolder","href":"/docs/api-reference/v3/reference/support/support-view-folder"},{"title":"SupportWorkSchedule","href":"/docs/api-reference/v3/reference/support/support-work-schedule"},{"title":"SupportWorkScheduleDateOverride","href":"/docs/api-reference/v3/reference/support/support-work-schedule-date-override"},{"title":"SupportWorkScheduleDay","href":"/docs/api-reference/v3/reference/support/support-work-schedule-day"},{"title":"VoiceMessage","href":"/docs/api-reference/v3/reference/support/voice-message"},{"title":"VoiceThread","href":"/docs/api-reference/v3/reference/support/voice-thread"},{"title":"VoiceTranscriptSegment","href":"/docs/api-reference/v3/reference/support/voice-transcript-segment"}]}]},{"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":"WebhookDelivery","href":"/docs/api-reference/v3/reference/webhooks/webhook-delivery"},{"title":"WebhookEndpoint","href":"/docs/api-reference/v3/reference/webhooks/webhook-endpoint"},{"title":"WebhookSubscription","href":"/docs/api-reference/v3/reference/webhooks/webhook-subscription"}]}]},{"group":"Workspaces","root":{"title":"Workspaces","href":"/docs/api-reference/v3/reference/workspaces/overview"},"pages":[{"group":"Queries","pages":[{"title":"workspace","href":"/docs/api-reference/v3/reference/workspaces/queries/workspace"}]},{"group":"Mutations","pages":[{"title":"workspaceCommit","href":"/docs/api-reference/v3/reference/workspaces/mutations/workspace-commit"},{"title":"workspaceCreate","href":"/docs/api-reference/v3/reference/workspaces/mutations/workspace-create"},{"title":"workspaceDelete","href":"/docs/api-reference/v3/reference/workspaces/mutations/workspace-delete"},{"title":"workspaceUpdate","href":"/docs/api-reference/v3/reference/workspaces/mutations/workspace-update"}]},{"group":"Objects","pages":[{"title":"Diagnostic","href":"/docs/api-reference/v3/reference/workspaces/diagnostic"},{"title":"DiagnosticFix","href":"/docs/api-reference/v3/reference/workspaces/diagnostic-fix"},{"title":"TextEdit","href":"/docs/api-reference/v3/reference/workspaces/text-edit"},{"title":"Workspace","href":"/docs/api-reference/v3/reference/workspaces/workspace"}]}]},{"title":"Access scopes","href":"/docs/api-reference/v3/reference/scopes"}]}]},{"version":"v2 (REST)","pages":[{"title":"v2 (REST)","href":"/docs/api-reference/introduction"}]}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/docs/mcp-server/introduction"}]}]},"basePath":"","title":"CampaignMessagingAnalytics - Redo","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":[],"chunks":[]}