# Komerza Documentation

## Docs

- [Blacklist Affiliate](https://docs.komerza.com/api-reference/endpoint/affiliates/blacklist.md): Disables the affiliate, blocks the customer on the store, and adds their email to the store's blacklist. Requires the `stores.affiliates.update` permission.
- [Configure Affiliate Program](https://docs.komerza.com/api-reference/endpoint/affiliates/configure.md): Updates the configuration options for the affiliate program of the specified store. Requires the `stores.affiliates.update` permission.
- [Create Affiliate](https://docs.komerza.com/api-reference/endpoint/affiliates/create.md): Creates a new affiliate record for the given customer in this store. Requires the `stores.affiliates.update` permission.
- [Delete Affiliate](https://docs.komerza.com/api-reference/endpoint/affiliates/delete.md): Permanently removes an affiliate and all their payout records from the store. Requires the `stores.affiliates.update` permission.
- [Get Affiliates](https://docs.komerza.com/api-reference/endpoint/affiliates/get-list.md): Retrieves affiliates for the specified store using query-based filter options. Supports filtering, sorting, and pagination via query parameters. Requires the `stores.affiliates.view` permission.
- [List Affiliate Orders](https://docs.komerza.com/api-reference/endpoint/affiliates/get-orders.md): Retrieves a paginated list of orders attributed to a specific affiliate (by customerId) in the store. Requires the `stores.affiliates.view` permission.
- [List Affiliate Payouts](https://docs.komerza.com/api-reference/endpoint/affiliates/get-payouts.md): Requires the `stores.affiliates.view` permission.
- [Invite Affiliate](https://docs.komerza.com/api-reference/endpoint/affiliates/invite.md): Invites an affiliate, this will create a customer profile if one does not exist and takes in a customer email address instead. Requires the `stores.affiliates.update` permission.
- [Record Affiliate Payout](https://docs.komerza.com/api-reference/endpoint/affiliates/record-payout.md): Requires the `stores.affiliates.update` permission.
- [Search Affiliates](https://docs.komerza.com/api-reference/endpoint/affiliates/search.md): Searches affiliates by the `query` parameter and applies filtering/sorting/pagination. The query is matched against affiliate email, affiliate link/code, affiliate ID, and customer ID. Requires the `stores.affiliates.view` permission.
- [Get Affiliate Statistics](https://docs.komerza.com/api-reference/endpoint/affiliates/stats.md): Retrieves the affiliate statistics associated with a specific store. Requires the `stores.affiliates.view` permission.
- [Update Affiliate](https://docs.komerza.com/api-reference/endpoint/affiliates/update.md): Updates affiliate settings for the given customer in this store. Requires the `stores.affiliates.update` permission.
- [Void Affiliate Payout](https://docs.komerza.com/api-reference/endpoint/affiliates/void-payout.md): Marks the payout as voided, restores balances, and records the admin and reason. Requires the `stores.affiliates.update` permission.
- [Create Category](https://docs.komerza.com/api-reference/endpoint/categories/create.md): Creates a new category in the store. Requires the `stores.categories.create` permission.
- [Delete Category](https://docs.komerza.com/api-reference/endpoint/categories/delete.md): Deletes an existing category from the store. Requires the `stores.categories.delete` permission.
- [Get Category](https://docs.komerza.com/api-reference/endpoint/categories/get.md): Retrieves a category by its ID with full product details. Requires the `stores.categories.view` permission.
- [Get All Categories](https://docs.komerza.com/api-reference/endpoint/categories/get-all.md): Retrieves all categories in the store as references (no pagination). Requires the `stores.categories.view` permission.
- [Get Categories](https://docs.komerza.com/api-reference/endpoint/categories/get-list.md): Gets the categories in the store with pagination and filtering. Requires the `stores.categories.view` permission.
- [Update Category](https://docs.komerza.com/api-reference/endpoint/categories/update.md): Updates an existing category in the store. Requires the `stores.categories.update` permission.
- [Create Coupon](https://docs.komerza.com/api-reference/endpoint/coupons/create.md): Creates a new coupon in the store. Requires the `stores.coupons.create` permission.
- [Delete Coupon](https://docs.komerza.com/api-reference/endpoint/coupons/delete.md): Deletes an existing coupon from the store. Requires the `stores.coupons.delete` permission.
- [Get Coupon](https://docs.komerza.com/api-reference/endpoint/coupons/get.md): Gets a coupon by ID. Requires the `stores.coupons.view` permission.
- [Get All Coupons](https://docs.komerza.com/api-reference/endpoint/coupons/get-all.md): Gets the coupons in the store as references. Requires the `stores.coupons.view` permission.
- [Get Coupons](https://docs.komerza.com/api-reference/endpoint/coupons/get-list.md): Gets the coupons in the store. Requires the `stores.coupons.view` permission.
- [Search Coupons](https://docs.komerza.com/api-reference/endpoint/coupons/search.md): Searches the coupons in the store by the given query. Requires the `stores.coupons.view` permission.
- [Update Coupon](https://docs.komerza.com/api-reference/endpoint/coupons/update.md): Requires the `stores.coupons.update` permission.
- [Create Customer](https://docs.komerza.com/api-reference/endpoint/customers/create.md): Registers a customer for the store using their email. If the customer already exists and is linked to the store, a 409 conflict is returned. Requires the `stores.customers.create` permission.
- [Get Customer](https://docs.komerza.com/api-reference/endpoint/customers/get.md): Retrieves detailed information for a single customer in the specified store. Requires the `stores.customers.view` permission.
- [Get Customers](https://docs.komerza.com/api-reference/endpoint/customers/get-list.md): Retrieves a paginated list of customers for the specified store. Requires the `stores.customers.view` permission.
- [Search Customers](https://docs.komerza.com/api-reference/endpoint/customers/search.md): Retrieves a paginated list of customers for the specified store, matching the provided query. Requires the `stores.customers.view` permission.
- [Update Customer Balance](https://docs.komerza.com/api-reference/endpoint/customers/update-balance.md): Updates the store-specific balance for a customer. Requires the `stores.customers.update` permission.
- [Create Order](https://docs.komerza.com/api-reference/endpoint/orders/create.md): Creates a new order for a customer in the admin dashboard. Requires the `stores.orders.create` permission.
- [Deliver Order](https://docs.komerza.com/api-reference/endpoint/orders/deliver.md): Forces delivery of an existing order as if purchased normally. No action is taken if the order is already delivered. Requires the `stores.orders.deliver` permission.
- [Get Order](https://docs.komerza.com/api-reference/endpoint/orders/get.md): Retrieve order details by ID in the given store. Requires the `stores.orders.view` permission.
- [Get Orders](https://docs.komerza.com/api-reference/endpoint/orders/get-list.md): Gets orders in the specified store and optionally filters by the given criteria. Requires the `stores.orders.view` permission.
- [Refund Order](https://docs.komerza.com/api-reference/endpoint/orders/refund.md): Refunds a delivered order for a customer in the admin dashboard. Requires the `stores.orders.refund` permission.
- [Search Orders](https://docs.komerza.com/api-reference/endpoint/orders/search.md): Search orders by ID or customer email in the specified store. Requires the `stores.orders.view` permission.
- [Create Product](https://docs.komerza.com/api-reference/endpoint/products/create.md): Creates a new product in the store. Requires the `stores.products.create` permission.
- [Delete Product](https://docs.komerza.com/api-reference/endpoint/products/delete.md): Deletes a product from the store. Requires the `stores.products.delete` permission.
- [Duplicate Product](https://docs.komerza.com/api-reference/endpoint/products/duplicate.md): Creates a copy of an existing product. Requires the `stores.products.create` permission.
- [Get Product](https://docs.komerza.com/api-reference/endpoint/products/get.md): Retrieves a product by its ID. Requires the `stores.products.view` permission.
- [Get All Products](https://docs.komerza.com/api-reference/endpoint/products/get-all.md): Retrieves all products in the store as redacted references (no pagination). Requires the `stores.products.view` permission.
- [Get Products](https://docs.komerza.com/api-reference/endpoint/products/get-list.md): Retrieves products in pages. Requires the `stores.products.view` permission.
- [Get Product by Slug](https://docs.komerza.com/api-reference/endpoint/products/get-slug.md): Retrieves a product by its slug. Requires the `stores.products.view` permission.
- [Order Products](https://docs.komerza.com/api-reference/endpoint/products/order.md)
- [Order Product Images](https://docs.komerza.com/api-reference/endpoint/products/order-images.md): Updates the display order of images for a product. Requires the `stores.products.update` permission.
- [Search Products](https://docs.komerza.com/api-reference/endpoint/products/search.md): Searches products by query within the store. Requires the `stores.products.view` permission.
- [Update Product](https://docs.komerza.com/api-reference/endpoint/products/update.md): Updates basic information of a product. Requires the `stores.products.update` permission.
- [Update Affiliate Discount](https://docs.komerza.com/api-reference/endpoint/products/update-affiliate-discount.md): Updates affiliate discount configuration of a product. Requires the `stores.products.update` permission.
- [Bulk Update Products](https://docs.komerza.com/api-reference/endpoint/products/update-bulk.md): Updates multiple products in one request. Requires the `stores.products.update` permission.
- [Update Payment Settings](https://docs.komerza.com/api-reference/endpoint/products/update-payment.md): Sets a custom fee structure for a product. Requires the `stores.products.update` permission.
- [Get Reviews](https://docs.komerza.com/api-reference/endpoint/reviews/get-list.md): Gets the current and previous reviews for a store. Requires the `stores.view` permission.
- [Reply to Review](https://docs.komerza.com/api-reference/endpoint/reviews/reply.md): Requires the `stores.update` permission.
- [Create Store](https://docs.komerza.com/api-reference/endpoint/stores/create.md): Creates a new store for the current user. Requires the `stores.create` permission.
- [Get Store](https://docs.komerza.com/api-reference/endpoint/stores/get.md): Retrieves the specified store's reference information. Requires the `stores.view` permission.
- [Get Permissions](https://docs.komerza.com/api-reference/endpoint/stores/get-permissions.md): Gets the permissions that the currently authenticated user has against the store, along with the payment methods enabled by the store owner Requires the `stores.view` permission.
- [Update Store](https://docs.komerza.com/api-reference/endpoint/stores/update.md): Replaces the specified store's data with the information in the form. Requires the `stores.update` permission.
- [Maintenance Mode](https://docs.komerza.com/api-reference/endpoint/stores/update-maintenance.md): Enables or disables maintenance mode for the specified store. Requires the `stores.update` permission.
- [Add Ticket Response](https://docs.komerza.com/api-reference/endpoint/tickets/add.md): Adds a response/reply to the given ticket. Requires the `stores.tickets.update` permission.
- [Close Ticket](https://docs.komerza.com/api-reference/endpoint/tickets/delete.md): Closes the given ticket. Requires the `stores.tickets.delete` permission.
- [Get Ticket](https://docs.komerza.com/api-reference/endpoint/tickets/get.md): Gets a ticket by the ID in the given store and returns it. Requires the `stores.tickets.view` permission.
- [Get Tickets](https://docs.komerza.com/api-reference/endpoint/tickets/get-list.md): Gets the tickets in the store. Requires the `stores.tickets.view` permission.
- [Get User](https://docs.komerza.com/api-reference/endpoint/users/get.md): Returns the currently authenticated user’s profile data. Requires the `user.view` permission.
- [Add License Keys](https://docs.komerza.com/api-reference/endpoint/variants/add-items.md): Appends delivery items to a variant. Requires the `stores.products.update` permission.
- [Clear License Keys](https://docs.komerza.com/api-reference/endpoint/variants/clear-items.md): Removes all items from a variant. Requires the `stores.products.update` permission.
- [Create Variant](https://docs.komerza.com/api-reference/endpoint/variants/create.md): Adds a new variant to the specified product. Requires the `stores.products.update` permission.
- [Delete Variant](https://docs.komerza.com/api-reference/endpoint/variants/delete.md): Removes the specified variant. Requires the `stores.products.update` permission.
- [Delete License Keys](https://docs.komerza.com/api-reference/endpoint/variants/delete-items.md): Deletes specified items from a variant. Requires the `stores.products.update` permission.
- [Create Field](https://docs.komerza.com/api-reference/endpoint/variants/fields/create.md): Adds a new custom field to the specified variant. Options for select/radio fields are managed separately. Requires the `stores.products.update` permission.
- [Delete Field](https://docs.komerza.com/api-reference/endpoint/variants/fields/delete.md): Removes the specified custom field and all its options from the variant. Requires the `stores.products.update` permission.
- [Create Field Option](https://docs.komerza.com/api-reference/endpoint/variants/fields/options/create.md): Adds a selectable option under the given custom field. Requires the `stores.products.update` permission.
- [Delete Field Option](https://docs.komerza.com/api-reference/endpoint/variants/fields/options/delete.md): Removes the specified option from its parent custom field. Requires the `stores.products.update` permission.
- [Update Field Option](https://docs.komerza.com/api-reference/endpoint/variants/fields/options/update.md): Updates the label, value, or display order of an existing option. Requires the `stores.products.update` permission.
- [Update Field](https://docs.komerza.com/api-reference/endpoint/variants/fields/update.md): Updates the label, placeholder, type, requirement, or hint of an existing custom field. Requires the `stores.products.update` permission.
- [Get Variant](https://docs.komerza.com/api-reference/endpoint/variants/get.md)
- [Get License Keys](https://docs.komerza.com/api-reference/endpoint/variants/get-items.md): Retrieves files/items delivered by a variant in pages. Requires the `stores.products.view` permission.
- [Order Variant Images](https://docs.komerza.com/api-reference/endpoint/variants/order-images.md): Sets the display order of images. Requires the `stores.products.update` permission.
- [Update Variant](https://docs.komerza.com/api-reference/endpoint/variants/update.md): Modifies a variant’s label, SKU, price, etc. Requires the `stores.products.update` permission.
- [Update Delivery Settings](https://docs.komerza.com/api-reference/endpoint/variants/update-delivery.md): Configures how the variant is delivered (e.g., file, custom script). Requires the `stores.products.update` permission.
- [Create Webhook](https://docs.komerza.com/api-reference/endpoint/webhooks/create.md): Allows the user to specify multiple store IDs in Komerza.Common.Forms.Users.WebhookForm.StoreIds. Requires the `user.webhooks.create` permission.
- [Delete Webhook](https://docs.komerza.com/api-reference/endpoint/webhooks/delete.md): Removes the webhook and all associated logs from the user account. Requires the `user.webhooks.delete` permission.
- [Get Webhook](https://docs.komerza.com/api-reference/endpoint/webhooks/get.md): Retrieves the webhook if it belongs to the currently authenticated user. Requires the `user.webhooks.view` permission.
- [Get Webhooks](https://docs.komerza.com/api-reference/endpoint/webhooks/get-list.md): Returns a list of all account-wide webhooks configured by the user. Requires the `user.webhooks.view` permission.
- [Get Webhook Logs](https://docs.komerza.com/api-reference/endpoint/webhooks/get-logs.md): Returns a paginated list of Komerza.Database.Entities.Webhooks.WebhookExecutionLog entries for the given webhook. Supports filtering by response code and success/failure status via query parameters. Requires the `user.webhooks.view` permission.
- [Resend Webhook](https://docs.komerza.com/api-reference/endpoint/webhooks/resend.md): Re-queues the Hangfire job for a particular webhook execution log. If the job no longer exists or the user does not own the log, it fails. This is a single execution log re-send. Requires the `user.webhooks.update` permission.
- [Update Webhook](https://docs.komerza.com/api-reference/endpoint/webhooks/update.md): Overwrites the URL, events, and store IDs. Requires the `user.webhooks.update` permission.
- [Enums & Constants](https://docs.komerza.com/api-reference/enums.md): Reference for all enumeration types and constant values used in the API
- [Error Codes](https://docs.komerza.com/api-reference/error-codes.md): Complete reference for all API error codes and how to handle them
- [Filtering & Sorting](https://docs.komerza.com/api-reference/filtering.md): Learn how to filter, sort, and paginate API results
- [Introduction](https://docs.komerza.com/api-reference/introduction.md): Complete REST API for the Komerza e-commerce platform
- [Exchange Code](https://docs.komerza.com/api-reference/oauth2/exchange.md): Exchanges an authorization code for an API key.
- [OAuth2 Integration](https://docs.komerza.com/api-reference/oauth2/introduction.md): Allow third-party applications to access user accounts with their consent
- [Payment Methods](https://docs.komerza.com/api-reference/payment-methods.md): Complete reference for all supported payment methods and cryptocurrencies
- [Order Status](https://docs.komerza.com/api-reference/payment-status.md): Reference for all order statuses and their meanings
- [Quick Start](https://docs.komerza.com/api-reference/quickstart.md): Get up and running with the Komerza API in minutes
- [Scopes](https://docs.komerza.com/api-reference/scopes.md): Complete reference for all available API key permission scopes
- [SDKs](https://docs.komerza.com/api-reference/sdks.md): Official SDKs for the Komerza API - coming soon
- [Analytics SDK](https://docs.komerza.com/guides/analytics-sdk.md): Bring back visitor analytics to your Komerza Dashboard with our lightweight analytics script
- [Setup Apple Pay with Stripe](https://docs.komerza.com/guides/apple-pay-stripe.md): Configure Apple Pay domains in Stripe for Komerza Checkout and Embeds
- [Setup Cash App](https://docs.komerza.com/guides/cash-app-setup.md): Configure Cash App payments with mail forwarding on Komerza
- [Komerza CLI](https://docs.komerza.com/guides/cli.md): Build and deploy Komerza storefronts from your local machine
- [Custom Domain](https://docs.komerza.com/guides/custom-domain.md): Connect your own domain to your Komerza store
- [How Delivery Works](https://docs.komerza.com/guides/delivery/introduction.md): Understanding Komerza's automated delivery system for digital goods
- [Dynamic Delivery](https://docs.komerza.com/guides/dynamic-delivery.md): Create custom fulfillment workflows by handling product delivery programmatically via webhooks
- [Embed SDK](https://docs.komerza.com/guides/embed-sdk.md): Integrate Komerza checkout directly into your website with our lightweight Embed SDK
- [Setup Paddle](https://docs.komerza.com/guides/paddle-setup.md): Configure Paddle payments on your Komerza store
- [Supported Payment Methods](https://docs.komerza.com/guides/payment-methods.md): A complete list of payment gateways and cryptocurrencies supported by Komerza
- [Setup PayPal F&F](https://docs.komerza.com/guides/paypal-ff-setup.md): Configure PayPal Friends & Family payments with IPN or mail forwarding
- [Setup Shopify](https://docs.komerza.com/guides/shopify-setup.md): Configure Shopify payments on your Komerza store
- [Intro](https://docs.komerza.com/index.md): Complete developer resources for integrating with the Komerza e-commerce platform - from APIs to SDKs to analytics
- [Basket](https://docs.komerza.com/storefront/basket.md): Manage shopping cart items with the Komerza client library
- [Checkout](https://docs.komerza.com/storefront/checkout.md): Process orders and redirect customers to hosted checkout
- [Currency Formatting](https://docs.komerza.com/storefront/formatting.md): Format prices consistently using your store's currency
- [Installation & Setup](https://docs.komerza.com/storefront/installation.md): Install the Komerza client library and initialize your storefront
- [Introduction](https://docs.komerza.com/storefront/introduction.md): Build custom storefront templates with the Komerza client library
- [Products](https://docs.komerza.com/storefront/products.md): Fetch and display products, variants, and reviews
- [Store Information](https://docs.komerza.com/storefront/store.md): Fetch store details, branding assets, and currency formatting

## OpenAPI Specs

- [openapi](https://docs.komerza.com/api-reference/openapi.json)

## Optional

- [System Status](https://status.komerza.com)
- [Telegram](https://t.me/komerzaecom)
- [Discord](https://discord.gg/komerza)