# Shoppex

- [Quickstart](https://docs.shoppex.io/start/quickstart.md): Get your Shoppex shop live, take your first sale, and see what happens next.
- [Products](https://docs.shoppex.io/selling/products.md): What you can sell on Shoppex, and how fulfillment works for each type.
- [Orders](https://docs.shoppex.io/selling/orders.md): Find an order, read its status, and act on it when something needs your attention.
- [Abandoned Carts](https://docs.shoppex.io/selling/abandoned-checkouts.md): See who started a checkout and left before paying, send them a recovery email with an optional coupon, and measure what came back.
- [Serials & license keys](https://docs.shoppex.io/selling/serials-and-licenses.md): Sell single-use codes like license keys, game codes, or gift cards.
- [Subscriptions](https://docs.shoppex.io/selling/subscriptions.md): Recurring billing with trials, retries, and cancellation handling.
- [Discord roles](https://docs.shoppex.io/selling/discord-roles.md): Grant a server role automatically when a buyer's payment clears.
- [Payment gateways](https://docs.shoppex.io/payments/gateways.md): Connect Stripe, PayPal, PayPal Friends & Family, Cash App, MisticPay (PIX), and crypto.
- [Checkout](https://docs.shoppex.io/payments/checkout.md): How a Shoppex checkout session is created and completed.
- [Refunds and disputes](https://docs.shoppex.io/payments/refunds.md): Issue full or partial refunds from the dashboard, and see what happens when a buyer disputes a charge.
- [Chargeback Shield](https://docs.shoppex.io/payments/chargeback-shield.md): Win your disputes automatically and keep your Stripe and PayPal accounts alive.
- [Shoppex Wallet](https://docs.shoppex.io/payments/crypto-wallet.md): Accept Bitcoin and Litecoin into a self-custodial wallet only you control.
- [Customers](https://docs.shoppex.io/customers/overview.md): Customer profiles, wallet credits, and affiliates.
- [Support inbox](https://docs.shoppex.io/customers/inbox.md): Reply to buyer questions from one place.
- [Resellers](https://docs.shoppex.io/customers/resellers.md): Let trusted partners buy your products at wholesale prices and pay from a prepaid balance.
- [Team and stores](https://docs.shoppex.io/account/team.md): Invite teammates with scoped access, and run more than one shop from one login.
- [Security](https://docs.shoppex.io/account/security.md): 2FA, active sessions, and the audit trail.
- [Playbooks](https://docs.shoppex.io/playbooks/overview.md): Step-by-step playbooks for common shop launches, sales, and migrations.
- [Themes](https://docs.shoppex.io/storefront/themes.md): Choose between an Easy visual theme and an Advanced code storefront, then see how Shoppex serves both.
- [Visual themes](https://docs.shoppex.io/storefront/visual-themes.md): Edit ThemeDocument settings, pages, and blocks in the Theme Builder, then preview and publish.
- [Advanced styling for Easy themes](https://docs.shoppex.io/storefront/easy-theme-advanced-styling.md): Add theme CSS, block CSS, custom classes, custom HTML, and scrolling announcement bars without a code storefront.
- [Editing with AI](https://docs.shoppex.io/storefront/editing-with-ai.md): Edit an Easy theme through MCP chat or a local ThemeDocument checkout, then review and publish it.
- [Theme CLI](https://docs.shoppex.io/storefront/theme-cli.md): Inspect ThemeDocument settings and schemas with the Shoppex CLI.
- [Code storefronts](https://docs.shoppex.io/storefront/code-storefronts.md): Move an Advanced storefront in and out of Shoppex as a portable ZIP package.
- [Code storefront development](https://docs.shoppex.io/storefront/code-storefront-development.md): The folder structure, the commerce layer, and how to work locally in an Advanced storefront project.
- [Customer accounts](https://docs.shoppex.io/storefront/code-storefront-accounts.md): Build a signed-in customer account into a code storefront, with the session rules that make it safe.
- [ThemeDocument structure](https://docs.shoppex.io/storefront/theme-document.md): Every field, page ID, and URL route inside a ThemeDocument, with pointers to blocks and design tokens.
- [Block reference](https://docs.shoppex.io/storefront/block-reference.md): Every block type a ThemeDocument can use, and the settings each one accepts.
- [Custom domain](https://docs.shoppex.io/storefront/custom-domain.md): Step-by-step DNS walkthrough to run your shop on your own domain.
- [SEO, link previews, and favicon](https://docs.shoppex.io/storefront/seo-and-favicon.md): Set the title, description, and image that Google, Discord, and X show for your shop, plus the icon in the browser tab.
- [Troubleshooting](https://docs.shoppex.io/storefront/troubleshooting.md): Resolve ThemeDocument validation, preview, revision, and build problems on either lane.
- [Quick start](https://docs.shoppex.io/developers/quickstart.md): Make your first API call in under 2 minutes
- [API introduction](https://docs.shoppex.io/developers/api-overview.md): Getting started with the Shoppex Developer API
- [Authentication](https://docs.shoppex.io/developers/authentication.md): How to authenticate with the Shoppex Developer API
- [SDKs & libraries](https://docs.shoppex.io/developers/sdks.md): Official and community SDKs for the Shoppex API
- [Error handling](https://docs.shoppex.io/developers/errors.md): Understanding and handling API errors
- [Invoices](https://docs.shoppex.io/developers/invoices.md): Understanding the invoice lifecycle and statuses
- [Payments](https://docs.shoppex.io/developers/payments.md): Accept payments through the API, payment links, or your storefront
- [External payment adapters](https://docs.shoppex.io/developers/external-payment-adapters.md): Connect a payment provider that Shoppex does not support natively with your own signed HTTPS service.
- [Complete or process manual-payment invoices](https://docs.shoppex.io/developers/manual-payments.md): Complete or process storefront manual-payment invoices after your external gateway confirms payment
- [Subscriptions](https://docs.shoppex.io/developers/subscriptions.md): Set up recurring billing and subscription management
- [Asynchronous and manual fulfillment](https://docs.shoppex.io/developers/fulfillment.md): Deliver paid order line items later through a dynamic webhook, the dashboard, or the Developer API
- [Webhooks](https://docs.shoppex.io/developers/webhooks.md): Register endpoints, verify signatures, and handle retries
- [Webhook events](https://docs.shoppex.io/developers/webhook-events.md): Supported webhook event names and example payloads
- [Dynamic product delivery](https://docs.shoppex.io/developers/dynamic-delivery.md): The callback contract used by DYNAMIC products through dynamic_webhook
- [Headless commerce with Shoppex](https://docs.shoppex.io/developers/headless/overview.md): Run Shoppex as the commerce engine behind any frontend — your UI, our orders, payments, invoices, licenses, subscriptions, and fulfillment.
- [Next.js quickstart](https://docs.shoppex.io/developers/headless/quickstart-nextjs.md): Build a custom storefront in Next.js 16 with Shoppex as the commerce engine — products, checkout, and webhook fulfillment in under 15 minutes.
- [Storefront starter](https://docs.shoppex.io/developers/headless/storefront-starter.md): Start from a self-hosted Next.js storefront with Shoppex products, cart, checkout, customer portal links, and webhook fulfillment already wired.
- [Headless checkout SDK](https://docs.shoppex.io/developers/headless/checkout.md): Build your own checkout UI with @shoppexio/checkout-js/headless while Shoppex handles payment sessions, webhooks, invoices, and fulfillment.
- [Headless customer portal](https://docs.shoppex.io/developers/headless/customer-accounts.md): Build a complete custom customer portal with Shoppex login, orders, delivery, support, account settings, subscriptions, licenses, and benefits.
- [Storefront SDK](https://docs.shoppex.io/developers/storefront-sdk/overview.md): Build headless or embedded storefronts with the browser-safe Shoppex Storefront SDK
- [Storefront SDK reference](https://docs.shoppex.io/developers/storefront-sdk/reference.md): Complete method and type reference for the Shoppex Storefront SDK
- [Checkout Embed SDK](https://docs.shoppex.io/developers/embeds/overview.md): Add Shoppex checkout as a modal on your existing website, with copy-paste framework snippets
- [Embed SDK reference](https://docs.shoppex.io/developers/embeds/reference.md): Complete reference for the Shoppex Checkout Embed SDK — script and versioning, snippet parameters, the JavaScript API, every public event, and the exact CSP directives your site needs
- [Telegram bots](https://docs.shoppex.io/developers/telegram-bots.md): Connect your Telegram bot to Shoppex for notifications, broadcasts, and AI-powered customer support
- [Resellers](https://docs.shoppex.io/developers/manage-resellers.md): Automate your wholesale reseller program from the Developer API.
- [Reseller panel](https://docs.shoppex.io/developers/reseller-panel.md): Where resellers manage their tier, balance, wholesale orders, and API keys.
- [Reseller API](https://docs.shoppex.io/developers/reseller-api.md): Programmatic wholesale purchasing for resellers of a Shoppex store.
- [Email segmentation filters](https://docs.shoppex.io/developers/email-segmentation-filters.md): JSON filter rules for email marketing audience segments
- [Validate licenses from your own desktop app](https://docs.shoppex.io/developers/tutorials/desktop-license-validation.md): Wire your installer's activation flow to Shoppex licenses with HWID and IP locking.
- [Webhook handler in a Cloudflare Worker](https://docs.shoppex.io/developers/tutorials/webhook-cloudflare-worker.md): Verify, idempotency-check, and act on Shoppex webhooks from a Worker.
- [Plug Shoppex into Zapier or n8n](https://docs.shoppex.io/developers/tutorials/zapier-n8n.md): Connect Shoppex to no-code automation tools using webhooks and the REST API.
- [Get current account](https://docs.shoppex.io/api-reference/account-&-auth/get-current-account.md): Developer API operation for GET /dev/v1/me.
- [Get current account capabilities](https://docs.shoppex.io/api-reference/account-&-auth/get-current-account-capabilities.md): Developer API operation for GET /dev/v1/me/capabilities.
- [Authorize an OAuth app](https://docs.shoppex.io/api-reference/oauth2/authorize-an-oauth-app.md): Developer API operation for GET /dev/v1/oauth/authorize.
- [Confirm OAuth app authorization](https://docs.shoppex.io/api-reference/oauth2/confirm-oauth-app-authorization.md): Developer API operation for POST /dev/v1/oauth/authorize.
- [Exchange an OAuth code or refresh token](https://docs.shoppex.io/api-reference/oauth2/exchange-an-oauth-code-or-refresh-token.md): Developer API operation for POST /dev/v1/oauth/token.
- [List affiliate customers](https://docs.shoppex.io/api-reference/affiliates/list-affiliate-customers.md): Developer API operation for GET /dev/v1/affiliates/customers.
- [Get affiliate settings](https://docs.shoppex.io/api-reference/affiliates/get-affiliate-settings.md): Developer API operation for GET /dev/v1/affiliates/settings.
- [Update affiliate settings](https://docs.shoppex.io/api-reference/affiliates/update-affiliate-settings.md): Developer API operation for PATCH /dev/v1/affiliates/settings.
- [List affiliate customers](https://docs.shoppex.io/api-reference/affiliates/list-affiliate-customers.md): Developer API operation for GET /dev/v1/affiliates/customers.
- [Invite affiliate customer](https://docs.shoppex.io/api-reference/affiliates/invite-affiliate-customer.md): Developer API operation for POST /dev/v1/affiliates/customers/{customerId}/invite.
- [Update affiliate link](https://docs.shoppex.io/api-reference/affiliates/update-affiliate-link.md): Developer API operation for PATCH /dev/v1/affiliates/links/{id}.
- [Create affiliate link primary](https://docs.shoppex.io/api-reference/affiliates/create-affiliate-link-primary.md): Developer API operation for POST /dev/v1/affiliates/links/{id}/primary.
- [Update affiliate customer status](https://docs.shoppex.io/api-reference/affiliates/update-affiliate-customer-status.md): Developer API operation for PATCH /dev/v1/affiliates/customers/{customerId}/status.
- [Get affiliate customer performance](https://docs.shoppex.io/api-reference/affiliates/get-affiliate-customer-performance.md): Developer API operation for GET /dev/v1/affiliates/customers/{customerId}/performance.
- [List affiliate applications](https://docs.shoppex.io/api-reference/affiliates/list-affiliate-applications.md): Developer API operation for GET /dev/v1/affiliates/applications.
- [Approve affiliate application](https://docs.shoppex.io/api-reference/affiliates/approve-affiliate-application.md): Developer API operation for POST /dev/v1/affiliates/applications/{id}/approve.
- [Reject affiliate application](https://docs.shoppex.io/api-reference/affiliates/reject-affiliate-application.md): Developer API operation for POST /dev/v1/affiliates/applications/{id}/reject.
- [List affiliate payout requests](https://docs.shoppex.io/api-reference/affiliates/list-affiliate-payout-requests.md): Developer API operation for GET /dev/v1/affiliates/payout-requests.
- [Approve affiliate payout request](https://docs.shoppex.io/api-reference/affiliates/approve-affiliate-payout-request.md): Developer API operation for POST /dev/v1/affiliates/payout-requests/{id}/approve.
- [Force approve affiliate payout request](https://docs.shoppex.io/api-reference/affiliates/force-approve-affiliate-payout-request.md): Developer API operation for POST /dev/v1/affiliates/payout-requests/{id}/force-approve.
- [Reject affiliate payout request](https://docs.shoppex.io/api-reference/affiliates/reject-affiliate-payout-request.md): Developer API operation for POST /dev/v1/affiliates/payout-requests/{id}/reject.
- [Complete affiliate payout request](https://docs.shoppex.io/api-reference/affiliates/complete-affiliate-payout-request.md): Developer API operation for POST /dev/v1/affiliates/payout-requests/{id}/complete.
- [Cancel affiliate payout request](https://docs.shoppex.io/api-reference/affiliates/cancel-affiliate-payout-request.md): Developer API operation for POST /dev/v1/affiliates/payout-requests/{id}/cancel.
- [Get affiliate analytics](https://docs.shoppex.io/api-reference/affiliates/get-affiliate-analytics.md): Developer API operation for GET /dev/v1/affiliates/analytics.
- [List allowlist entries](https://docs.shoppex.io/api-reference/allowlist/list-allowlist-entries.md): Developer API operation for GET /dev/v1/allowlist.
- [Create an allowlist entry](https://docs.shoppex.io/api-reference/allowlist/create-an-allowlist-entry.md): Developer API operation for POST /dev/v1/allowlist.
- [Get an allowlist entry](https://docs.shoppex.io/api-reference/allowlist/get-an-allowlist-entry.md): Developer API operation for GET /dev/v1/allowlist/{id}.
- [Delete an allowlist entry](https://docs.shoppex.io/api-reference/allowlist/delete-an-allowlist-entry.md): Developer API operation for DELETE /dev/v1/allowlist/{id}.
- [Get analytics revenue](https://docs.shoppex.io/api-reference/analytics/get-analytics-revenue.md): Developer API operation for GET /dev/v1/analytics/revenue.
- [List analytics reports](https://docs.shoppex.io/api-reference/analytics/list-analytics-reports.md): Developer API operation for GET /dev/v1/analytics/reports.
- [Create analytics report](https://docs.shoppex.io/api-reference/analytics/create-analytics-report.md): Developer API operation for POST /dev/v1/analytics/reports.
- [Generate analytics report](https://docs.shoppex.io/api-reference/analytics/generate-analytics-report.md): Developer API operation for POST /dev/v1/analytics/reports/{id}/generate.
- [Delete analytics report](https://docs.shoppex.io/api-reference/analytics/delete-analytics-report.md): Developer API operation for DELETE /dev/v1/analytics/reports/{id}.
- [List blacklist entries](https://docs.shoppex.io/api-reference/blacklist/list-blacklist-entries.md): Developer API operation for GET /dev/v1/blacklist.
- [Create a blacklist entry](https://docs.shoppex.io/api-reference/blacklist/create-a-blacklist-entry.md): Developer API operation for POST /dev/v1/blacklist.
- [Get blacklist entry](https://docs.shoppex.io/api-reference/blacklist/get-blacklist-entry.md): Developer API operation for GET /dev/v1/blacklist/{id}.
- [Delete blacklist entry](https://docs.shoppex.io/api-reference/blacklist/delete-blacklist-entry.md): Developer API operation for DELETE /dev/v1/blacklist/{id}.
- [List categories](https://docs.shoppex.io/api-reference/categories/list-categories.md): Returns categories for the current shop, including the public category cover URL in `cdn_image_url` when a category image exists.
- [Create category](https://docs.shoppex.io/api-reference/categories/create-category.md): Creates a category for the current shop. The response includes `cdn_image_url`, which is `null` unless the category already has a cover image.
- [Get category](https://docs.shoppex.io/api-reference/categories/get-category.md): Returns one category by uniqid, including its public cover URL in `cdn_image_url` when a category image exists.
- [Update category](https://docs.shoppex.io/api-reference/categories/update-category.md): Updates an existing category. The response keeps returning the current `cdn_image_url` so clients can continue rendering the category cover after non-image edits.
- [Delete category](https://docs.shoppex.io/api-reference/categories/delete-category.md): Deletes a category and unbinds linked products from it.
- [List code storefronts](https://docs.shoppex.io/api-reference/code-storefronts/list-code-storefronts.md): Developer API operation for GET /dev/v1/code-storefronts.
- [Get code storefront source manifest](https://docs.shoppex.io/api-reference/code-storefronts/get-code-storefront-source-manifest.md): Developer API operation for GET /dev/v1/code-storefronts/{id}/source.
- [Replace code storefront source](https://docs.shoppex.io/api-reference/code-storefronts/replace-code-storefront-source.md): Developer API operation for PUT /dev/v1/code-storefronts/{id}/source.
- [Get code storefront source file](https://docs.shoppex.io/api-reference/code-storefronts/get-code-storefront-source-file.md): Developer API operation for GET /dev/v1/code-storefronts/{id}/source/content.
- [Export code storefront source as a ZIP archive](https://docs.shoppex.io/api-reference/code-storefronts/export-code-storefront-source-as-a-zip-archive.md): Developer API operation for GET /dev/v1/code-storefronts/{id}/source/archive.
- [Replace code storefront source from a ZIP archive](https://docs.shoppex.io/api-reference/code-storefronts/replace-code-storefront-source-from-a-zip-archive.md): Developer API operation for PUT /dev/v1/code-storefronts/{id}/source/archive.
- [Enqueue code storefront build](https://docs.shoppex.io/api-reference/code-storefronts/enqueue-code-storefront-build.md): Developer API operation for POST /dev/v1/code-storefronts/{id}/builds.
- [Get current code storefront build](https://docs.shoppex.io/api-reference/code-storefronts/get-current-code-storefront-build.md): Developer API operation for GET /dev/v1/code-storefronts/{id}/builds/current.
- [Publish code storefront](https://docs.shoppex.io/api-reference/code-storefronts/publish-code-storefront.md): Developer API operation for POST /dev/v1/code-storefronts/{id}/publish.
- [List coupons](https://docs.shoppex.io/api-reference/coupons/list-coupons.md): Returns active coupons for the authenticated shop.
- [Create coupon](https://docs.shoppex.io/api-reference/coupons/create-coupon.md): Creates a coupon for the authenticated shop.
- [Validate coupon by code](https://docs.shoppex.io/api-reference/coupons/validate-coupon-by-code.md): Validates a coupon server-side by code. Use `product_id` for single-product checks or `cart` with a JSON string payload for cart validation.
- [Get coupon](https://docs.shoppex.io/api-reference/coupons/get-coupon.md): Returns one coupon by uniqid for the authenticated shop.
- [Update coupon](https://docs.shoppex.io/api-reference/coupons/update-coupon.md): Updates a coupon for the authenticated shop.
- [Delete coupon](https://docs.shoppex.io/api-reference/coupons/delete-coupon.md): Deletes a coupon, or deactivates it when invoices already reference it.
- [List customers](https://docs.shoppex.io/api-reference/customers/list-customers.md): Developer API operation for GET /dev/v1/customers.
- [Create customer](https://docs.shoppex.io/api-reference/customers/create-customer.md): Developer API operation for POST /dev/v1/customers.
- [Get customer](https://docs.shoppex.io/api-reference/customers/get-customer.md): Developer API operation for GET /dev/v1/customers/{id}.
- [Update customer](https://docs.shoppex.io/api-reference/customers/update-customer.md): Developer API operation for PATCH /dev/v1/customers/{id}.
- [Delete customer](https://docs.shoppex.io/api-reference/customers/delete-customer.md): Developer API operation for DELETE /dev/v1/customers/{id}.
- [Get customer affiliate](https://docs.shoppex.io/api-reference/customers/get-customer-affiliate.md): Developer API operation for GET /dev/v1/customers/{id}/affiliate.
- [Get customer wallet](https://docs.shoppex.io/api-reference/customers/get-customer-wallet.md): Developer API operation for GET /dev/v1/customers/{id}/wallet.
- [Credit customer wallet](https://docs.shoppex.io/api-reference/customers/credit-customer-wallet.md): Developer API operation for POST /dev/v1/customers/{id}/wallet/credit.
- [Debit customer wallet](https://docs.shoppex.io/api-reference/customers/debit-customer-wallet.md): Developer API operation for POST /dev/v1/customers/{id}/wallet/debit.
- [Convert affiliate balance](https://docs.shoppex.io/api-reference/customers/convert-affiliate-balance.md): Developer API operation for POST /dev/v1/customers/{id}/affiliate/convert-to-balance.
- [Create customer affiliate payout request](https://docs.shoppex.io/api-reference/customers/create-customer-affiliate-payout-request.md): Developer API operation for POST /dev/v1/customers/{id}/affiliate/payout-requests.
- [Get email marketing settings](https://docs.shoppex.io/api-reference/email-marketing/get-email-marketing-settings.md): Developer API operation for GET /dev/v1/email-marketing/settings.
- [List email marketing contacts](https://docs.shoppex.io/api-reference/email-marketing/list-email-marketing-contacts.md): Developer API operation for GET /dev/v1/email-marketing/contacts.
- [Create email marketing contact](https://docs.shoppex.io/api-reference/email-marketing/create-email-marketing-contact.md): Developer API operation for POST /dev/v1/email-marketing/contacts.
- [List email marketing lists](https://docs.shoppex.io/api-reference/email-marketing/list-email-marketing-lists.md): Developer API operation for GET /dev/v1/email-marketing/lists.
- [Get email marketing list](https://docs.shoppex.io/api-reference/email-marketing/get-email-marketing-list.md): Developer API operation for GET /dev/v1/email-marketing/lists/{id}.
- [List email marketing segments](https://docs.shoppex.io/api-reference/email-marketing/list-email-marketing-segments.md): Developer API operation for GET /dev/v1/email-marketing/segments.
- [Create email marketing segment](https://docs.shoppex.io/api-reference/email-marketing/create-email-marketing-segment.md): Developer API operation for POST /dev/v1/email-marketing/segments.
- [List email marketing suppressions](https://docs.shoppex.io/api-reference/email-marketing/list-email-marketing-suppressions.md): Developer API operation for GET /dev/v1/email-marketing/suppressions.
- [Create email marketing suppression](https://docs.shoppex.io/api-reference/email-marketing/create-email-marketing-suppression.md): Developer API operation for POST /dev/v1/email-marketing/suppressions.
- [List email marketing campaigns](https://docs.shoppex.io/api-reference/email-marketing/list-email-marketing-campaigns.md): Developer API operation for GET /dev/v1/email-marketing/campaigns.
- [Create email marketing campaign](https://docs.shoppex.io/api-reference/email-marketing/create-email-marketing-campaign.md): Developer API operation for POST /dev/v1/email-marketing/campaigns.
- [Get email marketing campaign](https://docs.shoppex.io/api-reference/email-marketing/get-email-marketing-campaign.md): Developer API operation for GET /dev/v1/email-marketing/campaigns/{id}.
- [List email marketing automations](https://docs.shoppex.io/api-reference/email-marketing/list-email-marketing-automations.md): Developer API operation for GET /dev/v1/email-marketing/automations.
- [Create email marketing automation](https://docs.shoppex.io/api-reference/email-marketing/create-email-marketing-automation.md): Developer API operation for POST /dev/v1/email-marketing/automations.
- [Create email marketing automation activate](https://docs.shoppex.io/api-reference/email-marketing/create-email-marketing-automation-activate.md): Developer API operation for POST /dev/v1/email-marketing/automations/{id}/activate.
- [Create email marketing automation trigger](https://docs.shoppex.io/api-reference/email-marketing/create-email-marketing-automation-trigger.md): Developer API operation for POST /dev/v1/email-marketing/automations/trigger.
- [Get email marketing billing usage](https://docs.shoppex.io/api-reference/email-marketing/get-email-marketing-billing-usage.md): Developer API operation for GET /dev/v1/email-marketing/billing/usage.
- [List disputes](https://docs.shoppex.io/api-reference/disputes-&-escrow/list-disputes.md): Developer API operation for GET /dev/v1/disputes.
- [Get dispute](https://docs.shoppex.io/api-reference/disputes-&-escrow/get-dispute.md): Developer API operation for GET /dev/v1/disputes/{id}.
- [List escrow records](https://docs.shoppex.io/api-reference/disputes-&-escrow/list-escrow-records.md): Developer API operation for GET /dev/v1/escrow.
- [Get escrow record](https://docs.shoppex.io/api-reference/disputes-&-escrow/get-escrow-record.md): Developer API operation for GET /dev/v1/escrow/{id}.
- [Release escrow record](https://docs.shoppex.io/api-reference/disputes-&-escrow/release-escrow-record.md): Developer API operation for POST /dev/v1/escrow/{id}/release.
- [List groups](https://docs.shoppex.io/api-reference/groups/list-groups.md): Developer API operation for GET /dev/v1/groups.
- [Create group](https://docs.shoppex.io/api-reference/groups/create-group.md): Developer API operation for POST /dev/v1/groups.
- [Get group](https://docs.shoppex.io/api-reference/groups/get-group.md): Developer API operation for GET /dev/v1/groups/{uniqid}.
- [Update group](https://docs.shoppex.io/api-reference/groups/update-group.md): Developer API operation for PATCH /dev/v1/groups/{uniqid}.
- [Delete group](https://docs.shoppex.io/api-reference/groups/delete-group.md): Developer API operation for DELETE /dev/v1/groups/{uniqid}.
- [List invoices](https://docs.shoppex.io/api-reference/invoices/list-invoices.md): Developer API operation for GET /dev/v1/invoices.
- [Get invoice](https://docs.shoppex.io/api-reference/invoices/get-invoice.md): Developer API operation for GET /dev/v1/invoices/{uniqid}.
- [Update invoice](https://docs.shoppex.io/api-reference/invoices/update-invoice.md): Developer API operation for PATCH /dev/v1/invoices/{uniqid}.
- [Trigger server-side invoice completion](https://docs.shoppex.io/api-reference/invoices/trigger-server-side-invoice-completion.md): Completes or processes a `PENDING` or `PENDING_PAYMENT` invoice through the existing completion pipeline. This is the public Developer API equivalent of the Dashboard’s **Process Invoice** action. The buyer email states that the merchant completed the order and that Shoppex did not verify the paymen…
- [Void invoice](https://docs.shoppex.io/api-reference/invoices/void-invoice.md): Voids a non-completed invoice through the existing invoice void pipeline.
- [Issue invoice replacement](https://docs.shoppex.io/api-reference/invoices/issue-invoice-replacement.md): Issues replacement serials for a completed serial-based invoice. By default, replacements cannot exceed the original purchased quantity. Set `override_remaining_quantity` to `true` for a manual support override when a previous replacement also failed.
- [List licenses](https://docs.shoppex.io/api-reference/licenses/list-licenses.md): Developer API operation for GET /dev/v1/licenses.
- [Create license](https://docs.shoppex.io/api-reference/licenses/create-license.md): Developer API operation for POST /dev/v1/licenses.
- [Get license product](https://docs.shoppex.io/api-reference/licenses/get-license-product.md): Developer API operation for GET /dev/v1/licenses/products/{product_id}.
- [Validate license](https://docs.shoppex.io/api-reference/licenses/validate-license.md): Developer API operation for POST /dev/v1/licenses/validate.
- [Get license](https://docs.shoppex.io/api-reference/licenses/get-license.md): Developer API operation for GET /dev/v1/licenses/{id}.
- [Update license](https://docs.shoppex.io/api-reference/licenses/update-license.md): Developer API operation for PATCH /dev/v1/licenses/{id}.
- [Reset license HWID](https://docs.shoppex.io/api-reference/licenses/reset-license-hwid.md): Developer API operation for POST /dev/v1/licenses/{id}/reset-hwid.
- [Delete license](https://docs.shoppex.io/api-reference/licenses/delete-license.md): Developer API operation for DELETE /dev/v1/licenses/{id}.
- [Update license HWID](https://docs.shoppex.io/api-reference/licenses/update-license-hwid.md): Developer API operation for PATCH /dev/v1/licenses/keys/{key}/hwid.
- [List orders](https://docs.shoppex.io/api-reference/orders/list-orders.md): Returns Shoppex orders created from invoices. Order payloads can include `custom_fields`, which are commonly used to carry internal routing markers from invoice creation. Example: `{ "custom_fields": { "source": "affiliate", "campaign": "spring_launch" } }`.
- [Create order from product line items](https://docs.shoppex.io/api-reference/orders/create-order-from-product-line-items.md): Creates a server-side Shoppex order from product or variant line items. Use `gateway` to preselect a valid active gateway for the resulting pending order.
- [Get order details](https://docs.shoppex.io/api-reference/orders/get-order-details.md): Returns a single Shoppex order by internal order ID or public uniqid. The response can include `custom_fields` set during invoice creation, for example `{ "source": "affiliate", "campaign": "spring_launch" }`.
- [Update order affiliate attribution](https://docs.shoppex.io/api-reference/orders/update-order-affiliate-attribution.md): Assigns affiliate attribution to a pending order using `affiliate_code`, `referral_code`, or `affiliate_id`. This updates attribution and pending commission records, but does not recalculate order totals or discounts.
- [Replace order affiliate attribution](https://docs.shoppex.io/api-reference/orders/replace-order-affiliate-attribution.md): Alias for `PATCH /dev/v1/orders/:id`.
- [Trigger server-side completion](https://docs.shoppex.io/api-reference/orders/trigger-server-side-completion.md): Completes a pending order server-side through the existing invoice completion pipeline. This is an explicit alias for integrations that look for a completion endpoint. The buyer email states that the merchant completed the order and that Shoppex did not verify the payment.
- [Trigger server-side fulfillment](https://docs.shoppex.io/api-reference/orders/trigger-server-side-fulfillment.md): Completes and fulfills a pending order server-side through the existing invoice completion pipeline. The buyer email states that the merchant completed the order and that Shoppex did not verify the payment.
- [Fulfill an order line item](https://docs.shoppex.io/api-reference/orders/fulfill-an-order-line-item.md): Delivers content for one line item on a completed order. A dynamic-delivery webhook may acknowledge the original delivery request with `{ "status": "pending" }` and later push the final content through this endpoint.
- [Retry a failed line-item delivery](https://docs.shoppex.io/api-reference/orders/retry-a-failed-line-item-delivery.md): Re-posts the dynamic-delivery webhook for a failed line item. Warning: the vendor may already have provisioned the item during the first ambiguous failure, so retrying can cause double delivery.
- [Refund an order](https://docs.shoppex.io/api-reference/orders/refund-an-order.md): Refunds the payment behind an order, either in full or for a partial `amount`. `Idempotency-Key` is required so retries reuse the same provider operation. Only gateways with refund support accept this call; unsupported gateways are rejected with a validation error.
- [List payment links](https://docs.shoppex.io/api-reference/payment-links/list-payment-links.md): Developer API operation for GET /dev/v1/payment-links.
- [Create payment link](https://docs.shoppex.io/api-reference/payment-links/create-payment-link.md): Developer API operation for POST /dev/v1/payment-links.
- [Get payment link](https://docs.shoppex.io/api-reference/payment-links/get-payment-link.md): Developer API operation for GET /dev/v1/payment-links/{id}.
- [Update payment link](https://docs.shoppex.io/api-reference/payment-links/update-payment-link.md): Developer API operation for PATCH /dev/v1/payment-links/{id}.
- [Delete payment link](https://docs.shoppex.io/api-reference/payment-links/delete-payment-link.md): Developer API operation for DELETE /dev/v1/payment-links/{id}.
- [Toggle payment link](https://docs.shoppex.io/api-reference/payment-links/toggle-payment-link.md): Developer API operation for POST /dev/v1/payment-links/{id}/toggle.
- [List payments](https://docs.shoppex.io/api-reference/payments/list-payments.md): Returns developer payments for the current shop. This endpoint lists payment records you already created through the Developer API; it does not return the shop's currently enabled payment methods. Use `/dev/v1/me/capabilities` when you need the payment methods enabled for the current shop. Session-b…
- [Create payment](https://docs.shoppex.io/api-reference/payments/create-payment.md): Creates a generic developer payment request. This endpoint does not create fulfillable product delivery. Use `/dev/v1/orders` when you need product line items and Shoppex fulfillment. If `webhook` is provided, the response includes `webhook_secret` once; use it to verify the `order:paid` callback fo…
- [Create checkout session](https://docs.shoppex.io/api-reference/payments/create-checkout-session.md): Stripe-style alias for `POST /dev/v1/payments`. Accepts `amount`, `success_url`, `cancel_url`, `customer_email`, and a single `product` descriptor; returns a session shape with `id`, `url`, and `status`. Internally delegates to the payments endpoint, so PSP orchestration, scopes, and webhook behavio…
- [Get payment](https://docs.shoppex.io/api-reference/payments/get-payment.md): Returns a single developer payment. Session-backed gateways can include `checkout_url` and `session_id` when Shoppex created the provider session.
- [Void payment](https://docs.shoppex.io/api-reference/payments/void-payment.md): Voids a pending developer payment.
- [Complete payment](https://docs.shoppex.io/api-reference/payments/complete-payment.md): Triggers server-side completion for a pending developer payment. This confirms the payment state only and does not create product fulfillment. The buyer receives a neutral merchant-confirmed completion email that does not claim Shoppex verified the payment. Use `/dev/v1/orders/:id/fulfill` for deliv…
- [List products](https://docs.shoppex.io/api-reference/products/list-products.md): Developer API operation for GET /dev/v1/products.
- [Create product](https://docs.shoppex.io/api-reference/products/create-product.md): Developer API operation for POST /dev/v1/products.
- [Search products](https://docs.shoppex.io/api-reference/products/search-products.md): Searches products by the required `q` query parameter. Use `GET /dev/v1/products` to list products without a search term.
- [Bulk update products](https://docs.shoppex.io/api-reference/products/bulk-update-products.md): Developer API operation for PATCH /dev/v1/products/bulk.
- [Reorder products](https://docs.shoppex.io/api-reference/products/reorder-products.md): Developer API operation for PATCH /dev/v1/products/order.
- [List product addons](https://docs.shoppex.io/api-reference/products/list-product-addons.md): Developer API operation for GET /dev/v1/products/addons.
- [Create product addon](https://docs.shoppex.io/api-reference/products/create-product-addon.md): Developer API operation for POST /dev/v1/products/addons.
- [Get product addon](https://docs.shoppex.io/api-reference/products/get-product-addon.md): Developer API operation for GET /dev/v1/products/addons/{uniqid}.
- [Update product addon](https://docs.shoppex.io/api-reference/products/update-product-addon.md): Developer API operation for PATCH /dev/v1/products/addons/{uniqid}.
- [Delete product addon](https://docs.shoppex.io/api-reference/products/delete-product-addon.md): Developer API operation for DELETE /dev/v1/products/addons/{uniqid}.
- [List product bundles](https://docs.shoppex.io/api-reference/products/list-product-bundles.md): Developer API operation for GET /dev/v1/products/bundles.
- [Create product bundle](https://docs.shoppex.io/api-reference/products/create-product-bundle.md): Developer API operation for POST /dev/v1/products/bundles.
- [Get product bundle](https://docs.shoppex.io/api-reference/products/get-product-bundle.md): Developer API operation for GET /dev/v1/products/bundles/{uniqid}.
- [Update product bundle](https://docs.shoppex.io/api-reference/products/update-product-bundle.md): Developer API operation for PATCH /dev/v1/products/bundles/{uniqid}.
- [Delete product bundle](https://docs.shoppex.io/api-reference/products/delete-product-bundle.md): Developer API operation for DELETE /dev/v1/products/bundles/{uniqid}.
- [List product quantity deals](https://docs.shoppex.io/api-reference/products/list-product-quantity-deals.md): Developer API operation for GET /dev/v1/products/quantity-deals.
- [Create product quantity deal](https://docs.shoppex.io/api-reference/products/create-product-quantity-deal.md): Developer API operation for POST /dev/v1/products/quantity-deals.
- [Get product quantity deal](https://docs.shoppex.io/api-reference/products/get-product-quantity-deal.md): Developer API operation for GET /dev/v1/products/quantity-deals/{uniqid}.
- [Update product quantity deal](https://docs.shoppex.io/api-reference/products/update-product-quantity-deal.md): Developer API operation for PATCH /dev/v1/products/quantity-deals/{uniqid}.
- [Delete product quantity deal](https://docs.shoppex.io/api-reference/products/delete-product-quantity-deal.md): Developer API operation for DELETE /dev/v1/products/quantity-deals/{uniqid}.
- [Get product](https://docs.shoppex.io/api-reference/products/get-product.md): Developer API operation for GET /dev/v1/products/{id}.
- [Get product stock](https://docs.shoppex.io/api-reference/products/get-product-stock.md): Returns the current stock snapshot for one product. For `SERIALS` products, `available_stock` is calculated from currently available serial inventory. Read `orderable`, not `stock`: a `supplier_backed` row is fulfilled through the shop's own supplier (Dynamic Delivery) and holds no local units on pu…
- [List product stock movements](https://docs.shoppex.io/api-reference/products/list-product-stock-movements.md): Returns a read-only stock movement timeline synthesized from serial inventory and completed invoice sales.
- [Update product](https://docs.shoppex.io/api-reference/products/update-product.md): Updates an existing product. For base `SERIALS` products, sending the `serials` field replaces the full base-product serial inventory. Use `/dev/v1/products/{id}/serials` when you need append/remove behavior instead of full replacement.
- [Delete product](https://docs.shoppex.io/api-reference/products/delete-product.md): Developer API operation for DELETE /dev/v1/products/{id}.
- [Duplicate product](https://docs.shoppex.io/api-reference/products/duplicate-product.md): Developer API operation for POST /dev/v1/products/{id}/duplicate.
- [List product serials](https://docs.shoppex.io/api-reference/products/list-product-serials.md): Returns unlinked inventory serials for a base serial product that does not use variants. Each serial item includes its `id`, and that `id` is the value you pass inside `serial_ids` when calling `DELETE /dev/v1/products/{id}/serials`. Use the variant serial routes only when the product inventory is t…
- [Update product serial](https://docs.shoppex.io/api-reference/products/update-product-serial.md): Updates a single serial inventory entry for a base serial product without variants.
- [Delete all product serials](https://docs.shoppex.io/api-reference/products/delete-all-product-serials.md): Removes all currently linked serial inventory entries from a base serial product without variants. Use the optional `search` filter to remove only matching serials.
- [Add product serials](https://docs.shoppex.io/api-reference/products/add-product-serials.md): Adds serial inventory to a base serial product without variants. This endpoint appends inventory. It does not replace the full serial list.
- [Claim product serials](https://docs.shoppex.io/api-reference/products/claim-product-serials.md): Atomically claims and removes the requested number of available serials from a base serial product without variants, then returns the claimed serial values plus the updated remaining stock. Use this endpoint when you want serial values directly and do not want to manually fetch serial IDs first.
- [Remove product serials](https://docs.shoppex.io/api-reference/products/remove-product-serials.md): Removes specific serial inventory entries from a base serial product without variants by serial ID. Use the `id` values returned by `GET /dev/v1/products/{id}/serials` as the entries inside `serial_ids`.
- [List product variants](https://docs.shoppex.io/api-reference/products/list-product-variants.md): Lists the variants of a product in display order, using cursor pagination.
- [Create variant](https://docs.shoppex.io/api-reference/products/create-variant.md): Creates a variant on a product. An explicit price is required; use 0 for a free variant. Send an `Idempotency-Key` header to make a retry safe.
- [Reorder variants](https://docs.shoppex.io/api-reference/products/reorder-variants.md): Applies a new display order to the product variants. Send every variant id in the wanted order.
- [Get variant](https://docs.shoppex.io/api-reference/products/get-variant.md): Returns one variant of a product by its variant id.
- [Update variant](https://docs.shoppex.io/api-reference/products/update-variant.md): Updates one variant of a product. Only the fields present in the request body are changed. Omit price to keep it unchanged; null is not a valid price.
- [Delete variant](https://docs.shoppex.io/api-reference/products/delete-variant.md): Deletes one variant of a product. Returns no content on success.
- [List variant serials](https://docs.shoppex.io/api-reference/products/list-variant-serials.md): Lists the serial inventory linked to one variant. This route uses page-based pagination (`page` and `limit`), not the cursor pagination the other list routes use.
- [Add variant serials](https://docs.shoppex.io/api-reference/products/add-variant-serials.md): Appends newline-separated serials to a variant. Set `remove_duplicates` to skip serials that are already in stock. Send an `Idempotency-Key` header to make a retry safe.
- [Delete all variant serials](https://docs.shoppex.io/api-reference/variants/delete-all-variant-serials.md): Removes all currently linked serial inventory entries for one variant. Use the optional `search` filter to remove only matching serials.
- [Remove variant serials](https://docs.shoppex.io/api-reference/products/remove-variant-serials.md): Removes the named serials from a variant. Serials that are reserved for an open order are skipped and counted in `skipped_reserved_count`.
- [List variant fields](https://docs.shoppex.io/api-reference/products/list-variant-fields.md): Lists the custom variant field definitions of a product, each with its selectable options. The list is not paginated: `has_more` is always false.
- [Create variant field](https://docs.shoppex.io/api-reference/products/create-variant-field.md): Adds a custom variant field definition to a product. Send an `Idempotency-Key` header to make a retry safe.
- [Get variant field](https://docs.shoppex.io/api-reference/products/get-variant-field.md): Returns one custom variant field definition of a product, including its selectable options.
- [Update variant field](https://docs.shoppex.io/api-reference/products/update-variant-field.md): Updates a custom variant field definition. Only the fields present in the request body are changed.
- [Delete variant field](https://docs.shoppex.io/api-reference/products/delete-variant-field.md): Deletes a custom variant field definition together with its options. Returns no content on success.
- [List variant field options](https://docs.shoppex.io/api-reference/products/list-variant-field-options.md): Lists the selectable options of one custom variant field. The list is not paginated: `has_more` is always false.
- [Create variant field option](https://docs.shoppex.io/api-reference/products/create-variant-field-option.md): Adds a selectable option to a custom variant field. Only select and radio fields accept options.
- [Update variant field option](https://docs.shoppex.io/api-reference/products/update-variant-field-option.md): Updates one selectable option of a custom variant field. Only the fields present in the request body are changed.
- [Delete variant field option](https://docs.shoppex.io/api-reference/products/delete-variant-field-option.md): Deletes one selectable option of a custom variant field. Returns no content on success.
- [List resellers](https://docs.shoppex.io/api-reference/resellers/list-resellers.md): Returns the wholesale reseller accounts of the current shop, newest first. Page-based pagination.
- [Retrieve a reseller](https://docs.shoppex.io/api-reference/resellers/retrieve-a-reseller.md): Returns one reseller account including its tier and lifetime wholesale totals.
- [Invite a reseller](https://docs.shoppex.io/api-reference/resellers/invite-a-reseller.md): Sends a wholesale invitation email. Requires an enabled program and either an explicit `tier_id` or a program default tier. Omitting `tier_id` uses the program default.
- [Suspend a reseller](https://docs.shoppex.io/api-reference/resellers/suspend-a-reseller.md): Blocks wholesale pricing and reseller API access. Only an ACTIVE reseller can be suspended.
- [Reinstate a reseller](https://docs.shoppex.io/api-reference/resellers/reinstate-a-reseller.md): Returns a SUSPENDED reseller to ACTIVE. Only a SUSPENDED reseller can be reinstated.
- [Retrieve the reseller program](https://docs.shoppex.io/api-reference/resellers/retrieve-the-reseller-program.md): Returns the wholesale program settings of the current shop. The row is created lazily on first read.
- [Update the reseller program](https://docs.shoppex.io/api-reference/resellers/update-the-reseller-program.md): Partial update of the wholesale program settings. `enrollment_mode: "OPEN"` requires a `default_tier_id`.
- [List reseller tiers](https://docs.shoppex.io/api-reference/resellers/list-reseller-tiers.md): Read-only list of wholesale tiers, ordered by `sort_order`. Tier authoring is dashboard-only.
- [List reviews](https://docs.shoppex.io/api-reference/reviews/list-reviews.md): Lists reviews that carry a message, newest first, using cursor pagination.
- [Get a review](https://docs.shoppex.io/api-reference/reviews/get-a-review.md): Retrieves a single review by its `uniqid`.
- [Reply to a review](https://docs.shoppex.io/api-reference/reviews/reply-to-a-review.md): Adds or replaces the merchant reply on a review and returns the updated review.
- [Get security settings](https://docs.shoppex.io/api-reference/security/get-security-settings.md): Developer API operation for GET /dev/v1/security.
- [Update security settings](https://docs.shoppex.io/api-reference/security/update-security-settings.md): Developer API operation for PATCH /dev/v1/security.
- [List security shared blacklists](https://docs.shoppex.io/api-reference/security/list-security-shared-blacklists.md): Developer API operation for GET /dev/v1/security/shared-blacklists.
- [List security events](https://docs.shoppex.io/api-reference/security/list-security-events.md): Developer API operation for GET /dev/v1/security/events.
- [Get advanced security settings](https://docs.shoppex.io/api-reference/security/get-advanced-security-settings.md): Developer API operation for GET /dev/v1/security/security-settings.
- [Update advanced security settings](https://docs.shoppex.io/api-reference/security/update-advanced-security-settings.md): Developer API operation for PATCH /dev/v1/security/security-settings.
- [Get session trail](https://docs.shoppex.io/api-reference/security/get-session-trail.md): Developer API operation for GET /dev/v1/security/session-trail/{session_id}.
- [Get audit trail](https://docs.shoppex.io/api-reference/security/get-audit-trail.md): Developer API operation for GET /dev/v1/security/audit-trail.
- [Get store settings](https://docs.shoppex.io/api-reference/store/get-store-settings.md): Developer API operation for GET /dev/v1/store/settings.
- [List store domains](https://docs.shoppex.io/api-reference/store/list-store-domains.md): Developer API operation for GET /dev/v1/store/domains.
- [Get custom domain status](https://docs.shoppex.io/api-reference/store/get-custom-domain-status.md): Developer API operation for GET /dev/v1/store/domains/custom/status.
- [Enable custom domain](https://docs.shoppex.io/api-reference/store/enable-custom-domain.md): Developer API operation for POST /dev/v1/store/domains/custom/enable.
- [Update custom domain](https://docs.shoppex.io/api-reference/store/update-custom-domain.md): Developer API operation for PATCH /dev/v1/store/domains/custom.
- [Disable custom domain](https://docs.shoppex.io/api-reference/store/disable-custom-domain.md): Developer API operation for POST /dev/v1/store/domains/custom/disable.
- [Add additional domain](https://docs.shoppex.io/api-reference/store/add-additional-domain.md): Developer API operation for POST /dev/v1/store/domains/additional.
- [Get additional domain verification](https://docs.shoppex.io/api-reference/store/get-additional-domain-verification.md): Developer API operation for GET /dev/v1/store/domains/additional/{id}/verification.
- [Enable additional domain](https://docs.shoppex.io/api-reference/store/enable-additional-domain.md): Developer API operation for POST /dev/v1/store/domains/additional/{id}/enable.
- [Disable additional domain](https://docs.shoppex.io/api-reference/store/disable-additional-domain.md): Developer API operation for POST /dev/v1/store/domains/additional/{id}/disable.
- [Request additional domain validation](https://docs.shoppex.io/api-reference/store/request-additional-domain-validation.md): Developer API operation for POST /dev/v1/store/domains/additional/{id}/request-validation.
- [Delete additional domain](https://docs.shoppex.io/api-reference/store/delete-additional-domain.md): Developer API operation for DELETE /dev/v1/store/domains/additional/{id}.
- [Get store branding](https://docs.shoppex.io/api-reference/store/get-store-branding.md): Developer API operation for GET /dev/v1/store/branding.
- [Get store features](https://docs.shoppex.io/api-reference/store/get-store-features.md): Developer API operation for GET /dev/v1/store/features.
- [Get storefront layout](https://docs.shoppex.io/api-reference/store/get-storefront-layout.md): Developer API operation for GET /dev/v1/store/layout.
- [Update storefront layout](https://docs.shoppex.io/api-reference/store/update-storefront-layout.md): Developer API operation for PUT /dev/v1/store/layout.
- [List themes](https://docs.shoppex.io/api-reference/themes/list-themes.md): Developer API operation for GET /dev/v1/themes.
- [Create theme](https://docs.shoppex.io/api-reference/themes/create-theme.md): Developer API operation for POST /dev/v1/themes/control/create.
- [Start theme preview](https://docs.shoppex.io/api-reference/themes/start-theme-preview.md): Developer API operation for POST /dev/v1/themes/{id}/control/preview.
- [Stop theme preview](https://docs.shoppex.io/api-reference/themes/stop-theme-preview.md): Developer API operation for DELETE /dev/v1/themes/{id}/control/preview/{sessionId}.
- [Publish theme](https://docs.shoppex.io/api-reference/themes/publish-theme.md): Developer API operation for POST /dev/v1/themes/{id}/control/publish.
- [Get theme builder settings](https://docs.shoppex.io/api-reference/themes/get-theme-builder-settings.md): Developer API operation for GET /dev/v1/themes/{id}/control/settings.
- [Update theme builder settings](https://docs.shoppex.io/api-reference/themes/update-theme-builder-settings.md): Developer API operation for POST /dev/v1/themes/{id}/control/settings.
- [Get theme document](https://docs.shoppex.io/api-reference/themes/get-theme-document.md): Developer API operation for GET /dev/v1/themes/{id}/control/document.
- [Get editable theme document draft](https://docs.shoppex.io/api-reference/themes/get-editable-theme-document-draft.md): Developer API operation for GET /dev/v1/themes/{id}/control/document/draft.
- [Save theme document draft](https://docs.shoppex.io/api-reference/themes/save-theme-document-draft.md): Developer API operation for PUT /dev/v1/themes/{id}/control/document.
- [Get theme document schema](https://docs.shoppex.io/api-reference/themes/get-theme-document-schema.md): Developer API operation for GET /dev/v1/themes/{id}/control/document/schema.
- [Get ThemeDocument JSON Schema for editors](https://docs.shoppex.io/api-reference/themes/get-themedocument-json-schema-for-editors.md): Developer API operation for GET /dev/v1/themes/{id}/control/document/json-schema.
- [List telegram bots](https://docs.shoppex.io/api-reference/telegram/list-telegram-bots.md): Developer API operation for GET /dev/v1/telegram/bots.
- [Create telegram bot](https://docs.shoppex.io/api-reference/telegram/create-telegram-bot.md): Developer API operation for POST /dev/v1/telegram/bots.
- [Update telegram bot agent](https://docs.shoppex.io/api-reference/telegram/update-telegram-bot-agent.md): Developer API operation for PUT /dev/v1/telegram/bots/{botId}/agent.
- [Get telegram agent stats](https://docs.shoppex.io/api-reference/telegram/get-telegram-agent-stats.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/agent/stats.
- [Delete telegram bot](https://docs.shoppex.io/api-reference/telegram/delete-telegram-bot.md): Developer API operation for DELETE /dev/v1/telegram/bots/{botId}.
- [List telegram bot users](https://docs.shoppex.io/api-reference/telegram/list-telegram-bot-users.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/users.
- [Get telegram bot user](https://docs.shoppex.io/api-reference/telegram/get-telegram-bot-user.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/users/{userId}.
- [Update telegram user notification](https://docs.shoppex.io/api-reference/telegram/update-telegram-user-notification.md): Developer API operation for PUT /dev/v1/telegram/bots/{botId}/users/{userId}/notifications.
- [Update telegram bulk notification](https://docs.shoppex.io/api-reference/telegram/update-telegram-bulk-notification.md): Developer API operation for PUT /dev/v1/telegram/bots/{botId}/users/bulk/notifications.
- [Get telegram user stats](https://docs.shoppex.io/api-reference/telegram/get-telegram-user-stats.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/users/stats.
- [List telegram bot segments](https://docs.shoppex.io/api-reference/telegram/list-telegram-bot-segments.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/segments.
- [Create telegram bot segment](https://docs.shoppex.io/api-reference/telegram/create-telegram-bot-segment.md): Developer API operation for POST /dev/v1/telegram/bots/{botId}/segments.
- [Get telegram bot segment](https://docs.shoppex.io/api-reference/telegram/get-telegram-bot-segment.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/segments/{segmentId}.
- [Update telegram bot segment](https://docs.shoppex.io/api-reference/telegram/update-telegram-bot-segment.md): Developer API operation for PUT /dev/v1/telegram/bots/{botId}/segments/{segmentId}.
- [Delete telegram bot segment](https://docs.shoppex.io/api-reference/telegram/delete-telegram-bot-segment.md): Developer API operation for DELETE /dev/v1/telegram/bots/{botId}/segments/{segmentId}.
- [Create telegram bot broadcast](https://docs.shoppex.io/api-reference/telegram/create-telegram-bot-broadcast.md): Developer API operation for POST /dev/v1/telegram/bots/{botId}/broadcasts.
- [List telegram bot broadcasts](https://docs.shoppex.io/api-reference/telegram/list-telegram-bot-broadcasts.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/broadcasts.
- [Get telegram bot broadcast](https://docs.shoppex.io/api-reference/telegram/get-telegram-bot-broadcast.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/broadcasts/{id}.
- [Update telegram bot broadcast](https://docs.shoppex.io/api-reference/telegram/update-telegram-bot-broadcast.md): Developer API operation for PUT /dev/v1/telegram/bots/{botId}/broadcasts/{id}.
- [Delete telegram bot broadcast](https://docs.shoppex.io/api-reference/telegram/delete-telegram-bot-broadcast.md): Developer API operation for DELETE /dev/v1/telegram/bots/{botId}/broadcasts/{id}.
- [Start telegram bot broadcast](https://docs.shoppex.io/api-reference/telegram/start-telegram-bot-broadcast.md): Developer API operation for POST /dev/v1/telegram/bots/{botId}/broadcasts/{id}/start.
- [Cancel telegram bot broadcast](https://docs.shoppex.io/api-reference/telegram/cancel-telegram-bot-broadcast.md): Developer API operation for POST /dev/v1/telegram/bots/{botId}/broadcasts/{id}/cancel.
- [Get telegram broadcast stats](https://docs.shoppex.io/api-reference/telegram/get-telegram-broadcast-stats.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/broadcasts/{id}/stats.
- [Get telegram broadcast analytics](https://docs.shoppex.io/api-reference/telegram/get-telegram-broadcast-analytics.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/broadcasts/{id}/analytics.
- [Send product restock broadcast](https://docs.shoppex.io/api-reference/telegram/send-product-restock-broadcast.md): Queues a Telegram restock notification for a product or variant. This is a notification endpoint, not a warehouse inventory endpoint.
- [Send warehouse restock broadcast](https://docs.shoppex.io/api-reference/telegram/send-warehouse-restock-broadcast.md): Legacy name for the Telegram product restock broadcast endpoint. Prefer `/dev/v1/telegram/bots/{botId}/broadcasts/restock` for new integrations.
- [Get telegram bot analytics](https://docs.shoppex.io/api-reference/telegram/get-telegram-bot-analytics.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/analytics.
- [List inbox conversations](https://docs.shoppex.io/api-reference/telegram/list-inbox-conversations.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/inbox.
- [Get inbox conversation](https://docs.shoppex.io/api-reference/telegram/get-inbox-conversation.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/inbox/{conversationId}.
- [Reply to inbox conversation](https://docs.shoppex.io/api-reference/telegram/reply-to-inbox-conversation.md): Developer API operation for POST /dev/v1/telegram/bots/{botId}/inbox/{conversationId}/reply.
- [Update inbox conversation status](https://docs.shoppex.io/api-reference/telegram/update-inbox-conversation-status.md): Developer API operation for PUT /dev/v1/telegram/bots/{botId}/inbox/{conversationId}/status.
- [List telegram bot journeys](https://docs.shoppex.io/api-reference/telegram/list-telegram-bot-journeys.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/journeys.
- [Create telegram bot journey](https://docs.shoppex.io/api-reference/telegram/create-telegram-bot-journey.md): Developer API operation for POST /dev/v1/telegram/bots/{botId}/journeys.
- [Get telegram bot journey](https://docs.shoppex.io/api-reference/telegram/get-telegram-bot-journey.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/journeys/{journeyId}.
- [Update telegram bot journey](https://docs.shoppex.io/api-reference/telegram/update-telegram-bot-journey.md): Developer API operation for PUT /dev/v1/telegram/bots/{botId}/journeys/{journeyId}.
- [Delete telegram bot journey](https://docs.shoppex.io/api-reference/telegram/delete-telegram-bot-journey.md): Developer API operation for DELETE /dev/v1/telegram/bots/{botId}/journeys/{journeyId}.
- [Send test telegram bot journey](https://docs.shoppex.io/api-reference/telegram/send-test-telegram-bot-journey.md): Developer API operation for POST /dev/v1/telegram/bots/{botId}/journeys/{journeyId}/test.
- [List subscriptions](https://docs.shoppex.io/api-reference/subscriptions/list-subscriptions.md): Developer API operation for GET /dev/v1/subscriptions.
- [Get subscription](https://docs.shoppex.io/api-reference/subscriptions/get-subscription.md): Developer API operation for GET /dev/v1/subscriptions/{id}.
- [Cancel subscription](https://docs.shoppex.io/api-reference/subscriptions/cancel-subscription.md): Developer API operation for POST /dev/v1/subscriptions/{id}/cancel.
- [Pause subscription](https://docs.shoppex.io/api-reference/subscriptions/pause-subscription.md): Developer API operation for POST /dev/v1/subscriptions/{id}/pause.
- [Resume subscription](https://docs.shoppex.io/api-reference/subscriptions/resume-subscription.md): Developer API operation for POST /dev/v1/subscriptions/{id}/resume.
- [Change subscription plan](https://docs.shoppex.io/api-reference/subscriptions/change-subscription-plan.md): Developer API operation for POST /dev/v1/subscriptions/{id}/change-plan.
- [Refund subscription](https://docs.shoppex.io/api-reference/subscriptions/refund-subscription.md): Developer API operation for POST /dev/v1/subscriptions/{id}/refund.
- [List subscription plan options](https://docs.shoppex.io/api-reference/subscriptions/list-subscription-plan-options.md): Developer API operation for GET /dev/v1/subscriptions/{id}/plan-options.
- [Update subscription custom fields](https://docs.shoppex.io/api-reference/subscriptions/update-subscription-custom-fields.md): Developer API operation for PATCH /dev/v1/subscriptions/{id}/custom-fields.
- [List subscription billing history](https://docs.shoppex.io/api-reference/subscriptions/list-subscription-billing-history.md): Developer API operation for GET /dev/v1/subscriptions/{id}/billing-history.
- [List tickets](https://docs.shoppex.io/api-reference/tickets/list-tickets.md): Developer API operation for GET /dev/v1/tickets.
- [Create ticket](https://docs.shoppex.io/api-reference/tickets/create-ticket.md): Developer API operation for POST /dev/v1/tickets.
- [Get ticket](https://docs.shoppex.io/api-reference/tickets/get-ticket.md): Developer API operation for GET /dev/v1/tickets/{id}.
- [Close ticket](https://docs.shoppex.io/api-reference/tickets/close-ticket.md): Developer API operation for POST /dev/v1/tickets/{id}/close.
- [Reopen ticket](https://docs.shoppex.io/api-reference/tickets/reopen-ticket.md): Developer API operation for POST /dev/v1/tickets/{id}/reopen.
- [Create ticket message](https://docs.shoppex.io/api-reference/tickets/create-ticket-message.md): Developer API operation for POST /dev/v1/tickets/{id}/messages.
- [List webhooks](https://docs.shoppex.io/api-reference/webhook-endpoints/list-webhooks.md): Developer API operation for GET /dev/v1/webhooks.
- [Create webhook](https://docs.shoppex.io/api-reference/webhook-endpoints/create-webhook.md): Developer API operation for POST /dev/v1/webhooks.
- [List webhook events](https://docs.shoppex.io/api-reference/webhook-endpoints/list-webhook-events.md): Developer API operation for GET /dev/v1/webhooks/events.
- [List webhook logs](https://docs.shoppex.io/api-reference/webhook-endpoints/list-webhook-logs.md): Developer API operation for GET /dev/v1/webhooks/logs.
- [Get webhook log](https://docs.shoppex.io/api-reference/webhook-endpoints/get-webhook-log.md): Developer API operation for GET /dev/v1/webhooks/logs/{id}.
- [Retry webhook log](https://docs.shoppex.io/api-reference/webhook-endpoints/retry-webhook-log.md): Developer API operation for POST /dev/v1/webhooks/logs/{id}/retry.
- [Get webhook](https://docs.shoppex.io/api-reference/webhook-endpoints/get-webhook.md): Developer API operation for GET /dev/v1/webhooks/{id}.
- [Update webhook](https://docs.shoppex.io/api-reference/webhook-endpoints/update-webhook.md): Developer API operation for PATCH /dev/v1/webhooks/{id}.
- [Delete webhook](https://docs.shoppex.io/api-reference/webhook-endpoints/delete-webhook.md): Developer API operation for DELETE /dev/v1/webhooks/{id}.
- [Send test webhook](https://docs.shoppex.io/api-reference/webhook-endpoints/send-test-webhook.md): Developer API operation for POST /dev/v1/webhooks/{id}/test.
- [Rotate webhook secret](https://docs.shoppex.io/api-reference/webhook-endpoints/rotate-webhook-secret.md): Developer API operation for POST /dev/v1/webhooks/{id}/rotate-secret.
- [List replacement rules](https://docs.shoppex.io/api-reference/replacements/list-replacement-rules.md): Developer API operation for GET /dev/v1/replacement-rules.
- [Create replacement rule](https://docs.shoppex.io/api-reference/replacements/create-replacement-rule.md): Developer API operation for POST /dev/v1/replacement-rules.
- [Get replacement rule](https://docs.shoppex.io/api-reference/replacements/get-replacement-rule.md): Developer API operation for GET /dev/v1/replacement-rules/{id}.
- [Update replacement rule](https://docs.shoppex.io/api-reference/replacements/update-replacement-rule.md): Developer API operation for PATCH /dev/v1/replacement-rules/{id}.
- [Archive replacement rule](https://docs.shoppex.io/api-reference/replacements/archive-replacement-rule.md): Developer API operation for DELETE /dev/v1/replacement-rules/{id}.
- [Dry-run a rule against a real invoice (no side effects)](https://docs.shoppex.io/api-reference/replacements/dry-run-a-rule-against-a-real-invoice-no-side-effects.md): Developer API operation for POST /dev/v1/replacement-rules/{id}/simulate.
- [List replacement audit events](https://docs.shoppex.io/api-reference/replacements/list-replacement-audit-events.md): Developer API operation for GET /dev/v1/replacement-events.
- [Get replacement audit event](https://docs.shoppex.io/api-reference/replacements/get-replacement-audit-event.md): Developer API operation for GET /dev/v1/replacement-events/{id}.

## OpenAPI Specs

- [openapi](/openapi.json)

## Optional

- [Discord](https://discord.gg/VjrptT6Nvx)
- [Telegram](https://t.me/shoppexhq)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.