# Komerza Documentation: German API-Referenz ## API-Referenz ### API Documentation - [Introduction](https://docs.komerza.com/api-reference/introduction.md): The Komerza REST API: what it covers and where to start - [Quick Start](https://docs.komerza.com/api-reference/quickstart.md): Make your first Komerza API call - [Authentication](https://docs.komerza.com/api-reference/authentication.md): API keys, required headers and scopes - [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 ### Reference - [Conventions](https://docs.komerza.com/api-reference/conventions.md): IDs, dates, enums, money, store scoping and paging - [Responses & Errors](https://docs.komerza.com/api-reference/responses.md): The response envelope, list responses, and how failures are reported - [Filtering & Sorting](https://docs.komerza.com/api-reference/filtering.md): Narrow down, order and page through list endpoints - [Enums & Constants](https://docs.komerza.com/api-reference/enums.md): Every enum value the API accepts and returns - [Error Codes](https://docs.komerza.com/api-reference/error-codes.md): Complete reference for all API error codes and how to handle them - [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 ### OAuth2 - [OAuth2 Integration](https://docs.komerza.com/api-reference/oauth2/introduction.md): Allow third-party applications to access user accounts with their consent - [Exchange Code](https://docs.komerza.com/api-reference/oauth2/exchange.md) ### User - [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. ### Stores - [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. - [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. - [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. ### Products - [Get Product](https://docs.komerza.com/api-reference/endpoint/products/get.md): Retrieves a product by its ID. Requires the `stores.products.view` 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. - [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. - [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. - [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. - [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 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. - [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. - [Order Products](https://docs.komerza.com/api-reference/endpoint/products/order.md): Updates the display order of products. Requires the `stores.products.update` permission. - [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. - [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. - [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. - [Update Product Badges](https://docs.komerza.com/api-reference/endpoint/products/update-badges.md): Replaces every badge on the product at once (bulk set). An empty list clears all badges. Requires the `stores.products.update` permission. - [Update Product Security](https://docs.komerza.com/api-reference/endpoint/products/update-security.md): Updates security information of a product. Requires the `stores.products.update` permission. - [Bulk Delete Products](https://docs.komerza.com/api-reference/endpoint/products/delete-bulk.md): Deletes multiple products in one request. This will delete all variants, files, images, and reviews associated with each product. Products that don't exist are silently skipped. Requires the `stores.products.delete` permission. ### Categories - [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 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. - [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. - [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. - [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. - [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. - [Order Categories](https://docs.komerza.com/api-reference/endpoint/categories/order.md): Updates the display order of categories. Requires the `stores.categories.update` permission. - [Order Products in Category](https://docs.komerza.com/api-reference/endpoint/categories/order-products.md): Updates the display order of products within a category. Requires the `stores.categories.update` permission. ### Variants - [Get Variant](https://docs.komerza.com/api-reference/endpoint/variants/get.md): Retrieves a single variant by ID. Requires the `stores.products.view` permission. - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [Delete Variant](https://docs.komerza.com/api-reference/endpoint/variants/delete.md): Removes the specified variant. 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. - [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. - [Order Variants](https://docs.komerza.com/api-reference/endpoint/variants/order.md): Updates the display order of variants. Requires the `stores.products.update` permission. - [Duplicate Variant](https://docs.komerza.com/api-reference/endpoint/variants/duplicate.md): Creates a copy of an existing variant in the same product. Requires the `stores.products.update` permission. - [Search License Keys](https://docs.komerza.com/api-reference/endpoint/variants/search-items.md): Searches for license keys in the specified store using fuzzy matching. Results are ordered by relevance score, with exact matches appearing first, followed by prefix matches, substring matches, and then similar keys. Requires the `stores.products.view` permission. - [Remove File from Variant](https://docs.komerza.com/api-reference/endpoint/variants/delete-file.md): Deletes the delivery file and its link. Requires the `stores.products.update` permission. - [Get Volume Discounts](https://docs.komerza.com/api-reference/endpoint/variants/discounts/get.md): Retrieves all volume discount tiers configured for the specified variant, ordered by quantity threshold. Requires the `stores.products.update` permission. - [Create Volume Discount](https://docs.komerza.com/api-reference/endpoint/variants/discounts/create.md): Adds a new volume discount tier to the specified variant. Each tier defines a minimum quantity and the discount to apply when that quantity is reached. Requires the `stores.products.update` permission. - [Replace Volume Discounts](https://docs.komerza.com/api-reference/endpoint/variants/discounts/replace.md): Replaces all existing volume discount tiers for the variant with a new set. This is useful for bulk updates where you want to set all tiers at once. Requires the `stores.products.update` permission. - [Update Volume Discount](https://docs.komerza.com/api-reference/endpoint/variants/discounts/update.md): Updates the quantity threshold, discount type, or discount value of an existing volume discount tier. Requires the `stores.products.update` permission. - [Delete Volume Discount](https://docs.komerza.com/api-reference/endpoint/variants/discounts/delete.md): Removes the specified volume discount tier from the variant. Requires the `stores.products.update` permission. ### Coupons - [Get Coupon](https://docs.komerza.com/api-reference/endpoint/coupons/get.md): Gets a coupon by ID. 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. - [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. - [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. - [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. - [Update Coupon](https://docs.komerza.com/api-reference/endpoint/coupons/update.md): Requires the `stores.coupons.update` 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. ### Tickets - [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. - [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. ### Customers - [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. - [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. - [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. - [Get Customer by Email](https://docs.komerza.com/api-reference/endpoint/customers/get-by-email.md): Retrieves detailed information for a single customer in the specified store. Requires the `stores.customers.view` permission. ### Orders - [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. - [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 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. - [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. - [Re-deliver Order](https://docs.komerza.com/api-reference/endpoint/orders/redeliver.md): Forces redelivery of an already delivered order as if purchased normally. Requires the `stores.orders.deliver` permission. - [Resend Receipt](https://docs.komerza.com/api-reference/endpoint/orders/resend-receipt.md): Resends the delivery receipt to the customer for a previously delivered order. Rate limited due to sensitivity. Requires the `stores.orders.deliver` permission. - [Approve Custom Payment](https://docs.komerza.com/api-reference/endpoint/orders/approve-custom-payment.md): Approves a pending custom payment order, marking it as delivered. Requires the `stores.orders.deliver` permission. - [Reject Custom Payment](https://docs.komerza.com/api-reference/endpoint/orders/reject-custom-payment.md): Rejects a pending custom payment order, cancelling it. Requires the `stores.orders.deliver` permission. - [Get Proof of Payment](https://docs.komerza.com/api-reference/endpoint/orders/get-payment-proof.md): Gets the proof of payment submitted by a customer for an order. Requires the `stores.orders.view` permission. ### Reviews - [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. - [Get Review Analytics](https://docs.komerza.com/api-reference/endpoint/reviews/analytics.md): Gets the review analytics for a store. Requires the `stores.view` permission. ### Affiliates - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [Record Affiliate Payout](https://docs.komerza.com/api-reference/endpoint/affiliates/record-payout.md): 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. ### Reseller Programme - [Get Programme](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get.md): Returns the store's reseller settings plus headline counts. A store that has never configured a programme comes back disabled with defaults rather than a 404. Requires the `stores.resellers.view` permission. - [Configure Programme](https://docs.komerza.com/api-reference/endpoint/reseller-programme/configure.md): Sets whether the store supplies resellers, how they enrol, the discount they pay, and the optional exposure and top-up limits. Requires the `stores.resellers.update` permission. - [Get Catalogue](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get-catalogue.md): The variants resellers can draw, each with its list price and the price a reseller pays, so the merchant can see the margin they are giving away. Requires the `stores.resellers.view` permission. - [Add to Catalogue](https://docs.komerza.com/api-reference/endpoint/reseller-programme/add-to-catalogue.md): Adds a variant to the catalogue or updates its terms. The variant does not have to be visible on the storefront — offering resellers something ordinary customers never see is a supported use. Requires the `stores.resellers.update` permission. - [Remove from Catalogue](https://docs.komerza.com/api-reference/endpoint/reseller-programme/remove-from-catalogue.md): Removes it from the catalogue entirely, discarding its price overrides. Resellers already listing it keep the listing, but their next draw fails. To pause it and keep the terms, set `isEnabled` to false instead. Requires the `stores.resellers.update` permission. - [Get Variant Stats](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get-variant-stats.md): How many resellers list this variant and what they have drawn, so the reselling side of a product is visible on the product page rather than only in the reseller section. Requires the `stores.resellers.view` permission. - [Set Volume Tiers](https://docs.komerza.com/api-reference/endpoint/reseller-programme/set-volume-tiers.md): Applies only when a reseller buys stock up front, not to ordinary draws — drawing one unit at a time commits them to nothing, so there is nothing for a discount to buy. Replaces the whole set, so what you send is exactly what applies. Requires the `stores.resellers.update` permission. - [Get Resellers](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get-resellers.md): Who resells for this store, what they have spent, and what they can currently draw against. Does not include the resellers' own customers — who they sell to is their business. Requires the `stores.resellers.view` permission. - [Update Status](https://docs.komerza.com/api-reference/endpoint/reseller-programme/update-status.md): Revoking stops further draws but leaves the reseller's balance alone — they funded it and are still owed it. Requires the `stores.resellers.update` permission. - [Grant Samples](https://docs.komerza.com/api-reference/endpoint/reseller-programme/grant-samples.md): Gives a reseller free units so they can prove delivery works end to end before funding a balance. Samples are spent before money on a matching draw. Requires the `stores.resellers.update` permission. - [Get Invitations](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get-invites.md): Tokens are never included — they exist only in the response that created them. Requires the `stores.resellers.view` permission. - [Create Invitation](https://docs.komerza.com/api-reference/endpoint/reseller-programme/create-invite.md): Returns the invite token once and only once — only its hash is stored, because the token grants an already-approved reseller relationship and a leaked invite list must not be usable. Send it on immediately; it cannot be read back. Requires the `stores.resellers.update` permission. - [Delete Invitation](https://docs.komerza.com/api-reference/endpoint/reseller-programme/delete-invite.md): Requires the `stores.resellers.update` permission. - [Get Questions](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get-questions.md): The store's reseller application form, in the order applicants are asked. Retired questions are left out — they exist only so answers already given to them stay readable. Requires the `stores.resellers.view` permission. - [Create Question](https://docs.komerza.com/api-reference/endpoint/reseller-programme/create-question.md): Questions can be added, reworded and reordered at any time, including while applications are waiting: an answer records the wording it was given against, so editing the form never changes what someone already in the queue appears to have been asked. Requires the `stores.resellers.update` permission. - [Update Question](https://docs.komerza.com/api-reference/endpoint/reseller-programme/update-question.md): Requires the `stores.resellers.update` permission. - [Delete Question](https://docs.komerza.com/api-reference/endpoint/reseller-programme/delete-question.md): Archived rather than deleted. Every answer ever given to it still points at it, and tidying the form should not orphan the applications that answered it. Requires the `stores.resellers.update` permission. - [Get Applications](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get-applications.md): The review queue: who has applied, what they answered, and what they have deposited since. The deposit is summed from the balance ledger rather than stored, so it always matches the money that actually arrived. Requires the `stores.resellers.view` permission. - [Create Application](https://docs.komerza.com/api-reference/endpoint/reseller-programme/create-application.md): For a merchant hosting their own application form. Collect whatever fields suit your site, then post them here with the applicant's email — answers may reference the questions configured on this store, carry a `label` of your own, or mix the two. - [Get Bundles](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get-bundles.md): Each comes back priced the way your resellers will see it: what it contains, what that comes to at list price, the discount, and what they would pay. A bundle whose products have left your reseller catalogue comes back unavailable, with the reason, rather than disappearing. Requires the `stores.rese… - [Create Bundle](https://docs.komerza.com/api-reference/endpoint/reseller-programme/create-bundle.md): A bundle is a basket you have composed and priced as one thing. Set a discount to advertise a figure, or leave it off and let your basket-size discounts decide. - [Update Bundle](https://docs.komerza.com/api-reference/endpoint/reseller-programme/update-bundle.md): Replaces the bundle wholesale, lines and all. Anyone who already bought it keeps what they bought at the price they paid. Requires the `stores.resellers.update` permission. - [Delete Bundle](https://docs.komerza.com/api-reference/endpoint/reseller-programme/delete-bundle.md): Takes it off sale. What resellers already bought through it, and what they paid, stays on record. Requires the `stores.resellers.update` permission. - [Get Basket Discounts](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get-basket-tiers.md): Volume terms measured on what a whole basket comes to rather than on how many of one product it holds, so a reseller taking a spread of your catalogue is credited for the whole commitment. Requires the `stores.resellers.view` permission. - [Create Basket Discount](https://docs.komerza.com/api-reference/endpoint/reseller-programme/create-basket-tier.md): Measured at list price before anything comes off, so qualifying for a discount cannot lower a basket's value and disqualify it again. Where several apply, the largest wins. Requires the `stores.resellers.update` permission. - [Update Basket Discount](https://docs.komerza.com/api-reference/endpoint/reseller-programme/update-basket-tier.md): Requires the `stores.resellers.update` permission. - [Delete Basket Discount](https://docs.komerza.com/api-reference/endpoint/reseller-programme/delete-basket-tier.md): Requires the `stores.resellers.update` permission. - [Get Leaderboard](https://docs.komerza.com/api-reference/endpoint/reseller-programme/get-leaderboard.md): Your resellers ranked by what they spent with you over a period, biggest first. Built for publishing: every reseller is identified by the store they sell from — its name, description, storefront and branding, all of which is public already — so nothing here has to be masked before it goes on a page. ### Reselling - [Get Suppliers](https://docs.komerza.com/api-reference/endpoint/reselling/get-suppliers.md): Every store this one draws stock from, with what it can currently spend at each. Requires the `stores.reselling.view` permission. - [Find Supplier](https://docs.komerza.com/api-reference/endpoint/reselling/find-supplier.md): There is no supplier directory, so this is how you reach a store you already know of: paste its address. - [Apply to Supplier](https://docs.komerza.com/api-reference/endpoint/reselling/apply.md): Asks to resell a store's stock. A customer account on that store is created from the caller's platform email, so there is nothing to sign up for separately. Stores that enrol openly approve immediately; stores that take applications leave this pending. Requires the `stores.reselling.update` permissi… - [Get Catalogue](https://docs.komerza.com/api-reference/endpoint/reselling/get-catalogue.md): Priced as it will actually cost this store, with whichever of its own products is already sourced from each. Requires the `stores.reselling.view` permission. - [Get Bundles](https://docs.komerza.com/api-reference/endpoint/reselling/get-bundles.md): Baskets the supplier composed and priced as one thing, each quoted for this store: what is in it, what that comes to at their list prices, the discount, and what you would pay. Bundles aimed at other resellers are not listed, and cannot be bought by guessing an id. Requires the `stores.reselling.vie… - [Buy Basket](https://docs.komerza.com/api-reference/endpoint/reselling/buy-basket.md): The basket is priced once and each line is then bought at its share of that price, landing on your own products as ordinary stock exactly as a single-variant purchase would. Short deliveries are refunded the same way. - [Quote Basket](https://docs.komerza.com/api-reference/endpoint/reselling/quote-basket.md): Give it a bundle id, or lines of your own, and it comes back with the same arithmetic the purchase will use — including what those lines would have cost bought separately, so a discount you already have is not counted twice in what you tell yourself you saved. Requires the `stores.reselling.view` pe… - [Buy Stock](https://docs.komerza.com/api-reference/endpoint/reselling/buy-stock.md): Buys units up front, at whatever volume price the supplier offers for that quantity, and puts them on your own product as ordinary stock. Nothing is held or pending: the units are yours, they sell through your normal delivery, and nothing the supplier does afterwards takes them away. - [Get Draws](https://docs.komerza.com/api-reference/endpoint/reselling/get-draws.md): One entry per draw, newest first, each quoting the supplier's own order id so it can be chased upstream. Requires the `stores.reselling.view` permission. - [Add Funds](https://docs.komerza.com/api-reference/endpoint/reselling/add-funds.md): Creates an order on the supplier's store that credits your balance with them once paid. Drawing stock and buying it in bulk both spend that balance, so this is what makes either possible. - [Get Payment Methods](https://docs.komerza.com/api-reference/endpoint/reselling/get-payment-methods.md): The supplier's own payment methods, since topping up is paid to them rather than to Komerza. Only readable by a store that actually holds a relationship with them — a merchant's enabled gateways are not public information. Requires the `stores.reselling.view` permission. - [Create Listing](https://docs.komerza.com/api-reference/endpoint/reselling/create-listing.md): Points one of this store's variants at a supplier's variant. Selling it then draws a unit from the supplier automatically — no delivery configuration of any kind is needed on this side. Requires the `stores.reselling.update` permission. - [Delete Listing](https://docs.komerza.com/api-reference/endpoint/reselling/delete-listing.md): The store's own product keeps existing and keeps selling; it just no longer draws from the supplier, which for a purely resold product means it can no longer be delivered. Worth unpublishing it at the same time. Requires the `stores.reselling.update` permission. - [Get Resold Products](https://docs.komerza.com/api-reference/endpoint/reselling/get-products.md): Every product of this store drawn from a supplier, with its cost, margin, and whether it would currently sell. A resold product can stop being deliverable without its owner touching anything — the supplier withdraws it, revokes them, raises the price past their ceiling, or runs out — so each carries… - [Get Linkable Accounts](https://docs.komerza.com/api-reference/endpoint/reselling/get-linkable.md): Relationships created by signing up on a supplier's own storefront, before this store existed or before you thought to use it. They have no store attached, so none of the reselling here applies to them and the supplier's panel keeps pointing you back at a dashboard that cannot see them. - [Link Account](https://docs.komerza.com/api-reference/endpoint/reselling/link-account.md): Attaches an off-platform reseller relationship to this store. From then on its draws are served in-process — stock lands on your own variants, there is no delivery URL to hold, and the balance already held with that supplier comes across untouched. Requires the `stores.reselling.update` permission. - [Accept Invitation](https://docs.komerza.com/api-reference/endpoint/reselling/accept-invite.md): Redeems an invite on behalf of the store in the route, which `PlatformAuthorize` has already proven you own. The relationship is approved outright — the supplier decided that when they sent it — and a draft product is created for everything the invite named, so you land on a dashboard with stock to… ### Webhooks - [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. - [Create Webhook](https://docs.komerza.com/api-reference/endpoint/webhooks/create.md): Creates a webhook that POSTs the events you subscribe to, for the stores you choose, as signed JSON. The signing secret is returned once here, so save it to verify the X-Signature header. Requires the `user.webhooks.create` 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. - [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. - [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 Logs](https://docs.komerza.com/api-reference/endpoint/webhooks/get-logs.md): Returns a webhook's delivery history: one entry per attempt, with the response code and, on failures, the reason. 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. - [Search Webhook Logs](https://docs.komerza.com/api-reference/endpoint/webhooks/search-logs.md): Searches logs by log ID, order ID (if the query is a valid GUID), or by URL fragment. All pagination and date/status filters from the listing endpoint are also supported. Requires the `user.webhooks.view` permission. ## OpenAPI Specs - [openapi](/api-reference/openapi.json)