Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P&L Analysis page. Requires analytics:read.
Amounts are in data.filters.currency. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OmniCommerce","description":"Developer documentation for OmniCommerce REST APIs, MCP tools, and agent integrations.","colors":{"primary":"#0F766E","light":"#2DD4BF","dark":"#115E59"},"logo":{"light":"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/logo/light.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=e012509da06089923275e6b0415addf9","dark":"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/logo/dark.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=547bdf6cb0b483a43238304bc7679fa1","href":"https://omnicommerce.sg"},"favicon":"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/favicon.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=2951c661b72ccdfa6777f7594193113c","api":{"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"],"prefill":false}},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://omnicommerce.sg","label":"App"},{"href":"https://omnicommerce.sg/login","label":"Log In"}],"primary":{"type":"button","label":"API Dashboard","href":"https://omnicommerce.sg/app"}},"footer":{"socials":{"website":"https://omnicommerce.sg"}},"seo":{"metatags":{"og:site_name":"OmniCommerce Docs","twitter:card":"summary_large_image"}},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"omnicommerce","hasAudioNarration":false,"actualSubdomain":"omnicommerce","customDomains":["docs.omnicommerce.sg"],"gitSource":{"type":"github","owner":"rmdort","repo":"omnicommerce","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adbd0b266dc5112c9cd1db7","collectionId":"5a8b52fa-144a-4ed2-99bb-c7d4439f5f99","liveDeploymentHistoryId":"6adbd0b266dc5112c9cd1db7","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adbd0b266dc5112c9cd1db7","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":141},{"language":"default","tag":"Endpoints","count":119},{"language":"default","tag":"Documentation","count":39},{"language":"default","tag":"Webhooks","count":31},{"language":"default","tag":"Guides","count":18},{"language":"default","tag":"Products","count":18},{"language":"default","tag":"Developer Platform","count":14},{"language":"default","tag":"Orders","count":11},{"language":"default","tag":"Analytics","count":11},{"language":"default","tag":"Promotions","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--docs-radius:6px;--docs-content-max:60rem;--docs-example-width:28rem}#navbar img[src*=logo],header img[src$=\"/logo/dark.svg\"],header img[src$=\"/logo/light.svg\"],header nav-logo img{height:32px!important;max-height:32px!important;width:auto!important}article p:not(.callout-title):not(.callout-body),main p:not(.callout-title):not(.callout-body){font-size:calc(1em - 1pt)}"}],"page":{"pagePath":"api-reference/analytics/get-profit-analytics","slug":"/api-reference/analytics/get-profit-analytics","pageMetadata":{"title":"Get Profit Analytics","description":"Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P\u0026L Analysis page. Requires `analytics:read`.\n\nAmounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/profit","href":"/api-reference/analytics/get-profit-analytics","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P\u0026L Analysis page. Requires \", _jsx(_components.code, {\n children: \"analytics:read\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Amounts are in \", _jsx(_components.code, {\n children: \"data.filters.currency\"\n }), \". Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Profit Analytics","description":"Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P\u0026L Analysis page. Requires `analytics:read`.\n\nAmounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/profit","href":"/api-reference/analytics/get-profit-analytics","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"get_v1_analytics_profit","summary":"Get Profit Analytics","description":"Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P\u0026L Analysis page. Requires `analytics:read`.\n\nAmounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.","tags":["analytics"],"security":["e1d357c0-c908-419f-a4ef-44383086019c"],"parameters":["69fa027d-8080-4942-b024-dde9c669c971","21cba782-3f6f-423b-923d-102369f96cf6","ef4304b8-8c3b-4d1f-8255-688175bdb685","5541aa8b-d56e-43a0-a632-52ac51a6a588","2ae0aed6-0ea6-446f-8c6d-28b4e7c68cbb","9db69e99-806b-4e22-a5f7-23cc720ab7ac","a6b8b1eb-ea95-4a44-a4ed-0c9af5889d3b","ed19e683-0605-4791-94a9-7d05e9686ed6","b7e03e53-9d6c-446a-bf62-19ab7e6ae7a8"],"responses":{"200":"e15462b9-5b53-46c2-bbc5-f44da5f3ef21","400":"3a43cbaa-916e-4e86-bf72-e3f8c05805b4","401":"27ff246c-e753-4364-8f3a-7d57a44fd914","403":"d59d4322-987e-45b3-8278-51dbae500462","429":"f4865513-0ab8-4d07-aee4-b0398e509a67","500":"a70e1c61-465e-4cf9-bdab-cb87775a6902"},"method":"get","type":"path","servers":["39970a03-ff72-4559-a542-364a55d2e30f","1047c457-3777-4869-be4f-4e086fafbbca"],"path":"/api/v1/analytics/profit","baseUrlOptions":["https://omnicommerce.sg","http://localhost:3000"],"title":"Get Profit Analytics","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"69fa027d-8080-4942-b024-dde9c669c971":{"name":"organizationId","in":"query","required":false,"description":"Required for session auth. API keys already belong to one organization.","schema":{"type":"string","maxLength":160,"isRequired":false,"description":"Required for session auth. API keys already belong to one organization.","uniqueKey":"","typeLabel":"string"}},"21cba782-3f6f-423b-923d-102369f96cf6":{"name":"from","in":"query","required":false,"description":"First day of the range (YYYY-MM-DD). Defaults to 29 days before `to`.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","isRequired":false,"description":"First day of the range (YYYY-MM-DD). Defaults to 29 days before `to`.","uniqueKey":"","typeLabel":"string"}},"ef4304b8-8c3b-4d1f-8255-688175bdb685":{"name":"to","in":"query","required":false,"description":"Last day of the range, inclusive (YYYY-MM-DD). Defaults to today.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","isRequired":false,"description":"Last day of the range, inclusive (YYYY-MM-DD). Defaults to today.","uniqueKey":"","typeLabel":"string"}},"5541aa8b-d56e-43a0-a632-52ac51a6a588":{"name":"timeZone","in":"query","required":false,"description":"IANA time zone that defines each day, for example `Asia/Kuala_Lumpur`. Defaults to Asia/Singapore.","schema":{"type":"string","maxLength":80,"isRequired":false,"description":"IANA time zone that defines each day, for example `Asia/Kuala_Lumpur`. Defaults to Asia/Singapore.","uniqueKey":"","typeLabel":"string"}},"2ae0aed6-0ea6-446f-8c6d-28b4e7c68cbb":{"name":"marketplace","in":"query","required":false,"description":"Comma-separated marketplaces, for example `shopee,lazada`.","schema":{"type":"string","maxLength":200,"isRequired":false,"description":"Comma-separated marketplaces, for example `shopee,lazada`.","uniqueKey":"","typeLabel":"string"}},"9db69e99-806b-4e22-a5f7-23cc720ab7ac":{"name":"country","in":"query","required":false,"description":"Comma-separated countries. One country selects its currency.","schema":{"type":"string","maxLength":200,"isRequired":false,"description":"Comma-separated countries. One country selects its currency.","uniqueKey":"","typeLabel":"string"}},"a6b8b1eb-ea95-4a44-a4ed-0c9af5889d3b":{"name":"store","in":"query","required":false,"description":"Comma-separated store (account) ids from `GET /api/v1/marketplaces/connected`.","schema":{"type":"string","maxLength":1000,"isRequired":false,"description":"Comma-separated store (account) ids from `GET /api/v1/marketplaces/connected`.","uniqueKey":"","typeLabel":"string"}},"ed19e683-0605-4791-94a9-7d05e9686ed6":{"name":"currency","in":"query","required":false,"description":"ISO currency. Only orders in this currency are counted; amounts are not converted. Defaults to the single country's currency, otherwise SGD.","schema":{"type":"string","maxLength":3,"isRequired":false,"description":"ISO currency. Only orders in this currency are counted; amounts are not converted. Defaults to the single country's currency, otherwise SGD.","uniqueKey":"","typeLabel":"string"}},"b7e03e53-9d6c-446a-bf62-19ab7e6ae7a8":{"name":"sku","in":"query","required":false,"description":"Comma-separated SKUs to report only those products.","schema":{"type":"string","maxLength":1000,"isRequired":false,"description":"Comma-separated SKUs to report only those products.","uniqueKey":"","typeLabel":"string"}}},"responses":{"e15462b9-5b53-46c2-bbc5-f44da5f3ef21":{"description":"Get Profit Analytics","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"apiVersion":{"type":"string","const":"developer_v1","isRequired":true,"uniqueKey":"apiVersion","typeLabel":"string"},"operationId":{"type":"string","isRequired":true,"uniqueKey":"operationId","typeLabel":"string"},"status":{"type":"string","enum":["accepted","completed","failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"warnings.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"warnings","typeLabel":"string[]"},"recommendations":{"type":"array","items":{"type":"string","uniqueKey":"recommendations.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"recommendations","typeLabel":"string[]"},"links":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"links.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"links","typeLabel":"object"},"data":{"type":"object","properties":{"filters":{"type":"object","properties":{"from":{"type":"string","isRequired":true,"uniqueKey":"data.filters.from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"data.filters.to","typeLabel":"string"},"marketplace":{"type":"string","isRequired":true,"uniqueKey":"data.filters.marketplace","typeLabel":"string"},"country":{"type":"string","isRequired":true,"uniqueKey":"data.filters.country","typeLabel":"string"},"store":{"type":"string","isRequired":true,"uniqueKey":"data.filters.store","typeLabel":"string"},"currency":{"type":"string","description":"Currency of every amount in the response.","isRequired":true,"uniqueKey":"data.filters.currency","typeLabel":"string"},"timeZone":{"type":"string","isRequired":true,"uniqueKey":"data.filters.timeZone","typeLabel":"string"},"sku":{"type":"string","isRequired":true,"uniqueKey":"data.filters.sku","typeLabel":"string"}},"required":["from","to","marketplace","country","store","currency","timeZone","sku"],"isRequired":true,"uniqueKey":"data.filters","typeLabel":"object"},"reportingBasis":{"type":"string","enum":["earnings","profit"],"description":"`profit` when cost prices cover sales, otherwise `earnings` (revenue after fees).","isRequired":true,"uniqueKey":"data.reportingBasis","typeLabel":"enum\u003cstring>"},"currentRange":{"type":"object","properties":{"from":{"type":"string","isRequired":true,"uniqueKey":"data.currentRange.from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"data.currentRange.to","typeLabel":"string"}},"required":["from","to"],"isRequired":true,"uniqueKey":"data.currentRange","typeLabel":"object"},"previousRange":{"type":"object","properties":{"from":{"type":"string","isRequired":true,"uniqueKey":"data.previousRange.from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"data.previousRange.to","typeLabel":"string"}},"required":["from","to"],"isRequired":true,"uniqueKey":"data.previousRange","typeLabel":"object"},"metricCards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["net_revenue","total_costs","net_profit","net_margin","marketplace_costs","earnings_after_fees","earnings_rate"],"isRequired":true,"uniqueKey":"data.metricCards.items.[INDEX].id","typeLabel":"enum\u003cstring>"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.metricCards.items.[INDEX].label","typeLabel":"string"},"value":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.metricCards.items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.metricCards.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.metricCards.items.[INDEX].value","typeLabel":"number | null"},"unit":{"type":"string","enum":["currency","percent"],"isRequired":true,"uniqueKey":"data.metricCards.items.[INDEX].unit","typeLabel":"enum\u003cstring>"},"changePercent":{"oneOf":[{"type":"number","description":"Change against the previous period of equal length. Null without a baseline.","isRequired":true,"uniqueKey":"data.metricCards.items.[INDEX].changePercent.oneOf.0","typeLabel":"number"},{"type":"null","description":"Change against the previous period of equal length. Null without a baseline.","isRequired":true,"uniqueKey":"data.metricCards.items.[INDEX].changePercent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.metricCards.items.[INDEX].changePercent","typeLabel":"number | null"}},"required":["id","label","value","unit","changePercent"],"uniqueKey":"data.metricCards.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.metricCards","typeLabel":"object[]"},"dailyTrend":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","isRequired":true,"uniqueKey":"data.dailyTrend.items.[INDEX].date","typeLabel":"string"},"netRevenue":{"type":"number","isRequired":true,"uniqueKey":"data.dailyTrend.items.[INDEX].netRevenue","typeLabel":"number"},"netProfit":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.dailyTrend.items.[INDEX].netProfit.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.dailyTrend.items.[INDEX].netProfit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.dailyTrend.items.[INDEX].netProfit","typeLabel":"number | null"},"earningsAfterFees":{"type":"number","isRequired":true,"uniqueKey":"data.dailyTrend.items.[INDEX].earningsAfterFees","typeLabel":"number"}},"required":["date","netRevenue","netProfit","earningsAfterFees"],"uniqueKey":"data.dailyTrend.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.dailyTrend","typeLabel":"object[]"},"waterfall":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["gross_sales","discounts","returns","platform_fees","cogs","fulfillment","operating","net_profit","earnings_after_fees"],"isRequired":true,"uniqueKey":"data.waterfall.items.[INDEX].id","typeLabel":"enum\u003cstring>"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.waterfall.items.[INDEX].label","typeLabel":"string"},"amount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.waterfall.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.waterfall.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.waterfall.items.[INDEX].amount","typeLabel":"number | null"},"kind":{"type":"string","enum":["positive","negative","result"],"isRequired":true,"uniqueKey":"data.waterfall.items.[INDEX].kind","typeLabel":"enum\u003cstring>"}},"required":["id","label","amount","kind"],"uniqueKey":"data.waterfall.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.waterfall","typeLabel":"object[]"},"breakdownSections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","enum":["revenue","platform_fees","cogs","fulfillment","operating"],"isRequired":true,"uniqueKey":"data.breakdownSections.items.[INDEX].id","typeLabel":"enum\u003cstring>"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.breakdownSections.items.[INDEX].title","typeLabel":"string"},"total":{"type":"number","isRequired":true,"uniqueKey":"data.breakdownSections.items.[INDEX].total","typeLabel":"number"},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.breakdownSections.items.[INDEX].rows.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.breakdownSections.items.[INDEX].rows.items.[INDEX].label","typeLabel":"string"},"amount":{"type":"number","isRequired":true,"uniqueKey":"data.breakdownSections.items.[INDEX].rows.items.[INDEX].amount","typeLabel":"number"},"unit":{"type":"string","enum":["currency","percent"],"isRequired":true,"uniqueKey":"data.breakdownSections.items.[INDEX].rows.items.[INDEX].unit","typeLabel":"enum\u003cstring>"}},"required":["id","label","amount","unit"],"uniqueKey":"data.breakdownSections.items.[INDEX].rows.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.breakdownSections.items.[INDEX].rows","typeLabel":"object[]"}},"required":["id","title","total","rows"],"uniqueKey":"data.breakdownSections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.breakdownSections","typeLabel":"object[]"},"insights":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.insights.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.insights.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"data.insights.items.[INDEX].description","typeLabel":"string"},"tone":{"type":"string","enum":["positive","warning","neutral"],"isRequired":true,"uniqueKey":"data.insights.items.[INDEX].tone","typeLabel":"enum\u003cstring>"}},"required":["id","title","description","tone"],"uniqueKey":"data.insights.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.insights","typeLabel":"object[]"},"profitabilitySnapshot":{"type":"object","properties":{"marketplaceCosts":{"type":"number","isRequired":true,"uniqueKey":"data.profitabilitySnapshot.marketplaceCosts","typeLabel":"number"},"earningsAfterFees":{"type":"number","isRequired":true,"uniqueKey":"data.profitabilitySnapshot.earningsAfterFees","typeLabel":"number"},"earningsRate":{"type":"number","isRequired":true,"uniqueKey":"data.profitabilitySnapshot.earningsRate","typeLabel":"number"},"totalKnownCosts":{"type":"number","isRequired":true,"uniqueKey":"data.profitabilitySnapshot.totalKnownCosts","typeLabel":"number"},"ordersInRange":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"data.profitabilitySnapshot.ordersInRange","typeLabel":"integer"},"costRatio":{"type":"number","isRequired":true,"uniqueKey":"data.profitabilitySnapshot.costRatio","typeLabel":"number"},"shippingRatio":{"type":"number","isRequired":true,"uniqueKey":"data.profitabilitySnapshot.shippingRatio","typeLabel":"number"},"uncostedUnits":{"type":"number","isRequired":true,"uniqueKey":"data.profitabilitySnapshot.uncostedUnits","typeLabel":"number"}},"required":["marketplaceCosts","earningsAfterFees","earningsRate","totalKnownCosts","ordersInRange","costRatio","shippingRatio","uncostedUnits"],"isRequired":true,"uniqueKey":"data.profitabilitySnapshot","typeLabel":"object"},"missingCostProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].productId","typeLabel":"string"},"variantId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].variantId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].variantId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].variantId","typeLabel":"string | null"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].name","typeLabel":"string"},"variantName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].variantName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].variantName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].variantName","typeLabel":"string | null"},"thumbnailUrl":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].thumbnailUrl.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].thumbnailUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].thumbnailUrl","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].sku","typeLabel":"string | null"},"soldUnits":{"type":"number","isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].soldUnits","typeLabel":"number"},"marketplaces":{"type":"array","items":{"type":"string","uniqueKey":"data.missingCostProducts.items.[INDEX].marketplaces.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].marketplaces","typeLabel":"string[]"},"countries":{"type":"array","items":{"type":"string","uniqueKey":"data.missingCostProducts.items.[INDEX].countries.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.missingCostProducts.items.[INDEX].countries","typeLabel":"string[]"}},"required":["productId","variantId","name","variantName","thumbnailUrl","sku","soldUnits","marketplaces","countries"],"uniqueKey":"data.missingCostProducts.items.[INDEX]","typeLabel":"object"},"description":"Sold products without a cost price.","isRequired":true,"uniqueKey":"data.missingCostProducts","typeLabel":"object[]"},"topProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].productId","typeLabel":"string"},"variantId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].variantId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].variantId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].variantId","typeLabel":"string | null"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].name","typeLabel":"string"},"variantName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].variantName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].variantName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].variantName","typeLabel":"string | null"},"thumbnailUrl":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].thumbnailUrl.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].thumbnailUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].thumbnailUrl","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].sku","typeLabel":"string | null"},"unitsSold":{"type":"number","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].unitsSold","typeLabel":"number"},"totalRevenue":{"type":"number","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].totalRevenue","typeLabel":"number"},"totalCogs":{"type":"number","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].totalCogs","typeLabel":"number"},"totalFees":{"type":"number","description":"Marketplace and fulfillment fees allocated to the product.","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].totalFees","typeLabel":"number"},"earningsAfterFees":{"type":"number","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].earningsAfterFees","typeLabel":"number"},"earningsRate":{"type":"number","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].earningsRate","typeLabel":"number"},"totalProfit":{"oneOf":[{"type":"number","description":"Null until every sold unit has a cost price.","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].totalProfit.oneOf.0","typeLabel":"number"},{"type":"null","description":"Null until every sold unit has a cost price.","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].totalProfit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].totalProfit","typeLabel":"number | null"},"profitMargin":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].profitMargin.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].profitMargin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].profitMargin","typeLabel":"number | null"},"knownCostProfit":{"type":"number","description":"Profit counting only units with a cost price.","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].knownCostProfit","typeLabel":"number"},"knownCostMargin":{"type":"number","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].knownCostMargin","typeLabel":"number"},"costCoverage":{"type":"number","description":"Share of sold units with a cost price, 0 to 1.","isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].costCoverage","typeLabel":"number"},"marketplaces":{"type":"array","items":{"type":"string","uniqueKey":"data.topProducts.items.[INDEX].marketplaces.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.topProducts.items.[INDEX].marketplaces","typeLabel":"string[]"}},"required":["productId","variantId","name","variantName","thumbnailUrl","sku","unitsSold","totalRevenue","totalCogs","totalFees","earningsAfterFees","earningsRate","totalProfit","profitMargin","knownCostProfit","knownCostMargin","costCoverage","marketplaces"],"uniqueKey":"data.topProducts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.topProducts","typeLabel":"object[]"},"underperformingProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].productId","typeLabel":"string"},"variantId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].variantId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].variantId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].variantId","typeLabel":"string | null"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].name","typeLabel":"string"},"variantName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].variantName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].variantName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].variantName","typeLabel":"string | null"},"thumbnailUrl":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].thumbnailUrl.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].thumbnailUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].thumbnailUrl","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].sku","typeLabel":"string | null"},"unitsSold":{"type":"number","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].unitsSold","typeLabel":"number"},"totalRevenue":{"type":"number","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].totalRevenue","typeLabel":"number"},"totalCogs":{"type":"number","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].totalCogs","typeLabel":"number"},"totalFees":{"type":"number","description":"Marketplace and fulfillment fees allocated to the product.","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].totalFees","typeLabel":"number"},"earningsAfterFees":{"type":"number","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].earningsAfterFees","typeLabel":"number"},"earningsRate":{"type":"number","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].earningsRate","typeLabel":"number"},"totalProfit":{"oneOf":[{"type":"number","description":"Null until every sold unit has a cost price.","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].totalProfit.oneOf.0","typeLabel":"number"},{"type":"null","description":"Null until every sold unit has a cost price.","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].totalProfit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].totalProfit","typeLabel":"number | null"},"profitMargin":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].profitMargin.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].profitMargin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].profitMargin","typeLabel":"number | null"},"knownCostProfit":{"type":"number","description":"Profit counting only units with a cost price.","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].knownCostProfit","typeLabel":"number"},"knownCostMargin":{"type":"number","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].knownCostMargin","typeLabel":"number"},"costCoverage":{"type":"number","description":"Share of sold units with a cost price, 0 to 1.","isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].costCoverage","typeLabel":"number"},"marketplaces":{"type":"array","items":{"type":"string","uniqueKey":"data.underperformingProducts.items.[INDEX].marketplaces.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.underperformingProducts.items.[INDEX].marketplaces","typeLabel":"string[]"}},"required":["productId","variantId","name","variantName","thumbnailUrl","sku","unitsSold","totalRevenue","totalCogs","totalFees","earningsAfterFees","earningsRate","totalProfit","profitMargin","knownCostProfit","knownCostMargin","costCoverage","marketplaces"],"uniqueKey":"data.underperformingProducts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.underperformingProducts","typeLabel":"object[]"},"retailUplift":{"oneOf":[{"type":"object","description":"Sales against the historical retail price, when price books record one.","required":["currency","soldUnits","coveredUnits","missingBaselineUnits","priceBookRecordedUnits","retailValue","salesValue","upliftAmount","markupRate"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.currency","typeLabel":"string"},"soldUnits":{"type":"number","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.soldUnits","typeLabel":"number"},"coveredUnits":{"type":"number","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.coveredUnits","typeLabel":"number"},"missingBaselineUnits":{"type":"number","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.missingBaselineUnits","typeLabel":"number"},"priceBookRecordedUnits":{"type":"number","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.priceBookRecordedUnits","typeLabel":"number"},"retailValue":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.retailValue.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.retailValue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.retailValue","typeLabel":"number | null"},"salesValue":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.salesValue.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.salesValue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.salesValue","typeLabel":"number | null"},"upliftAmount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.upliftAmount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.upliftAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.upliftAmount","typeLabel":"number | null"},"markupRate":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.markupRate.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.markupRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0.markupRate","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"data.retailUplift.oneOf.0","typeLabel":"object"},{"type":"null","description":"Sales against the historical retail price, when price books record one.","isRequired":true,"uniqueKey":"data.retailUplift.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.retailUplift","typeLabel":"object | null"},"notes":{"type":"array","items":{"type":"string","uniqueKey":"data.notes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.notes","typeLabel":"string[]"}},"required":["filters","reportingBasis","currentRange","previousRange","metricCards","dailyTrend","waterfall","breakdownSections","insights","profitabilitySnapshot","missingCostProducts","topProducts","underperformingProducts","retailUplift","notes"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"jobId":{"type":"string","uniqueKey":"jobId","typeLabel":"string"},"productId":{"type":"string","uniqueKey":"productId","typeLabel":"string"}},"required":["ok","apiVersion","operationId","status","warnings","recommendations","links","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"apiVersion":"developer_v1","operationId":"\u003cstring>","status":"accepted","warnings":["\u003cstring>"],"recommendations":["\u003cstring>"],"links":{},"data":{"filters":{"from":"\u003cstring>","to":"\u003cstring>","marketplace":"\u003cstring>","country":"\u003cstring>","store":"\u003cstring>","currency":"\u003cstring>","timeZone":"\u003cstring>","sku":"\u003cstring>"},"reportingBasis":"earnings","currentRange":{"from":"\u003cstring>","to":"\u003cstring>"},"previousRange":{"from":"\u003cstring>","to":"\u003cstring>"},"metricCards":[{"id":"net_revenue","label":"\u003cstring>","value":123,"unit":"currency","changePercent":123}],"dailyTrend":[{"date":"\u003cstring>","netRevenue":123,"netProfit":123,"earningsAfterFees":123}],"waterfall":[{"id":"gross_sales","label":"\u003cstring>","amount":123,"kind":"positive"}],"breakdownSections":[{"id":"revenue","title":"\u003cstring>","total":123,"rows":[{"id":"\u003cstring>","label":"\u003cstring>","amount":123,"unit":"currency"}]}],"insights":[{"id":"\u003cstring>","title":"\u003cstring>","description":"\u003cstring>","tone":"positive"}],"profitabilitySnapshot":{"marketplaceCosts":123,"earningsAfterFees":123,"earningsRate":123,"totalKnownCosts":123,"ordersInRange":0,"costRatio":123,"shippingRatio":123,"uncostedUnits":123},"missingCostProducts":[{"productId":"\u003cstring>","variantId":"\u003cstring>","name":"\u003cstring>","variantName":"\u003cstring>","thumbnailUrl":"\u003cstring>","sku":"\u003cstring>","soldUnits":123,"marketplaces":["\u003cstring>"],"countries":["\u003cstring>"]}],"topProducts":[{"productId":"\u003cstring>","variantId":"\u003cstring>","name":"\u003cstring>","variantName":"\u003cstring>","thumbnailUrl":"\u003cstring>","sku":"\u003cstring>","unitsSold":123,"totalRevenue":123,"totalCogs":123,"totalFees":123,"earningsAfterFees":123,"earningsRate":123,"totalProfit":123,"profitMargin":123,"knownCostProfit":123,"knownCostMargin":123,"costCoverage":123,"marketplaces":["\u003cstring>"]}],"underperformingProducts":[{"productId":"\u003cstring>","variantId":"\u003cstring>","name":"\u003cstring>","variantName":"\u003cstring>","thumbnailUrl":"\u003cstring>","sku":"\u003cstring>","unitsSold":123,"totalRevenue":123,"totalCogs":123,"totalFees":123,"earningsAfterFees":123,"earningsRate":123,"totalProfit":123,"profitMargin":123,"knownCostProfit":123,"knownCostMargin":123,"costCoverage":123,"marketplaces":["\u003cstring>"]}],"retailUplift":{"currency":"\u003cstring>","soldUnits":123,"coveredUnits":123,"missingBaselineUnits":123,"priceBookRecordedUnits":123,"retailValue":123,"salesValue":123,"upliftAmount":123,"markupRate":123},"notes":["\u003cstring>"]},"jobId":"\u003cstring>","productId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3a43cbaa-916e-4e86-bf72-e3f8c05805b4":{"description":"Invalid request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"27ff246c-e753-4364-8f3a-7d57a44fd914":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d59d4322-987e-45b3-8278-51dbae500462":{"description":"Missing the `analytics:read` scope","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"f4865513-0ab8-4d07-aee4-b0398e509a67":{"description":"Rate limit exceeded","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"a70e1c61-465e-4cf9-bdab-cb87775a6902":{"description":"Internal Server Error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"e1d357c0-c908-419f-a4ef-44383086019c":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"39970a03-ff72-4559-a542-364a55d2e30f":{"url":"https://omnicommerce.sg","description":"Production"},"1047c457-3777-4869-be4f-4e086fafbbca":{"url":"http://localhost:3000","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"omnicommerce","siteName":"OmniCommerce","title":"Get Profit Analytics - OmniCommerce","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T07:13:57.299Z","originalFileLocation":"api-reference/analytics/get-profit-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=\"dark\"}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=\"Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P\u0026amp;L Analysis page. Requires analytics:read. Amounts are in data.filters.currency. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OmniCommerce\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Profit Analytics - OmniCommerce\">\u003cmeta data-mint-head property=\"og:description\" content=\"Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P\u0026amp;L Analysis page. Requires analytics:read. Amounts are in data.filters.currency. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OmniCommerce Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://omnicommerce.mintlify.app/_mintlify/api/og/v2?division=Analytics\u0026amp;title=Get+Profit+Analytics\u0026amp;description=Revenue%2C+costs%2C+fees%2C+and+profit+with+a+waterfall%2C+cost+breakdowns%2C+a+daily+trend%2C+the+most+and+least+profitable+products%2C+and+products+missing+a+cost+price.+Se\u0026amp;theme=1a59a306fe3109e355163fa6\u0026amp;signature=816ee59df81a4b34cbad427833a8a8914fff91eef28cff549560decd93e4ebc8\">\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=\"Get Profit Analytics - OmniCommerce\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P\u0026amp;L Analysis page. Requires analytics:read. Amounts are in data.filters.currency. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://omnicommerce.mintlify.app/_mintlify/api/og/v2?division=Analytics\u0026amp;title=Get+Profit+Analytics\u0026amp;description=Revenue%2C+costs%2C+fees%2C+and+profit+with+a+waterfall%2C+cost+breakdowns%2C+a+daily+trend%2C+the+most+and+least+profitable+products%2C+and+products+missing+a+cost+price.+Se\u0026amp;theme=1a59a306fe3109e355163fa6\u0026amp;signature=816ee59df81a4b34cbad427833a8a8914fff91eef28cff549560decd93e4ebc8\">\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/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OmniCommerce\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F766E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/analytics/get-profit-analytics.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.omnicommerce.sg/#organization\",\"name\":\"OmniCommerce\",\"url\":\"https://docs.omnicommerce.sg\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/logo/light.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=e012509da06089923275e6b0415addf9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.omnicommerce.sg#website\",\"name\":\"OmniCommerce\",\"url\":\"https://docs.omnicommerce.sg\",\"publisher\":{\"@id\":\"https://docs.omnicommerce.sg/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics#webpage\",\"url\":\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics\",\"name\":\"Get Profit Analytics\",\"description\":\"Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P\u0026L Analysis page. Requires analytics:read. Amounts are in data.filters.currency. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.\",\"dateModified\":\"2026-10-23T07:13:57.299Z\",\"isPartOf\":{\"@id\":\"https://docs.omnicommerce.sg#website\"},\"breadcrumb\":{\"@id\":\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Analytics\",\"item\":\"https://docs.omnicommerce.sg/api-reference/analytics/get-ads-analytics\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Profit Analytics\",\"item\":\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics#apireference\",\"headline\":\"Get Profit Analytics\",\"name\":\"Get Profit Analytics\",\"description\":\"Revenue, costs, fees, and profit with a waterfall, cost breakdowns, a daily trend, the most and least profitable products, and products missing a cost price. Session members also need finance access. Matches the P\u0026L Analysis page. Requires analytics:read. Amounts are in data.filters.currency. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.\",\"url\":\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics\",\"mainEntityOfPage\":{\"@id\":\"https://docs.omnicommerce.sg/api-reference/analytics/get-profit-analytics#webpage\"},\"dateModified\":\"2026-10-23T07:13:57.299Z\",\"publisher\":{\"@id\":\"https://docs.omnicommerce.sg/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.omnicommerce.sg#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OmniCommerce\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OmniCommerce","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference"}]},{"group":"Endpoints","pages":[{"group":"Agents","pages":[{"title":"Invoke the Omni agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/agents/general/invoke","href":"/api-reference/agents/invoke-the-omni-agent"},{"title":"Start an Omni agent run","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/agents/general/runs","href":"/api-reference/agents/start-an-omni-agent-run"},{"title":"Get an Omni agent run","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/agents/general/runs/{runId}","href":"/api-reference/agents/get-an-omni-agent-run"}]},{"group":"Analytics","pages":[{"title":"Get Ads Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/ads","href":"/api-reference/analytics/get-ads-analytics"},{"title":"Get AI Traffic Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/ai-traffic","href":"/api-reference/analytics/get-ai-traffic-analytics"},{"title":"Get Video and LIVE Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/content","href":"/api-reference/analytics/get-video-and-live-analytics"},{"title":"Get Order Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/orders","href":"/api-reference/analytics/get-order-analytics"},{"title":"Get Growth Overview","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/overview","href":"/api-reference/analytics/get-growth-overview"},{"title":"Get Pricing Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/pricing","href":"/api-reference/analytics/get-pricing-analytics"},{"title":"Get Product Analytics","description":"Per-product sales, traffic, price, stock, profit, and ad performance, ranked by net sales, with ranked insights. Pass `productId` for specific products, for example on a product page. Matches the Products page. Requires `analytics:read`.\n\nAmounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/products","href":"/api-reference/analytics/get-product-analytics"},{"title":"Get Profit Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/profit","href":"/api-reference/analytics/get-profit-analytics"},{"title":"Get Business Report","description":"The management summary: headline KPIs, top products, sales by marketplace, alerts, settlement totals, and data quality. Matches the Business Reports page. Requires `analytics:read`.\n\nAmounts are in `data.filters.currency`. Only orders in that currency are counted; nothing is converted. A range covers at most 366 days.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/reports","href":"/api-reference/analytics/get-business-report"},{"title":"Get Store Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/stores","href":"/api-reference/analytics/get-store-analytics"},{"title":"Get Traffic Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/traffic","href":"/api-reference/analytics/get-traffic-analytics"}]},{"group":"AOPs","pages":[{"title":"Get AOP configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/aop/{aopId}/config","href":"/api-reference/aops/get-aop-configuration"},{"title":"Overwrite AOP configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/aop/{aopId}/config","href":"/api-reference/aops/overwrite-aop-configuration"},{"title":"Execute an AOP","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/aop/{aopId}/execute","href":"/api-reference/aops/execute-an-aop"},{"title":"Create AOP","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/aop/create","href":"/api-reference/aops/create-aop"},{"title":"Retry a failed AOP execution","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/aop/retry","href":"/api-reference/aops/retry-a-failed-aop-execution"},{"title":"Get Thread Status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/threads/{thread_id}/status","href":"/api-reference/aops/get-thread-status"}]},{"group":"Developer Platform","pages":[{"title":"Import BrandsGateway Products","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/brandsgateway/import","href":"/api-reference/developer-platform/import-brandsgateway-products"},{"title":"Evaluate SKU Readiness","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/evaluate","href":"/api-reference/developer-platform/evaluate-sku-readiness"},{"title":"Generate Ghost Mannequin Image","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/images/ghost-mannequin","href":"/api-reference/developer-platform/generate-ghost-mannequin-image"},{"title":"Get Developer Job Status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/jobs/{jobId}","href":"/api-reference/developer-platform/get-developer-job-status"},{"title":"Cancel Developer Job","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/jobs/{jobId}/cancel","href":"/api-reference/developer-platform/cancel-developer-job"},{"title":"Recommend Marketplace Product Categories","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/manage-product-category/recommend","href":"/api-reference/developer-platform/recommend-marketplace-product-categories"},{"title":"List Connected Marketplaces","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/marketplaces/connected","href":"/api-reference/developer-platform/list-connected-marketplaces"},{"title":"Run AI Shelf Share Monitor","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/monitor","href":"/api-reference/developer-platform/run-ai-shelf-share-monitor"},{"title":"Sync Product Commercial Fields","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/sync","href":"/api-reference/developer-platform/sync-product-commercial-fields"},{"title":"List Webhook Events","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhook-events","href":"/api-reference/developer-platform/list-webhook-events"},{"title":"List Developer Webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhooks","href":"/api-reference/developer-platform/list-developer-webhooks"},{"title":"Create Developer Webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhooks","href":"/api-reference/developer-platform/create-developer-webhook"},{"title":"Get Selected Zalora Import Status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/zalora/import","href":"/api-reference/developer-platform/get-selected-zalora-import-status"},{"title":"Import Selected Zalora Products","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/zalora/import","href":"/api-reference/developer-platform/import-selected-zalora-products"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Get Campaign","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns/{campaignId}","href":"/api-reference/campaigns/get-campaign"},{"title":"Update Campaign","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/campaigns/{campaignId}","href":"/api-reference/campaigns/update-campaign"},{"title":"Act on Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns/{campaignId}/actions","href":"/api-reference/campaigns/act-on-campaign"},{"title":"Archive Campaigns","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns/archive","href":"/api-reference/campaigns/archive-campaigns"},{"title":"Delete Campaigns","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns/delete","href":"/api-reference/campaigns/delete-campaigns"},{"title":"Get Campaign Options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns/options","href":"/api-reference/campaigns/get-campaign-options"}]},{"group":"Products","pages":[{"title":"Export Catalog Items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalog/items","href":"/api-reference/products/export-catalog-items"},{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products","href":"/api-reference/products/list-products"},{"title":"Create Product","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products","href":"/api-reference/products/create-product"},{"title":"Get Product","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products/{productId}","href":"/api-reference/products/get-product"},{"title":"Delete Product","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/products/{productId}","href":"/api-reference/products/delete-product"},{"title":"Update Product","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}","href":"/api-reference/products/update-product"},{"title":"Update Product Cost","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}/cost","href":"/api-reference/products/update-product-cost"},{"title":"Delist Product","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/{productId}/delist","href":"/api-reference/products/delist-product"},{"title":"Upload Product Image","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/{productId}/images","href":"/api-reference/products/upload-product-image"},{"title":"Update Product Inventory","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}/inventory","href":"/api-reference/products/update-product-inventory"},{"title":"Get Product Listings","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products/{productId}/listings","href":"/api-reference/products/get-product-listings"},{"title":"Update Product Price","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}/price","href":"/api-reference/products/update-product-price"},{"title":"Publish Product","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/{productId}/publish","href":"/api-reference/products/publish-product"},{"title":"Bulk Import Products from JSON or CSV","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/bulk-import","href":"/api-reference/products/bulk-import-products-from-json-or-csv"},{"title":"Compare Product Market Prices","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/compare-prices","href":"/api-reference/products/compare-product-market-prices"},{"title":"Get Product Price Comparison","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products/compare-prices/jobs/{jobId}","href":"/api-reference/products/get-product-price-comparison"},{"title":"Batch Update Product Cost","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/cost","href":"/api-reference/products/batch-update-product-cost"},{"title":"Queue Product Enrichment","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/enrich","href":"/api-reference/products/queue-product-enrichment"}]},{"group":"Agentic Checkout","pages":[{"title":"Create Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checkout-sessions","href":"/api-reference/agentic-checkout/create-agentic-checkout-session"},{"title":"Get Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/checkout-sessions/{sessionId}","href":"/api-reference/agentic-checkout/get-agentic-checkout-session"},{"title":"Replace Agentic Checkout Session Fields","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/checkout-sessions/{sessionId}","href":"/api-reference/agentic-checkout/replace-agentic-checkout-session-fields"},{"title":"Update Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/checkout-sessions/{sessionId}","href":"/api-reference/agentic-checkout/update-agentic-checkout-session"},{"title":"Cancel Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checkout-sessions/{sessionId}/cancel","href":"/api-reference/agentic-checkout/cancel-agentic-checkout-session"},{"title":"Complete Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checkout-sessions/{sessionId}/complete","href":"/api-reference/agentic-checkout/complete-agentic-checkout-session"}]},{"group":"Public Agent","pages":[{"title":"Compare Public Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/compare","href":"/api-reference/public-agent/compare-public-products"},{"title":"List Public Merchants","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/directory","href":"/api-reference/public-agent/list-public-merchants"},{"title":"Get Merchant LLM Feed","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/feed/{domain}/llms.txt","href":"/api-reference/public-agent/get-merchant-llm-feed"},{"title":"Get Public Merchant Manifest","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/merchants/{merchantId}/manifest","href":"/api-reference/public-agent/get-public-merchant-manifest"},{"title":"List Public Merchant Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/merchants/{merchantId}/products","href":"/api-reference/public-agent/list-public-merchant-products"},{"title":"Search Within Public Merchant Catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/merchants/{merchantId}/search","href":"/api-reference/public-agent/search-within-public-merchant-catalog"},{"title":"Search Public Merchant Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/search","href":"/api-reference/public-agent/search-public-merchant-products"},{"title":"Search Public Merchant Products","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/search","href":"/api-reference/public-agent/search-public-merchant-products-1"}]},{"group":"Knowledge Base","pages":[{"title":"Upload Document","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/documents","href":"/api-reference/documents/upload-document"},{"title":"Get Document","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/documents/{documentId}","href":"/api-reference/documents/get-document"}]},{"group":"Looks","pages":[{"title":"List Looks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/looks","href":"/api-reference/looks/list-looks"},{"title":"Create Look","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/looks","href":"/api-reference/looks/create-look"},{"title":"Get Look","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/looks/{lookId}","href":"/api-reference/looks/get-look"}]},{"group":"OAuth","pages":[{"title":"Revoke Access Token","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/oauth/revoke","href":"/api-reference/oauth/revoke-access-token"},{"title":"Get Access Token","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/oauth/token","href":"/api-reference/oauth/get-access-token"}]},{"group":"Orders","pages":[{"title":"List Orders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders","href":"/api-reference/orders/list-orders"},{"title":"Create Order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders","href":"/api-reference/orders/create-order"},{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}","href":"/api-reference/orders/get-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/orders/{orderId}","href":"/api-reference/orders/update-order"},{"title":"Get Order Action Options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}/action-options","href":"/api-reference/orders/get-order-action-options"},{"title":"List Order Actions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}/actions","href":"/api-reference/orders/list-order-actions"},{"title":"Queue Order Action","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/{orderId}/actions","href":"/api-reference/orders/queue-order-action"}]},{"group":"Organizations","pages":[{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/organizations","href":"/api-reference/organizations/create-organization"}]},{"group":"Price Books","pages":[{"title":"List Price Book Rules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/price-books","href":"/api-reference/price-books/list-price-book-rules"},{"title":"Create Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/price-books","href":"/api-reference/price-books/create-price-book-rule"},{"title":"Get Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/price-books/{ruleId}","href":"/api-reference/price-books/get-price-book-rule"},{"title":"Delete Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/price-books/{ruleId}","href":"/api-reference/price-books/delete-price-book-rule"},{"title":"Update Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/price-books/{ruleId}","href":"/api-reference/price-books/update-price-book-rule"},{"title":"Preview Channel List Price","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/price-books/preview","href":"/api-reference/price-books/preview-channel-list-price"}]},{"group":"Promotions","pages":[{"title":"List Promotions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/promotions","href":"/api-reference/promotions/list-promotions"},{"title":"Create Promotion","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions","href":"/api-reference/promotions/create-promotion"},{"title":"Get Promotion","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/promotions/{promotionId}","href":"/api-reference/promotions/get-promotion"},{"title":"Delete Promotion","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/promotions/{promotionId}","href":"/api-reference/promotions/delete-promotion"},{"title":"Update Promotion","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/promotions/{promotionId}","href":"/api-reference/promotions/update-promotion"},{"title":"List Promotion Assignments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/promotions/{promotionId}/products","href":"/api-reference/promotions/list-promotion-assignments"},{"title":"Assign Products to Promotion","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions/{promotionId}/products","href":"/api-reference/promotions/assign-products-to-promotion"},{"title":"Unassign Products from Promotion","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/promotions/{promotionId}/products","href":"/api-reference/promotions/unassign-products-from-promotion"},{"title":"Retry Marketplace Delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions/{promotionId}/retry","href":"/api-reference/promotions/retry-marketplace-delivery"}]},{"group":"Returns","pages":[{"title":"List Returns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns","href":"/api-reference/returns/list-returns"},{"title":"Get Return","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns/{returnId}","href":"/api-reference/returns/get-return"}]},{"group":"Reviews","pages":[{"title":"List Reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Get Review","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reviews/{reviewId}","href":"/api-reference/reviews/get-review"},{"title":"Reply to Review","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/reviews/{reviewId}/reply","href":"/api-reference/reviews/reply-to-review"}]},{"group":"Settlements","pages":[{"title":"List Settlements","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/settlements","href":"/api-reference/settlements/list-settlements"},{"title":"Apply Settlements","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/settlements","href":"/api-reference/settlements/apply-settlements"},{"title":"Get Settlement","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/settlements/{settlementId}","href":"/api-reference/settlements/get-settlement"}]},{"group":"UCP","pages":[{"title":"Create UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /ucp/v1/checkout-sessions","href":"/api-reference/ucp/create-ucp-checkout-session"},{"title":"Get UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json get /ucp/v1/checkout-sessions/{sessionId}","href":"/api-reference/ucp/get-ucp-checkout-session"},{"title":"Replace UCP Checkout Session Fields","deprecated":null,"version":null,"openapi":"/openapi.json put /ucp/v1/checkout-sessions/{sessionId}","href":"/api-reference/ucp/replace-ucp-checkout-session-fields"},{"title":"Update UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json patch /ucp/v1/checkout-sessions/{sessionId}","href":"/api-reference/ucp/update-ucp-checkout-session"},{"title":"Cancel UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /ucp/v1/checkout-sessions/{sessionId}/cancel","href":"/api-reference/ucp/cancel-ucp-checkout-session"},{"title":"Complete UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /ucp/v1/checkout-sessions/{sessionId}/complete","href":"/api-reference/ucp/complete-ucp-checkout-session"},{"title":"Get UCP Order","deprecated":null,"version":null,"openapi":"/openapi.json get /ucp/v1/orders/{orderId}","href":"/api-reference/ucp/get-ucp-order"}]},{"group":"product webhooks","pages":[]},{"group":"enrichment webhooks","pages":[]},{"group":"look webhooks","pages":[]},{"group":"review webhooks","pages":[]},{"group":"order webhooks","pages":[]},{"group":"settlement webhooks","pages":[]},{"group":"return webhooks","pages":[]},{"group":"account statement webhooks","pages":[]}]},{"group":"Webhooks","pages":[{"group":"Product","pages":[{"title":"Product created","openapi":"openapi.json webhook productCreated","href":"/webhooks/reference/product-created"},{"title":"Product updated","openapi":"openapi.json webhook productUpdated","href":"/webhooks/reference/product-updated"},{"title":"Product deleted","openapi":"openapi.json webhook productDeleted","href":"/webhooks/reference/product-deleted"},{"title":"Product delisted","openapi":"openapi.json webhook productDelisted","href":"/webhooks/reference/product-delisted"},{"title":"Product price changed","openapi":"openapi.json webhook productPriceChanged","href":"/webhooks/reference/product-price-changed"},{"title":"Product inventory changed","openapi":"openapi.json webhook productInventoryChanged","href":"/webhooks/reference/product-inventory-changed"}]},{"group":"Orders","pages":[{"title":"Order created","openapi":"openapi.json webhook orderCreated","href":"/webhooks/reference/order-created"},{"title":"Order updated","openapi":"openapi.json webhook orderUpdated","href":"/webhooks/reference/order-updated"},{"title":"Order status changed","openapi":"openapi.json webhook orderStatusChanged","href":"/webhooks/reference/order-status-changed"},{"title":"Order deleted","openapi":"openapi.json webhook orderDeleted","href":"/webhooks/reference/order-deleted"}]},{"group":"Looks","pages":[{"title":"Look created","openapi":"openapi.json webhook lookCreated","href":"/webhooks/reference/look-created"},{"title":"Look deleted","openapi":"openapi.json webhook lookDeleted","href":"/webhooks/reference/look-deleted"}]},{"group":"Review","pages":[{"title":"Review created","openapi":"openapi.json webhook reviewCreated","href":"/webhooks/reference/review-created"},{"title":"Review updated","openapi":"openapi.json webhook reviewUpdated","href":"/webhooks/reference/review-updated"},{"title":"Review status changed","openapi":"openapi.json webhook reviewStatusChanged","href":"/webhooks/reference/review-status-changed"}]},{"group":"Settlements","pages":[{"title":"Settlement created","openapi":"openapi.json webhook settlementCreated","href":"/webhooks/reference/settlement-created"},{"title":"Settlement updated","openapi":"openapi.json webhook settlementUpdated","href":"/webhooks/reference/settlement-updated"},{"title":"Settlement status changed","openapi":"openapi.json webhook settlementStatusChanged","href":"/webhooks/reference/settlement-status-changed"}]},{"group":"Returns","pages":[{"title":"Return created","openapi":"openapi.json webhook returnCreated","href":"/webhooks/reference/return-created"},{"title":"Return updated","openapi":"openapi.json webhook returnUpdated","href":"/webhooks/reference/return-updated"},{"title":"Return status changed","openapi":"openapi.json webhook returnStatusChanged","href":"/webhooks/reference/return-status-changed"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Get Profit Analytics - OmniCommerce","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}