{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Komerza Documentation","colors":{"primary":"#3b82f6","light":"#3b82f6","dark":"#2563eb"},"logo":{"light":"https://mintcdn.com/komerza/b8Ru_h-4KK1SQzzO/logo/light.svg?fit=max\u0026auto=format\u0026n=b8Ru_h-4KK1SQzzO\u0026q=85\u0026s=0f9ba8d2c97d0b7886be5ab88b8a1521","dark":"https://mintcdn.com/komerza/b8Ru_h-4KK1SQzzO/logo/dark.svg?fit=max\u0026auto=format\u0026n=b8Ru_h-4KK1SQzzO\u0026q=85\u0026s=d1f22d39eb73b84e71c17d38abfb45d7","href":"https://komerza.com"},"favicon":"https://mintcdn.com/komerza/b8Ru_h-4KK1SQzzO/favicon.svg?fit=max\u0026auto=format\u0026n=b8Ru_h-4KK1SQzzO\u0026q=85\u0026s=75bc08b60ad0a7f1695e7cdb5efa5130","api":{"playground":{"proxy":false},"examples":{"autogenerate":true}},"navbar":{"links":[{"href":"https://komerza.com","label":"Komerza"},{"href":"https://komerza.com/pricing","label":"Pricing"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.komerza.com"}},"footer":{"socials":{"x":"https://x.com/komerzaecom","github":"https://github.com/komerza","telegram":"https://t.me/komerzaecom"},"links":[{"header":"Komerza","items":[{"label":"Home","href":"https://komerza.com"},{"label":"Pricing","href":"https://komerza.com/pricing"},{"label":"Features","href":"https://komerza.com/features"},{"label":"Blog","href":"https://komerza.com/blog"}]},{"header":"Company","items":[{"label":"About","href":"https://komerza.com/about"},{"label":"Compare platforms","href":"https://komerza.com/alternatives"},{"label":"Brand","href":"https://komerza.com/brand"},{"label":"Legal","href":"https://komerza.com/legal"}]}]},"fonts":{"family":"Inter"},"integrations":{"intercom":{"appId":"hekgn53e"}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The page you're looking for doesn't exist. Head back to the [home page](/), explore the [API Reference](/api-reference/introduction), or browse the [Guides](/)."}},"contextual":{"options":["copy","view","chatgpt","claude","vscode","cursor"],"display":"header"},"metadata":{"timestamp":true},"markdown":{"schema":false},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"System Status","icon":"wave-pulse","href":"https://status.komerza.com"},{"anchor":"Telegram","icon":"telegram","href":"https://t.me/komerzaecom"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/komerza"}]},"languages":[{"language":"en","href":""},{"language":"fr","href":"fr"},{"language":"de","href":"de"},{"language":"pl","href":"pl"},{"language":"es","href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"komerza","hasAudioNarration":false,"actualSubdomain":"komerza","customDomains":["docs.komerza.com"],"gitSource":{"type":"github","owner":"komerza","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb977a27ec6dc3da981b39","collectionId":"f85ed26f-69be-4996-acd1-95a3687c9c74","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb977a27ec6dc3da981b39"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6adb977a27ec6dc3da981b39","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":169},{"language":"en","tag":"Guides","count":40},{"language":"default","tag":"Reseller Programme","count":28},{"language":"default","tag":"Variants","count":25},{"language":"default","tag":"Products","count":17},{"language":"default","tag":"Reselling","count":17},{"language":"default","tag":"Affiliates","count":13},{"language":"en","tag":"Payment Setup","count":13},{"language":"de","tag":"Anleitungen","count":11},{"language":"es","tag":"Guías","count":11},{"language":"fr","tag":"Guides","count":11},{"language":"pl","tag":"Przewodniki","count":11},{"language":"en","tag":"Storefront SDK","count":10},{"language":"default","tag":"Categories","count":8},{"language":"default","tag":"Orders","count":8},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Reference","count":7},{"language":"de","tag":"Storefront-SDK","count":7},{"language":"es","tag":"SDK de Tienda","count":7},{"language":"fr","tag":"SDK Storefront","count":7},{"language":"en","tag":"Integration Guides","count":7},{"language":"pl","tag":"SDK Sklepowy","count":7},{"language":"en","tag":"Store Setup","count":6},{"language":"en","tag":"Client Library","count":6},{"language":"de","tag":"Zahlungseinrichtung","count":5},{"language":"de","tag":"Client Library","count":5},{"language":"es","tag":"Configuración de Pagos","count":5},{"language":"es","tag":"Client Library","count":5},{"language":"fr","tag":"Configuration des Paiements","count":5},{"language":"fr","tag":"Client Library","count":5},{"language":"en","tag":"Storefront Builder","count":5},{"language":"pl","tag":"Konfiguracja Płatności","count":5},{"language":"pl","tag":"Client Library","count":5},{"language":"en","tag":"Getting Started","count":4},{"language":"de","tag":"Integrationsleitfäden","count":3},{"language":"es","tag":"Guías de Integración","count":3},{"language":"fr","tag":"Guides d'Intégration","count":3},{"language":"en","tag":"Orders \u0026 Customers","count":3},{"language":"en","tag":"Get Started","count":3},{"language":"pl","tag":"Przewodniki Integracji","count":3},{"language":"de","tag":"Erste Schritte","count":2},{"language":"de","tag":"Getting Started","count":2},{"language":"es","tag":"Empezar","count":2},{"language":"es","tag":"Getting Started","count":2},{"language":"fr","tag":"Démarrer","count":2},{"language":"fr","tag":"Getting Started","count":2},{"language":"pl","tag":"Pierwsze Kroki","count":2},{"language":"pl","tag":"Getting Started","count":2},{"language":"de","tag":"Shop-Einrichtung","count":1},{"language":"es","tag":"Configuración de la Tienda","count":1},{"language":"fr","tag":"Configuration du Magasin","count":1},{"language":"pl","tag":"Konfiguracja Sklepu","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--color-primary-50:#eff6ff;--color-primary-100:#dbeafe;--color-primary-200:#bfdbfe;--color-primary-300:#93c5fd;--color-primary-400:#60a5fa;--color-primary-500:#3b82f6;--color-primary-600:#2563eb;--color-primary-700:#1d4ed8;--color-primary-800:#1e40af;--color-primary-900:#1e3a8a;--color-success-50:#ecfdf5;--color-success-100:#d1fae5;--color-success-200:#a7f3d0;--color-success-300:#6ee7b7;--color-success-400:#34d399;--color-success-500:#10b981;--color-success-600:#059669;--color-success-700:#047857;--color-success-800:#065f46;--color-success-900:#064e3b;--color-warning-50:#fffbeb;--color-warning-100:#fef3c7;--color-warning-200:#fde68a;--color-warning-300:#fcd34d;--color-warning-400:#fbbf24;--color-warning-500:#f59e0b;--color-warning-600:#d97706;--color-warning-700:#b45309;--color-warning-800:#92400e;--color-warning-900:#78350f;--color-error-50:#fef2f2;--color-error-100:#fee2e2;--color-error-200:#fecaca;--color-error-300:#fca5a5;--color-error-400:#f87171;--color-error-500:#ef4444;--color-error-600:#dc2626;--color-error-700:#b91c1c;--color-error-800:#991b1b;--color-error-900:#7f1d1d;--color-gray-50:oklch(98.5% 0 0);--color-gray-100:oklch(97% 0 0);--color-gray-200:oklch(92.2% 0 0);--color-gray-300:oklch(87% 0 0);--color-gray-400:oklch(70.8% 0 0);--color-gray-500:#3c3c3c;--color-gray-600:#303030;--color-gray-700:#242424;--color-gray-800:#151515;--color-gray-900:#0c0c0c;font-family:\"Inter Variable\",system-ui,sans-serif}html{scroll-behavior:smooth}#page-title,h1,h2,h3,h4,h5,h6{font-weight:500}.kicon{display:inline-block;width:1.25rem;height:1.25rem;flex:none;vertical-align:-.2em;background-color:currentColor;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;-webkit-mask-size:contain;mask-size:contain}.kicon-sm{width:1rem;height:1rem}.kicon-arrow-up-right{-webkit-mask-image:url(/icons/arrow-up-right.svg);mask-image:url(/icons/arrow-up-right.svg)}.kicon-bell{-webkit-mask-image:url(/icons/bell.svg);mask-image:url(/icons/bell.svg)}.kicon-bolt{-webkit-mask-image:url(/icons/bolt.svg);mask-image:url(/icons/bolt.svg)}.kicon-book{-webkit-mask-image:url(/icons/book.svg);mask-image:url(/icons/book.svg)}.kicon-box{-webkit-mask-image:url(/icons/box.svg);mask-image:url(/icons/box.svg)}.kicon-chart-line{-webkit-mask-image:url(/icons/chart-line.svg);mask-image:url(/icons/chart-line.svg)}.kicon-check-list{-webkit-mask-image:url(/icons/check-list.svg);mask-image:url(/icons/check-list.svg)}.kicon-code{-webkit-mask-image:url(/icons/code.svg);mask-image:url(/icons/code.svg)}.kicon-color-palette{-webkit-mask-image:url(/icons/color-palette.svg);mask-image:url(/icons/color-palette.svg)}.kicon-credit-card{-webkit-mask-image:url(/icons/credit-card.svg);mask-image:url(/icons/credit-card.svg)}.kicon-flask{-webkit-mask-image:url(/icons/flask.svg);mask-image:url(/icons/flask.svg)}.kicon-globe{-webkit-mask-image:url(/icons/globe.svg);mask-image:url(/icons/globe.svg)}.kicon-handshake{-webkit-mask-image:url(/icons/handshake.svg);mask-image:url(/icons/handshake.svg)}.kicon-image{-webkit-mask-image:url(/icons/image.svg);mask-image:url(/icons/image.svg)}.kicon-key{-webkit-mask-image:url(/icons/key.svg);mask-image:url(/icons/key.svg)}.kicon-laptop{-webkit-mask-image:url(/icons/laptop.svg);mask-image:url(/icons/laptop.svg)}.kicon-layers{-webkit-mask-image:url(/icons/layers.svg);mask-image:url(/icons/layers.svg)}.kicon-list{-webkit-mask-image:url(/icons/list.svg);mask-image:url(/icons/list.svg)}.kicon-magnifier{-webkit-mask-image:url(/icons/magnifier.svg);mask-image:url(/icons/magnifier.svg)}.kicon-money-bill{-webkit-mask-image:url(/icons/money-bill.svg);mask-image:url(/icons/money-bill.svg)}.kicon-money-transfer{-webkit-mask-image:url(/icons/money-transfer.svg);mask-image:url(/icons/money-transfer.svg)}.kicon-palette{-webkit-mask-image:url(/icons/palette.svg);mask-image:url(/icons/palette.svg)}.kicon-pulse{-webkit-mask-image:url(/icons/pulse.svg);mask-image:url(/icons/pulse.svg)}.kicon-receipt{-webkit-mask-image:url(/icons/receipt.svg);mask-image:url(/icons/receipt.svg)}.kicon-repeat{-webkit-mask-image:url(/icons/repeat.svg);mask-image:url(/icons/repeat.svg)}.kicon-rocket{-webkit-mask-image:url(/icons/rocket.svg);mask-image:url(/icons/rocket.svg)}.kicon-shield{-webkit-mask-image:url(/icons/shield.svg);mask-image:url(/icons/shield.svg)}.kicon-sliders{-webkit-mask-image:url(/icons/sliders.svg);mask-image:url(/icons/sliders.svg)}.kicon-tag{-webkit-mask-image:url(/icons/tag.svg);mask-image:url(/icons/tag.svg)}.kicon-terminal{-webkit-mask-image:url(/icons/terminal.svg);mask-image:url(/icons/terminal.svg)}.kicon-truck{-webkit-mask-image:url(/icons/truck.svg);mask-image:url(/icons/truck.svg)}.kicon-users{-webkit-mask-image:url(/icons/users.svg);mask-image:url(/icons/users.svg)}.kicon-wallet{-webkit-mask-image:url(/icons/wallet.svg);mask-image:url(/icons/wallet.svg)}.kicon-webhook{-webkit-mask-image:url(/icons/webhook.svg);mask-image:url(/icons/webhook.svg)}svg[style*=\"/arrow-pointer.svg\"]{-webkit-mask-image:url(/icons/button-cursor.svg)!important;mask-image:url(/icons/button-cursor.svg)!important}svg[style*=\"/arrow-right-arrow-left.svg\"]{-webkit-mask-image:url(/icons/swap.svg)!important;mask-image:url(/icons/swap.svg)!important}svg[style*=\"/arrow-right-to-bracket.svg\"]{-webkit-mask-image:url(/icons/rect-login.svg)!important;mask-image:url(/icons/rect-login.svg)!important}svg[style*=\"/arrow-up.svg\"]{-webkit-mask-image:url(/icons/arrow-up.svg)!important;mask-image:url(/icons/arrow-up.svg)!important}svg[style*=\"/ban.svg\"]{-webkit-mask-image:url(/icons/ban.svg)!important;mask-image:url(/icons/ban.svg)!important}svg[style*=\"/bell.svg\"]{-webkit-mask-image:url(/icons/bell.svg)!important;mask-image:url(/icons/bell.svg)!important}svg[style*=\"/bolt.svg\"]{-webkit-mask-image:url(/icons/bolt.svg)!important;mask-image:url(/icons/bolt.svg)!important}svg[style*=\"/book.svg\"]{-webkit-mask-image:url(/icons/book.svg)!important;mask-image:url(/icons/book.svg)!important}svg[style*=\"/box.svg\"]{-webkit-mask-image:url(/icons/box.svg)!important;mask-image:url(/icons/box.svg)!important}svg[style*=\"/caret-right.svg\"]{-webkit-mask-image:url(/icons/chevron-right.svg)!important;mask-image:url(/icons/chevron-right.svg)!important}svg[style*=\"/cart-shopping.svg\"]{-webkit-mask-image:url(/icons/cart-shopping.svg)!important;mask-image:url(/icons/cart-shopping.svg)!important}svg[style*=\"/chart-bar.svg\"]{-webkit-mask-image:url(/icons/chart-bar.svg)!important;mask-image:url(/icons/chart-bar.svg)!important}svg[style*=\"/chart-line.svg\"]{-webkit-mask-image:url(/icons/chart-line.svg)!important;mask-image:url(/icons/chart-line.svg)!important}svg[style*=\"/circle-check.svg\"]{-webkit-mask-image:url(/icons/circle-check.svg)!important;mask-image:url(/icons/circle-check.svg)!important}svg[style*=\"/circle-info.svg\"]{-webkit-mask-image:url(/icons/circle-info.svg)!important;mask-image:url(/icons/circle-info.svg)!important}svg[style*=\"/circle-question.svg\"]{-webkit-mask-image:url(/icons/circle-question.svg)!important;mask-image:url(/icons/circle-question.svg)!important}svg[style*=\"/circle-xmark.svg\"]{-webkit-mask-image:url(/icons/circle-xmark.svg)!important;mask-image:url(/icons/circle-xmark.svg)!important}svg[style*=\"/clock.svg\"]{-webkit-mask-image:url(/icons/clock.svg)!important;mask-image:url(/icons/clock.svg)!important}svg[style*=\"/clock-rotate-left.svg\"]{-webkit-mask-image:url(/icons/arrow-rotate-clockwise.svg)!important;mask-image:url(/icons/arrow-rotate-clockwise.svg)!important}svg[style*=\"/cloud-arrow-up.svg\"]{-webkit-mask-image:url(/icons/cloud-upload.svg)!important;mask-image:url(/icons/cloud-upload.svg)!important}svg[style*=\"/code.svg\"]{-webkit-mask-image:url(/icons/code.svg)!important;mask-image:url(/icons/code.svg)!important}svg[style*=\"/code-merge.svg\"]{-webkit-mask-image:url(/icons/code-merge.svg)!important;mask-image:url(/icons/code-merge.svg)!important}svg[style*=\"/coins.svg\"]{-webkit-mask-image:url(/icons/coins.svg)!important;mask-image:url(/icons/coins.svg)!important}svg[style*=\"/credit-card.svg\"]{-webkit-mask-image:url(/icons/credit-card.svg)!important;mask-image:url(/icons/credit-card.svg)!important}svg[style*=\"/desktop.svg\"]{-webkit-mask-image:url(/icons/monitor.svg)!important;mask-image:url(/icons/monitor.svg)!important}svg[style*=\"/diagram-project.svg\"]{-webkit-mask-image:url(/icons/sitemap.svg)!important;mask-image:url(/icons/sitemap.svg)!important}svg[style*=\"/dollar-sign.svg\"]{-webkit-mask-image:url(/icons/currency-dollar.svg)!important;mask-image:url(/icons/currency-dollar.svg)!important}svg[style*=\"/download.svg\"]{-webkit-mask-image:url(/icons/download.svg)!important;mask-image:url(/icons/download.svg)!important}svg[style*=\"/ellipsis-vertical.svg\"]{-webkit-mask-image:url(/icons/dots-vertical.svg)!important;mask-image:url(/icons/dots-vertical.svg)!important}svg[style*=\"/envelope.svg\"]{-webkit-mask-image:url(/icons/envelope.svg)!important;mask-image:url(/icons/envelope.svg)!important}svg[style*=\"/eye-slash.svg\"]{-webkit-mask-image:url(/icons/eye-slash.svg)!important;mask-image:url(/icons/eye-slash.svg)!important}svg[style*=\"/feather.svg\"]{-webkit-mask-image:url(/icons/feather.svg)!important;mask-image:url(/icons/feather.svg)!important}svg[style*=\"/file-code.svg\"]{-webkit-mask-image:url(/icons/window-code.svg)!important;mask-image:url(/icons/window-code.svg)!important}svg[style*=\"/filter-list.svg\"]{-webkit-mask-image:url(/icons/filter.svg)!important;mask-image:url(/icons/filter.svg)!important}svg[style*=\"/gamepad.svg\"]{-webkit-mask-image:url(/icons/gamepad.svg)!important;mask-image:url(/icons/gamepad.svg)!important}svg[style*=\"/gauge-high.svg\"]{-webkit-mask-image:url(/icons/gauge.svg)!important;mask-image:url(/icons/gauge.svg)!important}svg[style*=\"/globe.svg\"]{-webkit-mask-image:url(/icons/globe.svg)!important;mask-image:url(/icons/globe.svg)!important}svg[style*=\"/handshake.svg\"]{-webkit-mask-image:url(/icons/handshake.svg)!important;mask-image:url(/icons/handshake.svg)!important}svg[style*=\"/headset.svg\"]{-webkit-mask-image:url(/icons/headset.svg)!important;mask-image:url(/icons/headset.svg)!important}svg[style*=\"/house.svg\"]{-webkit-mask-image:url(/icons/house.svg)!important;mask-image:url(/icons/house.svg)!important}svg[style*=\"/key.svg\"]{-webkit-mask-image:url(/icons/key.svg)!important;mask-image:url(/icons/key.svg)!important}svg[style*=\"/laptop-binary.svg\"]{-webkit-mask-image:url(/icons/laptop.svg)!important;mask-image:url(/icons/laptop.svg)!important}svg[style*=\"/layer-group.svg\"]{-webkit-mask-image:url(/icons/layers.svg)!important;mask-image:url(/icons/layers.svg)!important}svg[style*=\"/lock.svg\"]{-webkit-mask-image:url(/icons/lock.svg)!important;mask-image:url(/icons/lock.svg)!important}svg[style*=\"/magnifying-glass.svg\"]{-webkit-mask-image:url(/icons/magnifier.svg)!important;mask-image:url(/icons/magnifier.svg)!important}svg[style*=\"/megaphone.svg\"]{-webkit-mask-image:url(/icons/megaphone.svg)!important;mask-image:url(/icons/megaphone.svg)!important}svg[style*=\"/messages-question.svg\"]{-webkit-mask-image:url(/icons/circle-question.svg)!important;mask-image:url(/icons/circle-question.svg)!important}svg[style*=\"/mobile.svg\"]{-webkit-mask-image:url(/icons/mobile.svg)!important;mask-image:url(/icons/mobile.svg)!important}svg[style*=\"/object-group.svg\"]{-webkit-mask-image:url(/icons/object-selection.svg)!important;mask-image:url(/icons/object-selection.svg)!important}svg[style*=\"/palette.svg\"]{-webkit-mask-image:url(/icons/palette.svg)!important;mask-image:url(/icons/palette.svg)!important}svg[style*=\"/plug.svg\"]{-webkit-mask-image:url(/icons/plug.svg)!important;mask-image:url(/icons/plug.svg)!important}svg[style*=\"/puzzle-piece.svg\"]{-webkit-mask-image:url(/icons/puzzle-piece.svg)!important;mask-image:url(/icons/puzzle-piece.svg)!important}svg[style*=\"/receipt.svg\"]{-webkit-mask-image:url(/icons/receipt.svg)!important;mask-image:url(/icons/receipt.svg)!important}svg[style*=\"/repeat.svg\"]{-webkit-mask-image:url(/icons/repeat.svg)!important;mask-image:url(/icons/repeat.svg)!important}svg[style*=\"/robot.svg\"]{-webkit-mask-image:url(/icons/robot.svg)!important;mask-image:url(/icons/robot.svg)!important}svg[style*=\"/rocket.svg\"]{-webkit-mask-image:url(/icons/rocket.svg)!important;mask-image:url(/icons/rocket.svg)!important}svg[style*=\"/server.svg\"]{-webkit-mask-image:url(/icons/server.svg)!important;mask-image:url(/icons/server.svg)!important}svg[style*=\"/shield.svg\"]{-webkit-mask-image:url(/icons/shield.svg)!important;mask-image:url(/icons/shield.svg)!important}svg[style*=\"/shield-check.svg\"]{-webkit-mask-image:url(/icons/shield-check.svg)!important;mask-image:url(/icons/shield-check.svg)!important}svg[style*=\"/shield-halved.svg\"]{-webkit-mask-image:url(/icons/shield.svg)!important;mask-image:url(/icons/shield.svg)!important}svg[style*=\"/shopping-cart.svg\"]{-webkit-mask-image:url(/icons/cart-shopping.svg)!important;mask-image:url(/icons/cart-shopping.svg)!important}svg[style*=\"/sliders.svg\"]{-webkit-mask-image:url(/icons/sliders.svg)!important;mask-image:url(/icons/sliders.svg)!important}svg[style*=\"/store.svg\"]{-webkit-mask-image:url(/icons/shop.svg)!important;mask-image:url(/icons/shop.svg)!important}svg[style*=\"/swatchbook.svg\"]{-webkit-mask-image:url(/icons/color-palette.svg)!important;mask-image:url(/icons/color-palette.svg)!important}svg[style*=\"/tag.svg\"]{-webkit-mask-image:url(/icons/tag.svg)!important;mask-image:url(/icons/tag.svg)!important}svg[style*=\"/terminal.svg\"]{-webkit-mask-image:url(/icons/terminal.svg)!important;mask-image:url(/icons/terminal.svg)!important}svg[style*=\"/ticket.svg\"]{-webkit-mask-image:url(/icons/ticket.svg)!important;mask-image:url(/icons/ticket.svg)!important}svg[style*=\"/triangle-exclamation.svg\"]{-webkit-mask-image:url(/icons/triangle-warning.svg)!important;mask-image:url(/icons/triangle-warning.svg)!important}svg[style*=\"/truck.svg\"]{-webkit-mask-image:url(/icons/truck.svg)!important;mask-image:url(/icons/truck.svg)!important}svg[style*=\"/user-shield.svg\"]{-webkit-mask-image:url(/icons/user-shield.svg)!important;mask-image:url(/icons/user-shield.svg)!important}svg[style*=\"/users.svg\"]{-webkit-mask-image:url(/icons/users.svg)!important;mask-image:url(/icons/users.svg)!important}svg[style*=\"/vault.svg\"]{-webkit-mask-image:url(/icons/vault.svg)!important;mask-image:url(/icons/vault.svg)!important}svg[style*=\"/wallet.svg\"]{-webkit-mask-image:url(/icons/wallet.svg)!important;mask-image:url(/icons/wallet.svg)!important}svg[style*=\"/wave-pulse.svg\"]{-webkit-mask-image:url(/icons/heart-pulse.svg)!important;mask-image:url(/icons/heart-pulse.svg)!important}svg[style*=\"/webhook.svg\"]{-webkit-mask-image:url(/icons/webhook.svg)!important;mask-image:url(/icons/webhook.svg)!important}.callout [data-component-part=callout-icon]>svg>*{display:none}.callout [data-component-part=callout-icon]>svg{background-color:currentColor;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;-webkit-mask-size:contain;mask-size:contain}.callout.border-blue-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/circle-info.svg);mask-image:url(/icons/circle-info.svg)}.callout.border-green-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/circle-check.svg);mask-image:url(/icons/circle-check.svg)}.callout.border-red-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/circle-xmark.svg);mask-image:url(/icons/circle-xmark.svg)}.callout.border-yellow-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/triangle-warning.svg);mask-image:url(/icons/triangle-warning.svg)}.callout.border-neutral-200 [data-component-part=callout-icon]>svg{-webkit-mask-image:url(/icons/circle-info.svg);mask-image:url(/icons/circle-info.svg)}svg[style*=\"/fire.svg\"]{-webkit-mask-image:url(/brands/heleket.svg)!important;mask-image:url(/brands/heleket.svg)!important}svg[style*=\"/paypal.svg\"]{-webkit-mask-image:url(/brands/paypal.svg)!important;mask-image:url(/brands/paypal.svg)!important}svg[style*=\"/sack-dollar.svg\"]{-webkit-mask-image:url(/brands/paddle.svg)!important;mask-image:url(/brands/paddle.svg)!important}svg[style*=\"/shopify.svg\"]{-webkit-mask-image:url(/brands/shopify.svg)!important;mask-image:url(/brands/shopify.svg)!important}svg[style*=\"/square-dollar.svg\"]{-webkit-mask-image:url(/brands/cash-app.svg)!important;mask-image:url(/brands/cash-app.svg)!important}svg[style*=\"/stripe.svg\"]{-webkit-mask-image:url(/brands/stripe.svg)!important;mask-image:url(/brands/stripe.svg)!important}.kflag{display:inline-block;width:1.25rem;height:1.25rem;flex:none;vertical-align:-.2em;margin-right:.4rem;background-repeat:no-repeat;background-position:center;background-size:contain}.kflag-australia{background-image:url(/flags/australia.svg)}.kflag-belgium{background-image:url(/flags/belgium.svg)}.kflag-brazil{background-image:url(/flags/brazil.svg)}.kflag-canada{background-image:url(/flags/canada.svg)}.kflag-france{background-image:url(/flags/france.svg)}.kflag-germany{background-image:url(/flags/germany.svg)}.kflag-hong-kong{background-image:url(/flags/hong-kong.svg)}.kflag-india{background-image:url(/flags/india.svg)}.kflag-italy{background-image:url(/flags/italy.svg)}.kflag-mexico{background-image:url(/flags/mexico.svg)}.kflag-netherlands{background-image:url(/flags/netherlands.svg)}.kflag-poland{background-image:url(/flags/poland.svg)}.kflag-singapore{background-image:url(/flags/singapore.svg)}.kflag-spain{background-image:url(/flags/spain.svg)}.kflag-sweden{background-image:url(/flags/sweden.svg)}.kflag-united-kingdom{background-image:url(/flags/united-kingdom.svg)}.kflag-united-states{background-image:url(/flags/united-states.svg)}.k-btn{display:inline-flex;align-items:center;justify-content:center;gap:.5rem;font-weight:500;border-radius:var(--k-radius);border:1px solid transparent;cursor:pointer;user-select:none;transition:all 200ms;padding:.5rem 1rem;font-size:.875rem;line-height:1.25rem}.k-btn,.k-btn:active,.k-btn:hover,.k-btn:visited{text-decoration:none}.k-btn[aria-disabled=true],.k-btn[disabled]{opacity:.5;cursor:not-allowed;pointer-events:none}.k-btn--sm{padding:.375rem .75rem;font-size:.875rem}.k-btn--lg{padding:.75rem 1.5rem;font-size:1rem}.k-btn--primary{background-color:var(--color-primary-600);color:#fff;box-shadow:0 1px 2px 0 rgb(0 0 0/.05)}.k-btn--primary:hover{background-color:var(--color-primary-700);color:#fff;box-shadow:0 4px 6px -1px rgb(0 0 0/.1),0 2px 4px -2px rgb(0 0 0/.1)}.k-btn--primary:active{background-color:var(--color-primary-800);box-shadow:0 1px 2px 0 rgb(0 0 0/.05)}.k-btn--outline{border-color:var(--color-gray-300);background-color:#fff;color:var(--color-gray-700)}.k-btn--outline:hover{background-color:var(--color-gray-50);color:var(--color-gray-700)}.dark .k-btn--outline{border-color:var(--color-gray-600);background-color:var(--color-gray-800);color:var(--color-gray-300)}.dark .k-btn--outline:hover{background-color:var(--color-gray-700);color:var(--color-gray-300)}.k-btn--ghost,.k-btn--ghost:hover{color:var(--color-gray-700)}.k-btn--ghost:hover{background-color:var(--color-gray-200)}.dark .k-btn--ghost{color:#fff}.dark .k-btn--ghost:hover{background-color:var(--color-gray-700);color:#fff}.k-btn--danger{background-color:var(--color-error-600);color:#fff;box-shadow:0 1px 2px 0 rgb(0 0 0/.05)}.k-btn--danger:hover{background-color:var(--color-error-700);color:#fff}.k-btn--danger:active{background-color:var(--color-error-800)}:root{--k-radius:0.5rem;--color-orange-100:#ffedd5;--color-orange-400:#fb923c;--color-orange-800:#9a3412;--color-orange-900:#7c2d12}#content-area .card,#localization-select-trigger,#navbar li a[href],#search-bar-entry,#search-bar-entry-mobile,#sidebar-content .nav-anchor,#sidebar-content a[href],#theme-preference-menu-trigger,#topbar-cta-button a,#topbar-cta-button a>span,.tryit-button{border-radius:var(--k-radius)}input:not([type=checkbox]):not([type=radio]):not([type=range]),select,textarea{border-radius:var(--k-radius)}div:has(>div>input.chat-assistant-input){border-radius:var(--k-radius)}#content-area input:not([type=checkbox]):not([type=radio]):not([type=range]):not(.chat-assistant-input),#content-area select,#content-area textarea{display:block;width:100%;padding:.5rem .75rem;border:1px solid var(--color-gray-300);background-color:#fff;color:var(--color-gray-900);box-shadow:0 1px 2px 0 rgb(0 0 0/.05);transition:all 200ms}.dark #content-area input:not([type=checkbox]):not([type=radio]):not([type=range]):not(.chat-assistant-input),.dark #content-area select,.dark #content-area textarea{border-color:var(--color-gray-600);background-color:var(--color-gray-700);color:var(--color-gray-100)}#content-area input::placeholder,#content-area textarea::placeholder{color:var(--color-gray-400)}input:not([type=checkbox]):not([type=radio]):not([type=range]):not(.chat-assistant-input):focus,select:focus,textarea:focus{outline:0;border-color:var(--color-primary-500);box-shadow:0 0 0 3px var(--color-primary-500)}.code-block-copy-button button{border-radius:var(--k-radius);color:var(--color-gray-400);transition:color 150ms,background-color 150ms}.code-block-copy-button button:hover{color:var(--color-gray-600);background-color:var(--color-gray-200)}.dark .code-block-copy-button button:hover{color:var(--color-gray-200);background-color:var(--color-gray-600)}#page-context-menu-button{border-top-left-radius:var(--k-radius);border-bottom-left-radius:var(--k-radius)}#page-context-menu>button:last-child{border-top-right-radius:var(--k-radius);border-bottom-right-radius:var(--k-radius)}.code-block,.code-group{border-radius:var(--k-radius);border-color:var(--color-gray-300)}.dark .code-block,.dark .code-group,.dark a[data-component-part=pagination-next]:hover,.dark a[data-component-part=pagination-prev]:hover{border-color:var(--color-gray-600)}.code-group{padding-bottom:0}.code-group [data-component-part=code-block-root],.code-group div:has(>[data-component-part=code-block-root]){border-radius:0 0 calc(var(--k-radius) - 3px) calc(var(--k-radius) - 3px)!important}.code-group div:has(>[data-component-part=code-block-root])::before{border-radius:0 0 calc(var(--k-radius) - 3px) calc(var(--k-radius) - 3px)}.code-group>div:has([data-component-part=code-block-root]){margin-left:-.125rem;margin-right:-.125rem}#content-area table,.callout,.code-block [data-component-part=code-block-root]{border-radius:var(--k-radius)}.method-nav-pill>span{border-radius:9999px;font-weight:500}.method-nav-pill>span.bg-green-400\\/20{background-color:var(--color-success-100);color:var(--color-success-800)}.dark .method-nav-pill>span.bg-green-400\\/20{background-color:color-mix(in srgb,var(--color-success-900) 20%,transparent);color:var(--color-success-400)}.method-nav-pill>span.bg-blue-400\\/20{background-color:var(--color-primary-100);color:var(--color-primary-800)}.dark .callout.border-blue-200,.dark .method-nav-pill>span.bg-blue-400\\/20{background-color:color-mix(in srgb,var(--color-primary-900) 20%,transparent)}.dark .method-nav-pill>span.bg-blue-400\\/20{color:var(--color-primary-400)}.method-nav-pill>span.bg-yellow-400\\/20{background-color:var(--color-warning-100);color:var(--color-warning-800)}.dark .method-nav-pill>span.bg-yellow-400\\/20{background-color:color-mix(in srgb,var(--color-warning-900) 20%,transparent);color:var(--color-warning-400)}.method-nav-pill>span.bg-orange-400\\/20{background-color:var(--color-orange-100);color:var(--color-orange-800)}.dark .method-nav-pill>span.bg-orange-400\\/20{background-color:color-mix(in srgb,var(--color-orange-900) 20%,transparent);color:var(--color-orange-400)}.method-nav-pill>span.bg-red-400\\/20{background-color:var(--color-error-100);color:var(--color-error-800)}.dark .method-nav-pill>span.bg-red-400\\/20{background-color:color-mix(in srgb,var(--color-error-900) 20%,transparent);color:var(--color-error-400)}.method-nav-pill>span.bg-\\[\\#3064E3\\]{background-color:var(--color-primary-600);color:#fff}.callout{padding:1rem}.callout.border-blue-200{background-color:var(--color-primary-50);border-color:var(--color-primary-200)}.dark .callout.border-blue-200{border-color:var(--color-primary-800)}.callout.border-blue-200 [data-component-part=callout-content]{color:var(--color-primary-700)}.dark .callout.border-blue-200 [data-component-part=callout-content]{color:var(--color-primary-300)}.callout.border-blue-200 [data-component-part=callout-icon]>svg{color:var(--color-primary-600)}.dark .callout.border-blue-200 [data-component-part=callout-icon]>svg{color:var(--color-primary-400)}.callout.border-green-200{background-color:var(--color-success-50);border-color:var(--color-success-200)}.dark .callout.border-green-200{background-color:color-mix(in srgb,var(--color-success-900) 20%,transparent);border-color:var(--color-success-800)}.callout.border-green-200 [data-component-part=callout-content]{color:var(--color-success-700)}.dark .callout.border-green-200 [data-component-part=callout-content]{color:var(--color-success-300)}.callout.border-green-200 [data-component-part=callout-icon]>svg{color:var(--color-success-600)}.dark .callout.border-green-200 [data-component-part=callout-icon]>svg{color:var(--color-success-400)}.callout.border-yellow-200{background-color:var(--color-warning-50);border-color:var(--color-warning-200)}.dark .callout.border-yellow-200{background-color:color-mix(in srgb,var(--color-warning-900) 20%,transparent);border-color:var(--color-warning-800)}.callout.border-yellow-200 [data-component-part=callout-content]{color:var(--color-warning-700)}.dark .callout.border-yellow-200 [data-component-part=callout-content]{color:var(--color-warning-300)}.callout.border-yellow-200 [data-component-part=callout-icon]>svg{color:var(--color-warning-600)}.dark .callout.border-yellow-200 [data-component-part=callout-icon]>svg{color:var(--color-warning-400)}.callout.border-red-200{background-color:var(--color-error-50);border-color:var(--color-error-200)}.dark .callout.border-red-200{background-color:color-mix(in srgb,var(--color-error-900) 20%,transparent);border-color:var(--color-error-800)}.callout.border-red-200 [data-component-part=callout-content]{color:var(--color-error-700)}.dark .callout.border-red-200 [data-component-part=callout-content]{color:var(--color-error-300)}.callout.border-red-200 [data-component-part=callout-icon]>svg{color:var(--color-error-600)}.dark .callout.border-red-200 [data-component-part=callout-icon]>svg{color:var(--color-error-400)}.callout.border-neutral-200{background-color:var(--color-gray-50);border-color:var(--color-gray-200)}.dark .callout.border-neutral-200{background-color:var(--color-gray-800);border-color:var(--color-gray-700)}.callout.border-neutral-200 [data-component-part=callout-content]{color:var(--color-gray-700)}.dark .callout.border-neutral-200 [data-component-part=callout-content]{color:var(--color-gray-300)}.callout.border-neutral-200 [data-component-part=callout-icon]>svg{color:var(--color-gray-600)}.dark .callout.border-neutral-200 [data-component-part=callout-icon]>svg{color:var(--color-gray-400)}#content-area table{border-collapse:separate;border-spacing:0;border:1px solid var(--color-gray-200)}.dark #content-area .accordion-group,.dark #content-area details.accordion,.dark #content-area table,.dark a[data-component-part=pagination-next],.dark a[data-component-part=pagination-prev]{border-color:var(--color-gray-700)}#content-area table td,#content-area table th{border:0;border-bottom:1px solid var(--color-gray-200)}.dark #content-area table td,.dark #content-area table th{border-bottom-color:var(--color-gray-700)}#content-area table tbody tr:last-child td{border-bottom:0}#content-area table tbody tr:hover,#content-area table thead{background-color:var(--color-gray-50)}.dark #content-area table thead{background-color:var(--color-gray-800)}#content-area table th{padding:.75rem 1.5rem;text-align:left;font-size:.75rem;line-height:1rem;font-weight:500;text-transform:uppercase;letter-spacing:.05em;color:var(--color-gray-500)}.dark #content-area table th{color:var(--color-gray-400)}#content-area table td{padding:1rem 1.5rem}#content-area table tbody tr{transition:background-color 200ms}.dark #content-area details.accordion>summary:hover,.dark #content-area table tbody tr:hover{background-color:var(--color-gray-700)}#content-area table thead tr:first-child th:first-child{border-top-left-radius:calc(var(--k-radius) - 1px)}#content-area table thead tr:first-child th:last-child{border-top-right-radius:calc(var(--k-radius) - 1px)}#content-area table tbody tr:last-child td:first-child{border-bottom-left-radius:calc(var(--k-radius) - 1px)}#content-area table tbody tr:last-child td:last-child{border-bottom-right-radius:calc(var(--k-radius) - 1px)}#content-area .accordion-group,#content-area details.accordion,a[data-component-part=pagination-next],a[data-component-part=pagination-prev]{border-radius:var(--k-radius);border-color:var(--color-gray-200)}#content-area details.accordion>summary{border-top-left-radius:var(--k-radius);border-top-right-radius:var(--k-radius)}#content-area [data-component-part=field-required-pill]{border-radius:9999px;background-color:var(--color-error-100);color:var(--color-error-800)}.dark #content-area [data-component-part=field-required-pill]{background-color:color-mix(in srgb,var(--color-error-900) 20%,transparent);color:var(--color-error-400)}#content-area [data-component-part=field-info-pill]{border-radius:9999px;background-color:var(--color-gray-100);color:var(--color-gray-800)}.dark #content-area [data-component-part=field-info-pill],.dark #content-area [data-component-part=step-indicator]{background-color:var(--color-gray-700);color:var(--color-gray-300)}#content-area [data-component-part=step-indicator]{background-color:var(--color-gray-200);color:var(--color-gray-700)}#content-area [data-component-part=step-line]{background-color:var(--color-gray-200)}.dark #content-area [data-component-part=step-line]{background-color:var(--color-gray-700)}a[data-component-part=pagination-next]:hover,a[data-component-part=pagination-prev]:hover{border-color:var(--color-gray-300)}#content-area [role=tablist]:has([data-component-part=tab-button]){border-bottom-color:var(--color-gray-200)}.dark #content-area [role=tablist]:has([data-component-part=tab-button]){border-bottom-color:var(--color-gray-700)}#content-area [data-component-part=tab-button]{font-weight:500}#content-area [data-component-part=tab-button][data-active=true]{color:var(--color-primary-500)}.dark #content-area [data-component-part=tab-button][data-active=false]:hover,.dark #content-area [data-component-part=tab-button][data-active=true]{color:var(--color-primary-400)}#content-area [data-component-part=tab-button][data-active=false]{color:var(--color-gray-500)}.dark #content-area [data-component-part=tab-button][data-active=false]{color:var(--color-gray-400)}#content-area [data-component-part=tab-button][data-active=false]:hover{color:var(--color-primary-500)}"}],"page":{"pagePath":"api-reference/endpoint/orders/get","slug":"/api-reference/endpoint/orders/get","pageMetadata":{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","description":"Retrieve order details by ID in the given store.\nRequires the `stores.orders.view` permission.","href":"/api-reference/endpoint/orders/get"},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Retrieve order details by ID in the given store.\\nRequires the \", _jsx(_components.code, {\n children: \"stores.orders.view\"\n }), \" permission.\"]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Order Statuses`,icon:`circle-info`,href:`/api-reference/payment-status`,children:_jsx(_components.p,{children:`View all possible order status values and their meanings`})}),_jsx(Card,{title:`Payment Methods`,icon:`credit-card`,href:`/api-reference/payment-methods`,children:_jsx(_components.p,{children:`See supported payment gateways and cryptocurrencies`})})]})}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":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","description":"Retrieve order details by ID in the given store.\nRequires the `stores.orders.view` permission.","href":"/api-reference/endpoint/orders/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/komerza/8afe0a459f8a498b/hero-search.js","/_mintlify/custom/komerza/55d6214b814c5c42/ripple.js"],"openApiReferenceData":{"operation":{"tags":["Order"],"summary":"Get order by ID","description":"Retrieve order details by ID in the given store.\nRequires the `stores.orders.view` permission.","parameters":["a1ab2d11-c30a-43b1-a855-a7d58d3e8712","089d9aa6-027d-45f6-bf0f-b97c4bcd62c7"],"responses":{"200":"b2611381-dbb4-410e-b5a3-cb6407545a99","400":"ea73704a-93c5-4c7f-9a26-0797df91ae30","401":"813dd5dd-14ac-4b53-b5cb-e67f6f7afa13","403":"bef76654-5fd2-46ec-82cb-7ba5dc62274e","404":"762dc95e-8adb-4c2c-b7b6-806b007724f4"},"x-scopes":["stores.orders.view"],"method":"get","type":"path","servers":["c163b8df-bb70-462c-8f9f-8d6477f309a9"],"security":["aa17cceb-4c1e-42f0-8e8d-e9efcfdf2797"],"path":"/stores/{storeId}/orders/{orderId}","baseUrlOptions":["https://api.komerza.com"],"title":"Get order by ID","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"a1ab2d11-c30a-43b1-a855-a7d58d3e8712":{"name":"storeId","in":"path","description":"The ID of the store the order belongs to.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The ID of the store the order belongs to.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"089d9aa6-027d-45f6-bf0f-b97c4bcd62c7":{"name":"orderId","in":"path","description":"The ID of the order to retrieve.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The ID of the order to retrieve.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"b2611381-dbb4-410e-b5a3-cb6407545a99":{"description":"The object was successfully returned.","content":{"application/json":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"required":["ipInfo","logs","order","storeId","storeName"],"type":"object","properties":{"order":{"required":["amount","amountDueToGateway","appliedBalance","chargeAmountDue","chargeCurrencyCode","currencyCode","customer","dateCreated","deliveredItems","gateway","gatewayMetadata","globalGatewayFeeAmount","globalGatewayFeePercentage","globalGatewayFixedFee","globalGatewayFixedFeeAmount","id","ipAddress","isBuyerProtected","isCustomerAuthenticated","isDeliveredManually","isDeliveryItemsLocked","isMigrated","isSubscriptionOrder","isTopUp","items","komerzaPayAddonFeeEur","komerzaPayAddonFeeNative","komerzaPayItemPriceNative","platformFee","protectionFeeEur","protectionFeeNative","protectionKomerzaCutEur","protectionSellerShareEur","realCustomerId","sendReceipt","source","status","storeId","userAgent","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.dateCreated","typeLabel":"string\u003cdate-time>"},"items":{"type":"array","items":{"required":["additionalFeeAmount","additionalFeePercentage","additionalFixedFeeAmount","amount","dateCreated","id","lineTotal","orderId","productId","productName","quantity","storeId","variantId","variantName","volumeDiscountAmount"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"productName":{"maxLength":128,"minLength":3,"type":"string","description":"The name of the product","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].productName","typeLabel":"string"},"productId":{"type":"string","description":"The ID of the product","format":"uuid","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"variantId":{"type":"string","description":"The ID of the variant they purchased","format":"uuid","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].variantId","typeLabel":"string\u003cuuid>"},"variantName":{"maxLength":128,"minLength":3,"type":"string","description":"The name of the variant they purchased","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].variantName","typeLabel":"string"},"amount":{"type":"number","description":"The unit cost, how much one unit of the product costs","format":"double","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].amount","typeLabel":"number\u003cdouble>"},"lineTotal":{"type":"number","description":"The total cost for the line item (Amount * Quantity)","format":"double","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].lineTotal","typeLabel":"number\u003cdouble>"},"additionalFeePercentage":{"type":"number","description":"An additional fee percentage applied to the line item, if any.","format":"double","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].additionalFeePercentage","typeLabel":"number\u003cdouble>"},"additionalFeeAmount":{"type":"number","description":"The total amount of any additional percentage fees applied to the line item.","format":"double","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].additionalFeeAmount","typeLabel":"number\u003cdouble>"},"additionalFixedFeeAmount":{"type":"number","description":"The total amount of any additional fixed fees applied to the line item.","format":"double","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].additionalFixedFeeAmount","typeLabel":"number\u003cdouble>"},"volumeDiscountAmount":{"type":"number","description":"The volume discount amount applied to this line item.","format":"double","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].volumeDiscountAmount","typeLabel":"number\u003cdouble>"},"storeId":{"type":"string","description":"The ID of the store the product belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"orderId":{"type":"string","description":"The ID of the order associated with the item","format":"uuid","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].orderId","typeLabel":"string\u003cuuid>"},"quantity":{"type":"integer","description":"The amount of product that was purchased","format":"int32","isRequired":true,"uniqueKey":"data.order.\\items.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"volumeDiscountType":{"enum":[0,1,2],"type":"integer","description":"Specifies the type of discount to apply for volume pricing tiers.","format":"int32","x-enum-varnames":["Percentage","FixedAmount","FixedPrice"],"x-enum-descriptions":["Discount is applied as a percentage off the unit price.","A fixed amount is deducted from each unit price.","The unit price is overridden with a fixed price."],"uniqueKey":"data.order.\\items.items.[INDEX].volumeDiscountType","typeLabel":"enum\u003cinteger>"},"volumeDiscountValue":{"oneOf":[{"type":"number","description":"The discount value from the applied tier (e.g., 10 for 10% or $10).","format":"double","uniqueKey":"data.order.\\items.items.[INDEX].volumeDiscountValue.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The discount value from the applied tier (e.g., 10 for 10% or $10).","format":"double","uniqueKey":"data.order.\\items.items.[INDEX].volumeDiscountValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.\\items.items.[INDEX].volumeDiscountValue","typeLabel":"number\u003cdouble> | null"},"volumeDiscountTierQuantity":{"oneOf":[{"type":"integer","description":"The quantity threshold of the tier that was applied (e.g., 10 for \"Buy 10+\").","format":"int32","uniqueKey":"data.order.\\items.items.[INDEX].volumeDiscountTierQuantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The quantity threshold of the tier that was applied (e.g., 10 for \"Buy 10+\").","format":"int32","uniqueKey":"data.order.\\items.items.[INDEX].volumeDiscountTierQuantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.\\items.items.[INDEX].volumeDiscountTierQuantity","typeLabel":"integer\u003cint32> | null"},"billingInterval":{"enum":[0,1,2,3,4],"type":"integer","description":"The billing interval for a subscription product","format":"int32","x-enum-varnames":["Weekly","Monthly","Quarterly","Yearly","Custom"],"x-enum-descriptions":["Billed every week","Billed every month","Billed every three months","Billed every year","Billed at a custom interval defined by CustomIntervalDays"],"uniqueKey":"data.order.\\items.items.[INDEX].billingInterval","typeLabel":"enum\u003cinteger>"},"customIntervalDays":{"oneOf":[{"type":"integer","description":"Custom interval in days when BillingInterval is Custom.","format":"int32","uniqueKey":"data.order.\\items.items.[INDEX].customIntervalDays.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Custom interval in days when BillingInterval is Custom.","format":"int32","uniqueKey":"data.order.\\items.items.[INDEX].customIntervalDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.\\items.items.[INDEX].customIntervalDays","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"description":"An item associated with an order or checkout session","uniqueKey":"data.order.\\items.items.[INDEX]","typeLabel":"object"},"description":"The list of items the customer has ordered","isRequired":true,"uniqueKey":"data.order.\\items","typeLabel":"object[]"},"gatewayMetadata":{"required":["dateCreated","id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.gatewayMetadata.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.gatewayMetadata.dateCreated","typeLabel":"string\u003cdate-time>"},"transactionId":{"oneOf":[{"maxLength":128,"type":"string","description":"The transaction ID associated with the gateway","uniqueKey":"data.order.gatewayMetadata.transactionId.oneOf.0","typeLabel":"string"},{"maxLength":128,"type":"null","description":"The transaction ID associated with the gateway","uniqueKey":"data.order.gatewayMetadata.transactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.transactionId","typeLabel":"string | null"},"clientSecret":{"oneOf":[{"maxLength":256,"type":"string","description":"The client secret used by card gateways to facilitate payments down to the browser","uniqueKey":"data.order.gatewayMetadata.clientSecret.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The client secret used by card gateways to facilitate payments down to the browser","uniqueKey":"data.order.gatewayMetadata.clientSecret.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.clientSecret","typeLabel":"string | null"},"note":{"oneOf":[{"maxLength":64,"type":"string","description":"The note for PayPal Friends and Family or Cash App payments","uniqueKey":"data.order.gatewayMetadata.note.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The note for PayPal Friends and Family or Cash App payments","uniqueKey":"data.order.gatewayMetadata.note.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.note","typeLabel":"string | null"},"cryptocurrencyAddress":{"oneOf":[{"maxLength":256,"type":"string","description":"The address for a cryptocurrency payment","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyAddress.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The address for a cryptocurrency payment","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.cryptocurrencyAddress","typeLabel":"string | null"},"cryptocurrencyAmount":{"oneOf":[{"type":"number","description":"The amount of cryptocurrency converted at the time for a cryptocurrency payment","format":"double","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The amount of cryptocurrency converted at the time for a cryptocurrency payment","format":"double","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.cryptocurrencyAmount","typeLabel":"number\u003cdouble> | null"},"cryptocurrencyExpiration":{"oneOf":[{"type":"string","description":"The date the cryptocurrency payment expires","format":"date-time","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyExpiration.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the cryptocurrency payment expires","format":"date-time","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyExpiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.cryptocurrencyExpiration","typeLabel":"string\u003cdate-time> | null"},"cryptocurrencyProcessor":{"oneOf":[{"maxLength":32,"type":"string","description":"The non-custodial processor backing this crypto payment (e.g. `conduit`,\n`nowpayments`). Null for legacy custodial payments.","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyProcessor.oneOf.0","typeLabel":"string"},{"maxLength":32,"type":"null","description":"The non-custodial processor backing this crypto payment (e.g. `conduit`,\n`nowpayments`). Null for legacy custodial payments.","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyProcessor.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.cryptocurrencyProcessor","typeLabel":"string | null"},"cryptocurrencyPaymentUri":{"oneOf":[{"maxLength":512,"type":"string","description":"A wallet-ready payment URI for the QR code (BIP21 / EIP-681 / Solana Pay), when the\nprocessor provides one.","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyPaymentUri.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"A wallet-ready payment URI for the QR code (BIP21 / EIP-681 / Solana Pay), when the\nprocessor provides one.","uniqueKey":"data.order.gatewayMetadata.cryptocurrencyPaymentUri.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.cryptocurrencyPaymentUri","typeLabel":"string | null"},"gatewaySubscriptionId":{"oneOf":[{"maxLength":128,"type":"string","description":"The ID of the subscription created at checkout time (e.g. Stripe sub_xxx).\nWhen set, the delivery handler should skip remote subscription creation.","uniqueKey":"data.order.gatewayMetadata.gatewaySubscriptionId.oneOf.0","typeLabel":"string"},{"maxLength":128,"type":"null","description":"The ID of the subscription created at checkout time (e.g. Stripe sub_xxx).\nWhen set, the delivery handler should skip remote subscription creation.","uniqueKey":"data.order.gatewayMetadata.gatewaySubscriptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.gatewaySubscriptionId","typeLabel":"string | null"},"chargeCurrencyCode":{"oneOf":[{"maxLength":3,"type":"string","description":"Adaptive currency: the currency the payment gateway actually charges for this session, when it\ndiffers from the order's base currency. Null means the gateway charges in the base currency —\nthe pre-adaptive behavior and the default for every gateway that hasn't been currency-audited.\nScoped to the session: retiring the session (gateway switch) clears it, and the replacement\nsession re-resolves it for the new gateway.","uniqueKey":"data.order.gatewayMetadata.chargeCurrencyCode.oneOf.0","typeLabel":"string"},{"maxLength":3,"type":"null","description":"Adaptive currency: the currency the payment gateway actually charges for this session, when it\ndiffers from the order's base currency. Null means the gateway charges in the base currency —\nthe pre-adaptive behavior and the default for every gateway that hasn't been currency-audited.\nScoped to the session: retiring the session (gateway switch) clears it, and the replacement\nsession re-resolves it for the new gateway.","uniqueKey":"data.order.gatewayMetadata.chargeCurrencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.chargeCurrencyCode","typeLabel":"string | null"},"chargeFxRate":{"oneOf":[{"type":"number","description":"Adaptive currency: the base→charge conversion rate for this session (margin included). When the\ncharge currency equals the order's presentment currency this is the order's snapshotted\npresentment rate — the shopper is charged exactly the number they were shown. Only differs when\nthe gateway supports neither the shopper's nor the store's currency and a fallback major was\nselected.","format":"double","uniqueKey":"data.order.gatewayMetadata.chargeFxRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Adaptive currency: the base→charge conversion rate for this session (margin included). When the\ncharge currency equals the order's presentment currency this is the order's snapshotted\npresentment rate — the shopper is charged exactly the number they were shown. Only differs when\nthe gateway supports neither the shopper's nor the store's currency and a fallback major was\nselected.","format":"double","uniqueKey":"data.order.gatewayMetadata.chargeFxRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayMetadata.chargeFxRate","typeLabel":"number\u003cdouble> | null"}},"additionalProperties":false,"description":"The metadata for a specific payment gateway","isRequired":true,"uniqueKey":"data.order.gatewayMetadata","typeLabel":"object"},"customer":{"required":["countryCode","customerId","dateCreated","emailAddress","id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.customer.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.customer.dateCreated","typeLabel":"string\u003cdate-time>"},"countryCode":{"maxLength":2,"minLength":1,"type":"string","description":"The country code of the customer","isRequired":true,"uniqueKey":"data.order.customer.countryCode","typeLabel":"string"},"emailAddress":{"maxLength":256,"minLength":1,"type":"string","description":"The email address of the customer","isRequired":true,"uniqueKey":"data.order.customer.emailAddress","typeLabel":"string"},"customerId":{"type":"string","description":"The ID of the customer profile in the database","format":"uuid","isRequired":true,"uniqueKey":"data.order.customer.customerId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"description":"Represents a snapshot of the customer details at the time of the order","isRequired":true,"uniqueKey":"data.order.customer","typeLabel":"object"},"storeId":{"type":"string","description":"The ID of the store the order was created for","format":"uuid","isRequired":true,"uniqueKey":"data.order.storeId","typeLabel":"string\u003cuuid>"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The ID of the user who owns the store the order was created for","isRequired":true,"uniqueKey":"data.order.userId","typeLabel":"string"},"deliveredItems":{"type":"array","items":{"required":["customerId","dateCreated","id","orderId","productId","source","storeId","type","variantId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"orderId":{"type":"string","description":"The unique identifier for the order associated with the delivered item.","format":"uuid","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].orderId","typeLabel":"string\u003cuuid>"},"storeId":{"type":"string","description":"The unique identifier for the store associated with the delivered item.","format":"uuid","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"productId":{"type":"string","description":"The identifier of the related product, if applicable.","format":"uuid","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"variantId":{"type":"string","description":"The identifier for the variant of the delivered item, if applicable.","format":"uuid","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].variantId","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","description":"The optional identifier for the customer associated with the delivered item (and order)","format":"uuid","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"type":{"maxLength":128,"type":"string","description":"The type that categorizes the delivered item.","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].type","typeLabel":"string"},"source":{"maxLength":128,"type":"string","description":"The source of the delivered item, indicates its origin or context.","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].source","typeLabel":"string"},"textContent":{"oneOf":[{"maxLength":10000,"type":"string","description":"The text content associated with the delivered item. Used for LicenseKey, Plaintext, or Dynamic types.","uniqueKey":"data.order.deliveredItems.items.[INDEX].textContent.oneOf.0","typeLabel":"string"},{"maxLength":10000,"type":"null","description":"The text content associated with the delivered item. Used for LicenseKey, Plaintext, or Dynamic types.","uniqueKey":"data.order.deliveredItems.items.[INDEX].textContent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredItems.items.[INDEX].textContent","typeLabel":"string | null"},"fileId":{"oneOf":[{"type":"string","description":"The identifier of the file associated with the delivered item, if applicable.","format":"uuid","uniqueKey":"data.order.deliveredItems.items.[INDEX].fileId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The identifier of the file associated with the delivered item, if applicable.","format":"uuid","uniqueKey":"data.order.deliveredItems.items.[INDEX].fileId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredItems.items.[INDEX].fileId","typeLabel":"string\u003cuuid> | null"},"webhookExecutionLogId":{"oneOf":[{"type":"string","description":"The ID of the webhook/dynamic delivery request associated with this delivered item.","format":"uuid","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLogId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The ID of the webhook/dynamic delivery request associated with this delivered item.","format":"uuid","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLogId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLogId","typeLabel":"string\u003cuuid> | null"},"file":{"required":["dateCreated","friendlyName","id","ipAddress","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].file.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].file.dateCreated","typeLabel":"string\u003cdate-time>"},"friendlyName":{"maxLength":128,"minLength":1,"type":"string","description":"The friendly name of the file","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].file.friendlyName","typeLabel":"string"},"ipAddress":{"maxLength":45,"minLength":1,"type":"string","description":"The IP address which uploaded the file","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].file.ipAddress","typeLabel":"string"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The ID of the user who uploaded the file","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].file.userId","typeLabel":"string"}},"additionalProperties":false,"description":"A file stored on a product for delivery","uniqueKey":"data.order.deliveredItems.items.[INDEX].file","typeLabel":"object"},"webhookExecutionLog":{"required":["dateCreated","id","requestBody","retryCount","signature","url"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.dateCreated","typeLabel":"string\u003cdate-time>"},"url":{"maxLength":2048,"type":"string","description":"The URL associated with the webhook execution log.","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.url","typeLabel":"string"},"signature":{"maxLength":128,"type":"string","description":"The signature of the webhook execution, used for validation and security purposes.","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.signature","typeLabel":"string"},"requestBody":{"maxLength":8192,"type":"string","description":"The body of the request sent in a webhook execution.","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.requestBody","typeLabel":"string"},"retryCount":{"type":"integer","description":"The number of times this webhook has been dispatched (initial + retries via Hangfire requeue).\nStarts at 1 for the first attempt and increments on each resend.","format":"int32","isRequired":true,"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.retryCount","typeLabel":"integer\u003cint32>"},"responseCode":{"oneOf":[{"type":"integer","description":"The HTTP response code resulting from executing the webhook.","format":"int32","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.responseCode.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP response code resulting from executing the webhook.","format":"int32","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.responseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.responseCode","typeLabel":"integer\u003cint32> | null"},"responseBody":{"oneOf":[{"maxLength":8192,"type":"string","description":"The response body returned by a webhook execution log.","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.responseBody.oneOf.0","typeLabel":"string"},{"maxLength":8192,"type":"null","description":"The response body returned by a webhook execution log.","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.responseBody.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.responseBody","typeLabel":"string | null"},"webhookId":{"oneOf":[{"type":"string","description":"The unique identifier of the webhook associated with this log.","format":"uuid","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.webhookId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The unique identifier of the webhook associated with this log.","format":"uuid","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.webhookId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.webhookId","typeLabel":"string\u003cuuid> | null"},"userId":{"oneOf":[{"maxLength":36,"type":"string","description":"The ID of the user who owns the webhook. Nullable for backwards compatibility\nwith existing logs that predate this field.","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.userId.oneOf.0","typeLabel":"string"},{"maxLength":36,"type":"null","description":"The ID of the user who owns the webhook. Nullable for backwards compatibility\nwith existing logs that predate this field.","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.userId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.userId","typeLabel":"string | null"},"userAgent":{"oneOf":[{"maxLength":512,"type":"string","description":"The user agent header sent to the merchant's endpoint.","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.userAgent.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The user agent header sent to the merchant's endpoint.","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.userAgent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.userAgent","typeLabel":"string | null"},"orderId":{"oneOf":[{"type":"string","description":"The unique identifier for the order associated with the webhook execution log.","format":"uuid","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.orderId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The unique identifier for the order associated with the webhook execution log.","format":"uuid","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.orderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog.orderId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"description":"A log for a webhook execution.","uniqueKey":"data.order.deliveredItems.items.[INDEX].webhookExecutionLog","typeLabel":"object"}},"additionalProperties":false,"description":"Represents an item that is delivered as part of an order.","uniqueKey":"data.order.deliveredItems.items.[INDEX]","typeLabel":"object"},"description":"The collection of items that have been delivered as part of an order.","isRequired":true,"uniqueKey":"data.order.deliveredItems","typeLabel":"object[]"},"status":{"maxLength":64,"type":"string","description":"Represents the current status of the order, indicating the completion state of the payment process.","isRequired":true,"uniqueKey":"data.order.status","typeLabel":"string"},"gateway":{"maxLength":64,"type":"string","description":"The payment gateway used for processing the transaction.","isRequired":true,"uniqueKey":"data.order.gateway","typeLabel":"string"},"amount":{"type":"number","description":"Represents the monetary value associated with an order.","format":"double","isRequired":true,"uniqueKey":"data.order.amount","typeLabel":"number\u003cdouble>"},"isTopUp":{"type":"boolean","description":"Whether this order is a customer balance top-up (no products; on completion the\nBalanceTopUpAmount is credited to the customer's store balance).","isRequired":true,"uniqueKey":"data.order.isTopUp","typeLabel":"boolean"},"appliedBalance":{"type":"number","description":"The portion of this order paid from the customer's store balance (split payment). This amount is\nheld (debited from balance) when applied; the gateway charges the remainder\n(AmountDueToGateway). Defaults to zero for orders paid entirely by one method.","format":"double","isRequired":true,"uniqueKey":"data.order.appliedBalance","typeLabel":"number\u003cdouble>"},"amountDueToGateway":{"type":"number","description":"The amount the external payment gateway must charge: the gross Amount minus any\nAppliedBalance. Never persisted — derived for use by gateway handlers.","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"data.order.amountDueToGateway","typeLabel":"number\u003cdouble>"},"chargeCurrencyCode":{"type":"string","description":"Adaptive currency: the currency the current payment session charges in. Falls back to the base\nCurrencyCode when no charge snapshot exists (classic orders, unaudited gateways,\nor metadata not loaded) — the pre-adaptive behavior. Currency-enabled gateway adapters must read\nthis instead of CurrencyCode everywhere they talk to the PSP.","readOnly":true,"isRequired":true,"uniqueKey":"data.order.chargeCurrencyCode","typeLabel":"string"},"chargeAmountDue":{"type":"number","description":"Adaptive currency: AmountDueToGateway converted into the session's charge currency\nat the snapshotted rate (exponent-aware). Equals AmountDueToGateway when the\nsession charges in the base currency. Never persisted — always derived, so repricing can never\ndesync it.","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"data.order.chargeAmountDue","typeLabel":"number\u003cdouble>"},"platformFee":{"type":"number","description":"The fee collected by the platform from the order's total amount","format":"double","isRequired":true,"uniqueKey":"data.order.platformFee","typeLabel":"number\u003cdouble>"},"globalGatewayFeePercentage":{"type":"number","description":"The global gateway fee percentage that was configured (e.g., 2.5 for 2.5%).","format":"double","isRequired":true,"uniqueKey":"data.order.globalGatewayFeePercentage","typeLabel":"number\u003cdouble>"},"globalGatewayFeeAmount":{"type":"number","description":"The calculated amount from the global gateway fee percentage.","format":"double","isRequired":true,"uniqueKey":"data.order.globalGatewayFeeAmount","typeLabel":"number\u003cdouble>"},"globalGatewayFixedFee":{"type":"number","description":"The global gateway fixed fee that was configured.","format":"double","isRequired":true,"uniqueKey":"data.order.globalGatewayFixedFee","typeLabel":"number\u003cdouble>"},"globalGatewayFixedFeeAmount":{"type":"number","description":"The global gateway fixed fee amount actually applied (0 if product-level overrides exist).","format":"double","isRequired":true,"uniqueKey":"data.order.globalGatewayFixedFeeAmount","typeLabel":"number\u003cdouble>"},"realCustomerId":{"type":"string","description":"The ID of the customer who made the order","format":"uuid","isRequired":true,"uniqueKey":"data.order.realCustomerId","typeLabel":"string\u003cuuid>"},"currencyCode":{"maxLength":3,"minLength":1,"type":"string","description":"The fiat currency code used for the order, defaults to USD","isRequired":true,"uniqueKey":"data.order.currencyCode","typeLabel":"string"},"userAgent":{"maxLength":512,"minLength":1,"type":"string","description":"The user agent used to create the order","isRequired":true,"uniqueKey":"data.order.userAgent","typeLabel":"string"},"ipAddress":{"maxLength":45,"minLength":1,"type":"string","description":"The IP address used to create the order","isRequired":true,"uniqueKey":"data.order.ipAddress","typeLabel":"string"},"isDeliveredManually":{"type":"boolean","description":"Whether the order was delivered manually or not","isRequired":true,"uniqueKey":"data.order.isDeliveredManually","typeLabel":"boolean"},"isDeliveryItemsLocked":{"type":"boolean","description":"Whether the delivery items are locked or not, if this is true then the unauthenticated get order items will return\nan access denied error","isRequired":true,"uniqueKey":"data.order.isDeliveryItemsLocked","typeLabel":"boolean"},"isCustomerAuthenticated":{"type":"boolean","description":"Whether the customer has been authenticated by the create order endpoint, this makes the \"Pay with customer\nbalance\" button\nnot require auth","isRequired":true,"uniqueKey":"data.order.isCustomerAuthenticated","typeLabel":"boolean"},"isMigrated":{"type":"boolean","description":"Whether the order is migrated or not from another platform, these orders are not","isRequired":true,"uniqueKey":"data.order.isMigrated","typeLabel":"boolean"},"sendReceipt":{"type":"boolean","description":"Whether to send a receipt email to the customer after the order is completed.\nDefaults to true.","isRequired":true,"uniqueKey":"data.order.sendReceipt","typeLabel":"boolean"},"source":{"maxLength":16,"type":"string","description":"The source of the order: \"store\" (marketplace), \"embed\" (embeds), \"api\" (dashboard/API).","isRequired":true,"uniqueKey":"data.order.source","typeLabel":"string"},"isSubscriptionOrder":{"type":"boolean","description":"Whether this order contains subscription products with recurring billing.","isRequired":true,"uniqueKey":"data.order.isSubscriptionOrder","typeLabel":"boolean"},"isBuyerProtected":{"type":"boolean","description":"Whether the buyer opted into Komerza Buyer Protection on this order. When true a protection fee\nwas added on top of the order total and is tracked for revenue-share settlement.","isRequired":true,"uniqueKey":"data.order.isBuyerProtected","typeLabel":"boolean"},"protectionFeeEur":{"type":"number","description":"The protection fee charged for this order, in EUR, computed from a progressive fee schedule (see\n`ProtectionFeeCalculator`) keyed on the order value and capped at `ProtectionFeeCalculator.MaxFeeEur`.\nZero when not protected.","format":"double","isRequired":true,"uniqueKey":"data.order.protectionFeeEur","typeLabel":"number\u003cdouble>"},"protectionFeeNative":{"type":"number","description":"The protection fee in the order's own currency (CurrencyCode), i.e. the amount actually\nadded on top of the order total that the buyer paid via the seller's gateway.","format":"double","isRequired":true,"uniqueKey":"data.order.protectionFeeNative","typeLabel":"number\u003cdouble>"},"protectionSellerShareEur":{"type":"number","description":"The merchant's revenue share of the protection fee, in EUR.","format":"double","isRequired":true,"uniqueKey":"data.order.protectionSellerShareEur","typeLabel":"number\u003cdouble>"},"protectionKomerzaCutEur":{"type":"number","description":"Komerza's cut of the protection fee, in EUR (the amount that accrues toward the merchant's invoice).","format":"double","isRequired":true,"uniqueKey":"data.order.protectionKomerzaCutEur","typeLabel":"number\u003cdouble>"},"komerzaPayAddonFeeEur":{"type":"number","description":"The buyer-paid Komerza Pay addon fee charged on this order, in the order's own currency —\nthe amount added on top of the merchant's listed price, exactly as\nProtectionFeeNative is for Buyer Protection.\n\nAmount\u003cb>includes\u003c/b> this. The buyer is charged the order total and\n nothing more, so the price shown at checkout is the price taken at the bank — which for a\n merchant-of-record sale is not a nicety, since Komerza is the seller.\nStored rather than recomputed at settlement because the fee schedule moves: recomputing\n would price a months-old sale at today's rates and silently disagree with what the buyer\n actually paid.","format":"double","isRequired":true,"uniqueKey":"data.order.komerzaPayAddonFeeEur","typeLabel":"number\u003cdouble>"},"komerzaPayAddonFeeNative":{"type":"number","description":"The same fee in the order's own currency (CurrencyCode) — the amount actually\nadded on top of Amount, mirroring ProtectionFeeNative.\n\nBoth are stored because they answer different questions: the buyer paid the native figure,\n and Komerza earned the EUR one. Deriving either from the other later would use a rate that\n has since moved.","format":"double","isRequired":true,"uniqueKey":"data.order.komerzaPayAddonFeeNative","typeLabel":"number\u003cdouble>"},"komerzaPayItemPriceNative":{"type":"number","description":"What the merchant listed the goods at, in the order's own currency — the order total less the\nbuyer-paid Komerza Pay addon fee. Derived, never persisted.\n\nKomerza Pay settles in EUR, so this is not the figure the ledger uses: it credits the\n euro value of the sale, which is the euro amount actually charged less\n KomerzaPayAddonFeeEur. This is here for display, where the buyer's own\n currency is what makes sense.","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"data.order.komerzaPayItemPriceNative","typeLabel":"number\u003cdouble>"},"coupon":{"required":["code","couponId","dateCreated","id","netDecrease"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.coupon.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.coupon.dateCreated","typeLabel":"string\u003cdate-time>"},"netDecrease":{"type":"number","description":"The net amount the coupon decreased the order by","format":"double","isRequired":true,"uniqueKey":"data.order.coupon.netDecrease","typeLabel":"number\u003cdouble>"},"code":{"maxLength":32,"minLength":3,"type":"string","description":"The code of the coupon","isRequired":true,"uniqueKey":"data.order.coupon.code","typeLabel":"string"},"couponId":{"type":"string","description":"The ID of the coupon","format":"uuid","isRequired":true,"uniqueKey":"data.order.coupon.couponId","typeLabel":"string\u003cuuid>"},"percentageDecrease":{"oneOf":[{"type":"number","description":"The percentage the coupon cut off the order, this is null if the coupon was a fixed amount instead which the net\ndecrease is below","format":"double","uniqueKey":"data.order.coupon.percentageDecrease.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The percentage the coupon cut off the order, this is null if the coupon was a fixed amount instead which the net\ndecrease is below","format":"double","uniqueKey":"data.order.coupon.percentageDecrease.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.coupon.percentageDecrease","typeLabel":"number\u003cdouble> | null"}},"additionalProperties":false,"description":"Represents a coupon code used on an order","uniqueKey":"data.order.coupon","typeLabel":"object"},"affiliateDiscount":{"required":["dateCreated","id","netDecrease"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.affiliateDiscount.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.affiliateDiscount.dateCreated","typeLabel":"string\u003cdate-time>"},"netDecrease":{"type":"number","description":"The net amount the coupon decreased the order by","format":"double","isRequired":true,"uniqueKey":"data.order.affiliateDiscount.netDecrease","typeLabel":"number\u003cdouble>"},"percentageDecrease":{"oneOf":[{"type":"number","description":"The percentage the coupon cut off the order, this is null if the coupon was a fixed amount instead which the net\ndecrease is below","format":"double","uniqueKey":"data.order.affiliateDiscount.percentageDecrease.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The percentage the coupon cut off the order, this is null if the coupon was a fixed amount instead which the net\ndecrease is below","format":"double","uniqueKey":"data.order.affiliateDiscount.percentageDecrease.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.affiliateDiscount.percentageDecrease","typeLabel":"number\u003cdouble> | null"}},"additionalProperties":false,"description":"Represents a discount used on an order","uniqueKey":"data.order.affiliateDiscount","typeLabel":"object"},"tax":{"required":["dateCreated","id","isReverseCharge","preTaxAmount","taxAmount","taxBehavior","taxName","taxRate"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.tax.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.tax.dateCreated","typeLabel":"string\u003cdate-time>"},"taxAmount":{"type":"number","description":"The tax amount charged on this order.","format":"double","isRequired":true,"uniqueKey":"data.order.tax.taxAmount","typeLabel":"number\u003cdouble>"},"taxRate":{"type":"number","description":"The tax rate applied as a percentage (e.g. 20 for 20%).","format":"double","isRequired":true,"uniqueKey":"data.order.tax.taxRate","typeLabel":"number\u003cdouble>"},"taxName":{"maxLength":64,"minLength":1,"type":"string","description":"The display name of the tax (e.g. \"VAT\", \"Sales Tax\").","isRequired":true,"uniqueKey":"data.order.tax.taxName","typeLabel":"string"},"isReverseCharge":{"type":"boolean","description":"Whether reverse charge was applied (B2B cross-border EU).","isRequired":true,"uniqueKey":"data.order.tax.isReverseCharge","typeLabel":"boolean"},"preTaxAmount":{"type":"number","description":"The order subtotal before tax was applied.","format":"double","isRequired":true,"uniqueKey":"data.order.tax.preTaxAmount","typeLabel":"number\u003cdouble>"},"taxBehavior":{"maxLength":16,"minLength":1,"type":"string","description":"Tax behavior at time of order: \"exclusive\" or \"inclusive\".","isRequired":true,"uniqueKey":"data.order.tax.taxBehavior","typeLabel":"string"},"customerVatId":{"oneOf":[{"maxLength":64,"type":"string","description":"The customer's VAT/tax ID if provided.","uniqueKey":"data.order.tax.customerVatId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The customer's VAT/tax ID if provided.","uniqueKey":"data.order.tax.customerVatId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.tax.customerVatId","typeLabel":"string | null"}},"additionalProperties":false,"description":"Snapshot of the tax applied to an order at the time of purchase.","uniqueKey":"data.order.tax","typeLabel":"object"},"refund":{"required":["amount","dateCreated","id","ipAddress","orderId","reason","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.refund.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.refund.dateCreated","typeLabel":"string\u003cdate-time>"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"Represents the ID of the user associated with the refund.","isRequired":true,"uniqueKey":"data.order.refund.userId","typeLabel":"string"},"ipAddress":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the IP address associated with the refund transaction.","isRequired":true,"uniqueKey":"data.order.refund.ipAddress","typeLabel":"string"},"reason":{"enum":[0,1,2,3],"type":"integer","description":"Indicates a duplicate transaction or order as the reason for a refund.","format":"int32","x-enum-varnames":["Fraudulent","RequestedByCustomer","Duplicate","Other"],"x-enum-descriptions":["Indicates a refund was requested due to suspected fraudulent activity.","Indicates a refund was requested by the customer.","Indicates a duplicate transaction or order as the reason for a refund.","Indicates a refund was requested for reasons not covered by other predefined categories."],"isRequired":true,"uniqueKey":"data.order.refund.reason","typeLabel":"enum\u003cinteger>"},"amount":{"type":"number","description":"Gets or sets the amount of the refund.","format":"double","isRequired":true,"uniqueKey":"data.order.refund.amount","typeLabel":"number\u003cdouble>"},"orderId":{"type":"string","description":"Represents the unique identifier for the associated order in the refund process.","format":"uuid","isRequired":true,"uniqueKey":"data.order.refund.orderId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"description":"Represents a refund associated with a specific user, order, and reason for payment adjustment.","uniqueKey":"data.order.refund","typeLabel":"object"},"chargeback":{"required":["dateCreated","id","orderId","reason","status"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.chargeback.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.chargeback.dateCreated","typeLabel":"string\u003cdate-time>"},"status":{"maxLength":64,"minLength":1,"type":"string","description":"Represents the current state of the dispute.","isRequired":true,"uniqueKey":"data.order.chargeback.status","typeLabel":"string"},"reason":{"maxLength":2000,"minLength":1,"type":"string","description":"Represents the reason associated with a dispute.","isRequired":true,"uniqueKey":"data.order.chargeback.reason","typeLabel":"string"},"orderId":{"type":"string","description":"Represents the unique identifier for the associated order in the context of a dispute.","format":"uuid","isRequired":true,"uniqueKey":"data.order.chargeback.orderId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"description":"Represents a dispute entity in the payment system.\nA dispute is associated with a specific order and contains information about its status and reason.","uniqueKey":"data.order.chargeback","typeLabel":"object"},"discordAccount":{"required":["accessToken","dateCreated","discordUserId","id","orderId","username"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.order.discordAccount.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.order.discordAccount.dateCreated","typeLabel":"string\u003cdate-time>"},"orderId":{"type":"string","description":"The ID of the order this Discord account is associated with.","format":"uuid","isRequired":true,"uniqueKey":"data.order.discordAccount.orderId","typeLabel":"string\u003cuuid>"},"discordUserId":{"maxLength":32,"minLength":1,"type":"string","description":"The Discord user ID (snowflake).","isRequired":true,"uniqueKey":"data.order.discordAccount.discordUserId","typeLabel":"string"},"username":{"maxLength":64,"minLength":1,"type":"string","description":"The Discord username at the time of the order.","isRequired":true,"uniqueKey":"data.order.discordAccount.username","typeLabel":"string"},"accessToken":{"maxLength":512,"minLength":1,"type":"string","description":"The OAuth2 access token used for server membership actions.","isRequired":true,"uniqueKey":"data.order.discordAccount.accessToken","typeLabel":"string"},"displayName":{"oneOf":[{"maxLength":64,"type":"string","description":"The Discord display name at the time of the order.","uniqueKey":"data.order.discordAccount.displayName.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The Discord display name at the time of the order.","uniqueKey":"data.order.discordAccount.displayName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.discordAccount.displayName","typeLabel":"string | null"},"avatarUrl":{"oneOf":[{"maxLength":256,"type":"string","description":"The Discord avatar URL at the time of the order.","uniqueKey":"data.order.discordAccount.avatarUrl.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The Discord avatar URL at the time of the order.","uniqueKey":"data.order.discordAccount.avatarUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.discordAccount.avatarUrl","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents the Discord account details associated with an order at the time of purchase.","uniqueKey":"data.order.discordAccount","typeLabel":"object"},"amountPaid":{"oneOf":[{"type":"number","description":"Represents the amount that has been paid for an order.","format":"double","uniqueKey":"data.order.amountPaid.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Represents the amount that has been paid for an order.","format":"double","uniqueKey":"data.order.amountPaid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.amountPaid","typeLabel":"number\u003cdouble> | null"},"balanceTopUpAmount":{"oneOf":[{"type":"number","description":"For top-up orders, the amount of store credit to grant the customer on completion (the pre-fee\namount the customer requested). Amount for these orders equals this plus the gateway fee.","format":"double","uniqueKey":"data.order.balanceTopUpAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"For top-up orders, the amount of store credit to grant the customer on completion (the pre-fee\namount the customer requested). Amount for these orders equals this plus the gateway fee.","format":"double","uniqueKey":"data.order.balanceTopUpAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.balanceTopUpAmount","typeLabel":"number\u003cdouble> | null"},"resellerId":{"oneOf":[{"type":"string","description":"Set when this order was placed by a reseller drawing stock, rather than by an end customer.","format":"uuid","uniqueKey":"data.order.resellerId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Set when this order was placed by a reseller drawing stock, rather than by an end customer.","format":"uuid","uniqueKey":"data.order.resellerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.resellerId","typeLabel":"string\u003cuuid> | null"},"supplierInvoiceNumber":{"oneOf":[{"maxLength":48,"type":"string","description":"The number of the SUPPLIER invoice for this order — the merchant's document to Komerza.","uniqueKey":"data.order.supplierInvoiceNumber.oneOf.0","typeLabel":"string"},{"maxLength":48,"type":"null","description":"The number of the SUPPLIER invoice for this order — the merchant's document to Komerza.","uniqueKey":"data.order.supplierInvoiceNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.supplierInvoiceNumber","typeLabel":"string | null"},"gatewayFee":{"oneOf":[{"type":"number","description":"The fee charged by the payment gateway for processing a transaction","format":"double","uniqueKey":"data.order.gatewayFee.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The fee charged by the payment gateway for processing a transaction","format":"double","uniqueKey":"data.order.gatewayFee.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.gatewayFee","typeLabel":"number\u003cdouble> | null"},"affiliateId":{"oneOf":[{"type":"string","description":"Unique identifier for the affiliate who referred this order","format":"uuid","uniqueKey":"data.order.affiliateId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Unique identifier for the affiliate who referred this order","format":"uuid","uniqueKey":"data.order.affiliateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.affiliateId","typeLabel":"string\u003cuuid> | null"},"presentmentCurrencyCode":{"oneOf":[{"maxLength":3,"type":"string","description":"Adaptive currency: the currency the shopper saw prices in, when it differs from\nCurrencyCode. Null for classic single-currency orders. All persisted amounts stay\nin CurrencyCode — presentment is a projection over them.","uniqueKey":"data.order.presentmentCurrencyCode.oneOf.0","typeLabel":"string"},{"maxLength":3,"type":"null","description":"Adaptive currency: the currency the shopper saw prices in, when it differs from\nCurrencyCode. Null for classic single-currency orders. All persisted amounts stay\nin CurrencyCode — presentment is a projection over them.","uniqueKey":"data.order.presentmentCurrencyCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.presentmentCurrencyCode","typeLabel":"string | null"},"presentmentFxRate":{"oneOf":[{"type":"number","description":"Adaptive currency: the store→presentment conversion rate snapshotted at order creation, with the\nmerchant's FX margin already applied. Immutable for the order's life — every later projection,\ncharge, or reconciliation replays this rate, never a live one.","format":"double","uniqueKey":"data.order.presentmentFxRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Adaptive currency: the store→presentment conversion rate snapshotted at order creation, with the\nmerchant's FX margin already applied. Immutable for the order's life — every later projection,\ncharge, or reconciliation replays this rate, never a live one.","format":"double","uniqueKey":"data.order.presentmentFxRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.presentmentFxRate","typeLabel":"number\u003cdouble> | null"},"presentmentAmount":{"oneOf":[{"type":"number","description":"Adaptive currency: the order total in the shopper's currency. Never persisted — always derived\nfrom Amount at the snapshotted rate (exponent-aware for the presentment currency),\nso coupon/item/tax repricing can never desync it.","format":"double","readOnly":true,"uniqueKey":"data.order.presentmentAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Adaptive currency: the order total in the shopper's currency. Never persisted — always derived\nfrom Amount at the snapshotted rate (exponent-aware for the presentment currency),\nso coupon/item/tax repricing can never desync it.","format":"double","readOnly":true,"uniqueKey":"data.order.presentmentAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.presentmentAmount","typeLabel":"number\u003cdouble> | null"},"ipDetails":{"required":["as","asname","city","country","hosting","isp","mobile","proxy","regionName","status"],"type":"object","properties":{"status":{"type":"string","description":"The status of the operation, either success or error","isRequired":true,"uniqueKey":"data.order.ipDetails.status","typeLabel":"string"},"proxy":{"type":"boolean","description":"Whether the IP address was detected as a proxy","isRequired":true,"uniqueKey":"data.order.ipDetails.proxy","typeLabel":"boolean"},"hosting":{"type":"boolean","description":"Whether the IP address is used by a hosting company","isRequired":true,"uniqueKey":"data.order.ipDetails.hosting","typeLabel":"boolean"},"mobile":{"type":"boolean","description":"Whether the IP address belongs to a mobile network (3G, 4G (LTE), 5G, etc.)","isRequired":true,"uniqueKey":"data.order.ipDetails.mobile","typeLabel":"boolean"},"regionName":{"type":"string","description":"The region the IP was registered in","isRequired":true,"uniqueKey":"data.order.ipDetails.regionName","typeLabel":"string"},"country":{"type":"string","description":"The country the IP was registered in","isRequired":true,"uniqueKey":"data.order.ipDetails.country","typeLabel":"string"},"city":{"type":"string","description":"The city the IP was registered in","isRequired":true,"uniqueKey":"data.order.ipDetails.city","typeLabel":"string"},"isp":{"type":"string","description":"The ISP that owns the IP address","isRequired":true,"uniqueKey":"data.order.ipDetails.isp","typeLabel":"string"},"as":{"type":"string","description":"The AS number and organization, separated by space (e.g. \"AS13037 Zen Internet Ltd\").","isRequired":true,"uniqueKey":"data.order.ipDetails.as","typeLabel":"string"},"asname":{"type":"string","description":"The AS name (e.g. \"ZEN-AS\").","isRequired":true,"uniqueKey":"data.order.ipDetails.asname","typeLabel":"string"},"countryCode":{"oneOf":[{"type":"string","description":"The ISO 3166-1 alpha-2 code of the country the IP was registered in.","uniqueKey":"data.order.ipDetails.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO 3166-1 alpha-2 code of the country the IP was registered in.","uniqueKey":"data.order.ipDetails.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.ipDetails.countryCode","typeLabel":"string | null"}},"additionalProperties":false,"description":"Details about an IP address such as the registration location and the owner","uniqueKey":"data.order.ipDetails","typeLabel":"object"},"customFieldAnswers":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.order.customFieldAnswers.oneOf.0.additionalProperties","typeLabel":"string"},"description":"The answers to the custom fields for the order","uniqueKey":"data.order.customFieldAnswers.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"data.order.customFieldAnswers.oneOf.1.additionalProperties","typeLabel":"string"},"description":"The answers to the custom fields for the order","uniqueKey":"data.order.customFieldAnswers.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.customFieldAnswers","typeLabel":"object | null"},"deliveredByUserId":{"oneOf":[{"maxLength":36,"type":"string","description":"The ID of the user who manually delivered the order, null if the order was not manually delivered","uniqueKey":"data.order.deliveredByUserId.oneOf.0","typeLabel":"string"},{"maxLength":36,"type":"null","description":"The ID of the user who manually delivered the order, null if the order was not manually delivered","uniqueKey":"data.order.deliveredByUserId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.deliveredByUserId","typeLabel":"string | null"},"returnUrl":{"oneOf":[{"maxLength":2048,"type":"string","description":"The URL to redirect the customer to after payment completion.\nIf not set, falls back to the store's default return URL.","uniqueKey":"data.order.returnUrl.oneOf.0","typeLabel":"string"},{"maxLength":2048,"type":"null","description":"The URL to redirect the customer to after payment completion.\nIf not set, falls back to the store's default return URL.","uniqueKey":"data.order.returnUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.returnUrl","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.order.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Custom key-value metadata attached to the order for merchant tracking purposes.","uniqueKey":"data.order.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"data.order.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Custom key-value metadata attached to the order for merchant tracking purposes.","uniqueKey":"data.order.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.metadata","typeLabel":"object | null"},"cartRecoverySentAt":{"oneOf":[{"type":"string","description":"When the cart recovery email was sent for this order, null if not sent.","format":"date-time","uniqueKey":"data.order.cartRecoverySentAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the cart recovery email was sent for this order, null if not sent.","format":"date-time","uniqueKey":"data.order.cartRecoverySentAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.cartRecoverySentAt","typeLabel":"string\u003cdate-time> | null"},"renewalForSubscriptionId":{"oneOf":[{"type":"string","description":"If this order is a renewal for an existing subscription, the ID of that subscription.\nNull for initial subscription orders and non-subscription orders.","format":"uuid","uniqueKey":"data.order.renewalForSubscriptionId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"If this order is a renewal for an existing subscription, the ID of that subscription.\nNull for initial subscription orders and non-subscription orders.","format":"uuid","uniqueKey":"data.order.renewalForSubscriptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.renewalForSubscriptionId","typeLabel":"string\u003cuuid> | null"},"protectionFxRate":{"oneOf":[{"type":"number","description":"The store-currency → EUR exchange rate captured when the protection fee was computed, for reproducibility.","format":"double","uniqueKey":"data.order.protectionFxRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The store-currency → EUR exchange rate captured when the protection fee was computed, for reproducibility.","format":"double","uniqueKey":"data.order.protectionFxRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.protectionFxRate","typeLabel":"number\u003cdouble> | null"},"protectionBaseValueEur":{"oneOf":[{"type":"number","description":"The order subtotal (before the protection fee) in EUR that the fee was computed from. Captured so fee\nperformance can be monitored (effective rate, value bands) exactly without re-running FX. Null when\nnot protected.","format":"double","uniqueKey":"data.order.protectionBaseValueEur.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The order subtotal (before the protection fee) in EUR that the fee was computed from. Captured so fee\nperformance can be monitored (effective rate, value bands) exactly without re-running FX. Null when\nnot protected.","format":"double","uniqueKey":"data.order.protectionBaseValueEur.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.protectionBaseValueEur","typeLabel":"number\u003cdouble> | null"},"protectionFeeScheduleVersion":{"oneOf":[{"maxLength":32,"type":"string","description":"The identifier of the fee schedule (pricing rules) applied when this order's protection fee was\ncomputed (see `ProtectionFeeCalculator.ScheduleVersion`), so the performance of each schedule\ncan be monitored over time. Null when not protected (or priced under the original flat schedule).","uniqueKey":"data.order.protectionFeeScheduleVersion.oneOf.0","typeLabel":"string"},{"maxLength":32,"type":"null","description":"The identifier of the fee schedule (pricing rules) applied when this order's protection fee was\ncomputed (see `ProtectionFeeCalculator.ScheduleVersion`), so the performance of each schedule\ncan be monitored over time. Null when not protected (or priced under the original flat schedule).","uniqueKey":"data.order.protectionFeeScheduleVersion.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.protectionFeeScheduleVersion","typeLabel":"string | null"},"komerzaPayAddonTierId":{"oneOf":[{"maxLength":16,"type":"string","description":"Which addon band produced KomerzaPayAddonFeeEur, kept so a historical charge\nstays explicable after the published schedule changes. Null when no addon fee applied.","uniqueKey":"data.order.komerzaPayAddonTierId.oneOf.0","typeLabel":"string"},{"maxLength":16,"type":"null","description":"Which addon band produced KomerzaPayAddonFeeEur, kept so a historical charge\nstays explicable after the published schedule changes. Null when no addon fee applied.","uniqueKey":"data.order.komerzaPayAddonTierId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.komerzaPayAddonTierId","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents an order entity with details about the customer, products, payment, and optional features like warranty\nand discounts","isRequired":true,"uniqueKey":"data.order","typeLabel":"object"},"logs":{"type":"array","items":{"required":["dateCreated","id","requestBody","retryCount","signature","url"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.logs.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.logs.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"url":{"maxLength":2048,"type":"string","description":"The URL associated with the webhook execution log.","isRequired":true,"uniqueKey":"data.logs.items.[INDEX].url","typeLabel":"string"},"signature":{"maxLength":128,"type":"string","description":"The signature of the webhook execution, used for validation and security purposes.","isRequired":true,"uniqueKey":"data.logs.items.[INDEX].signature","typeLabel":"string"},"requestBody":{"maxLength":8192,"type":"string","description":"The body of the request sent in a webhook execution.","isRequired":true,"uniqueKey":"data.logs.items.[INDEX].requestBody","typeLabel":"string"},"retryCount":{"type":"integer","description":"The number of times this webhook has been dispatched (initial + retries via Hangfire requeue).\nStarts at 1 for the first attempt and increments on each resend.","format":"int32","isRequired":true,"uniqueKey":"data.logs.items.[INDEX].retryCount","typeLabel":"integer\u003cint32>"},"responseCode":{"oneOf":[{"type":"integer","description":"The HTTP response code resulting from executing the webhook.","format":"int32","uniqueKey":"data.logs.items.[INDEX].responseCode.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The HTTP response code resulting from executing the webhook.","format":"int32","uniqueKey":"data.logs.items.[INDEX].responseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logs.items.[INDEX].responseCode","typeLabel":"integer\u003cint32> | null"},"responseBody":{"oneOf":[{"maxLength":8192,"type":"string","description":"The response body returned by a webhook execution log.","uniqueKey":"data.logs.items.[INDEX].responseBody.oneOf.0","typeLabel":"string"},{"maxLength":8192,"type":"null","description":"The response body returned by a webhook execution log.","uniqueKey":"data.logs.items.[INDEX].responseBody.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logs.items.[INDEX].responseBody","typeLabel":"string | null"},"webhookId":{"oneOf":[{"type":"string","description":"The unique identifier of the webhook associated with this log.","format":"uuid","uniqueKey":"data.logs.items.[INDEX].webhookId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The unique identifier of the webhook associated with this log.","format":"uuid","uniqueKey":"data.logs.items.[INDEX].webhookId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logs.items.[INDEX].webhookId","typeLabel":"string\u003cuuid> | null"},"userId":{"oneOf":[{"maxLength":36,"type":"string","description":"The ID of the user who owns the webhook. Nullable for backwards compatibility\nwith existing logs that predate this field.","uniqueKey":"data.logs.items.[INDEX].userId.oneOf.0","typeLabel":"string"},{"maxLength":36,"type":"null","description":"The ID of the user who owns the webhook. Nullable for backwards compatibility\nwith existing logs that predate this field.","uniqueKey":"data.logs.items.[INDEX].userId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logs.items.[INDEX].userId","typeLabel":"string | null"},"userAgent":{"oneOf":[{"maxLength":512,"type":"string","description":"The user agent header sent to the merchant's endpoint.","uniqueKey":"data.logs.items.[INDEX].userAgent.oneOf.0","typeLabel":"string"},{"maxLength":512,"type":"null","description":"The user agent header sent to the merchant's endpoint.","uniqueKey":"data.logs.items.[INDEX].userAgent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logs.items.[INDEX].userAgent","typeLabel":"string | null"},"orderId":{"oneOf":[{"type":"string","description":"The unique identifier for the order associated with the webhook execution log.","format":"uuid","uniqueKey":"data.logs.items.[INDEX].orderId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The unique identifier for the order associated with the webhook execution log.","format":"uuid","uniqueKey":"data.logs.items.[INDEX].orderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.logs.items.[INDEX].orderId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"description":"A log for a webhook execution.","uniqueKey":"data.logs.items.[INDEX]","typeLabel":"object"},"description":"A collection of logs associated with webhook executions.","isRequired":true,"uniqueKey":"data.logs","typeLabel":"object[]"},"ipInfo":{"required":["as","asname","city","country","hosting","isp","mobile","proxy","regionName","status"],"type":"object","properties":{"status":{"type":"string","description":"The status of the operation, either success or error","isRequired":true,"uniqueKey":"data.ipInfo.status","typeLabel":"string"},"proxy":{"type":"boolean","description":"Whether the IP address was detected as a proxy","isRequired":true,"uniqueKey":"data.ipInfo.proxy","typeLabel":"boolean"},"hosting":{"type":"boolean","description":"Whether the IP address is used by a hosting company","isRequired":true,"uniqueKey":"data.ipInfo.hosting","typeLabel":"boolean"},"mobile":{"type":"boolean","description":"Whether the IP address belongs to a mobile network (3G, 4G (LTE), 5G, etc.)","isRequired":true,"uniqueKey":"data.ipInfo.mobile","typeLabel":"boolean"},"regionName":{"type":"string","description":"The region the IP was registered in","isRequired":true,"uniqueKey":"data.ipInfo.regionName","typeLabel":"string"},"country":{"type":"string","description":"The country the IP was registered in","isRequired":true,"uniqueKey":"data.ipInfo.country","typeLabel":"string"},"city":{"type":"string","description":"The city the IP was registered in","isRequired":true,"uniqueKey":"data.ipInfo.city","typeLabel":"string"},"isp":{"type":"string","description":"The ISP that owns the IP address","isRequired":true,"uniqueKey":"data.ipInfo.isp","typeLabel":"string"},"as":{"type":"string","description":"The AS number and organization, separated by space (e.g. \"AS13037 Zen Internet Ltd\").","isRequired":true,"uniqueKey":"data.ipInfo.as","typeLabel":"string"},"asname":{"type":"string","description":"The AS name (e.g. \"ZEN-AS\").","isRequired":true,"uniqueKey":"data.ipInfo.asname","typeLabel":"string"},"countryCode":{"oneOf":[{"type":"string","description":"The ISO 3166-1 alpha-2 code of the country the IP was registered in.","uniqueKey":"data.ipInfo.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO 3166-1 alpha-2 code of the country the IP was registered in.","uniqueKey":"data.ipInfo.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.ipInfo.countryCode","typeLabel":"string | null"}},"additionalProperties":false,"description":"Details about an IP address such as the registration location and the owner","isRequired":true,"uniqueKey":"data.ipInfo","typeLabel":"object"},"storeId":{"type":"string","description":"Represents the identifier of the store associated with the order.","format":"uuid","isRequired":true,"uniqueKey":"data.storeId","typeLabel":"string\u003cuuid>"},"storeName":{"type":"string","description":"Gets or sets the name of the store associated with the order.","isRequired":true,"uniqueKey":"data.storeName","typeLabel":"string"},"billingInformation":{"required":["countryCode"],"type":"object","properties":{"countryCode":{"maxLength":2,"minLength":1,"pattern":"^[A-Z]{2}$","type":"string","description":"The ISO 3166-1 alpha-2 country code associated with the address.\nExamples: \"US\" for the United States, \"CA\" for Canada.","isRequired":true,"uniqueKey":"data.billingInformation.countryCode","typeLabel":"string"},"legalEntityType":{"oneOf":[{"maxLength":1000,"minLength":1,"type":"string","description":"The legal entity type of the merchant.","uniqueKey":"data.billingInformation.legalEntityType.oneOf.0","typeLabel":"string"},{"maxLength":1000,"minLength":1,"type":"null","description":"The legal entity type of the merchant.","uniqueKey":"data.billingInformation.legalEntityType.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingInformation.legalEntityType","typeLabel":"string | null"},"taxId":{"oneOf":[{"maxLength":50,"type":"string","description":"Tax Identification Number or VAT number.","uniqueKey":"data.billingInformation.taxId.oneOf.0","typeLabel":"string"},{"maxLength":50,"type":"null","description":"Tax Identification Number or VAT number.","uniqueKey":"data.billingInformation.taxId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingInformation.taxId","typeLabel":"string | null"},"fullName":{"oneOf":[{"maxLength":100,"type":"string","description":"The full name of the individual or entity associated with merchant account.","uniqueKey":"data.billingInformation.fullName.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The full name of the individual or entity associated with merchant account.","uniqueKey":"data.billingInformation.fullName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingInformation.fullName","typeLabel":"string | null"},"addressLine1":{"oneOf":[{"maxLength":200,"type":"string","description":"The primary address line.\nTypically, includes house number, street name, or building name.","uniqueKey":"data.billingInformation.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","description":"The primary address line.\nTypically, includes house number, street name, or building name.","uniqueKey":"data.billingInformation.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingInformation.addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"maxLength":200,"type":"string","description":"The secondary address line, if applicable.\nMay include apartment, suite, unit, or floor details.\nOptional field.","uniqueKey":"data.billingInformation.addressLine2.oneOf.0","typeLabel":"string"},{"maxLength":200,"type":"null","description":"The secondary address line, if applicable.\nMay include apartment, suite, unit, or floor details.\nOptional field.","uniqueKey":"data.billingInformation.addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingInformation.addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"maxLength":100,"type":"string","description":"The city or locality associated with the address.","uniqueKey":"data.billingInformation.city.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The city or locality associated with the address.","uniqueKey":"data.billingInformation.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingInformation.city","typeLabel":"string | null"},"region":{"oneOf":[{"maxLength":100,"type":"string","description":"The region associated with the address.\nRepresents state, province, or other administrative division.","uniqueKey":"data.billingInformation.region.oneOf.0","typeLabel":"string"},{"maxLength":100,"type":"null","description":"The region associated with the address.\nRepresents state, province, or other administrative division.","uniqueKey":"data.billingInformation.region.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingInformation.region","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"type":"string","description":"The postal or ZIP code for the address.","uniqueKey":"data.billingInformation.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"The postal or ZIP code for the address.","uniqueKey":"data.billingInformation.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.billingInformation.postalCode","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents customer billing information with address and tax details.","uniqueKey":"data.billingInformation","typeLabel":"object"},"deliveredByEmail":{"oneOf":[{"type":"string","description":"The email of the user who manually delivered the order, if applicable.","uniqueKey":"data.deliveredByEmail.oneOf.0","typeLabel":"string"},{"type":"null","description":"The email of the user who manually delivered the order, if applicable.","uniqueKey":"data.deliveredByEmail.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.deliveredByEmail","typeLabel":"string | null"},"heldKeys":{"oneOf":[{"type":"array","items":{"required":["expiresAt","keys","productId","quantity","variantId"],"type":"object","properties":{"productId":{"type":"string","description":"The product whose stock is held.","format":"uuid","isRequired":true,"uniqueKey":"data.heldKeys.oneOf.0.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"variantId":{"type":"string","description":"The variant whose keys are held.","format":"uuid","isRequired":true,"uniqueKey":"data.heldKeys.oneOf.0.items.[INDEX].variantId","typeLabel":"string\u003cuuid>"},"quantity":{"type":"integer","description":"The number of keys held.","format":"int32","isRequired":true,"uniqueKey":"data.heldKeys.oneOf.0.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"expiresAt":{"type":"string","description":"When the hold lapses if the payment never confirms.","format":"date-time","isRequired":true,"uniqueKey":"data.heldKeys.oneOf.0.items.[INDEX].expiresAt","typeLabel":"string\u003cdate-time>"},"keys":{"type":"array","items":{"type":"string","uniqueKey":"data.heldKeys.oneOf.0.items.[INDEX].keys.items.[INDEX]","typeLabel":"string"},"description":"The exact license keys held for the order.","isRequired":true,"uniqueKey":"data.heldKeys.oneOf.0.items.[INDEX].keys","typeLabel":"string[]"}},"additionalProperties":false,"description":"Merchant-facing view of a \"smart crypto hold\": license keys currently held for an order whose\ncryptocurrency payment has been detected but not yet confirmed. Only ever returned on the merchant\nOrderResponse — never on any customer-facing order response.","uniqueKey":"data.heldKeys.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"License keys currently held for this order by the \"smart crypto hold\" (its cryptocurrency payment\nhas been detected but not yet confirmed). Null when nothing is held. Merchant-only.","uniqueKey":"data.heldKeys.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"required":["expiresAt","keys","productId","quantity","variantId"],"type":"object","properties":{"productId":{"type":"string","description":"The product whose stock is held.","format":"uuid"},"variantId":{"type":"string","description":"The variant whose keys are held.","format":"uuid"},"quantity":{"type":"integer","description":"The number of keys held.","format":"int32"},"expiresAt":{"type":"string","description":"When the hold lapses if the payment never confirms.","format":"date-time"},"keys":{"type":"array","items":{"type":"string"},"description":"The exact license keys held for the order."}},"additionalProperties":false,"description":"Merchant-facing view of a \"smart crypto hold\": license keys currently held for an order whose\ncryptocurrency payment has been detected but not yet confirmed. Only ever returned on the merchant\nOrderResponse — never on any customer-facing order response."},"description":"License keys currently held for this order by the \"smart crypto hold\" (its cryptocurrency payment\nhas been detected but not yet confirmed). Null when nothing is held. Merchant-only.","uniqueKey":"data.heldKeys.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.heldKeys","typeLabel":"object[] | null"}},"additionalProperties":false,"description":"Represents the response details for an order.","uniqueKey":"data","typeLabel":"object"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":{"order":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","items":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","productName":"\u003cstring>","productId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","variantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","variantName":"\u003cstring>","amount":123,"lineTotal":123,"additionalFeePercentage":123,"additionalFeeAmount":123,"additionalFixedFeeAmount":123,"volumeDiscountAmount":123,"storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","orderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","quantity":123,"volumeDiscountType":0,"volumeDiscountValue":123,"volumeDiscountTierQuantity":123,"billingInterval":0,"customIntervalDays":123}],"gatewayMetadata":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","transactionId":"\u003cstring>","clientSecret":"\u003cstring>","note":"\u003cstring>","cryptocurrencyAddress":"\u003cstring>","cryptocurrencyAmount":123,"cryptocurrencyExpiration":"2023-11-07T05:31:56Z","cryptocurrencyProcessor":"\u003cstring>","cryptocurrencyPaymentUri":"\u003cstring>","gatewaySubscriptionId":"\u003cstring>","chargeCurrencyCode":"\u003cstring>","chargeFxRate":123},"customer":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","countryCode":"\u003cstring>","emailAddress":"\u003cstring>","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","userId":"\u003cstring>","deliveredItems":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","orderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","variantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"\u003cstring>","source":"\u003cstring>","textContent":"\u003cstring>","fileId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","webhookExecutionLogId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","file":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","friendlyName":"\u003cstring>","ipAddress":"\u003cstring>","userId":"\u003cstring>"},"webhookExecutionLog":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","url":"\u003cstring>","signature":"\u003cstring>","requestBody":"\u003cstring>","retryCount":123,"responseCode":123,"responseBody":"\u003cstring>","webhookId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","userId":"\u003cstring>","userAgent":"\u003cstring>","orderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}],"status":"\u003cstring>","gateway":"\u003cstring>","amount":123,"isTopUp":true,"appliedBalance":123,"amountDueToGateway":123,"chargeCurrencyCode":"\u003cstring>","chargeAmountDue":123,"platformFee":123,"globalGatewayFeePercentage":123,"globalGatewayFeeAmount":123,"globalGatewayFixedFee":123,"globalGatewayFixedFeeAmount":123,"realCustomerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","currencyCode":"\u003cstring>","userAgent":"\u003cstring>","ipAddress":"\u003cstring>","isDeliveredManually":true,"isDeliveryItemsLocked":true,"isCustomerAuthenticated":true,"isMigrated":true,"sendReceipt":true,"source":"\u003cstring>","isSubscriptionOrder":true,"isBuyerProtected":true,"protectionFeeEur":123,"protectionFeeNative":123,"protectionSellerShareEur":123,"protectionKomerzaCutEur":123,"komerzaPayAddonFeeEur":123,"komerzaPayAddonFeeNative":123,"komerzaPayItemPriceNative":123,"coupon":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","netDecrease":123,"code":"\u003cstring>","couponId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","percentageDecrease":123},"affiliateDiscount":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","netDecrease":123,"percentageDecrease":123},"tax":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","taxAmount":123,"taxRate":123,"taxName":"\u003cstring>","isReverseCharge":true,"preTaxAmount":123,"taxBehavior":"\u003cstring>","customerVatId":"\u003cstring>"},"refund":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","userId":"\u003cstring>","ipAddress":"\u003cstring>","reason":0,"amount":123,"orderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"chargeback":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","status":"\u003cstring>","reason":"\u003cstring>","orderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"discordAccount":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","orderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","discordUserId":"\u003cstring>","username":"\u003cstring>","accessToken":"\u003cstring>","displayName":"\u003cstring>","avatarUrl":"\u003cstring>"},"amountPaid":123,"balanceTopUpAmount":123,"resellerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","supplierInvoiceNumber":"\u003cstring>","gatewayFee":123,"affiliateId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","presentmentCurrencyCode":"\u003cstring>","presentmentFxRate":123,"presentmentAmount":123,"ipDetails":{"status":"\u003cstring>","proxy":true,"hosting":true,"mobile":true,"regionName":"\u003cstring>","country":"\u003cstring>","city":"\u003cstring>","isp":"\u003cstring>","as":"\u003cstring>","asname":"\u003cstring>","countryCode":"\u003cstring>"},"customFieldAnswers":{},"deliveredByUserId":"\u003cstring>","returnUrl":"\u003cstring>","metadata":{},"cartRecoverySentAt":"2023-11-07T05:31:56Z","renewalForSubscriptionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","protectionFxRate":123,"protectionBaseValueEur":123,"protectionFeeScheduleVersion":"\u003cstring>","komerzaPayAddonTierId":"\u003cstring>"},"logs":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","url":"\u003cstring>","signature":"\u003cstring>","requestBody":"\u003cstring>","retryCount":123,"responseCode":123,"responseBody":"\u003cstring>","webhookId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","userId":"\u003cstring>","userAgent":"\u003cstring>","orderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"ipInfo":{"status":"\u003cstring>","proxy":true,"hosting":true,"mobile":true,"regionName":"\u003cstring>","country":"\u003cstring>","city":"\u003cstring>","isp":"\u003cstring>","as":"\u003cstring>","asname":"\u003cstring>","countryCode":"\u003cstring>"},"storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","storeName":"\u003cstring>","billingInformation":{"countryCode":"\u003cstring>","legalEntityType":"\u003cstring>","taxId":"\u003cstring>","fullName":"\u003cstring>","addressLine1":"\u003cstring>","addressLine2":"\u003cstring>","city":"\u003cstring>","region":"\u003cstring>","postalCode":"\u003cstring>"},"deliveredByEmail":"\u003cstring>","heldKeys":[{"productId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","variantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","quantity":123,"expiresAt":"2023-11-07T05:31:56Z","keys":["\u003cstring>"]}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"ea73704a-93c5-4c7f-9a26-0797df91ae30":{"description":"The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.","content":{"application/json":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"oneOf":[{"description":"Represents the data associated with a response.","uniqueKey":"data.oneOf.0","typeLabel":"any"},{"description":"Represents the data associated with a response.","type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"any | null"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"813dd5dd-14ac-4b53-b5cb-e67f6f7afa13":{"description":"You are not authorized, check your API key and try again.","content":{"application/json":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"oneOf":[{"description":"Represents the data associated with a response.","uniqueKey":"data.oneOf.0","typeLabel":"any"},{"description":"Represents the data associated with a response.","type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"any | null"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"bef76654-5fd2-46ec-82cb-7ba5dc62274e":{"description":"You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.","content":{"application/json":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"oneOf":[{"description":"Represents the data associated with a response.","uniqueKey":"data.oneOf.0","typeLabel":"any"},{"description":"Represents the data associated with a response.","type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"any | null"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"762dc95e-8adb-4c2c-b7b6-806b007724f4":{"description":"One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.","content":{"application/json":{"schema":{"required":["success"],"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation or response was successful.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"oneOf":[{"type":"string","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A descriptive message providing additional context or information about the response.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code (if there was an error) to use when referencing the error","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"data":{"oneOf":[{"description":"Represents the data associated with a response.","uniqueKey":"data.oneOf.0","typeLabel":"any"},{"description":"Represents the data associated with a response.","type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"any | null"}},"additionalProperties":false,"description":"Represents a default generic response for API endpoints.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","code":"\u003cstring>","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"aa17cceb-4c1e-42f0-8e8d-e9efcfdf2797":{"bearer":{"type":"http","description":"Your API key goes here","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"}}},"servers":{"c163b8df-bb70-462c-8f9f-8d6477f309a9":{"url":"https://api.komerza.com","description":"The production Komerza API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Your API key goes here","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key goes here","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"komerza","siteName":"Komerza Documentation","title":"Get Order - Komerza Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/endpoint/orders/get","matchLevel":0},"fr":{"href":"/api-reference/endpoint/orders/get","matchLevel":0},"de":{"href":"/api-reference/endpoint/orders/get","matchLevel":0},"pl":{"href":"/api-reference/endpoint/orders/get","matchLevel":0},"es":{"href":"/api-reference/endpoint/orders/get","matchLevel":0}}},"lastModified":"2025-11-27T22:04:54.069Z","gitLastModified":"2025-11-27T22:04:33.000Z","originalFileLocation":"api-reference/endpoint/orders/get.mdx","locale":"en"},"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=\"Retrieve order details by ID in the given store. Requires the stores.orders.view permission.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Komerza Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_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/komerza/iqYRnvBA9e16yiP0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Order - Komerza Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve order details by ID in the given store. Requires the stores.orders.view permission.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Komerza Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.komerza.com/api-reference/endpoint/orders/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://komerza.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Get+Order\u0026amp;description=Retrieve+order+details+by+ID+in+the+given+store.%0ARequires+the+%60stores.orders.view%60+permission.\u0026amp;theme=ddc75211e622c8b9003b058b\u0026amp;signature=81588cb19fa9eba427d2a727e53a7a40dfd8d2cb7c62e42af956f636704c2fff\">\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 Order - Komerza Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve order details by ID in the given store. Requires the stores.orders.view permission.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://komerza.mintlify.app/_mintlify/api/og/v2?division=Orders\u0026amp;title=Get+Order\u0026amp;description=Retrieve+order+details+by+ID+in+the+given+store.%0ARequires+the+%60stores.orders.view%60+permission.\u0026amp;theme=ddc75211e622c8b9003b058b\u0026amp;signature=81588cb19fa9eba427d2a727e53a7a40dfd8d2cb7c62e42af956f636704c2fff\">\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/komerza/iqYRnvBA9e16yiP0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Komerza Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3b82f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.komerza.com/api-reference/endpoint/orders/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/orders/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.komerza.com/#organization\",\"name\":\"Komerza Documentation\",\"url\":\"https://docs.komerza.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/komerza/b8Ru_h-4KK1SQzzO/logo/light.svg?fit=max\u0026auto=format\u0026n=b8Ru_h-4KK1SQzzO\u0026q=85\u0026s=0f9ba8d2c97d0b7886be5ab88b8a1521\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.komerza.com#website\",\"name\":\"Komerza Documentation\",\"url\":\"https://docs.komerza.com\",\"publisher\":{\"@id\":\"https://docs.komerza.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.komerza.com/api-reference/endpoint/orders/get#webpage\",\"url\":\"https://docs.komerza.com/api-reference/endpoint/orders/get\",\"name\":\"Get Order\",\"description\":\"Retrieve order details by ID in the given store. Requires the stores.orders.view permission.\",\"dateModified\":\"2025-11-27T22:04:33.000Z\",\"isPartOf\":{\"@id\":\"https://docs.komerza.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.komerza.com/api-reference/endpoint/orders/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.komerza.com/api-reference/endpoint/orders/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Komerza Documentation\",\"item\":\"https://docs.komerza.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Order\",\"item\":\"https://docs.komerza.com/api-reference/endpoint/orders/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.komerza.com/api-reference/endpoint/orders/get#apireference\",\"headline\":\"Get Order\",\"name\":\"Get Order\",\"description\":\"Retrieve order details by ID in the given store. Requires the stores.orders.view permission.\",\"url\":\"https://docs.komerza.com/api-reference/endpoint/orders/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.komerza.com/api-reference/endpoint/orders/get#webpage\"},\"dateModified\":\"2025-11-27T22:04:33.000Z\",\"publisher\":{\"@id\":\"https://docs.komerza.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.komerza.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Komerza Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Komerza Documentation","nav":{"global":{"anchors":[{"anchor":"System Status","icon":"wave-pulse","href":"https://status.komerza.com"},{"anchor":"Telegram","icon":"telegram","href":"https://t.me/komerzaecom"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/komerza"}]},"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Conventions","href":"/api-reference/conventions"},{"title":"Responses \u0026 Errors","href":"/api-reference/responses"},{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","description":"Retrieves detailed information for a single customer in the specified store.\nRequires the `stores.customers.view` permission.","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","description":"Gets orders in the specified store and optionally filters by the given criteria.\nRequires the `stores.orders.view` permission.","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"Storefront SDK","pages":[{"title":"Storefront SDK","href":"/storefront/introduction"}]}]},{"language":"fr","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/fr"}]},{"tab":"Référence API","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Conventions","href":"/api-reference/conventions"},{"title":"Responses \u0026 Errors","href":"/api-reference/responses"},{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","description":"Retrieves detailed information for a single customer in the specified store.\nRequires the `stores.customers.view` permission.","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","description":"Gets orders in the specified store and optionally filters by the given criteria.\nRequires the `stores.orders.view` permission.","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"SDK Storefront","pages":[{"title":"SDK Storefront","href":"/fr/storefront/introduction"}]}]},{"language":"de","tabs":[{"tab":"Anleitungen","pages":[{"title":"Anleitungen","href":"/de"}]},{"tab":"API-Referenz","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Conventions","href":"/api-reference/conventions"},{"title":"Responses \u0026 Errors","href":"/api-reference/responses"},{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","description":"Retrieves detailed information for a single customer in the specified store.\nRequires the `stores.customers.view` permission.","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","description":"Gets orders in the specified store and optionally filters by the given criteria.\nRequires the `stores.orders.view` permission.","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"Storefront-SDK","pages":[{"title":"Storefront-SDK","href":"/de/storefront/introduction"}]}]},{"language":"pl","tabs":[{"tab":"Przewodniki","pages":[{"title":"Przewodniki","href":"/pl"}]},{"tab":"Dokumentacja API","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Conventions","href":"/api-reference/conventions"},{"title":"Responses \u0026 Errors","href":"/api-reference/responses"},{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","description":"Retrieves detailed information for a single customer in the specified store.\nRequires the `stores.customers.view` permission.","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","description":"Gets orders in the specified store and optionally filters by the given criteria.\nRequires the `stores.orders.view` permission.","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"SDK Sklepowy","pages":[{"title":"SDK Sklepowy","href":"/pl/storefront/introduction"}]}]},{"language":"es","tabs":[{"tab":"Guías","pages":[{"title":"Guías","href":"/es"}]},{"tab":"Referencia de API","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Quick Start","href":"/api-reference/quickstart"},{"title":"Scopes","href":"/api-reference/scopes"},{"title":"SDKs","href":"/api-reference/sdks"}]},{"group":"Reference","pages":[{"title":"Filtering \u0026 Sorting","href":"/api-reference/filtering"},{"title":"Payment Methods","href":"/api-reference/payment-methods"},{"title":"Order Status","href":"/api-reference/payment-status"},{"title":"Error Codes","href":"/api-reference/error-codes"},{"title":"Enums \u0026 Constants","href":"/api-reference/enums"}]},{"group":"OAuth2","pages":[{"title":"OAuth2 Integration","href":"/api-reference/oauth2/introduction"},{"title":"Exchange Code","openapi":"GET /oauth2/{appId}/exchange/{code}","href":"/api-reference/oauth2/exchange"}]},{"group":"User","pages":[{"title":"Get User","openapi":"GET /user","href":"/api-reference/endpoint/users/get"}]},{"group":"Stores","pages":[{"title":"Get Store","openapi":"GET /stores/{storeId}","href":"/api-reference/endpoint/stores/get"},{"title":"Create Store","openapi":"POST /stores","href":"/api-reference/endpoint/stores/create"},{"title":"Update Store","openapi":"PUT /stores/{storeId}","href":"/api-reference/endpoint/stores/update"},{"title":"Maintenance Mode","openapi":"PUT /stores/{storeId}/maintenance","href":"/api-reference/endpoint/stores/update-maintenance"}]},{"group":"Products","pages":[{"title":"Get Product","openapi":"GET /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/get"},{"title":"Search Products","openapi":"GET /stores/{storeId}/products/search/{query}","href":"/api-reference/endpoint/products/search"},{"title":"Get Product by Slug","openapi":"GET /stores/{storeId}/products/slug/{slug}","href":"/api-reference/endpoint/products/get-slug"},{"title":"Get All Products","openapi":"GET /stores/{storeId}/products/all","href":"/api-reference/endpoint/products/get-all"},{"title":"Get Products","openapi":"GET /stores/{storeId}/products","href":"/api-reference/endpoint/products/get-list"},{"title":"Create Product","openapi":"POST /stores/{storeId}/products","href":"/api-reference/endpoint/products/create"},{"title":"Delete Product","openapi":"DELETE /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/delete"},{"title":"Update Product","openapi":"PUT /stores/{storeId}/products/{productId}","href":"/api-reference/endpoint/products/update"},{"title":"Update Payment Settings","openapi":"PUT /stores/{storeId}/products/{productId}/payment","href":"/api-reference/endpoint/products/update-payment"},{"title":"Bulk Update Products","openapi":"PUT /stores/{storeId}/products","href":"/api-reference/endpoint/products/update-bulk"},{"title":"Order Products","openapi":"PATCH /stores/{storeId}/products/order","href":"/api-reference/endpoint/products/order"},{"title":"Order Product Images","openapi":"PATCH /stores/{storeId}/products/{productId}/images/order","href":"/api-reference/endpoint/products/order-images"},{"title":"Duplicate Product","openapi":"POST /stores/{storeId}/products/{productId}/duplicate","href":"/api-reference/endpoint/products/duplicate"},{"title":"Update Affiliate Discount","openapi":"PUT /stores/{storeId}/products/{productId}/affiliateDiscount","href":"/api-reference/endpoint/products/update-affiliate-discount"},{"title":"Update Product Badges","openapi":"PUT /stores/{storeId}/products/{productId}/badges","href":"/api-reference/endpoint/products/update-badges"},{"title":"Update Product Security","openapi":"PUT /stores/{storeId}/products/{productId}/security","href":"/api-reference/endpoint/products/update-security"},{"title":"Bulk Delete Products","openapi":"DELETE /stores/{storeId}/products","href":"/api-reference/endpoint/products/delete-bulk"}]},{"group":"Categories","pages":[{"title":"Get Category","openapi":"GET /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/get"},{"title":"Get Categories","openapi":"GET /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/get-list"},{"title":"Get All Categories","openapi":"GET /stores/{storeId}/categories/all","href":"/api-reference/endpoint/categories/get-all"},{"title":"Create Category","openapi":"POST /stores/{storeId}/categories","href":"/api-reference/endpoint/categories/create"},{"title":"Update Category","openapi":"PUT /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/update"},{"title":"Delete Category","openapi":"DELETE /stores/{storeId}/categories/{categoryId}","href":"/api-reference/endpoint/categories/delete"},{"title":"Order Categories","openapi":"PATCH /stores/{storeId}/categories/order","href":"/api-reference/endpoint/categories/order"},{"title":"Order Products in Category","openapi":"PATCH /stores/{storeId}/categories/{categoryId}/products/order","href":"/api-reference/endpoint/categories/order-products"}]},{"group":"Variants","pages":[{"title":"Get Variant","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/get"},{"title":"Get License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/{page}","href":"/api-reference/endpoint/variants/get-items"},{"title":"Create Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants","href":"/api-reference/endpoint/variants/create"},{"title":"Create Field","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields","href":"/api-reference/endpoint/variants/fields/create"},{"title":"Create Field Option","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options","href":"/api-reference/endpoint/variants/fields/options/create"},{"title":"Add License Keys","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/add-items"},{"title":"Update Variant","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/update"},{"title":"Update Delivery Settings","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/delivery","href":"/api-reference/endpoint/variants/update-delivery"},{"title":"Update Field","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/update"},{"title":"Update Field Option","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/update"},{"title":"Order Variant Images","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/{variantId}/images/order","href":"/api-reference/endpoint/variants/order-images"},{"title":"Delete License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items","href":"/api-reference/endpoint/variants/delete-items"},{"title":"Clear License Keys","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/items/clear","href":"/api-reference/endpoint/variants/clear-items"},{"title":"Delete Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}","href":"/api-reference/endpoint/variants/delete"},{"title":"Delete Field","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}","href":"/api-reference/endpoint/variants/fields/delete"},{"title":"Delete Field Option","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/fields/{fieldId}/options/{optionId}","href":"/api-reference/endpoint/variants/fields/options/delete"},{"title":"Order Variants","openapi":"PATCH /stores/{storeId}/products/{productId}/variants/order","href":"/api-reference/endpoint/variants/order"},{"title":"Duplicate Variant","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/duplicate","href":"/api-reference/endpoint/variants/duplicate"},{"title":"Search License Keys","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/items/search/{query}","href":"/api-reference/endpoint/variants/search-items"},{"title":"Remove File from Variant","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/file/{fileId}","href":"/api-reference/endpoint/variants/delete-file"},{"title":"Get Volume Discounts","openapi":"GET /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/get"},{"title":"Create Volume Discount","openapi":"POST /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/create"},{"title":"Replace Volume Discounts","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts","href":"/api-reference/endpoint/variants/discounts/replace"},{"title":"Update Volume Discount","openapi":"PUT /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/update"},{"title":"Delete Volume Discount","openapi":"DELETE /stores/{storeId}/products/{productId}/variants/{variantId}/discounts/{discountId}","href":"/api-reference/endpoint/variants/discounts/delete"}]},{"group":"Coupons","pages":[{"title":"Get Coupon","openapi":"GET /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/get"},{"title":"Get Coupons","openapi":"GET /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/get-list"},{"title":"Get All Coupons","openapi":"GET /stores/{storeId}/coupons/all","href":"/api-reference/endpoint/coupons/get-all"},{"title":"Search Coupons","openapi":"GET /stores/{storeId}/coupons/search/{query}","href":"/api-reference/endpoint/coupons/search"},{"title":"Create Coupon","openapi":"POST /stores/{storeId}/coupons","href":"/api-reference/endpoint/coupons/create"},{"title":"Update Coupon","openapi":"PUT /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/update"},{"title":"Delete Coupon","openapi":"DELETE /stores/{storeId}/coupons/{couponId}","href":"/api-reference/endpoint/coupons/delete"}]},{"group":"Tickets","pages":[{"title":"Get Ticket","openapi":"GET /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/get"},{"title":"Get Tickets","openapi":"GET /stores/{storeId}/tickets","href":"/api-reference/endpoint/tickets/get-list"},{"title":"Add Ticket Response","openapi":"PUT /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/add"},{"title":"Close Ticket","openapi":"DELETE /stores/{storeId}/tickets/{ticketId}","href":"/api-reference/endpoint/tickets/delete"}]},{"group":"Customers","pages":[{"title":"Get Customer","openapi":"GET /stores/{storeId}/customers/{customerId}","href":"/api-reference/endpoint/customers/get"},{"title":"Get Customers","openapi":"GET /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/get-list"},{"title":"Search Customers","openapi":"GET /stores/{storeId}/customers/search/{query}","href":"/api-reference/endpoint/customers/search"},{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","href":"/api-reference/endpoint/customers/create"},{"title":"Update Customer Balance","openapi":"PATCH /stores/{storeId}/customers/{customerId}/balance","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","description":"Retrieves detailed information for a single customer in the specified store.\nRequires the `stores.customers.view` permission.","href":"/api-reference/endpoint/customers/get-by-email"}]},{"group":"Orders","pages":[{"title":"Get Order","openapi":"GET /stores/{storeId}/orders/{orderId}","href":"/api-reference/endpoint/orders/get"},{"title":"Get Orders","openapi":"GET /stores/{storeId}/orders","description":"Gets orders in the specified store and optionally filters by the given criteria.\nRequires the `stores.orders.view` permission.","href":"/api-reference/endpoint/orders/get-list"},{"title":"Search Orders","openapi":"GET /stores/{storeId}/orders/search/{query}","href":"/api-reference/endpoint/orders/search"},{"title":"Create Order","openapi":"POST /stores/{storeId}/orders","href":"/api-reference/endpoint/orders/create"},{"title":"Deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/deliver","href":"/api-reference/endpoint/orders/deliver"},{"title":"Refund Order","openapi":"DELETE /stores/{storeId}/orders/{orderId}/refund","href":"/api-reference/endpoint/orders/refund"},{"title":"Re-deliver Order","openapi":"PUT /stores/{storeId}/orders/{orderId}/redeliver","href":"/api-reference/endpoint/orders/redeliver"},{"title":"Get Proof of Payment","openapi":"GET /stores/{storeId}/paymentMethods/custom/orders/{orderId}/proof","href":"/api-reference/endpoint/orders/get-payment-proof"}]},{"group":"Reviews","pages":[{"title":"Get Reviews","openapi":"GET /stores/{storeId}/reviews","href":"/api-reference/endpoint/reviews/get-list"},{"title":"Reply to Review","openapi":"PUT /stores/{storeId}/reviews/{reviewId}/reply","href":"/api-reference/endpoint/reviews/reply"},{"title":"Get Review Analytics","openapi":"GET /stores/{storeId}/reviews/analytics","href":"/api-reference/endpoint/reviews/analytics"}]},{"group":"Affiliates","pages":[{"title":"Get Affiliates","openapi":"GET /stores/{storeId}/affiliates","href":"/api-reference/endpoint/affiliates/get-list"},{"title":"Search Affiliates","openapi":"GET /stores/{storeId}/affiliates/search","href":"/api-reference/endpoint/affiliates/search"},{"title":"Get Affiliate Statistics","openapi":"GET /stores/{storeId}/affiliates/stats","href":"/api-reference/endpoint/affiliates/stats"},{"title":"Create Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/create"},{"title":"Update Affiliate","openapi":"PUT /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/update"},{"title":"Delete Affiliate","openapi":"DELETE /stores/{storeId}/affiliates/{customerId}","href":"/api-reference/endpoint/affiliates/delete"},{"title":"Invite Affiliate","openapi":"POST /stores/{storeId}/affiliates/invite","href":"/api-reference/endpoint/affiliates/invite"},{"title":"Blacklist Affiliate","openapi":"POST /stores/{storeId}/affiliates/{customerId}/blacklist","href":"/api-reference/endpoint/affiliates/blacklist"},{"title":"Configure Affiliate Program","openapi":"PUT /stores/{storeId}/affiliates/configure","href":"/api-reference/endpoint/affiliates/configure"},{"title":"List Affiliate Orders","openapi":"GET /stores/{storeId}/affiliates/{customerId}/orders/{page}","href":"/api-reference/endpoint/affiliates/get-orders"},{"title":"List Affiliate Payouts","openapi":"GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}","href":"/api-reference/endpoint/affiliates/get-payouts"},{"title":"Record Affiliate Payout","openapi":"POST /stores/{storeId}/affiliates/{customerId}/payouts","href":"/api-reference/endpoint/affiliates/record-payout"},{"title":"Void Affiliate Payout","openapi":"PATCH /stores/{storeId}/affiliates/{customerId}/payouts/{payoutId}","href":"/api-reference/endpoint/affiliates/void-payout"}]},{"group":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-api"},{"title":"Get Affiliate Account","openapi":"GET /affiliate","href":"/api-reference/endpoint/affiliate/get-account"},{"title":"List Affiliate Discounts","openapi":"GET /affiliate/discounts","href":"/api-reference/endpoint/affiliate/get-discounts"},{"title":"List Referred Orders","openapi":"GET /affiliate/orders","href":"/api-reference/endpoint/affiliate/get-orders"},{"title":"List Received Payouts","openapi":"GET /affiliate/payouts","href":"/api-reference/endpoint/affiliate/get-payouts"},{"title":"Get Referral Statistics","openapi":"GET /affiliate/stats","href":"/api-reference/endpoint/affiliate/stats"}]},{"group":"Reseller Programme","pages":[{"title":"Get Programme","openapi":"GET /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/get"},{"title":"Configure Programme","openapi":"PUT /stores/{storeId}/reseller","href":"/api-reference/endpoint/reseller-programme/configure"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reseller/catalogue","href":"/api-reference/endpoint/reseller-programme/get-catalogue"},{"title":"Add to Catalogue","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/add-to-catalogue"},{"title":"Remove from Catalogue","openapi":"DELETE /stores/{storeId}/reseller/catalogue/{variantId}","href":"/api-reference/endpoint/reseller-programme/remove-from-catalogue"},{"title":"Get Variant Stats","openapi":"GET /stores/{storeId}/reseller/catalogue/{variantId}/stats","href":"/api-reference/endpoint/reseller-programme/get-variant-stats"},{"title":"Set Volume Tiers","openapi":"PUT /stores/{storeId}/reseller/catalogue/{variantId}/tiers","href":"/api-reference/endpoint/reseller-programme/set-volume-tiers"},{"title":"Get Resellers","openapi":"GET /stores/{storeId}/reseller/resellers","href":"/api-reference/endpoint/reseller-programme/get-resellers"},{"title":"Update Status","openapi":"PUT /stores/{storeId}/reseller/resellers/{resellerId}/status","href":"/api-reference/endpoint/reseller-programme/update-status"},{"title":"Grant Samples","openapi":"POST /stores/{storeId}/reseller/resellers/{resellerId}/samples","href":"/api-reference/endpoint/reseller-programme/grant-samples"},{"title":"Get Invitations","openapi":"GET /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/get-invites"},{"title":"Create Invitation","openapi":"POST /stores/{storeId}/reseller/invites","href":"/api-reference/endpoint/reseller-programme/create-invite"},{"title":"Delete Invitation","openapi":"DELETE /stores/{storeId}/reseller/invites/{inviteId}","href":"/api-reference/endpoint/reseller-programme/delete-invite"},{"title":"Get Questions","openapi":"GET /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/get-questions"},{"title":"Create Question","openapi":"POST /stores/{storeId}/reseller/application/questions","href":"/api-reference/endpoint/reseller-programme/create-question"},{"title":"Update Question","openapi":"PUT /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/update-question"},{"title":"Delete Question","openapi":"DELETE /stores/{storeId}/reseller/application/questions/{questionId}","href":"/api-reference/endpoint/reseller-programme/delete-question"},{"title":"Get Applications","openapi":"GET /stores/{storeId}/reseller/application/submissions","href":"/api-reference/endpoint/reseller-programme/get-applications"},{"title":"Create Application","openapi":"POST /stores/{storeId}/reseller/applications","href":"/api-reference/endpoint/reseller-programme/create-application"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/get-bundles"},{"title":"Create Bundle","openapi":"POST /stores/{storeId}/reseller/bundles","href":"/api-reference/endpoint/reseller-programme/create-bundle"},{"title":"Update Bundle","openapi":"PUT /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/update-bundle"},{"title":"Delete Bundle","openapi":"DELETE /stores/{storeId}/reseller/bundles/{bundleId}","href":"/api-reference/endpoint/reseller-programme/delete-bundle"},{"title":"Get Basket Discounts","openapi":"GET /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/get-basket-tiers"},{"title":"Create Basket Discount","openapi":"POST /stores/{storeId}/reseller/basket-tiers","href":"/api-reference/endpoint/reseller-programme/create-basket-tier"},{"title":"Update Basket Discount","openapi":"PUT /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/update-basket-tier"},{"title":"Delete Basket Discount","openapi":"DELETE /stores/{storeId}/reseller/basket-tiers/{basketTierId}","href":"/api-reference/endpoint/reseller-programme/delete-basket-tier"},{"title":"Get Leaderboard","openapi":"GET /stores/{storeId}/reseller/leaderboard","href":"/api-reference/endpoint/reseller-programme/get-leaderboard"}]},{"group":"Reselling","pages":[{"title":"Get Suppliers","openapi":"GET /stores/{storeId}/reselling/suppliers","href":"/api-reference/endpoint/reselling/get-suppliers"},{"title":"Find Supplier","openapi":"GET /stores/{storeId}/reselling/suppliers/lookup","href":"/api-reference/endpoint/reselling/find-supplier"},{"title":"Apply to Supplier","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}","href":"/api-reference/endpoint/reselling/apply"},{"title":"Get Catalogue","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/catalogue","href":"/api-reference/endpoint/reselling/get-catalogue"},{"title":"Get Bundles","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/bundles","href":"/api-reference/endpoint/reselling/get-bundles"},{"title":"Buy Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket","href":"/api-reference/endpoint/reselling/buy-basket"},{"title":"Quote Basket","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/basket/quote","href":"/api-reference/endpoint/reselling/quote-basket"},{"title":"Buy Stock","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/stock","href":"/api-reference/endpoint/reselling/buy-stock"},{"title":"Get Draws","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/draws","href":"/api-reference/endpoint/reselling/get-draws"},{"title":"Add Funds","openapi":"POST /stores/{storeId}/reselling/suppliers/{supplierStoreId}/topup","href":"/api-reference/endpoint/reselling/add-funds"},{"title":"Get Payment Methods","openapi":"GET /stores/{storeId}/reselling/suppliers/{supplierStoreId}/payment-methods","href":"/api-reference/endpoint/reselling/get-payment-methods"},{"title":"Create Listing","openapi":"PUT /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/create-listing"},{"title":"Delete Listing","openapi":"DELETE /stores/{storeId}/reselling/suppliers/{supplierStoreId}/listings/{sourceVariantId}","href":"/api-reference/endpoint/reselling/delete-listing"},{"title":"Get Resold Products","openapi":"GET /stores/{storeId}/reselling/products","href":"/api-reference/endpoint/reselling/get-products"},{"title":"Get Linkable Accounts","openapi":"GET /stores/{storeId}/reselling/linkable","href":"/api-reference/endpoint/reselling/get-linkable"},{"title":"Link Account","openapi":"POST /stores/{storeId}/reselling/linkable/{resellerId}","href":"/api-reference/endpoint/reselling/link-account"},{"title":"Accept Invitation","openapi":"POST /stores/{storeId}/reselling/invites/accept","href":"/api-reference/endpoint/reselling/accept-invite"}]},{"group":"Webhooks","pages":[{"title":"Get Webhooks","openapi":"GET /webhooks","href":"/api-reference/endpoint/webhooks/get-list"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/endpoint/webhooks/create"},{"title":"Get Webhook","openapi":"GET /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/get"},{"title":"Update Webhook","openapi":"PUT /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/update"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhookId}","href":"/api-reference/endpoint/webhooks/delete"},{"title":"Get Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs","href":"/api-reference/endpoint/webhooks/get-logs"},{"title":"Resend Webhook","openapi":"POST /webhooks/{webhookId}/logs/{executionLogId}/resend","href":"/api-reference/endpoint/webhooks/resend"},{"title":"Search Webhook Logs","openapi":"GET /webhooks/{webhookId}/logs/search/{query}","href":"/api-reference/endpoint/webhooks/search-logs"}]}]},{"tab":"SDK de Tienda","pages":[{"title":"SDK de Tienda","href":"/es/storefront/introduction"}]}]}]},"basePath":"","title":"Get Order - Komerza Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}