> For the complete documentation index, see [llms.txt](https://docs.violet.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.violet.io/prism.md). # PRISM - [Quickstart](https://docs.violet.io/prism/overview.md) - [Create a Violet Application](https://docs.violet.io/prism/overview/create-a-violet-application.md) - [Login](https://docs.violet.io/prism/overview/postman-login.md) - [View Merchants](https://docs.violet.io/prism/overview/view-merchants.md) - [Get Merchants](https://docs.violet.io/prism/overview/view-merchants/get-merchants.md): What Merchants am I connected to? - [Get Merchant by ID](https://docs.violet.io/prism/overview/view-merchants/get-merchant-by-id.md): Get Individual Merchant Info - [Interact with Catalogs](https://docs.violet.io/prism/overview/interact-with-catalogs.md) - [List Connected Offers](https://docs.violet.io/prism/overview/interact-with-catalogs/list-connected-offers.md): Search and list Offers across all connected merchants - [Get Offers for a Merchant](https://docs.violet.io/prism/overview/interact-with-catalogs/get-offers-for-a-merchant.md): Get Offers for a Merchant by Merchant Id - [Get Details About a SKU](https://docs.violet.io/prism/overview/interact-with-catalogs/get-details-about-a-sku.md): Get details about a SKU given SKU ID - [Try 'Iterative Checkout'](https://docs.violet.io/prism/overview/place-an-order.md) - [Create Cart](https://docs.violet.io/prism/overview/place-an-order/create-cart.md): Create a new Cart with SKU 10064 in it. - [Apply Customer Info](https://docs.violet.io/prism/overview/place-an-order/apply-customer-info.md): Here we will apply customer info to the cart (including the address). - [Get Shipping Method](https://docs.violet.io/prism/overview/place-an-order/get-shipping-method.md): This will get the available shipping methods, it will return an array of shipping methods for each bag in the cart. - [Apply Shipping Method](https://docs.violet.io/prism/overview/place-an-order/apply-shipping-method.md): Set the shipping method for each bag within a cart. By passing in an array of Objects containing the bag id and associated shipping id. - [Apply Payment Method](https://docs.violet.io/prism/overview/place-an-order/payment-info.md): Apply a Payment Method for the Cart. - [Submit Cart](https://docs.violet.io/prism/overview/place-an-order/submit-cart.md): Submit a Cart, turning the Cart into an Order - [Violet Connect](https://docs.violet.io/prism/violet-connect.md) - [Setup](https://docs.violet.io/prism/violet-connect/setup.md): Follow these steps to get your Channel ready to connect merchants - [Payouts](https://docs.violet.io/prism/violet-connect/payouts.md) - [Commissions](https://docs.violet.io/prism/violet-connect/commissions.md) - [Guides](https://docs.violet.io/prism/violet-connect/guides.md) - [Pre-provisioning Merchant Data](https://docs.violet.io/prism/violet-connect/guides/pre-provisioning-merchant-data.md) - [Violet Connect for Channels](https://docs.violet.io/prism/violet-connect/guides/violet-connect-for-channels.md) - [Violet Connect for Merchants](https://docs.violet.io/prism/violet-connect/guides/violet-connect-for-merchants.md) - [Shopify Custom App Migration](https://docs.violet.io/prism/violet-connect/guides/shopify-custom-app-migration.md): Shopify now requires single-merchant custom apps for all new merchant connections - [Connection Health](https://docs.violet.io/prism/violet-connect/guides/connection-health.md) - [Detecting Merchants Connections](https://docs.violet.io/prism/violet-connect/guides/detecting-merchants-post-connection.md) - [Connecting your BigCommerce App](https://docs.violet.io/prism/violet-connect/guides/violet-connect-your-bigcommerce-app.md) - [Testing](https://docs.violet.io/prism/violet-connect/testing.md) - [Connecting a Shopify Store](https://docs.violet.io/prism/violet-connect/testing/connecting-a-shopify-store.md) - [FAQs](https://docs.violet.io/prism/violet-connect/faqs.md) - [Merchants](https://docs.violet.io/prism/merchants.md) - [Merchant Parity](https://docs.violet.io/prism/merchants/merchant-parity.md) - [Merchant App Connections](https://docs.violet.io/prism/merchants/merchant-app-connections.md) - [Merchant Enabled / Disabled](https://docs.violet.io/prism/merchants/merchant-enable-disable.md) - [Merchant Configurations](https://docs.violet.io/prism/merchants/merchant-configurations.md) - [Merchant Configuration Resources](https://docs.violet.io/prism/merchants/merchant-configuration-resources.md) - [Configuration](https://docs.violet.io/prism/merchants/configuration.md) - [How Violet shipping works with the merchant's platform](https://docs.violet.io/prism/merchants/configuration/shipping-and-your-platform.md) - [Choosing which shipping rates are passed through](https://docs.violet.io/prism/merchants/configuration/choosing-shipping-rates.md) - [Fallback shipping methods](https://docs.violet.io/prism/merchants/configuration/fallback-shipping-methods.md) - [When fallback methods are used](https://docs.violet.io/prism/merchants/configuration/when-fallback-methods-apply.md) - [Inventory location filters](https://docs.violet.io/prism/merchants/configuration/inventory-location-filters.md) - [How catalog rules work](https://docs.violet.io/prism/merchants/configuration/how-catalog-rules-work.md) - [Availability rules](https://docs.violet.io/prism/merchants/configuration/availability-rules.md) - [Exclusion rules](https://docs.violet.io/prism/merchants/configuration/exclusion-rules.md) - [Offer publishing and visibility](https://docs.violet.io/prism/merchants/configuration/offer-publishing-and-visibility.md) - [Catalog](https://docs.violet.io/prism/catalog.md) - [Offers](https://docs.violet.io/prism/catalog/offers.md) - [SKUs](https://docs.violet.io/prism/catalog/skus.md) - [Categories](https://docs.violet.io/prism/catalog/categories.md) - [Collections](https://docs.violet.io/prism/catalog/collections.md) - [Metadata](https://docs.violet.io/prism/catalog/metadata-syncing.md) - [Syncing SKU Metadata](https://docs.violet.io/prism/catalog/metadata-syncing/sku-metadata.md) - [Media Transformations](https://docs.violet.io/prism/catalog/media-transformations.md): Media Transformations allow you to resize offer media dynamically in the cloud, saving bandwidth and page load time when rendering PDPs - [Contextual Pricing](https://docs.violet.io/prism/catalog/contextual-pricing.md) - [Checkout](https://docs.violet.io/prism/checkout-guides.md) - [Checkout Guides](https://docs.violet.io/prism/checkout-guides/guides.md) - [Order and Bag States](https://docs.violet.io/prism/checkout-guides/guides/order-and-bag-states.md) - [Direct Order Submission](https://docs.violet.io/prism/checkout-guides/guides/direct-order-submission.md) - [Discounts with Direct Order Submission](https://docs.violet.io/prism/checkout-guides/guides/direct-order-submission-with-discounts.md) - [Custom Commission Rates](https://docs.violet.io/prism/checkout-guides/guides/custom-commission-rates.md) - [Utilizing Quick Checkout](https://docs.violet.io/prism/checkout-guides/guides/utilizing-quick-checkout.md) - [Checkout with Stripe.js v3](https://docs.violet.io/prism/checkout-guides/guides/violet-checkout-with-stripejs-v3.md): Violet Checkout using Stripe V3 Payments - [Checkout with Apple Pay or Google Pay](https://docs.violet.io/prism/checkout-guides/guides/violet-checkout-with-apple-pay.md): Violet Checkout using Apple Pay, Google Pay and other supported wallets - [Tax Remittance](https://docs.violet.io/prism/checkout-guides/guides/tax-remittance.md) - [Cross-Border Duties](https://docs.violet.io/prism/checkout-guides/guides/cross-border-duties.md) - [Calculating Duties with Avalara](https://docs.violet.io/prism/checkout-guides/guides/calculating-duties-with-avalara.md): How to use Avalara AvaTax Cross-Border to calculate import duties, then submit them on Violet orders. - [Marketing Consent](https://docs.violet.io/prism/checkout-guides/guides/marketing-consent.md): How marketing consent is captured and passed for orders via Violet. - [Carts & Bags](https://docs.violet.io/prism/checkout-guides/carts-and-bags.md) - [Carts](https://docs.violet.io/prism/checkout-guides/carts-and-bags/carts.md) - [Lifecycle of a Cart](https://docs.violet.io/prism/checkout-guides/carts-and-bags/carts/lifecycle-of-a-cart.md) - [Adding Items to Cart](https://docs.violet.io/prism/checkout-guides/carts-and-bags/carts/add-items-to-cart.md) - [Modify Items in Cart](https://docs.violet.io/prism/checkout-guides/carts-and-bags/carts/modify-items-in-cart.md) - [Applying Different Currencies](https://docs.violet.io/prism/checkout-guides/carts-and-bags/carts/currencies.md) - [Override Cart Prices](https://docs.violet.io/prism/checkout-guides/carts-and-bags/carts/override-prices.md) - [Bags](https://docs.violet.io/prism/checkout-guides/carts-and-bags/bags.md) - [Lifecycle of a Bag](https://docs.violet.io/prism/checkout-guides/carts-and-bags/bags/lifecycle-of-a-bag.md) - [States of a Bag](https://docs.violet.io/prism/checkout-guides/carts-and-bags/bags/states-of-a-bag.md): Post-Submission states and sub-states of a bag - [Customers](https://docs.violet.io/prism/checkout-guides/carts-and-bags/customers.md) - [Shipping Methods](https://docs.violet.io/prism/checkout-guides/carts-and-bags/shipping-methods.md) - [Discounts](https://docs.violet.io/prism/checkout-guides/discounts.md) - [Applying And Removing Discounts](https://docs.violet.io/prism/checkout-guides/discounts/applying-discounts.md) - [Current Platforms](https://docs.violet.io/prism/checkout-guides/current-platforms.md) - [Payments](https://docs.violet.io/prism/payments.md) - [Payment Integrations](https://docs.violet.io/prism/payments/payment-integrations.md) - [Supported Providers](https://docs.violet.io/prism/payments/payment-integrations/supported-providers.md) - [Stripe](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/stripe.md) - [Stripe Platform Accounts](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/stripe/stripe-platform-account.md) - [Stripe KYC Guide](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/stripe/channel-kyc-guide.md) - [Connecting a Stripe Platform Account](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/stripe/connecting-a-platform-stripe-account.md) - [Stripe Scopes](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/stripe/required-stripe-scopes.md) - [Stripe Connect](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/stripe/stripe-connect.md) - [Stripe Elements](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/stripe/stripe-elements.md) - [Wallet-based Payments](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/stripe/wallet-based-payments.md) - [Payment Integration Health](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/stripe/payment-integration-health.md) - [Apple Pay](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/apple-pay.md) - [Google Pay](https://docs.violet.io/prism/payments/payment-integrations/supported-providers/google-pay.md) - [Bypassing Payments](https://docs.violet.io/prism/payments/payment-integrations/bypassing-payments-through-violet.md) - [Payment Settings](https://docs.violet.io/prism/payments/payment-settings.md) - [Capture Settings](https://docs.violet.io/prism/payments/payment-settings/capture-settings.md) - [Transfer Settings](https://docs.violet.io/prism/payments/payment-settings/transfer-settings.md) - [Transfer Mechanisms](https://docs.violet.io/prism/payments/payment-settings/transfer-mechanisms.md) - [Scheduled Transfers](https://docs.violet.io/prism/payments/payment-settings/scheduled-transfers.md) - [Tax Remitter Settings](https://docs.violet.io/prism/payments/payment-settings/tax-remitter-settings.md) - [Country-Specific Restrictions](https://docs.violet.io/prism/payments/payment-settings/supported-countries.md) - [Setup](https://docs.violet.io/prism/payments/setup.md) - [Demo Mode](https://docs.violet.io/prism/payments/setup/demo-mode.md) - [Test Mode](https://docs.violet.io/prism/payments/setup/test-mode.md) - [Requirements](https://docs.violet.io/prism/payments/setup/test-mode/test-mode-requirements.md) - [Live Mode](https://docs.violet.io/prism/payments/setup/live-mode.md) - [Requirements](https://docs.violet.io/prism/payments/setup/live-mode/live-mode-requirements.md) - [Payments during Checkout](https://docs.violet.io/prism/payments/payments-during-checkout.md) - [Payment Transactions](https://docs.violet.io/prism/payments/payments-during-checkout/payment-transactions.md) - [Transfers](https://docs.violet.io/prism/payments/payments-during-checkout/transfers.md) - [Transfer Reversals](https://docs.violet.io/prism/payments/payments-during-checkout/transfer-reversals.md) - [Order Transfer Groups](https://docs.violet.io/prism/payments/payments-during-checkout/order-transfer-groups.md) - [Fee Structure](https://docs.violet.io/prism/payments/payments-during-checkout/fee-structure.md) - [Supported Currencies](https://docs.violet.io/prism/payments/payments-during-checkout/supported-currencies.md) - [Guides](https://docs.violet.io/prism/payments/payments-during-checkout/guides.md) - [Handling Failed Transfers](https://docs.violet.io/prism/payments/payments-during-checkout/guides/handling-failed-transfers.md) - [Using Custom Transfers](https://docs.violet.io/prism/payments/payments-during-checkout/guides/using-custom-transfers.md) - [Using External Transfers](https://docs.violet.io/prism/payments/payments-during-checkout/guides/using-external-transfers.md) - [Creating Stripe Dashboard Transfers](https://docs.violet.io/prism/payments/payments-during-checkout/guides/creating-stripe-dashboard-transfers.md) - [Payouts](https://docs.violet.io/prism/payments/payouts.md) - [Prism Payout Accounts](https://docs.violet.io/prism/payments/payouts/prism-payout-accounts.md) - [Payout Account Setup](https://docs.violet.io/prism/payments/payouts/prism-payout-accounts/setting-up-a-payout-account.md) - [Delete Prism Payout Account](https://docs.violet.io/prism/payments/payouts/prism-payout-accounts/delete-payout-accounts.md) - [Commission Rates](https://docs.violet.io/prism/payments/payouts/commission-rates.md) - [Commission Base: Tax, Duty and Discounts](https://docs.violet.io/prism/payments/payouts/commission-base.md): Exactly which part of an order Violet charges commission on, how tax is taken out of tax-inclusive prices using a retailer's tax profile, and how duty and discounts are treated, on the sale and on ref - [Return Commission Policy](https://docs.violet.io/prism/payments/payouts/return-commission-policy.md): Choose whether a retailer's commission is reversed or retained when a sale is refunded, set it per retailer through the API, and see exactly how each refund is calculated. - [Retained Commission Recovery](https://docs.violet.io/prism/payments/payouts/commission-recovery.md): How Violet recovers commission a channel keeps under the RETAIN return policy: when a recovery case opens, which payouts it draws on and in what order, its statuses, and what you see in Stripe and in - [Recovery Cases API](https://docs.violet.io/prism/payments/payouts/commission-recovery/recovery-cases-api.md): List and read retained-commission recovery cases and their allocations: endpoints, parameters, permissions, fields and errors. - [Net Receipts](https://docs.violet.io/prism/payments/payouts/net-receipts.md): How Net Receipts works: the per-retailer fee settings you control through the API, submitting per-bag transaction fees, how they change the commission split, the wait for a fee, refunds, and hold case - [Supported Countries](https://docs.violet.io/prism/payments/payouts/supported-countries.md) - [Distributions](https://docs.violet.io/prism/payments/payouts/distributions.md) - [Accessing Distributions via API](https://docs.violet.io/prism/payments/payouts/distributions/distributions-apis.md) - [Examples](https://docs.violet.io/prism/payments/payouts/distributions/distributions-examples.md) - [Guides](https://docs.violet.io/prism/payments/payouts/guides.md) - [Funds Flow & Payout Timing](https://docs.violet.io/prism/payments/payouts/guides/funds-flow-timing.md): Understanding when and how merchants receive their money through Violet with Stripe - [Stripe KYC Guide](https://docs.violet.io/prism/payments/payouts/guides/stripe-kyc-guide.md) - [Disputes](https://docs.violet.io/prism/payments/disputes.md) - [Webhooks](https://docs.violet.io/prism/webhooks.md) - [Managing Webhooks](https://docs.violet.io/prism/webhooks/managing-webhooks.md) - [Webhook Headers](https://docs.violet.io/prism/webhooks/managing-webhook-headers.md) - [Simulating Webhook Events](https://docs.violet.io/prism/webhooks/simulating-webhook-events.md) - [Handling Webhooks](https://docs.violet.io/prism/webhooks/handling-webhooks.md) - [Webhook Events](https://docs.violet.io/prism/webhooks/events.md) - [Orders](https://docs.violet.io/prism/webhooks/events/order-webhooks.md) - [Merchants](https://docs.violet.io/prism/webhooks/events/merchant-webhooks.md) - [Offers](https://docs.violet.io/prism/webhooks/events/offer-webhooks.md) - [Collections](https://docs.violet.io/prism/webhooks/events/collection-webhooks.md) - [Syncs](https://docs.violet.io/prism/webhooks/events/sync-webhooks.md) - [Payout Accounts](https://docs.violet.io/prism/webhooks/events/payout-account-webhooks.md) - [Payment Transactions](https://docs.violet.io/prism/webhooks/events/payment-transaction-webhooks.md) - [Transfers](https://docs.violet.io/prism/webhooks/events/transfer-webhooks.md) - [Recovery Cases](https://docs.violet.io/prism/webhooks/events/recovery-case-webhooks.md) - [Disputes](https://docs.violet.io/prism/webhooks/events/dispute-webhooks.md) - [Retrieving Webhook Events](https://docs.violet.io/prism/webhooks/retrieving-webhook-events.md) - [Reporting](https://docs.violet.io/prism/reporting.md) - [Commission Rate Log](https://docs.violet.io/prism/reporting/commission-rate-change-log.md) - [Available Columns](https://docs.violet.io/prism/reporting/commission-rate-change-log/columns.md) - [Connected Merchants](https://docs.violet.io/prism/reporting/connected-merchants.md) - [Available Columns](https://docs.violet.io/prism/reporting/connected-merchants/columns.md) - [Distributions](https://docs.violet.io/prism/reporting/distributions.md) - [Available Columns](https://docs.violet.io/prism/reporting/distributions/columns.md) - [Payouts](https://docs.violet.io/prism/reporting/payouts.md) - [Available Columns](https://docs.violet.io/prism/reporting/payouts/columns.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.violet.io/prism.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.