Registers a customer for the store using their email.
If the customer already exists and is linked to the store, a 409 conflict is returned.
Requires the stores.customers.create permission.
Represents a customer registered at Komerza globally
Show child attributes
Last modified on August 29, 2025
{"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":"6ae9f4d6382c567ac45702b7","collectionId":"eef137df-156c-47f2-93c4-6e810011c36c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae9f4d6382c567ac45702b7"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6ae9f4d6382c567ac45702b7","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":169},{"language":"en","tag":"Guides","count":41},{"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":"en","tag":"Payment Setup","count":14},{"language":"default","tag":"Affiliates","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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"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/customers/create","slug":"/api-reference/endpoint/customers/create","pageMetadata":{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","description":"Registers a customer for the store using their email.\nIf the customer already exists and is linked to the store, a 409 conflict is returned.\nRequires the `stores.customers.create` permission.","href":"/api-reference/endpoint/customers/create"},"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: [\"Registers a customer for the store using their email.\\nIf the customer already exists and is linked to the store, a 409 conflict is returned.\\nRequires the \", _jsx(_components.code, {\n children: \"stores.customers.create\"\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Customer","openapi":"POST /stores/{storeId}/customers","description":"Registers a customer for the store using their email.\nIf the customer already exists and is linked to the store, a 409 conflict is returned.\nRequires the `stores.customers.create` permission.","href":"/api-reference/endpoint/customers/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/komerza/8afe0a459f8a498b/hero-search.js","/_mintlify/custom/komerza/55d6214b814c5c42/ripple.js"],"openApiReferenceData":{"operation":{"tags":["Customer"],"summary":"Create customer","description":"Registers a customer for the store using their email.\nIf the customer already exists and is linked to the store, a 409 conflict is returned.\nRequires the `stores.customers.create` permission.","parameters":["230208dc-af61-42e8-bf3f-49e2bcdcf007"],"requestBody":"6a879b18-9bab-4930-9a39-f52c83b1f392","responses":{"200":"25103d1d-2820-4ec1-9dc0-38b8657137ac","400":"045a622e-f5f9-4140-80ac-e86b6034a6b3","409":"70fb2746-e863-407e-99c4-3a5c3c433426"},"x-scopes":["stores.customers.create"],"method":"post","type":"path","servers":["af080bf6-2445-4a3b-a4be-10460d82015f"],"security":["4bfc9aef-efef-48eb-b71f-b5256c8031b8"],"path":"/stores/{storeId}/customers","baseUrlOptions":["https://api.komerza.com"],"title":"Create customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"230208dc-af61-42e8-bf3f-49e2bcdcf007":{"name":"storeId","in":"path","description":"ID of the store.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the store.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"description":"Customer email payload.","content":{"application/json":{"schema":{"required":["emailAddress"],"type":"object","properties":{"emailAddress":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the email address associated with the form.","format":"email","isRequired":true,"uniqueKey":"emailAddress","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"description":"Represents a form for creating customer data, inheriting email validation functionality.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"emailAddress":"jsmith@example.com"}}},"exampleType":"generated"},"text/json":{"schema":{"required":["emailAddress"],"type":"object","properties":{"emailAddress":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the email address associated with the form.","format":"email","isRequired":true,"uniqueKey":"emailAddress","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"description":"Represents a form for creating customer data, inheriting email validation functionality.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"emailAddress":"jsmith@example.com"}}},"exampleType":"generated"},"application/*+json":{"schema":{"required":["emailAddress"],"type":"object","properties":{"emailAddress":{"maxLength":256,"minLength":1,"type":"string","description":"Represents the email address associated with the form.","format":"email","isRequired":true,"uniqueKey":"emailAddress","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"description":"Represents a form for creating customer data, inheriting email validation functionality.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"emailAddress":"jsmith@example.com"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"25103d1d-2820-4ec1-9dc0-38b8657137ac":{"description":"The object was successfully created.","content":{"text/plain":{"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":["dateCreated","emailAddress","id","ipAddress","storeData"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.dateCreated","typeLabel":"string\u003cdate-time>"},"emailAddress":{"maxLength":256,"minLength":3,"type":"string","description":"Represents the email address of the customer","isRequired":true,"uniqueKey":"data.emailAddress","typeLabel":"string"},"ipAddress":{"maxLength":45,"type":"string","description":"Represents the IP address associated with the customer.","isRequired":true,"uniqueKey":"data.ipAddress","typeLabel":"string"},"storeData":{"type":"array","items":{"required":["balance","customer","customerId","dateCreated","externalIntegrations","gatewayCustomerIds","id","ipAddress","isBlocked","storeId","subscriptions","tickets"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.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.storeData.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"balance":{"type":"number","description":"The customer balance, this can be used to buy items on the store with","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].balance","typeLabel":"number\u003cdouble>"},"externalIntegrations":{"type":"array","items":{"required":["accountId","dateCreated","id","platformId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.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.storeData.items.[INDEX].externalIntegrations.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"accountId":{"maxLength":256,"type":"string","description":"The users account identifier, used to identify the account on the platform","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].accountId","typeLabel":"string"},"platformId":{"maxLength":64,"type":"string","description":"The ID of the platform which the integration is for","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].platformId","typeLabel":"string"},"expirationDate":{"oneOf":[{"type":"string","description":"The date the access token expires","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].expirationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the access token expires","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].expirationDate","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"A third-party integration (typically OAuth2 login) for a customer","uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX]","typeLabel":"object"},"description":"The list of external integrations linked to this customer","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations","typeLabel":"object[]"},"tickets":{"type":"array","items":{"required":["customerId","dateCreated","entries","id","status","storeId","subject","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.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.storeData.items.[INDEX].tickets.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"subject":{"maxLength":128,"minLength":1,"type":"string","description":"Gets or sets the subject or title of the ticket, summarizing the issue or request.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].subject","typeLabel":"string"},"status":{"enum":[0,1,2,3,4],"type":"integer","description":"The different states of the ticket","format":"int32","x-enum-varnames":["Opened","Resolved","Closed","Responded","CustomerResponded"],"x-enum-descriptions":["The ticket has been opened and is awaiting a response from the seller","The ticket has been closed AND marked as resolved by the customer","The ticket has been closed and NOT marked as resolved by the customer","The seller has responded to the ticket","The customer has responded to the ticket"],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].status","typeLabel":"enum\u003cinteger>"},"customerId":{"type":"string","description":"The customer who opened the ticket","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The user who owns the store the ticket was made in","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].userId","typeLabel":"string"},"storeId":{"type":"string","description":"The store which the ticket is for","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"entries":{"type":"array","items":{"required":["dateCreated","id","message","name","ticketId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.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.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"name":{"maxLength":50,"minLength":1,"type":"string","description":"The name of the user that posted the entry","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].name","typeLabel":"string"},"message":{"maxLength":2048,"minLength":1,"type":"string","description":"The message the user has posted to the ticket","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].message","typeLabel":"string"},"ticketId":{"type":"string","description":"The ID of the ticket","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].ticketId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"description":"An entry or response on a ticket given by a seller or customer","uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX]","typeLabel":"object"},"description":"Gets or sets the list of entries or messages associated with the ticket.\nThese entries represent the conversation or updates related to the ticket.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries","typeLabel":"object[]"}},"additionalProperties":false,"description":"Represents a support ticket created by a customer for a specific store.","uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX]","typeLabel":"object"},"description":"The list of tickets created by the customer","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets","typeLabel":"object[]"},"subscriptions":{"type":"array","items":{"required":["autoRenew","billingInterval","cancelAtPeriodEnd","currencyCode","currentPeriodEnd","currentPeriodStart","customerId","customerStoreDataId","dateCreated","failedPaymentCount","gateway","id","pauseCount","price","productId","status","storeId","variantId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.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.storeData.items.[INDEX].subscriptions.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"customerId":{"type":"string","description":"The ID of the customer who owns this subscription","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"customerStoreDataId":{"type":"string","description":"The ID of the customer's store-scoped data","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customerStoreDataId","typeLabel":"string\u003cuuid>"},"storeId":{"type":"string","description":"The ID of the store this subscription belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"productId":{"type":"string","description":"The ID of the product being subscribed to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"variantId":{"type":"string","description":"The ID of the specific variant being subscribed to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].variantId","typeLabel":"string\u003cuuid>"},"status":{"enum":[0,1,2,3,4],"type":"integer","description":"The status of a customer subscription","format":"int32","x-enum-varnames":["Active","PastDue","Canceled","Expired","Paused"],"x-enum-descriptions":["The subscription is active and in good standing","A payment has failed but the subscription is within the grace period","The subscription has been canceled by the customer or merchant","The subscription has expired (past the end of the billing period after cancellation or failed payment)","The subscription is temporarily paused"],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].status","typeLabel":"enum\u003cinteger>"},"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"],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].billingInterval","typeLabel":"enum\u003cinteger>"},"price":{"type":"number","description":"The price charged per billing interval","format":"double","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].price","typeLabel":"number\u003cdouble>"},"currencyCode":{"maxLength":4,"type":"string","description":"The ISO 4217 currency code for the subscription price","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].currencyCode","typeLabel":"string"},"currentPeriodStart":{"type":"string","description":"The start of the current billing period","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].currentPeriodStart","typeLabel":"string\u003cdate-time>"},"currentPeriodEnd":{"type":"string","description":"The end of the current billing period","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].currentPeriodEnd","typeLabel":"string\u003cdate-time>"},"cancelAtPeriodEnd":{"type":"boolean","description":"Whether this subscription should be canceled at the end of the current billing period","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].cancelAtPeriodEnd","typeLabel":"boolean"},"pauseCount":{"type":"integer","description":"The total number of times this subscription has been paused over its lifetime","format":"int32","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseCount","typeLabel":"integer\u003cint32>"},"gateway":{"maxLength":64,"type":"string","description":"The payment gateway handling this subscription (e.g., \"stripe\", \"mollie\", \"square\")","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gateway","typeLabel":"string"},"autoRenew":{"type":"boolean","description":"Whether this subscription auto-renews through the payment gateway.\nFalse for gateways that don't support native recurring billing.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].autoRenew","typeLabel":"boolean"},"failedPaymentCount":{"type":"integer","description":"The number of consecutive failed payment attempts","format":"int32","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].failedPaymentCount","typeLabel":"integer\u003cint32>"},"customIntervalDays":{"oneOf":[{"type":"integer","description":"Custom interval in days when BillingInterval is Custom","format":"int32","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customIntervalDays.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Custom interval in days when BillingInterval is Custom","format":"int32","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customIntervalDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customIntervalDays","typeLabel":"integer\u003cint32> | null"},"canceledAt":{"oneOf":[{"type":"string","description":"The date the subscription was canceled, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the subscription was canceled, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].canceledAt","typeLabel":"string\u003cdate-time> | null"},"pausedAt":{"oneOf":[{"type":"string","description":"The date the subscription was paused, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pausedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the subscription was paused, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pausedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pausedAt","typeLabel":"string\u003cdate-time> | null"},"pauseResumeDate":{"oneOf":[{"type":"string","description":"The date the subscription should be automatically resumed. Null means indefinite pause (until manual resume).","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseResumeDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the subscription should be automatically resumed. Null means indefinite pause (until manual resume).","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseResumeDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseResumeDate","typeLabel":"string\u003cdate-time> | null"},"gatewaySubscriptionId":{"oneOf":[{"maxLength":256,"type":"string","description":"The subscription ID within the external payment gateway","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewaySubscriptionId.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The subscription ID within the external payment gateway","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewaySubscriptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewaySubscriptionId","typeLabel":"string | null"},"gatewayCustomerId":{"oneOf":[{"maxLength":256,"type":"string","description":"The customer ID within the external payment gateway (denormalized for quick lookups)","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewayCustomerId.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The customer ID within the external payment gateway (denormalized for quick lookups)","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewayCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewayCustomerId","typeLabel":"string | null"},"lastPaymentFailureDate":{"oneOf":[{"type":"string","description":"The date of the most recent payment failure","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastPaymentFailureDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date of the most recent payment failure","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastPaymentFailureDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastPaymentFailureDate","typeLabel":"string\u003cdate-time> | null"},"nextRetryDate":{"oneOf":[{"type":"string","description":"The next scheduled retry date for a failed payment (exponential backoff)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].nextRetryDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The next scheduled retry date for a failed payment (exponential backoff)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].nextRetryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].nextRetryDate","typeLabel":"string\u003cdate-time> | null"},"lastReminderSentAt":{"oneOf":[{"type":"string","description":"The date the last renewal reminder was sent to the customer","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastReminderSentAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the last renewal reminder was sent to the customer","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastReminderSentAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastReminderSentAt","typeLabel":"string\u003cdate-time> | null"},"metadataJson":{"oneOf":[{"maxLength":4096,"type":"string","description":"Gateway-specific metadata stored as JSON","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].metadataJson.oneOf.0","typeLabel":"string"},{"maxLength":4096,"type":"null","description":"Gateway-specific metadata stored as JSON","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].metadataJson.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].metadataJson","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents a customer's subscription to a product within a store, tracking billing lifecycle,\ngateway integration, and pause/cancel state.","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX]","typeLabel":"object"},"description":"The list of subscriptions the customer has","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions","typeLabel":"object[]"},"gatewayCustomerIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.storeData.items.[INDEX].gatewayCustomerIds.additionalProperties","typeLabel":"string"},"description":"Gateway-specific customer IDs, keyed by payment method name (e.g. \"stripe\", \"mollie\").","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].gatewayCustomerIds","typeLabel":"object"},"storeId":{"type":"string","description":"The ID the customer data is associated with","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","description":"The ID of the customer the data belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"customer":{"oneOf":[{"$circularRef":"dc573a81-c87e-4ca1-b4c9-75479245a982","isRequired":true}],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].customer","typeLabel":"any"},"isBlocked":{"type":"boolean","description":"Whether this customer is blocked from purchasing on this store.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].isBlocked","typeLabel":"boolean"},"ipAddress":{"maxLength":45,"type":"string","description":"Represents the IP address the customer created the store data with.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].ipAddress","typeLabel":"string"},"affiliate":{"required":["balance","customerId","dateCreated","discountVariesByProduct","id","isEnabled","link","storeId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.dateCreated","typeLabel":"string\u003cdate-time>"},"storeId":{"type":"string","description":"Unique identifier for the store associated with the affiliate","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.storeId","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","description":"Unique identifier for the customer associated with the affiliate","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.customerId","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Indicates whether the store is affiliated with a user","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.isEnabled","typeLabel":"boolean"},"link":{"maxLength":256,"minLength":1,"type":"string","description":"A link provided to affiliates for tracking and promotional purposes.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.link","typeLabel":"string"},"discountVariesByProduct":{"type":"boolean","description":"Whether some products give buyers less than PercentageOff, or nothing at all.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.discountVariesByProduct","typeLabel":"boolean"},"balance":{"type":"number","description":"Represents the balance of the affiliate, typically indicating the amount earned through affiliations.","format":"double","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.balance","typeLabel":"number\u003cdouble>"},"returnPercentage":{"oneOf":[{"type":"integer","description":"The percentage of the return that an affiliate receives","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.returnPercentage.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The percentage of the return that an affiliate receives","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.returnPercentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].affiliate.returnPercentage","typeLabel":"integer\u003cint32> | null"},"percentageOff":{"oneOf":[{"type":"integer","description":"The percentage discount offered by the store affiliate","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.percentageOff.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The percentage discount offered by the store affiliate","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.percentageOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].affiliate.percentageOff","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"description":"Represents an affiliate associated with a store.","uniqueKey":"data.storeData.items.[INDEX].affiliate","typeLabel":"object"},"stripeCustomerId":{"oneOf":[{"maxLength":64,"type":"string","description":"The ID of the Stripe customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].stripeCustomerId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The ID of the Stripe customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].stripeCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].stripeCustomerId","typeLabel":"string | null"},"mollieCustomerId":{"oneOf":[{"maxLength":64,"type":"string","description":"The ID of the Mollie customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].mollieCustomerId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The ID of the Mollie customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].mollieCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].mollieCustomerId","typeLabel":"string | null"},"marketingOptions":{"required":["customerId","customerStoreDataId","dateCreated","id","isEnabled"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.dateCreated","typeLabel":"string\u003cdate-time>"},"isEnabled":{"type":"boolean","description":"Whether the customer has opted-in to recieve marketing communications or not from the store","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.isEnabled","typeLabel":"boolean"},"customerId":{"type":"string","description":"The ID of the customer this belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.customerId","typeLabel":"string\u003cuuid>"},"customerStoreDataId":{"type":"string","description":"The ID of the CSD this belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.customerStoreDataId","typeLabel":"string\u003cuuid>"},"disabledAt":{"oneOf":[{"type":"string","description":"The date the customer opted out of email marketing","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.disabledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the customer opted out of email marketing","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.disabledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.disabledAt","typeLabel":"string\u003cdate-time> | null"},"consentSource":{"oneOf":[{"maxLength":64,"type":"string","description":"How consent was obtained (e.g. \"checkout\", \"import\", \"manual\")","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentSource.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"How consent was obtained (e.g. \"checkout\", \"import\", \"manual\")","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentSource","typeLabel":"string | null"},"consentTimestamp":{"oneOf":[{"type":"string","description":"When the customer gave or refused marketing consent","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentTimestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the customer gave or refused marketing consent","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentTimestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentTimestamp","typeLabel":"string\u003cdate-time> | null"},"consentIpAddress":{"oneOf":[{"maxLength":45,"type":"string","description":"The IP address of the customer at the time consent was recorded","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentIpAddress.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","description":"The IP address of the customer at the time consent was recorded","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentIpAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentIpAddress","typeLabel":"string | null"},"consentWithdrawnAt":{"oneOf":[{"type":"string","description":"When the customer withdrew their marketing consent (unsubscribed)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentWithdrawnAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the customer withdrew their marketing consent (unsubscribed)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentWithdrawnAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentWithdrawnAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"The user-defined configuration for customer email marketing","uniqueKey":"data.storeData.items.[INDEX].marketingOptions","typeLabel":"object"},"blockedNote":{"oneOf":[{"maxLength":2000,"type":"string","description":"An optional note explaining why the customer was blocked.","uniqueKey":"data.storeData.items.[INDEX].blockedNote.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","description":"An optional note explaining why the customer was blocked.","uniqueKey":"data.storeData.items.[INDEX].blockedNote.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].blockedNote","typeLabel":"string | null"},"blockedAt":{"oneOf":[{"type":"string","description":"The date the customer was blocked, if applicable.","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].blockedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the customer was blocked, if applicable.","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].blockedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].blockedAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"The store-scoped customer data","uniqueKey":"data.storeData.items.[INDEX]","typeLabel":"object"},"description":"The list of store-scoped data for the customer","isRequired":true,"uniqueKey":"data.storeData","typeLabel":"object[]"}},"additionalProperties":false,"description":"Represents a customer registered at Komerza globally","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":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","emailAddress":"\u003cstring>","ipAddress":"\u003cstring>","storeData":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","balance":123,"externalIntegrations":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","accountId":"\u003cstring>","platformId":"\u003cstring>","expirationDate":"2023-11-07T05:31:56Z"}],"tickets":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","subject":"\u003cstring>","status":0,"customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","userId":"\u003cstring>","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","entries":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","name":"\u003cstring>","message":"\u003cstring>","ticketId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}],"subscriptions":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerStoreDataId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","variantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":0,"billingInterval":0,"price":123,"currencyCode":"\u003cstring>","currentPeriodStart":"2023-11-07T05:31:56Z","currentPeriodEnd":"2023-11-07T05:31:56Z","cancelAtPeriodEnd":true,"pauseCount":123,"gateway":"\u003cstring>","autoRenew":true,"failedPaymentCount":123,"customIntervalDays":123,"canceledAt":"2023-11-07T05:31:56Z","pausedAt":"2023-11-07T05:31:56Z","pauseResumeDate":"2023-11-07T05:31:56Z","gatewaySubscriptionId":"\u003cstring>","gatewayCustomerId":"\u003cstring>","lastPaymentFailureDate":"2023-11-07T05:31:56Z","nextRetryDate":"2023-11-07T05:31:56Z","lastReminderSentAt":"2023-11-07T05:31:56Z","metadataJson":"\u003cstring>"}],"gatewayCustomerIds":{},"storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customer":"\u003cunknown>","isBlocked":true,"ipAddress":"\u003cstring>","affiliate":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"link":"\u003cstring>","discountVariesByProduct":true,"balance":123,"returnPercentage":123,"percentageOff":123},"stripeCustomerId":"\u003cstring>","mollieCustomerId":"\u003cstring>","marketingOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","isEnabled":true,"customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerStoreDataId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","disabledAt":"2023-11-07T05:31:56Z","consentSource":"\u003cstring>","consentTimestamp":"2023-11-07T05:31:56Z","consentIpAddress":"\u003cstring>","consentWithdrawnAt":"2023-11-07T05:31:56Z"},"blockedNote":"\u003cstring>","blockedAt":"2023-11-07T05:31:56Z"}]}}}},"exampleType":"generated"},"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":["dateCreated","emailAddress","id","ipAddress","storeData"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.dateCreated","typeLabel":"string\u003cdate-time>"},"emailAddress":{"maxLength":256,"minLength":3,"type":"string","description":"Represents the email address of the customer","isRequired":true,"uniqueKey":"data.emailAddress","typeLabel":"string"},"ipAddress":{"maxLength":45,"type":"string","description":"Represents the IP address associated with the customer.","isRequired":true,"uniqueKey":"data.ipAddress","typeLabel":"string"},"storeData":{"type":"array","items":{"required":["balance","customer","customerId","dateCreated","externalIntegrations","gatewayCustomerIds","id","ipAddress","isBlocked","storeId","subscriptions","tickets"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.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.storeData.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"balance":{"type":"number","description":"The customer balance, this can be used to buy items on the store with","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].balance","typeLabel":"number\u003cdouble>"},"externalIntegrations":{"type":"array","items":{"required":["accountId","dateCreated","id","platformId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.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.storeData.items.[INDEX].externalIntegrations.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"accountId":{"maxLength":256,"type":"string","description":"The users account identifier, used to identify the account on the platform","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].accountId","typeLabel":"string"},"platformId":{"maxLength":64,"type":"string","description":"The ID of the platform which the integration is for","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].platformId","typeLabel":"string"},"expirationDate":{"oneOf":[{"type":"string","description":"The date the access token expires","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].expirationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the access token expires","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].expirationDate","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"A third-party integration (typically OAuth2 login) for a customer","uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX]","typeLabel":"object"},"description":"The list of external integrations linked to this customer","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations","typeLabel":"object[]"},"tickets":{"type":"array","items":{"required":["customerId","dateCreated","entries","id","status","storeId","subject","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.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.storeData.items.[INDEX].tickets.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"subject":{"maxLength":128,"minLength":1,"type":"string","description":"Gets or sets the subject or title of the ticket, summarizing the issue or request.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].subject","typeLabel":"string"},"status":{"enum":[0,1,2,3,4],"type":"integer","description":"The different states of the ticket","format":"int32","x-enum-varnames":["Opened","Resolved","Closed","Responded","CustomerResponded"],"x-enum-descriptions":["The ticket has been opened and is awaiting a response from the seller","The ticket has been closed AND marked as resolved by the customer","The ticket has been closed and NOT marked as resolved by the customer","The seller has responded to the ticket","The customer has responded to the ticket"],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].status","typeLabel":"enum\u003cinteger>"},"customerId":{"type":"string","description":"The customer who opened the ticket","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The user who owns the store the ticket was made in","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].userId","typeLabel":"string"},"storeId":{"type":"string","description":"The store which the ticket is for","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"entries":{"type":"array","items":{"required":["dateCreated","id","message","name","ticketId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.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.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"name":{"maxLength":50,"minLength":1,"type":"string","description":"The name of the user that posted the entry","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].name","typeLabel":"string"},"message":{"maxLength":2048,"minLength":1,"type":"string","description":"The message the user has posted to the ticket","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].message","typeLabel":"string"},"ticketId":{"type":"string","description":"The ID of the ticket","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].ticketId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"description":"An entry or response on a ticket given by a seller or customer","uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX]","typeLabel":"object"},"description":"Gets or sets the list of entries or messages associated with the ticket.\nThese entries represent the conversation or updates related to the ticket.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries","typeLabel":"object[]"}},"additionalProperties":false,"description":"Represents a support ticket created by a customer for a specific store.","uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX]","typeLabel":"object"},"description":"The list of tickets created by the customer","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets","typeLabel":"object[]"},"subscriptions":{"type":"array","items":{"required":["autoRenew","billingInterval","cancelAtPeriodEnd","currencyCode","currentPeriodEnd","currentPeriodStart","customerId","customerStoreDataId","dateCreated","failedPaymentCount","gateway","id","pauseCount","price","productId","status","storeId","variantId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.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.storeData.items.[INDEX].subscriptions.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"customerId":{"type":"string","description":"The ID of the customer who owns this subscription","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"customerStoreDataId":{"type":"string","description":"The ID of the customer's store-scoped data","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customerStoreDataId","typeLabel":"string\u003cuuid>"},"storeId":{"type":"string","description":"The ID of the store this subscription belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"productId":{"type":"string","description":"The ID of the product being subscribed to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"variantId":{"type":"string","description":"The ID of the specific variant being subscribed to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].variantId","typeLabel":"string\u003cuuid>"},"status":{"enum":[0,1,2,3,4],"type":"integer","description":"The status of a customer subscription","format":"int32","x-enum-varnames":["Active","PastDue","Canceled","Expired","Paused"],"x-enum-descriptions":["The subscription is active and in good standing","A payment has failed but the subscription is within the grace period","The subscription has been canceled by the customer or merchant","The subscription has expired (past the end of the billing period after cancellation or failed payment)","The subscription is temporarily paused"],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].status","typeLabel":"enum\u003cinteger>"},"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"],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].billingInterval","typeLabel":"enum\u003cinteger>"},"price":{"type":"number","description":"The price charged per billing interval","format":"double","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].price","typeLabel":"number\u003cdouble>"},"currencyCode":{"maxLength":4,"type":"string","description":"The ISO 4217 currency code for the subscription price","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].currencyCode","typeLabel":"string"},"currentPeriodStart":{"type":"string","description":"The start of the current billing period","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].currentPeriodStart","typeLabel":"string\u003cdate-time>"},"currentPeriodEnd":{"type":"string","description":"The end of the current billing period","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].currentPeriodEnd","typeLabel":"string\u003cdate-time>"},"cancelAtPeriodEnd":{"type":"boolean","description":"Whether this subscription should be canceled at the end of the current billing period","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].cancelAtPeriodEnd","typeLabel":"boolean"},"pauseCount":{"type":"integer","description":"The total number of times this subscription has been paused over its lifetime","format":"int32","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseCount","typeLabel":"integer\u003cint32>"},"gateway":{"maxLength":64,"type":"string","description":"The payment gateway handling this subscription (e.g., \"stripe\", \"mollie\", \"square\")","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gateway","typeLabel":"string"},"autoRenew":{"type":"boolean","description":"Whether this subscription auto-renews through the payment gateway.\nFalse for gateways that don't support native recurring billing.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].autoRenew","typeLabel":"boolean"},"failedPaymentCount":{"type":"integer","description":"The number of consecutive failed payment attempts","format":"int32","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].failedPaymentCount","typeLabel":"integer\u003cint32>"},"customIntervalDays":{"oneOf":[{"type":"integer","description":"Custom interval in days when BillingInterval is Custom","format":"int32","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customIntervalDays.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Custom interval in days when BillingInterval is Custom","format":"int32","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customIntervalDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customIntervalDays","typeLabel":"integer\u003cint32> | null"},"canceledAt":{"oneOf":[{"type":"string","description":"The date the subscription was canceled, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the subscription was canceled, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].canceledAt","typeLabel":"string\u003cdate-time> | null"},"pausedAt":{"oneOf":[{"type":"string","description":"The date the subscription was paused, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pausedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the subscription was paused, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pausedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pausedAt","typeLabel":"string\u003cdate-time> | null"},"pauseResumeDate":{"oneOf":[{"type":"string","description":"The date the subscription should be automatically resumed. Null means indefinite pause (until manual resume).","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseResumeDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the subscription should be automatically resumed. Null means indefinite pause (until manual resume).","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseResumeDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseResumeDate","typeLabel":"string\u003cdate-time> | null"},"gatewaySubscriptionId":{"oneOf":[{"maxLength":256,"type":"string","description":"The subscription ID within the external payment gateway","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewaySubscriptionId.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The subscription ID within the external payment gateway","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewaySubscriptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewaySubscriptionId","typeLabel":"string | null"},"gatewayCustomerId":{"oneOf":[{"maxLength":256,"type":"string","description":"The customer ID within the external payment gateway (denormalized for quick lookups)","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewayCustomerId.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The customer ID within the external payment gateway (denormalized for quick lookups)","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewayCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewayCustomerId","typeLabel":"string | null"},"lastPaymentFailureDate":{"oneOf":[{"type":"string","description":"The date of the most recent payment failure","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastPaymentFailureDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date of the most recent payment failure","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastPaymentFailureDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastPaymentFailureDate","typeLabel":"string\u003cdate-time> | null"},"nextRetryDate":{"oneOf":[{"type":"string","description":"The next scheduled retry date for a failed payment (exponential backoff)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].nextRetryDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The next scheduled retry date for a failed payment (exponential backoff)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].nextRetryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].nextRetryDate","typeLabel":"string\u003cdate-time> | null"},"lastReminderSentAt":{"oneOf":[{"type":"string","description":"The date the last renewal reminder was sent to the customer","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastReminderSentAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the last renewal reminder was sent to the customer","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastReminderSentAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastReminderSentAt","typeLabel":"string\u003cdate-time> | null"},"metadataJson":{"oneOf":[{"maxLength":4096,"type":"string","description":"Gateway-specific metadata stored as JSON","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].metadataJson.oneOf.0","typeLabel":"string"},{"maxLength":4096,"type":"null","description":"Gateway-specific metadata stored as JSON","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].metadataJson.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].metadataJson","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents a customer's subscription to a product within a store, tracking billing lifecycle,\ngateway integration, and pause/cancel state.","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX]","typeLabel":"object"},"description":"The list of subscriptions the customer has","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions","typeLabel":"object[]"},"gatewayCustomerIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.storeData.items.[INDEX].gatewayCustomerIds.additionalProperties","typeLabel":"string"},"description":"Gateway-specific customer IDs, keyed by payment method name (e.g. \"stripe\", \"mollie\").","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].gatewayCustomerIds","typeLabel":"object"},"storeId":{"type":"string","description":"The ID the customer data is associated with","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","description":"The ID of the customer the data belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"customer":{"oneOf":[{"$circularRef":"dc573a81-c87e-4ca1-b4c9-75479245a982","isRequired":true}],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].customer","typeLabel":"any"},"isBlocked":{"type":"boolean","description":"Whether this customer is blocked from purchasing on this store.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].isBlocked","typeLabel":"boolean"},"ipAddress":{"maxLength":45,"type":"string","description":"Represents the IP address the customer created the store data with.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].ipAddress","typeLabel":"string"},"affiliate":{"required":["balance","customerId","dateCreated","discountVariesByProduct","id","isEnabled","link","storeId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.dateCreated","typeLabel":"string\u003cdate-time>"},"storeId":{"type":"string","description":"Unique identifier for the store associated with the affiliate","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.storeId","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","description":"Unique identifier for the customer associated with the affiliate","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.customerId","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Indicates whether the store is affiliated with a user","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.isEnabled","typeLabel":"boolean"},"link":{"maxLength":256,"minLength":1,"type":"string","description":"A link provided to affiliates for tracking and promotional purposes.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.link","typeLabel":"string"},"discountVariesByProduct":{"type":"boolean","description":"Whether some products give buyers less than PercentageOff, or nothing at all.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.discountVariesByProduct","typeLabel":"boolean"},"balance":{"type":"number","description":"Represents the balance of the affiliate, typically indicating the amount earned through affiliations.","format":"double","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.balance","typeLabel":"number\u003cdouble>"},"returnPercentage":{"oneOf":[{"type":"integer","description":"The percentage of the return that an affiliate receives","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.returnPercentage.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The percentage of the return that an affiliate receives","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.returnPercentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].affiliate.returnPercentage","typeLabel":"integer\u003cint32> | null"},"percentageOff":{"oneOf":[{"type":"integer","description":"The percentage discount offered by the store affiliate","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.percentageOff.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The percentage discount offered by the store affiliate","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.percentageOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].affiliate.percentageOff","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"description":"Represents an affiliate associated with a store.","uniqueKey":"data.storeData.items.[INDEX].affiliate","typeLabel":"object"},"stripeCustomerId":{"oneOf":[{"maxLength":64,"type":"string","description":"The ID of the Stripe customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].stripeCustomerId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The ID of the Stripe customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].stripeCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].stripeCustomerId","typeLabel":"string | null"},"mollieCustomerId":{"oneOf":[{"maxLength":64,"type":"string","description":"The ID of the Mollie customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].mollieCustomerId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The ID of the Mollie customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].mollieCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].mollieCustomerId","typeLabel":"string | null"},"marketingOptions":{"required":["customerId","customerStoreDataId","dateCreated","id","isEnabled"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.dateCreated","typeLabel":"string\u003cdate-time>"},"isEnabled":{"type":"boolean","description":"Whether the customer has opted-in to recieve marketing communications or not from the store","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.isEnabled","typeLabel":"boolean"},"customerId":{"type":"string","description":"The ID of the customer this belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.customerId","typeLabel":"string\u003cuuid>"},"customerStoreDataId":{"type":"string","description":"The ID of the CSD this belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.customerStoreDataId","typeLabel":"string\u003cuuid>"},"disabledAt":{"oneOf":[{"type":"string","description":"The date the customer opted out of email marketing","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.disabledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the customer opted out of email marketing","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.disabledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.disabledAt","typeLabel":"string\u003cdate-time> | null"},"consentSource":{"oneOf":[{"maxLength":64,"type":"string","description":"How consent was obtained (e.g. \"checkout\", \"import\", \"manual\")","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentSource.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"How consent was obtained (e.g. \"checkout\", \"import\", \"manual\")","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentSource","typeLabel":"string | null"},"consentTimestamp":{"oneOf":[{"type":"string","description":"When the customer gave or refused marketing consent","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentTimestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the customer gave or refused marketing consent","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentTimestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentTimestamp","typeLabel":"string\u003cdate-time> | null"},"consentIpAddress":{"oneOf":[{"maxLength":45,"type":"string","description":"The IP address of the customer at the time consent was recorded","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentIpAddress.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","description":"The IP address of the customer at the time consent was recorded","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentIpAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentIpAddress","typeLabel":"string | null"},"consentWithdrawnAt":{"oneOf":[{"type":"string","description":"When the customer withdrew their marketing consent (unsubscribed)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentWithdrawnAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the customer withdrew their marketing consent (unsubscribed)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentWithdrawnAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentWithdrawnAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"The user-defined configuration for customer email marketing","uniqueKey":"data.storeData.items.[INDEX].marketingOptions","typeLabel":"object"},"blockedNote":{"oneOf":[{"maxLength":2000,"type":"string","description":"An optional note explaining why the customer was blocked.","uniqueKey":"data.storeData.items.[INDEX].blockedNote.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","description":"An optional note explaining why the customer was blocked.","uniqueKey":"data.storeData.items.[INDEX].blockedNote.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].blockedNote","typeLabel":"string | null"},"blockedAt":{"oneOf":[{"type":"string","description":"The date the customer was blocked, if applicable.","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].blockedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the customer was blocked, if applicable.","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].blockedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].blockedAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"The store-scoped customer data","uniqueKey":"data.storeData.items.[INDEX]","typeLabel":"object"},"description":"The list of store-scoped data for the customer","isRequired":true,"uniqueKey":"data.storeData","typeLabel":"object[]"}},"additionalProperties":false,"description":"Represents a customer registered at Komerza globally","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":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","emailAddress":"\u003cstring>","ipAddress":"\u003cstring>","storeData":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","balance":123,"externalIntegrations":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","accountId":"\u003cstring>","platformId":"\u003cstring>","expirationDate":"2023-11-07T05:31:56Z"}],"tickets":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","subject":"\u003cstring>","status":0,"customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","userId":"\u003cstring>","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","entries":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","name":"\u003cstring>","message":"\u003cstring>","ticketId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}],"subscriptions":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerStoreDataId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","variantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":0,"billingInterval":0,"price":123,"currencyCode":"\u003cstring>","currentPeriodStart":"2023-11-07T05:31:56Z","currentPeriodEnd":"2023-11-07T05:31:56Z","cancelAtPeriodEnd":true,"pauseCount":123,"gateway":"\u003cstring>","autoRenew":true,"failedPaymentCount":123,"customIntervalDays":123,"canceledAt":"2023-11-07T05:31:56Z","pausedAt":"2023-11-07T05:31:56Z","pauseResumeDate":"2023-11-07T05:31:56Z","gatewaySubscriptionId":"\u003cstring>","gatewayCustomerId":"\u003cstring>","lastPaymentFailureDate":"2023-11-07T05:31:56Z","nextRetryDate":"2023-11-07T05:31:56Z","lastReminderSentAt":"2023-11-07T05:31:56Z","metadataJson":"\u003cstring>"}],"gatewayCustomerIds":{},"storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customer":"\u003cunknown>","isBlocked":true,"ipAddress":"\u003cstring>","affiliate":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"link":"\u003cstring>","discountVariesByProduct":true,"balance":123,"returnPercentage":123,"percentageOff":123},"stripeCustomerId":"\u003cstring>","mollieCustomerId":"\u003cstring>","marketingOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","isEnabled":true,"customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerStoreDataId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","disabledAt":"2023-11-07T05:31:56Z","consentSource":"\u003cstring>","consentTimestamp":"2023-11-07T05:31:56Z","consentIpAddress":"\u003cstring>","consentWithdrawnAt":"2023-11-07T05:31:56Z"},"blockedNote":"\u003cstring>","blockedAt":"2023-11-07T05:31:56Z"}]}}}},"exampleType":"generated"},"text/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":["dateCreated","emailAddress","id","ipAddress","storeData"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.dateCreated","typeLabel":"string\u003cdate-time>"},"emailAddress":{"maxLength":256,"minLength":3,"type":"string","description":"Represents the email address of the customer","isRequired":true,"uniqueKey":"data.emailAddress","typeLabel":"string"},"ipAddress":{"maxLength":45,"type":"string","description":"Represents the IP address associated with the customer.","isRequired":true,"uniqueKey":"data.ipAddress","typeLabel":"string"},"storeData":{"type":"array","items":{"required":["balance","customer","customerId","dateCreated","externalIntegrations","gatewayCustomerIds","id","ipAddress","isBlocked","storeId","subscriptions","tickets"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.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.storeData.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"balance":{"type":"number","description":"The customer balance, this can be used to buy items on the store with","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].balance","typeLabel":"number\u003cdouble>"},"externalIntegrations":{"type":"array","items":{"required":["accountId","dateCreated","id","platformId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.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.storeData.items.[INDEX].externalIntegrations.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"accountId":{"maxLength":256,"type":"string","description":"The users account identifier, used to identify the account on the platform","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].accountId","typeLabel":"string"},"platformId":{"maxLength":64,"type":"string","description":"The ID of the platform which the integration is for","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].platformId","typeLabel":"string"},"expirationDate":{"oneOf":[{"type":"string","description":"The date the access token expires","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].expirationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the access token expires","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX].expirationDate","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"A third-party integration (typically OAuth2 login) for a customer","uniqueKey":"data.storeData.items.[INDEX].externalIntegrations.items.[INDEX]","typeLabel":"object"},"description":"The list of external integrations linked to this customer","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].externalIntegrations","typeLabel":"object[]"},"tickets":{"type":"array","items":{"required":["customerId","dateCreated","entries","id","status","storeId","subject","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.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.storeData.items.[INDEX].tickets.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"subject":{"maxLength":128,"minLength":1,"type":"string","description":"Gets or sets the subject or title of the ticket, summarizing the issue or request.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].subject","typeLabel":"string"},"status":{"enum":[0,1,2,3,4],"type":"integer","description":"The different states of the ticket","format":"int32","x-enum-varnames":["Opened","Resolved","Closed","Responded","CustomerResponded"],"x-enum-descriptions":["The ticket has been opened and is awaiting a response from the seller","The ticket has been closed AND marked as resolved by the customer","The ticket has been closed and NOT marked as resolved by the customer","The seller has responded to the ticket","The customer has responded to the ticket"],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].status","typeLabel":"enum\u003cinteger>"},"customerId":{"type":"string","description":"The customer who opened the ticket","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The user who owns the store the ticket was made in","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].userId","typeLabel":"string"},"storeId":{"type":"string","description":"The store which the ticket is for","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"entries":{"type":"array","items":{"required":["dateCreated","id","message","name","ticketId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.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.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"name":{"maxLength":50,"minLength":1,"type":"string","description":"The name of the user that posted the entry","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].name","typeLabel":"string"},"message":{"maxLength":2048,"minLength":1,"type":"string","description":"The message the user has posted to the ticket","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].message","typeLabel":"string"},"ticketId":{"type":"string","description":"The ID of the ticket","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX].ticketId","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"description":"An entry or response on a ticket given by a seller or customer","uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries.items.[INDEX]","typeLabel":"object"},"description":"Gets or sets the list of entries or messages associated with the ticket.\nThese entries represent the conversation or updates related to the ticket.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX].entries","typeLabel":"object[]"}},"additionalProperties":false,"description":"Represents a support ticket created by a customer for a specific store.","uniqueKey":"data.storeData.items.[INDEX].tickets.items.[INDEX]","typeLabel":"object"},"description":"The list of tickets created by the customer","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].tickets","typeLabel":"object[]"},"subscriptions":{"type":"array","items":{"required":["autoRenew","billingInterval","cancelAtPeriodEnd","currencyCode","currentPeriodEnd","currentPeriodStart","customerId","customerStoreDataId","dateCreated","failedPaymentCount","gateway","id","pauseCount","price","productId","status","storeId","variantId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.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.storeData.items.[INDEX].subscriptions.items.[INDEX].dateCreated","typeLabel":"string\u003cdate-time>"},"customerId":{"type":"string","description":"The ID of the customer who owns this subscription","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"customerStoreDataId":{"type":"string","description":"The ID of the customer's store-scoped data","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customerStoreDataId","typeLabel":"string\u003cuuid>"},"storeId":{"type":"string","description":"The ID of the store this subscription belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"productId":{"type":"string","description":"The ID of the product being subscribed to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"variantId":{"type":"string","description":"The ID of the specific variant being subscribed to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].variantId","typeLabel":"string\u003cuuid>"},"status":{"enum":[0,1,2,3,4],"type":"integer","description":"The status of a customer subscription","format":"int32","x-enum-varnames":["Active","PastDue","Canceled","Expired","Paused"],"x-enum-descriptions":["The subscription is active and in good standing","A payment has failed but the subscription is within the grace period","The subscription has been canceled by the customer or merchant","The subscription has expired (past the end of the billing period after cancellation or failed payment)","The subscription is temporarily paused"],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].status","typeLabel":"enum\u003cinteger>"},"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"],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].billingInterval","typeLabel":"enum\u003cinteger>"},"price":{"type":"number","description":"The price charged per billing interval","format":"double","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].price","typeLabel":"number\u003cdouble>"},"currencyCode":{"maxLength":4,"type":"string","description":"The ISO 4217 currency code for the subscription price","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].currencyCode","typeLabel":"string"},"currentPeriodStart":{"type":"string","description":"The start of the current billing period","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].currentPeriodStart","typeLabel":"string\u003cdate-time>"},"currentPeriodEnd":{"type":"string","description":"The end of the current billing period","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].currentPeriodEnd","typeLabel":"string\u003cdate-time>"},"cancelAtPeriodEnd":{"type":"boolean","description":"Whether this subscription should be canceled at the end of the current billing period","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].cancelAtPeriodEnd","typeLabel":"boolean"},"pauseCount":{"type":"integer","description":"The total number of times this subscription has been paused over its lifetime","format":"int32","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseCount","typeLabel":"integer\u003cint32>"},"gateway":{"maxLength":64,"type":"string","description":"The payment gateway handling this subscription (e.g., \"stripe\", \"mollie\", \"square\")","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gateway","typeLabel":"string"},"autoRenew":{"type":"boolean","description":"Whether this subscription auto-renews through the payment gateway.\nFalse for gateways that don't support native recurring billing.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].autoRenew","typeLabel":"boolean"},"failedPaymentCount":{"type":"integer","description":"The number of consecutive failed payment attempts","format":"int32","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].failedPaymentCount","typeLabel":"integer\u003cint32>"},"customIntervalDays":{"oneOf":[{"type":"integer","description":"Custom interval in days when BillingInterval is Custom","format":"int32","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customIntervalDays.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Custom interval in days when BillingInterval is Custom","format":"int32","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customIntervalDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].customIntervalDays","typeLabel":"integer\u003cint32> | null"},"canceledAt":{"oneOf":[{"type":"string","description":"The date the subscription was canceled, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the subscription was canceled, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].canceledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].canceledAt","typeLabel":"string\u003cdate-time> | null"},"pausedAt":{"oneOf":[{"type":"string","description":"The date the subscription was paused, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pausedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the subscription was paused, if applicable","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pausedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pausedAt","typeLabel":"string\u003cdate-time> | null"},"pauseResumeDate":{"oneOf":[{"type":"string","description":"The date the subscription should be automatically resumed. Null means indefinite pause (until manual resume).","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseResumeDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the subscription should be automatically resumed. Null means indefinite pause (until manual resume).","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseResumeDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].pauseResumeDate","typeLabel":"string\u003cdate-time> | null"},"gatewaySubscriptionId":{"oneOf":[{"maxLength":256,"type":"string","description":"The subscription ID within the external payment gateway","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewaySubscriptionId.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The subscription ID within the external payment gateway","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewaySubscriptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewaySubscriptionId","typeLabel":"string | null"},"gatewayCustomerId":{"oneOf":[{"maxLength":256,"type":"string","description":"The customer ID within the external payment gateway (denormalized for quick lookups)","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewayCustomerId.oneOf.0","typeLabel":"string"},{"maxLength":256,"type":"null","description":"The customer ID within the external payment gateway (denormalized for quick lookups)","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewayCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].gatewayCustomerId","typeLabel":"string | null"},"lastPaymentFailureDate":{"oneOf":[{"type":"string","description":"The date of the most recent payment failure","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastPaymentFailureDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date of the most recent payment failure","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastPaymentFailureDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastPaymentFailureDate","typeLabel":"string\u003cdate-time> | null"},"nextRetryDate":{"oneOf":[{"type":"string","description":"The next scheduled retry date for a failed payment (exponential backoff)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].nextRetryDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The next scheduled retry date for a failed payment (exponential backoff)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].nextRetryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].nextRetryDate","typeLabel":"string\u003cdate-time> | null"},"lastReminderSentAt":{"oneOf":[{"type":"string","description":"The date the last renewal reminder was sent to the customer","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastReminderSentAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the last renewal reminder was sent to the customer","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastReminderSentAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].lastReminderSentAt","typeLabel":"string\u003cdate-time> | null"},"metadataJson":{"oneOf":[{"maxLength":4096,"type":"string","description":"Gateway-specific metadata stored as JSON","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].metadataJson.oneOf.0","typeLabel":"string"},{"maxLength":4096,"type":"null","description":"Gateway-specific metadata stored as JSON","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].metadataJson.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX].metadataJson","typeLabel":"string | null"}},"additionalProperties":false,"description":"Represents a customer's subscription to a product within a store, tracking billing lifecycle,\ngateway integration, and pause/cancel state.","uniqueKey":"data.storeData.items.[INDEX].subscriptions.items.[INDEX]","typeLabel":"object"},"description":"The list of subscriptions the customer has","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].subscriptions","typeLabel":"object[]"},"gatewayCustomerIds":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.storeData.items.[INDEX].gatewayCustomerIds.additionalProperties","typeLabel":"string"},"description":"Gateway-specific customer IDs, keyed by payment method name (e.g. \"stripe\", \"mollie\").","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].gatewayCustomerIds","typeLabel":"object"},"storeId":{"type":"string","description":"The ID the customer data is associated with","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].storeId","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","description":"The ID of the customer the data belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"customer":{"oneOf":[{"$circularRef":"dc573a81-c87e-4ca1-b4c9-75479245a982","isRequired":true}],"isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].customer","typeLabel":"any"},"isBlocked":{"type":"boolean","description":"Whether this customer is blocked from purchasing on this store.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].isBlocked","typeLabel":"boolean"},"ipAddress":{"maxLength":45,"type":"string","description":"Represents the IP address the customer created the store data with.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].ipAddress","typeLabel":"string"},"affiliate":{"required":["balance","customerId","dateCreated","discountVariesByProduct","id","isEnabled","link","storeId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.dateCreated","typeLabel":"string\u003cdate-time>"},"storeId":{"type":"string","description":"Unique identifier for the store associated with the affiliate","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.storeId","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","description":"Unique identifier for the customer associated with the affiliate","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.customerId","typeLabel":"string\u003cuuid>"},"isEnabled":{"type":"boolean","description":"Indicates whether the store is affiliated with a user","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.isEnabled","typeLabel":"boolean"},"link":{"maxLength":256,"minLength":1,"type":"string","description":"A link provided to affiliates for tracking and promotional purposes.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.link","typeLabel":"string"},"discountVariesByProduct":{"type":"boolean","description":"Whether some products give buyers less than PercentageOff, or nothing at all.","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.discountVariesByProduct","typeLabel":"boolean"},"balance":{"type":"number","description":"Represents the balance of the affiliate, typically indicating the amount earned through affiliations.","format":"double","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].affiliate.balance","typeLabel":"number\u003cdouble>"},"returnPercentage":{"oneOf":[{"type":"integer","description":"The percentage of the return that an affiliate receives","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.returnPercentage.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The percentage of the return that an affiliate receives","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.returnPercentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].affiliate.returnPercentage","typeLabel":"integer\u003cint32> | null"},"percentageOff":{"oneOf":[{"type":"integer","description":"The percentage discount offered by the store affiliate","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.percentageOff.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The percentage discount offered by the store affiliate","format":"int32","uniqueKey":"data.storeData.items.[INDEX].affiliate.percentageOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].affiliate.percentageOff","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"description":"Represents an affiliate associated with a store.","uniqueKey":"data.storeData.items.[INDEX].affiliate","typeLabel":"object"},"stripeCustomerId":{"oneOf":[{"maxLength":64,"type":"string","description":"The ID of the Stripe customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].stripeCustomerId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The ID of the Stripe customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].stripeCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].stripeCustomerId","typeLabel":"string | null"},"mollieCustomerId":{"oneOf":[{"maxLength":64,"type":"string","description":"The ID of the Mollie customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].mollieCustomerId.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"The ID of the Mollie customer for the customer","deprecated":true,"uniqueKey":"data.storeData.items.[INDEX].mollieCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].mollieCustomerId","typeLabel":"string | null"},"marketingOptions":{"required":["customerId","customerStoreDataId","dateCreated","id","isEnabled"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.id","typeLabel":"string\u003cuuid>"},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.dateCreated","typeLabel":"string\u003cdate-time>"},"isEnabled":{"type":"boolean","description":"Whether the customer has opted-in to recieve marketing communications or not from the store","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.isEnabled","typeLabel":"boolean"},"customerId":{"type":"string","description":"The ID of the customer this belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.customerId","typeLabel":"string\u003cuuid>"},"customerStoreDataId":{"type":"string","description":"The ID of the CSD this belongs to","format":"uuid","isRequired":true,"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.customerStoreDataId","typeLabel":"string\u003cuuid>"},"disabledAt":{"oneOf":[{"type":"string","description":"The date the customer opted out of email marketing","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.disabledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the customer opted out of email marketing","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.disabledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.disabledAt","typeLabel":"string\u003cdate-time> | null"},"consentSource":{"oneOf":[{"maxLength":64,"type":"string","description":"How consent was obtained (e.g. \"checkout\", \"import\", \"manual\")","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentSource.oneOf.0","typeLabel":"string"},{"maxLength":64,"type":"null","description":"How consent was obtained (e.g. \"checkout\", \"import\", \"manual\")","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentSource","typeLabel":"string | null"},"consentTimestamp":{"oneOf":[{"type":"string","description":"When the customer gave or refused marketing consent","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentTimestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the customer gave or refused marketing consent","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentTimestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentTimestamp","typeLabel":"string\u003cdate-time> | null"},"consentIpAddress":{"oneOf":[{"maxLength":45,"type":"string","description":"The IP address of the customer at the time consent was recorded","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentIpAddress.oneOf.0","typeLabel":"string"},{"maxLength":45,"type":"null","description":"The IP address of the customer at the time consent was recorded","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentIpAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentIpAddress","typeLabel":"string | null"},"consentWithdrawnAt":{"oneOf":[{"type":"string","description":"When the customer withdrew their marketing consent (unsubscribed)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentWithdrawnAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the customer withdrew their marketing consent (unsubscribed)","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentWithdrawnAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].marketingOptions.consentWithdrawnAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"The user-defined configuration for customer email marketing","uniqueKey":"data.storeData.items.[INDEX].marketingOptions","typeLabel":"object"},"blockedNote":{"oneOf":[{"maxLength":2000,"type":"string","description":"An optional note explaining why the customer was blocked.","uniqueKey":"data.storeData.items.[INDEX].blockedNote.oneOf.0","typeLabel":"string"},{"maxLength":2000,"type":"null","description":"An optional note explaining why the customer was blocked.","uniqueKey":"data.storeData.items.[INDEX].blockedNote.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].blockedNote","typeLabel":"string | null"},"blockedAt":{"oneOf":[{"type":"string","description":"The date the customer was blocked, if applicable.","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].blockedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date the customer was blocked, if applicable.","format":"date-time","uniqueKey":"data.storeData.items.[INDEX].blockedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.storeData.items.[INDEX].blockedAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"The store-scoped customer data","uniqueKey":"data.storeData.items.[INDEX]","typeLabel":"object"},"description":"The list of store-scoped data for the customer","isRequired":true,"uniqueKey":"data.storeData","typeLabel":"object[]"}},"additionalProperties":false,"description":"Represents a customer registered at Komerza globally","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":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","emailAddress":"\u003cstring>","ipAddress":"\u003cstring>","storeData":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","balance":123,"externalIntegrations":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","accountId":"\u003cstring>","platformId":"\u003cstring>","expirationDate":"2023-11-07T05:31:56Z"}],"tickets":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","subject":"\u003cstring>","status":0,"customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","userId":"\u003cstring>","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","entries":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","name":"\u003cstring>","message":"\u003cstring>","ticketId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}]}],"subscriptions":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerStoreDataId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","variantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":0,"billingInterval":0,"price":123,"currencyCode":"\u003cstring>","currentPeriodStart":"2023-11-07T05:31:56Z","currentPeriodEnd":"2023-11-07T05:31:56Z","cancelAtPeriodEnd":true,"pauseCount":123,"gateway":"\u003cstring>","autoRenew":true,"failedPaymentCount":123,"customIntervalDays":123,"canceledAt":"2023-11-07T05:31:56Z","pausedAt":"2023-11-07T05:31:56Z","pauseResumeDate":"2023-11-07T05:31:56Z","gatewaySubscriptionId":"\u003cstring>","gatewayCustomerId":"\u003cstring>","lastPaymentFailureDate":"2023-11-07T05:31:56Z","nextRetryDate":"2023-11-07T05:31:56Z","lastReminderSentAt":"2023-11-07T05:31:56Z","metadataJson":"\u003cstring>"}],"gatewayCustomerIds":{},"storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customer":"\u003cunknown>","isBlocked":true,"ipAddress":"\u003cstring>","affiliate":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","storeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isEnabled":true,"link":"\u003cstring>","discountVariesByProduct":true,"balance":123,"returnPercentage":123,"percentageOff":123},"stripeCustomerId":"\u003cstring>","mollieCustomerId":"\u003cstring>","marketingOptions":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","dateCreated":"2023-11-07T05:31:56Z","isEnabled":true,"customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","customerStoreDataId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","disabledAt":"2023-11-07T05:31:56Z","consentSource":"\u003cstring>","consentTimestamp":"2023-11-07T05:31:56Z","consentIpAddress":"\u003cstring>","consentWithdrawnAt":"2023-11-07T05:31:56Z"},"blockedNote":"\u003cstring>","blockedAt":"2023-11-07T05:31:56Z"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"045a622e-f5f9-4140-80ac-e86b6034a6b3":{"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":{"text/plain":{"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"},"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"},"text/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"},"70fb2746-e863-407e-99c4-3a5c3c433426":{"description":"Customer already exists","content":{"text/plain":{"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"},"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"},"text/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":{"4bfc9aef-efef-48eb-b71f-b5256c8031b8":{"bearer":{"type":"http","description":"Your API key goes here","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"}}},"servers":{"af080bf6-2445-4a3b-a4be-10460d82015f":{"url":"https://api.komerza.com","description":"The production Komerza API"}},"schemas":{"dc573a81-c87e-4ca1-b4c9-75479245a982":{"required":["dateCreated","emailAddress","id","ipAddress","storeData"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true},"emailAddress":{"maxLength":256,"minLength":3,"type":"string","description":"Represents the email address of the customer","isRequired":true},"ipAddress":{"maxLength":45,"type":"string","description":"Represents the IP address associated with the customer.","isRequired":true},"storeData":{"type":"array","items":{"required":["balance","customer","customerId","dateCreated","externalIntegrations","gatewayCustomerIds","id","ipAddress","isBlocked","storeId","subscriptions","tickets"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true},"externalIntegrations":{"type":"array","items":{"required":["accountId","dateCreated","id","platformId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true},"accountId":{"maxLength":256,"type":"string","description":"The users account identifier, used to identify the account on the platform","isRequired":true},"platformId":{"maxLength":64,"type":"string","description":"The ID of the platform which the integration is for","isRequired":true},"expirationDate":{"oneOf":[{"type":"string","description":"The date the access token expires","format":"date-time"},{"type":"null","description":"The date the access token expires","format":"date-time"}]}},"additionalProperties":false,"description":"A third-party integration (typically OAuth2 login) for a customer"},"description":"The list of external integrations linked to this customer","isRequired":true},"tickets":{"type":"array","items":{"required":["customerId","dateCreated","entries","id","status","storeId","subject","userId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true},"subject":{"maxLength":128,"minLength":1,"type":"string","description":"Gets or sets the subject or title of the ticket, summarizing the issue or request.","isRequired":true},"status":{"enum":[0,1,2,3,4],"type":"integer","description":"The different states of the ticket","format":"int32","x-enum-varnames":["Opened","Resolved","Closed","Responded","CustomerResponded"],"x-enum-descriptions":["The ticket has been opened and is awaiting a response from the seller","The ticket has been closed AND marked as resolved by the customer","The ticket has been closed and NOT marked as resolved by the customer","The seller has responded to the ticket","The customer has responded to the ticket"],"isRequired":true},"customerId":{"type":"string","description":"The customer who opened the ticket","format":"uuid","isRequired":true},"userId":{"maxLength":36,"minLength":1,"type":"string","description":"The user who owns the store the ticket was made in","isRequired":true},"storeId":{"type":"string","description":"The store which the ticket is for","format":"uuid","isRequired":true},"entries":{"type":"array","items":{"required":["dateCreated","id","message","name","ticketId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true},"name":{"maxLength":50,"minLength":1,"type":"string","description":"The name of the user that posted the entry","isRequired":true},"message":{"maxLength":2048,"minLength":1,"type":"string","description":"The message the user has posted to the ticket","isRequired":true},"ticketId":{"type":"string","description":"The ID of the ticket","format":"uuid","isRequired":true}},"additionalProperties":false,"description":"An entry or response on a ticket given by a seller or customer"},"description":"Gets or sets the list of entries or messages associated with the ticket.\nThese entries represent the conversation or updates related to the ticket.","isRequired":true}},"additionalProperties":false,"description":"Represents a support ticket created by a customer for a specific store."},"description":"The list of tickets created by the customer","isRequired":true},"subscriptions":{"type":"array","items":{"required":["autoRenew","billingInterval","cancelAtPeriodEnd","currencyCode","currentPeriodEnd","currentPeriodStart","customerId","customerStoreDataId","dateCreated","failedPaymentCount","gateway","id","pauseCount","price","productId","status","storeId","variantId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true},"customerId":{"type":"string","description":"The ID of the customer who owns this subscription","format":"uuid","isRequired":true},"customerStoreDataId":{"type":"string","description":"The ID of the customer's store-scoped data","format":"uuid","isRequired":true},"storeId":{"type":"string","description":"The ID of the store this subscription belongs to","format":"uuid","isRequired":true},"productId":{"type":"string","description":"The ID of the product being subscribed to","format":"uuid","isRequired":true},"variantId":{"type":"string","description":"The ID of the specific variant being subscribed to","format":"uuid","isRequired":true},"status":{"enum":[0,1,2,3,4],"type":"integer","description":"The status of a customer subscription","format":"int32","x-enum-varnames":["Active","PastDue","Canceled","Expired","Paused"],"x-enum-descriptions":["The subscription is active and in good standing","A payment has failed but the subscription is within the grace period","The subscription has been canceled by the customer or merchant","The subscription has expired (past the end of the billing period after cancellation or failed payment)","The subscription is temporarily paused"],"isRequired":true},"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"],"isRequired":true},"price":{"type":"number","description":"The price charged per billing interval","format":"double","isRequired":true},"currencyCode":{"maxLength":4,"type":"string","description":"The ISO 4217 currency code for the subscription price","isRequired":true},"currentPeriodStart":{"type":"string","description":"The start of the current billing period","format":"date-time","isRequired":true},"currentPeriodEnd":{"type":"string","description":"The end of the current billing period","format":"date-time","isRequired":true},"cancelAtPeriodEnd":{"type":"boolean","description":"Whether this subscription should be canceled at the end of the current billing period","isRequired":true},"pauseCount":{"type":"integer","description":"The total number of times this subscription has been paused over its lifetime","format":"int32","isRequired":true},"gateway":{"maxLength":64,"type":"string","description":"The payment gateway handling this subscription (e.g., \"stripe\", \"mollie\", \"square\")","isRequired":true},"autoRenew":{"type":"boolean","description":"Whether this subscription auto-renews through the payment gateway.\nFalse for gateways that don't support native recurring billing.","isRequired":true},"failedPaymentCount":{"type":"integer","description":"The number of consecutive failed payment attempts","format":"int32","isRequired":true},"customIntervalDays":{"oneOf":[{"type":"integer","description":"Custom interval in days when BillingInterval is Custom","format":"int32"},{"type":"null","description":"Custom interval in days when BillingInterval is Custom","format":"int32"}]},"canceledAt":{"oneOf":[{"type":"string","description":"The date the subscription was canceled, if applicable","format":"date-time"},{"type":"null","description":"The date the subscription was canceled, if applicable","format":"date-time"}]},"pausedAt":{"oneOf":[{"type":"string","description":"The date the subscription was paused, if applicable","format":"date-time"},{"type":"null","description":"The date the subscription was paused, if applicable","format":"date-time"}]},"pauseResumeDate":{"oneOf":[{"type":"string","description":"The date the subscription should be automatically resumed. Null means indefinite pause (until manual resume).","format":"date-time"},{"type":"null","description":"The date the subscription should be automatically resumed. Null means indefinite pause (until manual resume).","format":"date-time"}]},"gatewaySubscriptionId":{"oneOf":[{"type":"string","description":"The subscription ID within the external payment gateway","maxLength":256},{"type":"null","description":"The subscription ID within the external payment gateway","maxLength":256}]},"gatewayCustomerId":{"oneOf":[{"type":"string","description":"The customer ID within the external payment gateway (denormalized for quick lookups)","maxLength":256},{"type":"null","description":"The customer ID within the external payment gateway (denormalized for quick lookups)","maxLength":256}]},"lastPaymentFailureDate":{"oneOf":[{"type":"string","description":"The date of the most recent payment failure","format":"date-time"},{"type":"null","description":"The date of the most recent payment failure","format":"date-time"}]},"nextRetryDate":{"oneOf":[{"type":"string","description":"The next scheduled retry date for a failed payment (exponential backoff)","format":"date-time"},{"type":"null","description":"The next scheduled retry date for a failed payment (exponential backoff)","format":"date-time"}]},"lastReminderSentAt":{"oneOf":[{"type":"string","description":"The date the last renewal reminder was sent to the customer","format":"date-time"},{"type":"null","description":"The date the last renewal reminder was sent to the customer","format":"date-time"}]},"metadataJson":{"oneOf":[{"type":"string","description":"Gateway-specific metadata stored as JSON","maxLength":4096},{"type":"null","description":"Gateway-specific metadata stored as JSON","maxLength":4096}]}},"additionalProperties":false,"description":"Represents a customer's subscription to a product within a store, tracking billing lifecycle,\ngateway integration, and pause/cancel state."},"description":"The list of subscriptions the customer has","isRequired":true},"gatewayCustomerIds":{"type":"object","additionalProperties":{"type":"string"},"description":"Gateway-specific customer IDs, keyed by payment method name (e.g. \"stripe\", \"mollie\").","isRequired":true},"storeId":{"type":"string","description":"The ID the customer data is associated with","format":"uuid","isRequired":true},"customerId":{"type":"string","description":"The ID of the customer the data belongs to","format":"uuid","isRequired":true},"customer":{"oneOf":[{"isRequired":true}],"isRequired":true},"isBlocked":{"type":"boolean","description":"Whether this customer is blocked from purchasing on this store.","isRequired":true},"ipAddress":{"maxLength":45,"type":"string","description":"Represents the IP address the customer created the store data with.","isRequired":true},"affiliate":{"required":["balance","customerId","dateCreated","discountVariesByProduct","id","isEnabled","link","storeId"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true},"storeId":{"type":"string","description":"Unique identifier for the store associated with the affiliate","format":"uuid","isRequired":true},"customerId":{"type":"string","description":"Unique identifier for the customer associated with the affiliate","format":"uuid","isRequired":true},"isEnabled":{"type":"boolean","description":"Indicates whether the store is affiliated with a user","isRequired":true},"link":{"maxLength":256,"minLength":1,"type":"string","description":"A link provided to affiliates for tracking and promotional purposes.","isRequired":true},"discountVariesByProduct":{"type":"boolean","description":"Whether some products give buyers less than PercentageOff, or nothing at all.","isRequired":true},"balance":{"type":"number","description":"Represents the balance of the affiliate, typically indicating the amount earned through affiliations.","format":"double","isRequired":true},"returnPercentage":{"oneOf":[{"type":"integer","description":"The percentage of the return that an affiliate receives","format":"int32"},{"type":"null","description":"The percentage of the return that an affiliate receives","format":"int32"}]},"percentageOff":{"oneOf":[{"type":"integer","description":"The percentage discount offered by the store affiliate","format":"int32"},{"type":"null","description":"The percentage discount offered by the store affiliate","format":"int32"}]}},"additionalProperties":false,"description":"Represents an affiliate associated with a store."},"stripeCustomerId":{"oneOf":[{"type":"string","description":"The ID of the Stripe customer for the customer","maxLength":64,"deprecated":true},{"type":"null","description":"The ID of the Stripe customer for the customer","maxLength":64,"deprecated":true}]},"mollieCustomerId":{"oneOf":[{"type":"string","description":"The ID of the Mollie customer for the customer","maxLength":64,"deprecated":true},{"type":"null","description":"The ID of the Mollie customer for the customer","maxLength":64,"deprecated":true}]},"marketingOptions":{"required":["customerId","customerStoreDataId","dateCreated","id","isEnabled"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the entity","format":"uuid","isRequired":true},"dateCreated":{"type":"string","description":"The date the entity was created in the database","format":"date-time","isRequired":true},"isEnabled":{"type":"boolean","description":"Whether the customer has opted-in to recieve marketing communications or not from the store","isRequired":true},"customerId":{"type":"string","description":"The ID of the customer this belongs to","format":"uuid","isRequired":true},"customerStoreDataId":{"type":"string","description":"The ID of the CSD this belongs to","format":"uuid","isRequired":true},"disabledAt":{"oneOf":[{"type":"string","description":"The date the customer opted out of email marketing","format":"date-time"},{"type":"null","description":"The date the customer opted out of email marketing","format":"date-time"}]},"consentSource":{"oneOf":[{"type":"string","description":"How consent was obtained (e.g. \"checkout\", \"import\", \"manual\")","maxLength":64},{"type":"null","description":"How consent was obtained (e.g. \"checkout\", \"import\", \"manual\")","maxLength":64}]},"consentTimestamp":{"oneOf":[{"type":"string","description":"When the customer gave or refused marketing consent","format":"date-time"},{"type":"null","description":"When the customer gave or refused marketing consent","format":"date-time"}]},"consentIpAddress":{"oneOf":[{"type":"string","description":"The IP address of the customer at the time consent was recorded","maxLength":45},{"type":"null","description":"The IP address of the customer at the time consent was recorded","maxLength":45}]},"consentWithdrawnAt":{"oneOf":[{"type":"string","description":"When the customer withdrew their marketing consent (unsubscribed)","format":"date-time"},{"type":"null","description":"When the customer withdrew their marketing consent (unsubscribed)","format":"date-time"}]}},"additionalProperties":false,"description":"The user-defined configuration for customer email marketing"},"blockedNote":{"oneOf":[{"type":"string","description":"An optional note explaining why the customer was blocked.","maxLength":2000},{"type":"null","description":"An optional note explaining why the customer was blocked.","maxLength":2000}]},"blockedAt":{"oneOf":[{"type":"string","description":"The date the customer was blocked, if applicable.","format":"date-time"},{"type":"null","description":"The date the customer was blocked, if applicable.","format":"date-time"}]}},"additionalProperties":false,"description":"The store-scoped customer data"},"description":"The list of store-scoped data for the customer","isRequired":true}},"additionalProperties":false,"description":"Represents a customer registered at Komerza globally"}},"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":"Create Customer - Komerza Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/endpoint/customers/create","matchLevel":0},"fr":{"href":"/api-reference/endpoint/customers/create","matchLevel":0},"de":{"href":"/api-reference/endpoint/customers/create","matchLevel":0},"pl":{"href":"/api-reference/endpoint/customers/create","matchLevel":0},"es":{"href":"/api-reference/endpoint/customers/create","matchLevel":0}}},"lastModified":"2025-11-27T22:04:53.694Z","gitLastModified":"2025-08-29T23:44:51.000Z","originalFileLocation":"api-reference/endpoint/customers/create.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=\"Registers a customer for the store using their email. If the customer already exists and is linked to the store, a 409 conflict is returned. Requires the stores.customers.create 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=\"Create Customer - Komerza Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Registers a customer for the store using their email. If the customer already exists and is linked to the store, a 409 conflict is returned. Requires the stores.customers.create 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/customers/create\">\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=Customers\u0026amp;title=Create+Customer\u0026amp;description=Registers+a+customer+for+the+store+using+their+email.%0AIf+the+customer+already+exists+and+is+linked+to+the+store%2C+a+409+conflict+is+returned.%0ARequires+the+%60store\u0026amp;theme=ddc75211e622c8b9003b058b\u0026amp;signature=5beb36d1e5a4d8376da109a033d3e24040cb6c29c7068dba66cbf12c0dab93d8\">\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=\"Create Customer - Komerza Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Registers a customer for the store using their email. If the customer already exists and is linked to the store, a 409 conflict is returned. Requires the stores.customers.create permission.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://komerza.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+Customer\u0026amp;description=Registers+a+customer+for+the+store+using+their+email.%0AIf+the+customer+already+exists+and+is+linked+to+the+store%2C+a+409+conflict+is+returned.%0ARequires+the+%60store\u0026amp;theme=ddc75211e622c8b9003b058b\u0026amp;signature=5beb36d1e5a4d8376da109a033d3e24040cb6c29c7068dba66cbf12c0dab93d8\">\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/customers/create\">\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/customers/create.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/customers/create#webpage\",\"url\":\"https://docs.komerza.com/api-reference/endpoint/customers/create\",\"name\":\"Create Customer\",\"description\":\"Registers a customer for the store using their email. If the customer already exists and is linked to the store, a 409 conflict is returned. Requires the stores.customers.create permission.\",\"dateModified\":\"2025-08-29T23:44:51.000Z\",\"isPartOf\":{\"@id\":\"https://docs.komerza.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.komerza.com/api-reference/endpoint/customers/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.komerza.com/api-reference/endpoint/customers/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customers\",\"item\":\"https://docs.komerza.com/api-reference/endpoint/customers/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Customer\",\"item\":\"https://docs.komerza.com/api-reference/endpoint/customers/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.komerza.com/api-reference/endpoint/customers/create#apireference\",\"headline\":\"Create Customer\",\"name\":\"Create Customer\",\"description\":\"Registers a customer for the store using their email. If the customer already exists and is linked to the store, a 409 conflict is returned. Requires the stores.customers.create permission.\",\"url\":\"https://docs.komerza.com/api-reference/endpoint/customers/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.komerza.com/api-reference/endpoint/customers/create#webpage\"},\"dateModified\":\"2025-08-29T23:44:51.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}","description":"Retrieves a paginated list of customers for the specified store, matching the provided query.\nRequires the `stores.customers.view` permission.","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","description":"Updates the store-specific balance for a customer.\nRequires the `stores.customers.update` permission.","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","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","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}","description":"Retrieves a paginated list of customers for the specified store, matching the provided query.\nRequires the `stores.customers.view` permission.","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","description":"Updates the store-specific balance for a customer.\nRequires the `stores.customers.update` permission.","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","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","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}","description":"Retrieves a paginated list of customers for the specified store, matching the provided query.\nRequires the `stores.customers.view` permission.","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","description":"Updates the store-specific balance for a customer.\nRequires the `stores.customers.update` permission.","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","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","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}","description":"Retrieves a paginated list of customers for the specified store, matching the provided query.\nRequires the `stores.customers.view` permission.","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","description":"Updates the store-specific balance for a customer.\nRequires the `stores.customers.update` permission.","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","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","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}","description":"Retrieves a paginated list of customers for the specified store, matching the provided query.\nRequires the `stores.customers.view` permission.","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","description":"Updates the store-specific balance for a customer.\nRequires the `stores.customers.update` permission.","href":"/api-reference/endpoint/customers/update-balance"},{"title":"Get Customer by Email","openapi":"GET /stores/{storeId}/customers/{customerEmail}/email","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","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":"Create Customer - Komerza Documentation","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}