# Shoppex

## Docs

- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Get affiliate analytics](https://docs.shoppex.io/api-reference/affiliates/get-affiliate-analytics.md): Developer API operation for GET /dev/v1/affiliates/analytics.
- [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.
- [Get affiliate settings](https://docs.shoppex.io/api-reference/affiliates/get-affiliate-settings.md): Developer API operation for GET /dev/v1/affiliates/settings.
- [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.
- [List affiliate applications](https://docs.shoppex.io/api-reference/affiliates/list-affiliate-applications.md): Developer API operation for GET /dev/v1/affiliates/applications.
- [List affiliate customers](https://docs.shoppex.io/api-reference/affiliates/list-affiliate-customers.md): Developer API operation for GET /dev/v1/affiliates/customers.
- [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.
- [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.
- [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.
- [Update affiliate customer custom link](https://docs.shoppex.io/api-reference/affiliates/update-affiliate-customer-custom-link.md): Developer API operation for PATCH /dev/v1/affiliates/customers/{customerId}/custom-link.
- [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.
- [Update affiliate settings](https://docs.shoppex.io/api-reference/affiliates/update-affiliate-settings.md): Developer API operation for PATCH /dev/v1/affiliates/settings.
- [Create analytics report](https://docs.shoppex.io/api-reference/analytics/create-analytics-report.md): Developer API operation for POST /dev/v1/analytics/reports.
- [Delete analytics report](https://docs.shoppex.io/api-reference/analytics/delete-analytics-report.md): Developer API operation for DELETE /dev/v1/analytics/reports/{id}.
- [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.
- [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.
- [Authentication](https://docs.shoppex.io/api-reference/authentication.md): How to authenticate with the Shoppex Developer API
- [Create blacklist entry](https://docs.shoppex.io/api-reference/blacklist/create-blacklist-entry.md): Developer API operation for POST /dev/v1/blacklist.
- [Delete blacklist entry](https://docs.shoppex.io/api-reference/blacklist/delete-blacklist-entry.md): Developer API operation for DELETE /dev/v1/blacklist/{id}.
- [Get blacklist entry](https://docs.shoppex.io/api-reference/blacklist/get-blacklist-entry.md): Developer API operation for GET /dev/v1/blacklist/{id}.
- [List blacklist entries](https://docs.shoppex.io/api-reference/blacklist/list-blacklist-entries.md): Developer API operation for GET /dev/v1/blacklist.
- [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.
- [Delete category](https://docs.shoppex.io/api-reference/categories/delete-category.md): Deletes a category and unbinds linked products from it.
- [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.
- [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.
- [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.
- [Create coupon](https://docs.shoppex.io/api-reference/coupons/create-coupon.md): Creates 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.
- [Get coupon](https://docs.shoppex.io/api-reference/coupons/get-coupon.md): Returns one coupon by uniqid for the authenticated shop.
- [List coupons](https://docs.shoppex.io/api-reference/coupons/list-coupons.md): Returns active coupons for the authenticated shop.
- [Update coupon](https://docs.shoppex.io/api-reference/coupons/update-coupon.md): Updates 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.
- [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](https://docs.shoppex.io/api-reference/customers/create-customer.md): Developer API operation for POST /dev/v1/customers.
- [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.
- [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.
- [Delete customer](https://docs.shoppex.io/api-reference/customers/delete-customer.md): Developer API operation for DELETE /dev/v1/customers/{id}.
- [Get customer](https://docs.shoppex.io/api-reference/customers/get-customer.md): Developer API operation for GET /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.
- [List customers](https://docs.shoppex.io/api-reference/customers/list-customers.md): Developer API operation for GET /dev/v1/customers.
- [Update customer](https://docs.shoppex.io/api-reference/customers/update-customer.md): Developer API operation for PATCH /dev/v1/customers/{id}.
- [Get dispute](https://docs.shoppex.io/api-reference/disputes-&-escrow/get-dispute.md): Developer API operation for GET /dev/v1/disputes/{id}.
- [Get escrow record](https://docs.shoppex.io/api-reference/disputes-&-escrow/get-escrow-record.md): Developer API operation for GET /dev/v1/escrow/{id}.
- [List disputes](https://docs.shoppex.io/api-reference/disputes-&-escrow/list-disputes.md): Developer API operation for GET /dev/v1/disputes.
- [List escrow records](https://docs.shoppex.io/api-reference/disputes-&-escrow/list-escrow-records.md): Developer API operation for GET /dev/v1/escrow.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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}.
- [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}.
- [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 automations](https://docs.shoppex.io/api-reference/email-marketing/list-email-marketing-automations.md): Developer API operation for GET /dev/v1/email-marketing/automations.
- [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.
- [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.
- [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.
- [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.
- [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.
- [Email Segmentation Filters](https://docs.shoppex.io/api-reference/email-segmentation-filters.md): JSON filter rules for email marketing audience segments
- [Error Handling](https://docs.shoppex.io/api-reference/errors.md): Understanding and handling API errors
- [Create group](https://docs.shoppex.io/api-reference/groups/create-group.md): Developer API operation for POST /dev/v1/groups.
- [Delete group](https://docs.shoppex.io/api-reference/groups/delete-group.md): Developer API operation for DELETE /dev/v1/groups/{uniqid}.
- [Get group](https://docs.shoppex.io/api-reference/groups/get-group.md): Developer API operation for GET /dev/v1/groups/{uniqid}.
- [List groups](https://docs.shoppex.io/api-reference/groups/list-groups.md): Developer API operation for GET /dev/v1/groups.
- [Update group](https://docs.shoppex.io/api-reference/groups/update-group.md): Developer API operation for PATCH /dev/v1/groups/{uniqid}.
- [API Introduction](https://docs.shoppex.io/api-reference/introduction.md): Getting started with the Shoppex Developer API
- [Get invoice](https://docs.shoppex.io/api-reference/invoices/get-invoice.md): Developer API operation for GET /dev/v1/invoices/{uniqid}.
- [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 invoices](https://docs.shoppex.io/api-reference/invoices/list-invoices.md): Developer API operation for GET /dev/v1/invoices.
- [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. `Idempotency-Key` is required.
- [Update invoice](https://docs.shoppex.io/api-reference/invoices/update-invoice.md): Developer API operation for PATCH /dev/v1/invoices/{uniqid}.
- [Void invoice](https://docs.shoppex.io/api-reference/invoices/void-invoice.md): Voids a non-completed invoice through the existing invoice void pipeline.
- [Create license](https://docs.shoppex.io/api-reference/licenses/create-license.md): Developer API operation for POST /dev/v1/licenses.
- [Delete license](https://docs.shoppex.io/api-reference/licenses/delete-license.md): Developer API operation for DELETE /dev/v1/licenses/{id}.
- [Get license](https://docs.shoppex.io/api-reference/licenses/get-license.md): Developer API operation for GET /dev/v1/licenses/{id}.
- [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}.
- [List licenses](https://docs.shoppex.io/api-reference/licenses/list-licenses.md): Developer API operation for GET /dev/v1/licenses.
- [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.
- [Update license](https://docs.shoppex.io/api-reference/licenses/update-license.md): Developer API operation for PATCH /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.
- [Validate license](https://docs.shoppex.io/api-reference/licenses/validate-license.md): Developer API operation for POST /dev/v1/licenses/validate.
- [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.
- [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" }`.
- [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" } }`.
- [Refund order](https://docs.shoppex.io/api-reference/orders/refund-order.md): Developer API operation for POST /dev/v1/orders/{id}/refund.
- [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.
- [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.
- [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.
- [Pagination](https://docs.shoppex.io/api-reference/pagination.md): Navigate Dev API result sets with cursor-based and page-based pagination
- [Create payment link](https://docs.shoppex.io/api-reference/payment-links/create-payment-link.md): Developer API operation for POST /dev/v1/payment-links.
- [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}.
- [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}.
- [List payment links](https://docs.shoppex.io/api-reference/payment-links/list-payment-links.md): Developer API operation for GET /dev/v1/payment-links.
- [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.
- [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}.
- [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. Use `/dev/v1/orders/:id/fulfill` for deliverable orders.
- [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…
- [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…
- [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.
- [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…
- [Void payment](https://docs.shoppex.io/api-reference/payments/void-payment.md): Voids a pending developer payment.
- [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.
- [Bulk update products](https://docs.shoppex.io/api-reference/products/bulk-update-products.md): Developer API operation for PATCH /dev/v1/products/bulk.
- [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.
- [Create product](https://docs.shoppex.io/api-reference/products/create-product.md): Developer API operation for POST /dev/v1/products.
- [Create product addon](https://docs.shoppex.io/api-reference/products/create-product-addon.md): Developer API operation for POST /dev/v1/products/addons.
- [Create product bundle](https://docs.shoppex.io/api-reference/products/create-product-bundle.md): Developer API operation for POST /dev/v1/products/bundles.
- [Create product field option](https://docs.shoppex.io/api-reference/products/create-product-field-option.md): Developer API operation for POST /dev/v1/products/{id}/variants/fields/{fieldId}/options.
- [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.
- [Create product variant](https://docs.shoppex.io/api-reference/products/create-product-variant.md): Developer API operation for POST /dev/v1/products/{id}/variants.
- [Create product variant field](https://docs.shoppex.io/api-reference/products/create-product-variant-field.md): Developer API operation for POST /dev/v1/products/{id}/variants/fields.
- [Create product variant serial](https://docs.shoppex.io/api-reference/products/create-product-variant-serial.md): Developer API operation for POST /dev/v1/products/{id}/variants/{variantId}/serials.
- [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.
- [Delete product](https://docs.shoppex.io/api-reference/products/delete-product.md): Developer API operation for DELETE /dev/v1/products/{id}.
- [Delete product addon](https://docs.shoppex.io/api-reference/products/delete-product-addon.md): Developer API operation for DELETE /dev/v1/products/addons/{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}.
- [Delete product field option](https://docs.shoppex.io/api-reference/products/delete-product-field-option.md): Developer API operation for DELETE /dev/v1/products/{id}/variants/fields/{fieldId}/options/{optionId}.
- [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}.
- [Delete product variant](https://docs.shoppex.io/api-reference/products/delete-product-variant.md): Developer API operation for DELETE /dev/v1/products/{id}/variants/{variantId}.
- [Delete product variant field](https://docs.shoppex.io/api-reference/products/delete-product-variant-field.md): Developer API operation for DELETE /dev/v1/products/{id}/variants/fields/{fieldId}.
- [Delete product variant serial](https://docs.shoppex.io/api-reference/products/delete-product-variant-serial.md): Developer API operation for DELETE /dev/v1/products/{id}/variants/{variantId}/serials.
- [Duplicate product](https://docs.shoppex.io/api-reference/products/duplicate-product.md): Developer API operation for POST /dev/v1/products/{id}/duplicate.
- [Get product](https://docs.shoppex.io/api-reference/products/get-product.md): Developer API operation for GET /dev/v1/products/{id}.
- [Get product addon](https://docs.shoppex.io/api-reference/products/get-product-addon.md): Developer API operation for GET /dev/v1/products/addons/{uniqid}.
- [Get product bundle](https://docs.shoppex.io/api-reference/products/get-product-bundle.md): Developer API operation for GET /dev/v1/products/bundles/{uniqid}.
- [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}.
- [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.
- [Get product variant](https://docs.shoppex.io/api-reference/products/get-product-variant.md): Developer API operation for GET /dev/v1/products/{id}/variants/{variantId}.
- [Get product variant field](https://docs.shoppex.io/api-reference/products/get-product-variant-field.md): Developer API operation for GET /dev/v1/products/{id}/variants/fields/{fieldId}.
- [List product addons](https://docs.shoppex.io/api-reference/products/list-product-addons.md): Developer API operation for GET /dev/v1/products/addons.
- [List product bundles](https://docs.shoppex.io/api-reference/products/list-product-bundles.md): Developer API operation for GET /dev/v1/products/bundles.
- [List product field options](https://docs.shoppex.io/api-reference/products/list-product-field-options.md): Developer API operation for GET /dev/v1/products/{id}/variants/fields/{fieldId}/options.
- [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.
- [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…
- [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, completed invoice sales, and allocated reseller stock transfers.
- [List product variant fields](https://docs.shoppex.io/api-reference/products/list-product-variant-fields.md): Developer API operation for GET /dev/v1/products/{id}/variants/fields.
- [List product variant serials](https://docs.shoppex.io/api-reference/products/list-product-variant-serials.md): Developer API operation for GET /dev/v1/products/{id}/variants/{variantId}/serials.
- [List product variants](https://docs.shoppex.io/api-reference/products/list-product-variants.md): Developer API operation for GET /dev/v1/products/{id}/variants.
- [List products](https://docs.shoppex.io/api-reference/products/list-products.md): Developer API operation for GET /dev/v1/products.
- [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`.
- [Reorder product variants](https://docs.shoppex.io/api-reference/products/reorder-product-variants.md): Developer API operation for PATCH /dev/v1/products/{id}/variants/order.
- [Reorder products](https://docs.shoppex.io/api-reference/products/reorder-products.md): Developer API operation for PATCH /dev/v1/products/order.
- [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.
- [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.
- [Update product addon](https://docs.shoppex.io/api-reference/products/update-product-addon.md): Developer API operation for PATCH /dev/v1/products/addons/{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}.
- [Update product field option](https://docs.shoppex.io/api-reference/products/update-product-field-option.md): Developer API operation for PATCH /dev/v1/products/{id}/variants/fields/{fieldId}/options/{optionId}.
- [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}.
- [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.
- [Update product variant](https://docs.shoppex.io/api-reference/products/update-product-variant.md): Developer API operation for PATCH /dev/v1/products/{id}/variants/{variantId}.
- [Update product variant field](https://docs.shoppex.io/api-reference/products/update-product-variant-field.md): Developer API operation for PATCH /dev/v1/products/{id}/variants/fields/{fieldId}.
- [Quick Start](https://docs.shoppex.io/api-reference/quickstart.md): Make your first API call in under 2 minutes
- [Archive replacement rule](https://docs.shoppex.io/api-reference/replacements/archive-replacement-rule.md): Developer API operation for DELETE /dev/v1/replacement-rules/{id}.
- [Create replacement rule](https://docs.shoppex.io/api-reference/replacements/create-replacement-rule.md): Developer API operation for POST /dev/v1/replacement-rules.
- [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.
- [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}.
- [Get replacement rule](https://docs.shoppex.io/api-reference/replacements/get-replacement-rule.md): Developer API operation for GET /dev/v1/replacement-rules/{id}.
- [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.
- [List replacement rules](https://docs.shoppex.io/api-reference/replacements/list-replacement-rules.md): Developer API operation for GET /dev/v1/replacement-rules.
- [Update replacement rule](https://docs.shoppex.io/api-reference/replacements/update-replacement-rule.md): Developer API operation for PATCH /dev/v1/replacement-rules/{id}.
- [Reseller API](https://docs.shoppex.io/api-reference/resellers.md): Automate reseller programs, invites, payouts, embeds, stock purchases, and inventory delivery
- [Allocate a reseller stock transfer](https://docs.shoppex.io/api-reference/resellers/allocate-a-reseller-stock-transfer.md): Developer API operation for POST /dev/v1/resellers/{id}/stock-transfers/{transferId}/allocate.
- [Approve a reseller payout request](https://docs.shoppex.io/api-reference/resellers/approve-a-reseller-payout-request.md): Developer API operation for POST /dev/v1/resellers/{id}/payouts/{claimId}/approve.
- [Cancel a reseller payout request](https://docs.shoppex.io/api-reference/resellers/cancel-a-reseller-payout-request.md): Developer API operation for POST /dev/v1/resellers/{id}/payouts/{claimId}/cancel.
- [Complete a reseller payout request](https://docs.shoppex.io/api-reference/resellers/complete-a-reseller-payout-request.md): Developer API operation for POST /dev/v1/resellers/{id}/payouts/{claimId}/complete.
- [Create a reseller embed campaign](https://docs.shoppex.io/api-reference/resellers/create-a-reseller-embed-campaign.md): Developer API operation for POST /dev/v1/resellers/{id}/embed-campaigns.
- [Create a reseller stock purchase invoice](https://docs.shoppex.io/api-reference/resellers/create-a-reseller-stock-purchase-invoice.md): Developer API operation for POST /dev/v1/resellers/{id}/stock-transfers/{transferId}/invoice.
- [Create a reseller stock purchase request](https://docs.shoppex.io/api-reference/resellers/create-a-reseller-stock-purchase-request.md): Developer API operation for POST /dev/v1/resellers/{id}/stock-purchases.
- [Create an auto-fulfilled reseller listing](https://docs.shoppex.io/api-reference/resellers/create-an-auto-fulfilled-reseller-listing.md): Developer API operation for POST /dev/v1/resellers/{id}/listings.
- [Deliver a reseller inventory item](https://docs.shoppex.io/api-reference/resellers/deliver-a-reseller-inventory-item.md): Developer API operation for POST /dev/v1/resellers/{id}/inventory/{itemId}/deliver.
- [Get reseller analytics](https://docs.shoppex.io/api-reference/resellers/get-reseller-analytics.md): Developer API operation for GET /dev/v1/resellers/analytics.
- [Get reseller analytics by reseller](https://docs.shoppex.io/api-reference/resellers/get-reseller-analytics-by-reseller.md): Developer API operation for GET /dev/v1/resellers/{id}/analytics.
- [Get reseller program settings](https://docs.shoppex.io/api-reference/resellers/get-reseller-program-settings.md): Developer API operation for GET /dev/v1/reseller-program.
- [Invite a reseller](https://docs.shoppex.io/api-reference/resellers/invite-a-reseller.md): Developer API operation for POST /dev/v1/resellers/invite.
- [List auto-fulfilled reseller listings](https://docs.shoppex.io/api-reference/resellers/list-auto-fulfilled-reseller-listings.md): Developer API operation for GET /dev/v1/resellers/{id}/listings.
- [List reseller attributed sales](https://docs.shoppex.io/api-reference/resellers/list-reseller-attributed-sales.md): Developer API operation for GET /dev/v1/resellers/{id}/sales.
- [List reseller embed campaigns](https://docs.shoppex.io/api-reference/resellers/list-reseller-embed-campaigns.md): Developer API operation for GET /dev/v1/resellers/{id}/embed-campaigns.
- [List reseller inventory](https://docs.shoppex.io/api-reference/resellers/list-reseller-inventory.md): Developer API operation for GET /dev/v1/resellers/{id}/inventory.
- [List reseller payout state](https://docs.shoppex.io/api-reference/resellers/list-reseller-payout-state.md): Developer API operation for GET /dev/v1/resellers/{id}/payouts.
- [List reseller stock transfers](https://docs.shoppex.io/api-reference/resellers/list-reseller-stock-transfers.md): Developer API operation for GET /dev/v1/resellers/{id}/stock-transfers.
- [List resellers](https://docs.shoppex.io/api-reference/resellers/list-resellers.md): Developer API operation for GET /dev/v1/resellers.
- [Mark a reseller payout request for manual processing](https://docs.shoppex.io/api-reference/resellers/mark-a-reseller-payout-request-for-manual-processing.md): Developer API operation for POST /dev/v1/resellers/{id}/payouts/{claimId}/force-approve.
- [Mark a reseller stock transfer paid](https://docs.shoppex.io/api-reference/resellers/mark-a-reseller-stock-transfer-paid.md): Developer API operation for POST /dev/v1/resellers/{id}/stock-transfers/{transferId}/mark-paid.
- [Reject a reseller payout request](https://docs.shoppex.io/api-reference/resellers/reject-a-reseller-payout-request.md): Developer API operation for POST /dev/v1/resellers/{id}/payouts/{claimId}/reject.
- [Revoke a reseller stock transfer](https://docs.shoppex.io/api-reference/resellers/revoke-a-reseller-stock-transfer.md): Developer API operation for POST /dev/v1/resellers/{id}/stock-transfers/{transferId}/revoke.
- [Suspend a reseller](https://docs.shoppex.io/api-reference/resellers/suspend-a-reseller.md): Developer API operation for POST /dev/v1/resellers/{id}/suspend.
- [Terminate a reseller](https://docs.shoppex.io/api-reference/resellers/terminate-a-reseller.md): Developer API operation for POST /dev/v1/resellers/{id}/terminate.
- [Update a reseller](https://docs.shoppex.io/api-reference/resellers/update-a-reseller.md): Developer API operation for PATCH /dev/v1/resellers/{id}.
- [Update a reseller embed campaign](https://docs.shoppex.io/api-reference/resellers/update-a-reseller-embed-campaign.md): Developer API operation for PATCH /dev/v1/resellers/{id}/embed-campaigns/{campaignId}.
- [Update an auto-fulfilled reseller listing](https://docs.shoppex.io/api-reference/resellers/update-an-auto-fulfilled-reseller-listing.md): Developer API operation for PATCH /dev/v1/resellers/{id}/listings/{listingId}.
- [Update reseller program settings](https://docs.shoppex.io/api-reference/resellers/update-reseller-program-settings.md): Developer API operation for PATCH /dev/v1/reseller-program.
- [Create review reply](https://docs.shoppex.io/api-reference/reviews/create-review-reply.md): Developer API operation for POST /dev/v1/reviews/{uniqid}/reply.
- [Get review](https://docs.shoppex.io/api-reference/reviews/get-review.md): Developer API operation for GET /dev/v1/reviews/{uniqid}.
- [List reviews](https://docs.shoppex.io/api-reference/reviews/list-reviews.md): Developer API operation for GET /dev/v1/reviews.
- [SDKs & Libraries](https://docs.shoppex.io/api-reference/sdks.md): Official and community SDKs for the Shoppex API
- [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.
- [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 security settings](https://docs.shoppex.io/api-reference/security/get-security-settings.md): Developer API operation for GET /dev/v1/security.
- [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}.
- [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.
- [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.
- [Update security settings](https://docs.shoppex.io/api-reference/security/update-security-settings.md): Developer API operation for PATCH /dev/v1/security.
- [Add additional domain](https://docs.shoppex.io/api-reference/store/add-additional-domain.md): Developer API operation for POST /dev/v1/store/domains/additional.
- [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}.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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 store settings](https://docs.shoppex.io/api-reference/store/get-store-settings.md): Developer API operation for GET /dev/v1/store/settings.
- [Get storefront layout](https://docs.shoppex.io/api-reference/store/get-storefront-layout.md): Developer API operation for GET /dev/v1/store/layout.
- [List store domains](https://docs.shoppex.io/api-reference/store/list-store-domains.md): Developer API operation for GET /dev/v1/store/domains.
- [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.
- [Update custom domain](https://docs.shoppex.io/api-reference/store/update-custom-domain.md): Developer API operation for PATCH /dev/v1/store/domains/custom.
- [Update storefront layout](https://docs.shoppex.io/api-reference/store/update-storefront-layout.md): Developer API operation for PUT /dev/v1/store/layout.
- [Cancel subscription](https://docs.shoppex.io/api-reference/subscriptions/cancel-subscription.md): Developer API operation for POST /dev/v1/subscriptions/{id}/cancel.
- [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.
- [Get subscription](https://docs.shoppex.io/api-reference/subscriptions/get-subscription.md): Developer API operation for GET /dev/v1/subscriptions/{id}.
- [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 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.
- [List subscriptions](https://docs.shoppex.io/api-reference/subscriptions/list-subscriptions.md): Developer API operation for GET /dev/v1/subscriptions.
- [Pause subscription](https://docs.shoppex.io/api-reference/subscriptions/pause-subscription.md): Developer API operation for POST /dev/v1/subscriptions/{id}/pause.
- [Refund subscription](https://docs.shoppex.io/api-reference/subscriptions/refund-subscription.md): Developer API operation for POST /dev/v1/subscriptions/{id}/refund.
- [Resume subscription](https://docs.shoppex.io/api-reference/subscriptions/resume-subscription.md): Developer API operation for POST /dev/v1/subscriptions/{id}/resume.
- [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.
- [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.
- [Create telegram bot](https://docs.shoppex.io/api-reference/telegram/create-telegram-bot.md): Developer API operation for POST /dev/v1/telegram/bots.
- [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.
- [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.
- [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.
- [Delete telegram bot](https://docs.shoppex.io/api-reference/telegram/delete-telegram-bot.md): Developer API operation for DELETE /dev/v1/telegram/bots/{botId}.
- [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}.
- [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}.
- [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}.
- [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}.
- [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.
- [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.
- [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}.
- [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}.
- [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}.
- [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}.
- [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.
- [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 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 inbox conversations](https://docs.shoppex.io/api-reference/telegram/list-inbox-conversations.md): Developer API operation for GET /dev/v1/telegram/bots/{botId}/inbox.
- [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.
- [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.
- [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.
- [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.
- [List telegram bots](https://docs.shoppex.io/api-reference/telegram/list-telegram-bots.md): Developer API operation for GET /dev/v1/telegram/bots.
- [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.
- [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 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.
- [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.
- [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.
- [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.
- [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.
- [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}.
- [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}.
- [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}.
- [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.
- [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.
- [Accept theme draft](https://docs.shoppex.io/api-reference/themes/accept-theme-draft.md): Developer API operation for POST /dev/v1/themes/{id}/control/accept.
- [Apply theme changes](https://docs.shoppex.io/api-reference/themes/apply-theme-changes.md): Developer API operation for POST /dev/v1/themes/{id}/control/apply.
- [Create theme](https://docs.shoppex.io/api-reference/themes/create-theme.md): Developer API operation for POST /dev/v1/themes/control/create.
- [Create theme AI apply](https://docs.shoppex.io/api-reference/themes/create-theme-ai-apply.md): Developer API operation for POST /dev/v1/themes/{id}/ai/apply.
- [Deploy theme](https://docs.shoppex.io/api-reference/themes/deploy-theme.md): Developer API operation for POST /dev/v1/themes/{id}/control/deploy.
- [Export theme source](https://docs.shoppex.io/api-reference/themes/export-theme-source.md): Developer API operation for GET /dev/v1/themes/{id}/export.
- [Force purge storefront cache](https://docs.shoppex.io/api-reference/themes/force-purge-storefront-cache.md): Developer API operation for POST /dev/v1/themes/{id}/control/force-purge-storefront-cache.
- [Get latest theme control run](https://docs.shoppex.io/api-reference/themes/get-latest-theme-control-run.md): Developer API operation for GET /dev/v1/themes/{id}/control/runs/latest.
- [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.
- [Get theme diff](https://docs.shoppex.io/api-reference/themes/get-theme-diff.md): Developer API operation for GET /dev/v1/themes/{id}/control/diff.
- [Get theme preview status](https://docs.shoppex.io/api-reference/themes/get-theme-preview-status.md): Developer API operation for GET /dev/v1/themes/{id}/control/preview/starts/{startId}.
- [Get theme publish status](https://docs.shoppex.io/api-reference/themes/get-theme-publish-status.md): Developer API operation for GET /dev/v1/themes/{id}/control/publish/{jobId}/status.
- [Inspect theme](https://docs.shoppex.io/api-reference/themes/inspect-theme.md): Developer API operation for GET /dev/v1/themes/{id}/control/inspect.
- [List theme backups](https://docs.shoppex.io/api-reference/themes/list-theme-backups.md): Developer API operation for GET /dev/v1/themes/{id}/control/backups.
- [List themes](https://docs.shoppex.io/api-reference/themes/list-themes.md): Developer API operation for GET /dev/v1/themes.
- [Publish theme](https://docs.shoppex.io/api-reference/themes/publish-theme.md): Developer API operation for POST /dev/v1/themes/{id}/control/publish.
- [Purge storefront cache](https://docs.shoppex.io/api-reference/themes/purge-storefront-cache.md): Developer API operation for POST /dev/v1/themes/{id}/control/purge-storefront-cache.
- [Replace theme source](https://docs.shoppex.io/api-reference/themes/replace-theme-source.md): Developer API operation for POST /dev/v1/themes/{id}/source.
- [Restore theme backup](https://docs.shoppex.io/api-reference/themes/restore-theme-backup.md): Developer API operation for POST /dev/v1/themes/{id}/control/rollback/{backupId}.
- [Search theme files](https://docs.shoppex.io/api-reference/themes/search-theme-files.md): Developer API operation for GET /dev/v1/themes/{id}/control/search.
- [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}.
- [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.
- [Update theme config](https://docs.shoppex.io/api-reference/themes/update-theme-config.md): Developer API operation for POST /dev/v1/themes/{id}/control/config.
- [Validate theme](https://docs.shoppex.io/api-reference/themes/validate-theme.md): Developer API operation for POST /dev/v1/themes/{id}/control/validate.
- [Close ticket](https://docs.shoppex.io/api-reference/tickets/close-ticket.md): Developer API operation for POST /dev/v1/tickets/{id}/close.
- [Create ticket](https://docs.shoppex.io/api-reference/tickets/create-ticket.md): Developer API operation for POST /dev/v1/tickets.
- [Create ticket message](https://docs.shoppex.io/api-reference/tickets/create-ticket-message.md): Developer API operation for POST /dev/v1/tickets/{id}/messages.
- [Get ticket](https://docs.shoppex.io/api-reference/tickets/get-ticket.md): Developer API operation for GET /dev/v1/tickets/{id}.
- [List tickets](https://docs.shoppex.io/api-reference/tickets/list-tickets.md): Developer API operation for GET /dev/v1/tickets.
- [Reopen ticket](https://docs.shoppex.io/api-reference/tickets/reopen-ticket.md): Developer API operation for POST /dev/v1/tickets/{id}/reopen.
- [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.
- [Create webhook](https://docs.shoppex.io/api-reference/webhook-endpoints/create-webhook.md): Developer API operation for POST /dev/v1/webhooks.
- [Delete webhook](https://docs.shoppex.io/api-reference/webhook-endpoints/delete-webhook.md): Developer API operation for DELETE /dev/v1/webhooks/{id}.
- [Get webhook](https://docs.shoppex.io/api-reference/webhook-endpoints/get-webhook.md): Developer API operation for GET /dev/v1/webhooks/{id}.
- [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}.
- [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.
- [List webhooks](https://docs.shoppex.io/api-reference/webhook-endpoints/list-webhooks.md): Developer API operation for GET /dev/v1/webhooks.
- [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.
- [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.
- [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.
- [Update webhook](https://docs.shoppex.io/api-reference/webhook-endpoints/update-webhook.md): Developer API operation for PATCH /dev/v1/webhooks/{id}.
- [Dynamic Product Delivery](https://docs.shoppex.io/api-reference/webhooks/dynamic-delivery.md): The callback contract used by DYNAMIC products via dynamic_webhook
- [Webhook Events](https://docs.shoppex.io/api-reference/webhooks/events.md): Supported webhook event names and example payloads
- [Webhooks Overview](https://docs.shoppex.io/api-reference/webhooks/overview.md): Receive real-time event notifications via webhooks
- [Signature V2 Migration](https://docs.shoppex.io/api-reference/webhooks/signature-migration.md): Move webhook verification from legacy body-only signatures to timestamped signatures
- [Build with Shoppex](https://docs.shoppex.io/developers/learn/overview.md): Hosted checkout, Developer API, storefront SDK, and theme platform.
- [Build a custom checkout with the Storefront SDK](https://docs.shoppex.io/developers/tutorials/custom-checkout.md): Use @shoppexio/storefront to wire your own frontend to Shoppex checkout.
- [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.
- [Tutorials](https://docs.shoppex.io/developers/tutorials/overview.md): End-to-end walkthroughs for building with Shoppex.
- [Customize your theme with AI](https://docs.shoppex.io/developers/tutorials/theme-with-ai.md): A step-by-step walkthrough — from "fresh shop" to "live theme change" using Claude Code.
- [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.
- [Checkout Embed SDK](https://docs.shoppex.io/guides/embeds.md): Add Shoppex checkout as a modal on your existing website
- [Embed SDK Reference](https://docs.shoppex.io/guides/embeds-reference.md): Complete reference for Shoppex Checkout Embed SDK
- [Embed Security & Troubleshooting](https://docs.shoppex.io/guides/embeds-security.md): CSP, origin safety, and production checklist for Checkout Embed SDK
- [Embed SDK Snippets](https://docs.shoppex.io/guides/embeds-snippets.md): Copy/paste snippets for Next.js, React, WordPress, and Webflow
- [Headless Affiliate And Customer Portals](https://docs.shoppex.io/guides/headless-affiliate-portals.md): Build your own branded customer and affiliate dashboard while Shoppex handles orders, attribution, balances, and payout requests.
- [Invoices](https://docs.shoppex.io/guides/invoices.md): Understanding the invoice lifecycle and statuses
- [Complete or process manual-payment invoices](https://docs.shoppex.io/guides/manual-payment-completion.md): Complete or process storefront manual-payment invoices after your external gateway confirms payment
- [Payments](https://docs.shoppex.io/guides/payments.md): Accept payments via API, Payment Links, or your Storefront
- [Subscriptions](https://docs.shoppex.io/guides/subscriptions.md): Set up recurring billing and subscription management
- [Telegram Bots](https://docs.shoppex.io/guides/telegram-bots.md): Connect your Telegram bot to Shoppex for notifications, broadcasts, and AI-powered customer support
- [Webhooks](https://docs.shoppex.io/guides/webhooks.md): Receive real-time notifications for events
- [Architecture Reference](https://docs.shoppex.io/headless/architecture.md): Three reference setups for using Shoppex as a headless commerce engine — pure SPA, Next.js SSR, and mobile with backend-for-frontend.
- [Headless Checkout SDK](https://docs.shoppex.io/headless/checkout.md): Build your own checkout UI with @shoppexio/checkout-js/headless while Shoppex handles payment sessions, webhooks, invoices, and fulfillment.
- [Headless Commerce with Shoppex](https://docs.shoppex.io/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/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/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.
- [Storefront Template — SaaS Tool](https://docs.shoppex.io/headless/storefront-template-saas-tool.md): A premium dark-theme Next.js storefront template designed for selling subscription-based digital tools. Forkable, AI-customizable, and wired to Shoppex checkout.
- [Discord Bot Shop](https://docs.shoppex.io/headless/use-cases/discord-bot-shop.md): Sell roles, access passes, licenses, or gaming keys from a Discord bot using Shoppex as the commerce engine.
- [Gaming Key Reseller](https://docs.shoppex.io/headless/use-cases/gaming-reseller.md): Run a gaming-key reseller with Shoppex as the commerce engine — serial pools, HWID binding, license validation, and crypto payouts.
- [Mobile App](https://docs.shoppex.io/headless/use-cases/mobile-app.md): Add commerce to iOS / Android / React Native with Shoppex as a backend-for-frontend — your native UX, web-based payment finalization.
- [SaaS Paywall](https://docs.shoppex.io/headless/use-cases/saas-paywall.md): Gate a SaaS product with Shoppex subscriptions — your app owns the UX, Shoppex owns billing, trials, and dunning.
- [Custom domain](https://docs.shoppex.io/merchants/account/custom-domain.md): Step-by-step DNS walkthrough to run your shop on your own domain.
- [Multiple stores](https://docs.shoppex.io/merchants/account/multiple-stores.md): Run several shops from one account.
- [Your account](https://docs.shoppex.io/merchants/account/overview.md): Profile, team, custom domains, security, and multiple stores.
- [Security](https://docs.shoppex.io/merchants/account/security.md): 2FA, active sessions, and the audit trail.
- [Team & permissions](https://docs.shoppex.io/merchants/account/team.md): Invite teammates with scoped access to your shop.
- [Customers](https://docs.shoppex.io/merchants/customers/overview.md): Customer profiles, wallet credits, affiliates, and the support inbox.
- [Support inbox](https://docs.shoppex.io/merchants/customers/tickets.md): Reply to buyer questions from one place.
- [Welcome to Shoppex](https://docs.shoppex.io/merchants/overview.md): The commerce stack for digital product sellers.
- [Chargeback Shield](https://docs.shoppex.io/merchants/payments/chargeback-shield.md): Win your disputes automatically and keep your Stripe and PayPal accounts alive.
- [Shoppex Wallet](https://docs.shoppex.io/merchants/payments/crypto-wallet.md): Accept Bitcoin and Litecoin into a self-custodial wallet only you control.
- [Disputes & chargebacks](https://docs.shoppex.io/merchants/payments/disputes.md): What happens when a buyer disputes a charge.
- [Payment gateways](https://docs.shoppex.io/merchants/payments/gateways.md): Connect Stripe, PayPal, PayPal Friends & Family, Cash App, and crypto.
- [How payments work](https://docs.shoppex.io/merchants/payments/overview.md): From checkout to settlement — what happens to the buyer's money.
- [Payouts](https://docs.shoppex.io/merchants/payments/payouts.md): When and how the money reaches you.
- [Refunds](https://docs.shoppex.io/merchants/payments/refunds.md): Issue full or partial refunds from the dashboard.
- [Run a Black Friday sale with coupons and email](https://docs.shoppex.io/merchants/playbooks/black-friday-sale.md): Coupons, scheduled email blasts, segments, and tracking — from prep to post-mortem.
- [Launch a Discord supporter tier](https://docs.shoppex.io/merchants/playbooks/discord-supporter-tier.md): From bot setup to first paying member, end to end.
- [Set up your first reseller program](https://docs.shoppex.io/merchants/playbooks/first-reseller-program.md): Recruit B2B resellers who sell your products under their own brand.
- [Migrate to Shoppex](https://docs.shoppex.io/merchants/playbooks/migrate-to-shoppex.md): Move your shop from Billgang, Sell.app, SellAuth, or Komerza without breaking customer links.
- [Playbooks](https://docs.shoppex.io/merchants/playbooks/overview.md): End-to-end walkthroughs for common Shoppex use cases.
- [Switch from one-time codes to recurring access](https://docs.shoppex.io/merchants/playbooks/switch-to-recurring.md): Move a product line from single-use serials to subscriptions without losing existing customers.
- [Launch a Telegram-only sales channel](https://docs.shoppex.io/merchants/playbooks/telegram-only-shop.md): Sell entirely through a Telegram bot, with or without a web storefront.
- [File downloads](https://docs.shoppex.io/merchants/products/digital-files.md): Sell software, ebooks, presets, samples — any downloadable file.
- [Discord roles](https://docs.shoppex.io/merchants/products/discord-roles.md): Grant a server role automatically when a buyer's payment clears.
- [Dynamic products](https://docs.shoppex.io/merchants/products/dynamic.md): Generate the buyer's delivery on-the-fly from your own backend.
- [Serials & license keys](https://docs.shoppex.io/merchants/products/license-keys.md): Sell single-use codes like license keys, game codes, or gift cards.
- [Products](https://docs.shoppex.io/merchants/products/overview.md): What you can sell on Shoppex, and how fulfillment works for each type.
- [Services](https://docs.shoppex.io/merchants/products/services.md): Manual fulfillment for anything Shoppex can't deliver automatically.
- [Subscriptions](https://docs.shoppex.io/merchants/products/subscriptions.md): Recurring billing with trials, retries, and cancellation handling.
- [Quickstart](https://docs.shoppex.io/merchants/start/quickstart.md): Get your Shoppex shop live and selling in a few minutes.
- [Cart API](https://docs.shoppex.io/sdk/api/cart.md): Manage shopping cart items in the browser
- [Checkout API](https://docs.shoppex.io/sdk/api/checkout.md): Redirect customers to secure hosted checkout
- [Products API](https://docs.shoppex.io/sdk/api/products.md): Fetch products, variants, and categories
- [Reviews & Invoices](https://docs.shoppex.io/sdk/api/reviews.md): Fetch shop reviews and invoice status
- [Store API](https://docs.shoppex.io/sdk/api/store.md): Fetch store metadata, branding, and configuration
- [Installation](https://docs.shoppex.io/sdk/installation.md): Add the browser-safe Shoppex Storefront SDK to a custom headless storefront
- [Storefront SDK](https://docs.shoppex.io/sdk/introduction.md): Build headless or embedded storefronts with the browser-safe Shoppex Storefront SDK.
- [Quick Start](https://docs.shoppex.io/sdk/quickstart.md): Build your first custom headless storefront in 5 minutes
- [TypeScript Types](https://docs.shoppex.io/sdk/types.md): Complete type definitions for the SDK
- [AI Theme Workflows](https://docs.shoppex.io/themes/ai-workflows.md): Use AI assistants safely with Shoppex Liquid themes, CLI, MCP, preview, and publish.
- [AI theme editing — concept](https://docs.shoppex.io/themes/build-and-customize-with-ai.md): What you can do with Claude Code or Codex on a Shoppex theme, and how the workflow is shaped.
- [Liquid Build And Publish](https://docs.shoppex.io/themes/build-pipeline.md): How Shoppex validates, stores, renders, publishes, and serves Liquid theme packages.
- [Liquid Cart And Checkout](https://docs.shoppex.io/themes/cart-and-checkout.md): Wire product forms, cart state, coupons, and hosted checkout in Liquid themes.
- [CLI Reference](https://docs.shoppex.io/themes/cli-reference.md): Full command reference for the Shoppex Theme CLI (@shoppexio/cli) — auth, MCP setup, and theme development workflows.
- [Liquid Core Contract](https://docs.shoppex.io/themes/core-contract.md): The contract between Liquid templates, StorefrontRenderContext, Builder settings, and the commerce runtime.
- [Editing Liquid Themes](https://docs.shoppex.io/themes/editing.md): The shared workflow behind dashboard editing, CLI, Dev API, MCP, validation, preview, and publish.
- [Hosted Theme Sync](https://docs.shoppex.io/themes/hosted-theme-sync.md): Pull a hosted Liquid theme locally, run the Liquid preview, push validated source, then preview and publish.
- [Import, Export, And Upgrades](https://docs.shoppex.io/themes/import-export-and-upgrades.md): How Liquid theme source export, source replacement, validation, and upgrades work.
- [Theme Development](https://docs.shoppex.io/themes/introduction.md): Build hosted themes visually in the Theme Builder, or write custom code themes with Liquid, Builder settings, and the shared commerce runtime.
- [Liquid Local Development](https://docs.shoppex.io/themes/local-development.md): Work locally on Shoppex Liquid themes with fixtures, live shop data, and safe source sync.
- [Server Liquid Rendering](https://docs.shoppex.io/themes/pre-rendering.md): How Shoppex renders Liquid HTML for custom code themes in live storefronts, preview, CLI, and tests.
- [Liquid Theme Quickstart](https://docs.shoppex.io/themes/quickstart.md): Run a Shoppex Liquid theme locally with fixture data or live storefront data.
- [Liquid Runtime And Storefront SDK](https://docs.shoppex.io/themes/runtime-and-sdk.md): When Liquid themes use the platform runtime, and when custom storefronts use the Storefront SDK.
- [Serving And Caching](https://docs.shoppex.io/themes/serving-and-caching.md): How Shoppex serves Liquid storefronts, assets, custom domains, and cache purges.
- [Liquid Theme Package Format](https://docs.shoppex.io/themes/theme-package-format.md): Required files, manifest fields, block registry, and validation rules for Shoppex Liquid themes.
- [Liquid Theme Settings](https://docs.shoppex.io/themes/theme-settings.md): How Builder settings, defaults, schema, and CSS variables flow into Liquid rendering.
- [Liquid Theme Troubleshooting](https://docs.shoppex.io/themes/troubleshooting.md): Fix common Liquid validation, local preview, source sync, asset, cart, checkout, and publish issues.

## OpenAPI Specs

- [openapi](https://docs.shoppex.io/openapi.json)

## Optional

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