# V I O L E T Docs ## Channel Docs - [Welcome to Violet](https://docs.violet.io/readme.md): We're glad you're here 💜 - [Change Log](https://docs.violet.io/changelog.md): Learn about Violet's latest integrations and features. - [Merchant Help Center](https://docs.violet.io/merchant-help-center.md) - [Apps](https://docs.violet.io/concepts/apps.md) - [Pagination](https://docs.violet.io/concepts/pagination.md) - [Rate Limits](https://docs.violet.io/concepts/rate-limits.md): Handling rate limits with Violet - [Authentication](https://docs.violet.io/concepts/overview.md) - [Initial Authentication](https://docs.violet.io/concepts/overview/obtaining-api-token.md) - [Making Authenticated Requests](https://docs.violet.io/concepts/overview/making-authenticated-requests.md) - [Token Refresh Management](https://docs.violet.io/concepts/overview/token-refresh-management.md) - [Environments](https://docs.violet.io/concepts/environments.md) - [Definitions](https://docs.violet.io/concepts/definitions.md) - [Overview](https://docs.violet.io/ecom-platforms/ecom-platforms.md): Platform-specific guides for connecting merchants to Violet across supported ecommerce platforms - [Shopify](https://docs.violet.io/ecom-platforms/shopify.md): Complete guide for onboarding Shopify merchants using pre-registration in Channel Dashboard - [Prerequisites](https://docs.violet.io/ecom-platforms/shopify/prerequisites.md) - [Shopify App Setup](https://docs.violet.io/ecom-platforms/shopify/shopify-app-setup.md) - [Pre-Registration Process](https://docs.violet.io/ecom-platforms/shopify/pre-registration.md) - [Merchant Onboarding](https://docs.violet.io/ecom-platforms/shopify/merchant-onboarding.md) - [Global-E x Shopify](https://docs.violet.io/ecom-platforms/shopify/global-e.md) - [Troubleshooting & FAQs](https://docs.violet.io/ecom-platforms/shopify/troubleshooting-faqs.md) - [BigCommerce](https://docs.violet.io/ecom-platforms/bigcommerce.md): Overview of Violet's BigCommerce integration for channel developers - [WooCommerce](https://docs.violet.io/ecom-platforms/woocommerce.md): Overview of Violet's WooCommerce integration for channel developers - [Magento](https://docs.violet.io/ecom-platforms/magento.md): Overview of Violet's Magento (Adobe Commerce) integration for channel developers - [Salesforce Commerce Cloud](https://docs.violet.io/ecom-platforms/salesforce-commerce-cloud.md): Overview of Violet's Salesforce Commerce Cloud (SFCC) integration for channel developers - [CommerceTools](https://docs.violet.io/ecom-platforms/commercetools.md): Overview of Violet's commercetools integration for channel developers - [Centra](https://docs.violet.io/ecom-platforms/centra.md): Overview of Violet's Centra integration for channel developers - [PrestaShop](https://docs.violet.io/ecom-platforms/prestashop.md): Overview of Violet's PrestaShop integration for channel developers - [Ecwid](https://docs.violet.io/ecom-platforms/ecwid.md): Overview of Violet's Ecwid (Lightspeed eCom) integration for channel developers - [Wix](https://docs.violet.io/ecom-platforms/wix.md): Overview of Violet's Wix integration for channel developers - [Squarespace](https://docs.violet.io/ecom-platforms/squarespace.md): Overview of Violet's Squarespace integration for channel developers - [Swell](https://docs.violet.io/ecom-platforms/swell.md): Overview of Violet's Swell integration for channel developers - [Spree Commerce](https://docs.violet.io/ecom-platforms/spree.md): Overview of Violet's Spree Commerce integration for channel developers - [Vendo](https://docs.violet.io/ecom-platforms/vendo.md): Overview of Violet's Vendo integration for channel developers - [Miva Merchant](https://docs.violet.io/ecom-platforms/miva.md): Overview of Violet's Miva Merchant integration for channel developers - [Shoprenter](https://docs.violet.io/ecom-platforms/shoprenter.md): Overview of Violet's Shoprenter integration for channel developers - [SAP Commerce Cloud](https://docs.violet.io/ecom-platforms/sap-commerce-cloud.md): Overview of Violet's SAP Commerce Cloud integration for channel developers - [Oracle Commerce Cloud](https://docs.violet.io/ecom-platforms/oracle-commerce-cloud.md): Overview of Violet's Oracle Commerce Cloud integration for channel developers - [Rithum](https://docs.violet.io/ecom-platforms/rithum.md): Overview of Violet's Rithum integration for channel developers - [Lightspeed eCom](https://docs.violet.io/ecom-platforms/lightspeed.md): Overview of Violet's Lightspeed eCom integration for channel developers - [3dcart / Shift4Shop](https://docs.violet.io/ecom-platforms/3dcart.md): Overview of Violet's 3dcart (Shift4Shop) integration for channel developers - [Shoptet](https://docs.violet.io/ecom-platforms/shoptet.md): Overview of Violet's Shoptet integration for channel developers - [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) - [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) - [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) - [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) - [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) - [Resources](https://docs.violet.io/resources.md) - [Channel Dashboard](https://docs.violet.io/resources/channel-dashboard.md) - [Merchant Dashboard](https://docs.violet.io/resources/merchant-dashboard.md) - [FAQs](https://docs.violet.io/faqs.md): Find quick answers to the most commonly asked questions about integrating with Violet's unified checkout API. - [Catalog](https://docs.violet.io/faqs/catalog.md): Questions relating to Catalog and Offers. - [Checkout](https://docs.violet.io/faqs/checkout.md): Questions relating to the Checkout API flow. - [Shipping](https://docs.violet.io/faqs/checkout/shipping.md): Questions relating to shipping within the Checkout API flow. - [Shopify Questions](https://docs.violet.io/faqs/checkout/shopify-questions.md): Questions relating to Shopify within the Checkout API flow. - [Discounts](https://docs.violet.io/faqs/discounts.md): Questions relating to Discounts. - [Distributions](https://docs.violet.io/faqs/distributions.md): Questions relating to payout distributions and order adjustments. - [Login](https://docs.violet.io/faqs/login.md): Questions relating to logging into the API and authenticating/authorizing requests. - [Payments](https://docs.violet.io/faqs/payments.md): Questions relating to payments, i.e. accepting money from shoppers during checkout. - [What is Relay?](https://docs.violet.io/relay/relay.md): Access real-time data in external commerce platforms - [Relay Offers](https://docs.violet.io/relay/get-offers.md) - [Relay Orders](https://docs.violet.io/relay/get-orders.md) - [Relay Collections](https://docs.violet.io/relay/get-collections.md) - [Relay Shipping Zones](https://docs.violet.io/relay/get-shipping-zones.md) - [Webhooks](https://docs.violet.io/relay/webhooks.md) - [Current Platforms](https://docs.violet.io/relay/current-platforms.md) - [Support Request](https://docs.violet.io/help/support-request.md) - [Security](https://docs.violet.io/help/security.md) - [Violet SLA](https://docs.violet.io/help/violet-sla.md) ## API Reference - [Overview](https://docs.violet.io/api-reference/readme.md): Violet API Reference - [Authenticate](https://docs.violet.io/api-reference/auth/login.md) - [Refresh Access Token](https://docs.violet.io/api-reference/auth/refresh-token.md) - [Merchant Onboarding](https://docs.violet.io/api-reference/onboarding/merchant-onboarding.md) - [Create Merchant Onboarding Record](https://docs.violet.io/api-reference/onboarding/merchant-onboarding/create-merchant-onboarding-record.md) - [Get Merchant Onboarding Record](https://docs.violet.io/api-reference/onboarding/merchant-onboarding/get-merchant-onboarding-record.md) - [Get All Merchant Onboarding Records](https://docs.violet.io/api-reference/onboarding/merchant-onboarding/list-merchant-onboarding-records.md) - [Update Merchant Onboarding Record](https://docs.violet.io/api-reference/onboarding/merchant-onboarding/update-merchant-onboarding-record.md) - [Merchant](https://docs.violet.io/api-reference/merchants/merchant.md) - [Get Merchants](https://docs.violet.io/api-reference/merchants/merchant/get-merchants.md) - [Get Merchant](https://docs.violet.io/api-reference/merchants/merchant/get-merchant-by-id.md) - [Search Merchants](https://docs.violet.io/api-reference/merchants/merchant/merchants-search.md) - [Configuration](https://docs.violet.io/api-reference/merchants/configuration.md) - [Get Merchant Configuration](https://docs.violet.io/api-reference/merchants/configuration/get-merchant-configuration.md) - [Toggle Global Feature Flag](https://docs.violet.io/api-reference/merchants/configuration/toggle-merchant-configuration-global-feature-flag.md) - [Modify Merchant Order Config](https://docs.violet.io/api-reference/merchants/configuration/modify-merchant-order-configuration.md) - [Onboarding](https://docs.violet.io/api-reference/merchants/onboarding.md) - [Get Violet Connect URLs](https://docs.violet.io/api-reference/merchants/onboarding/get-vc-urls.md) - [Explore](https://docs.violet.io/api-reference/merchants/explore.md) - [Merchants Explore](https://docs.violet.io/api-reference/merchants/explore/merchants-explore.md) - [Catalog Rules](https://docs.violet.io/api-reference/merchants/catalog-rules.md) - [Get Merchant Catalog Rules](https://docs.violet.io/api-reference/merchants/catalog-rules/get-catalog-rules.md) - [Create or Replace Availability Rule](https://docs.violet.io/api-reference/merchants/catalog-rules/put-availability-rule.md) - [Delete Availability Rule](https://docs.violet.io/api-reference/merchants/catalog-rules/delete-availability-rule.md) - [Create or Replace Exclusion Rule](https://docs.violet.io/api-reference/merchants/catalog-rules/put-exclusion-rule.md) - [Delete Exclusion Rule](https://docs.violet.io/api-reference/merchants/catalog-rules/delete-exclusion-rule.md) - [Catalog Settings](https://docs.violet.io/api-reference/merchants/catalog-settings.md) - [Get Merchant Catalog Settings](https://docs.violet.io/api-reference/merchants/catalog-settings/get-catalog-settings.md) - [Update Merchant Catalog Settings](https://docs.violet.io/api-reference/merchants/catalog-settings/update-catalog-settings.md) - [Inventory](https://docs.violet.io/api-reference/merchants/inventory.md) - [Get Inventory Location Filters](https://docs.violet.io/api-reference/merchants/inventory/get-inventory-location-filters.md) - [Replace Inventory Location Filters](https://docs.violet.io/api-reference/merchants/inventory/replace-inventory-location-filters.md) - [Shipping](https://docs.violet.io/api-reference/merchants/shipping.md) - [List Fallback Shipping Methods](https://docs.violet.io/api-reference/merchants/shipping/list-shipping-methods.md) - [Create Fallback Shipping Method](https://docs.violet.io/api-reference/merchants/shipping/create-shipping-method.md) - [Get Fallback Shipping Method](https://docs.violet.io/api-reference/merchants/shipping/get-shipping-method.md) - [Create or Replace Fallback Shipping Method](https://docs.violet.io/api-reference/merchants/shipping/put-shipping-method.md) - [Delete Fallback Shipping Method](https://docs.violet.io/api-reference/merchants/shipping/delete-shipping-method.md) - [Get Merchant Shipping Settings](https://docs.violet.io/api-reference/merchants/shipping/get-shipping-settings.md) - [Update Merchant Shipping Settings](https://docs.violet.io/api-reference/merchants/shipping/update-shipping-settings.md) - [Offers](https://docs.violet.io/api-reference/catalog/offers.md) - [Get All Merchant Offers](https://docs.violet.io/api-reference/catalog/offers/get-all-merchant-offers.md) - [Get All Merchant Offers (Lightweight)](https://docs.violet.io/api-reference/catalog/offers/get-all-merchant-offers-lightweight.md) - [Get Count of Merchant Offers](https://docs.violet.io/api-reference/catalog/offers/count-merchant-offers.md) - [Get Offer by ID](https://docs.violet.io/api-reference/catalog/offers/get-offer-by-id.md) - [Search Offers](https://docs.violet.io/api-reference/catalog/offers/search-offers.md) - [SKUs](https://docs.violet.io/api-reference/catalog/skus.md) - [Get SKU by ID](https://docs.violet.io/api-reference/catalog/skus/get-sku-by-id.md) - [Categories](https://docs.violet.io/api-reference/catalog/categories.md) - [Get Categories](https://docs.violet.io/api-reference/catalog/categories/get-categories.md) - [Get Category by ID](https://docs.violet.io/api-reference/catalog/categories/get-category-by-id.md) - [Get Category by Slug](https://docs.violet.io/api-reference/catalog/categories/get-category-by-slug.md) - [Get Category Tree](https://docs.violet.io/api-reference/catalog/categories/get-category-tree.md) - [Search Categories](https://docs.violet.io/api-reference/catalog/categories/search-categories.md) - [Collections](https://docs.violet.io/api-reference/catalog/collections.md) - [Get All Collections](https://docs.violet.io/api-reference/catalog/collections/get-collections.md) - [Get All Merchant Collections](https://docs.violet.io/api-reference/catalog/collections/get-all-merchant-collections.md) - [Get Collection by ID](https://docs.violet.io/api-reference/catalog/collections/get-collection-by-id.md) - [Get Collection Offers](https://docs.violet.io/api-reference/catalog/collections/get-collection-offers.md) - [Get Collection Offers IDs](https://docs.violet.io/api-reference/catalog/collections/get-collection-offers-ids.md) - [Currencies](https://docs.violet.io/api-reference/catalog/currencies.md) - [Currency Exchange Rates](https://docs.violet.io/api-reference/catalog/currencies/currency-exchange-rates.md) - [Carts](https://docs.violet.io/api-reference/orders-and-checkout/carts.md) - [Create Cart](https://docs.violet.io/api-reference/orders-and-checkout/carts/create-cart.md) - [Get Cart by ID](https://docs.violet.io/api-reference/orders-and-checkout/carts/get-cart-by-id.md) - [Delete Cart](https://docs.violet.io/api-reference/orders-and-checkout/carts/delete-cart.md) - [Cart Items](https://docs.violet.io/api-reference/orders-and-checkout/cart-items.md) - [Add SKU to Cart](https://docs.violet.io/api-reference/orders-and-checkout/cart-items/add-sku-to-cart.md) - [Update SKU in Cart](https://docs.violet.io/api-reference/orders-and-checkout/cart-items/update-sku-in-cart.md) - [Remove SKU from Cart](https://docs.violet.io/api-reference/orders-and-checkout/cart-items/remove-sku-from-cart.md) - [Cart Customer](https://docs.violet.io/api-reference/orders-and-checkout/cart-customer.md) - [Apply Customer to Cart](https://docs.violet.io/api-reference/orders-and-checkout/cart-customer/apply-customer-to-cart.md) - [Set Shipping Address](https://docs.violet.io/api-reference/orders-and-checkout/cart-customer/set-shipping-address.md) - [Set Billing Address](https://docs.violet.io/api-reference/orders-and-checkout/cart-customer/set-billing-address.md) - [Cart Discounts](https://docs.violet.io/api-reference/orders-and-checkout/cart-discounts.md) - [Add Discount to Cart](https://docs.violet.io/api-reference/orders-and-checkout/cart-discounts/add-discount-to-cart.md) - [Remove Discount from Cart](https://docs.violet.io/api-reference/orders-and-checkout/cart-discounts/remove-discount-from-cart.md) - [Cart Shipping](https://docs.violet.io/api-reference/orders-and-checkout/cart-shipping.md) - [Get Available Shipping Methods](https://docs.violet.io/api-reference/orders-and-checkout/cart-shipping/get-available-shipping-methods.md) - [Set Shipping Methods](https://docs.violet.io/api-reference/orders-and-checkout/cart-shipping/set-shipping-methods.md) - [Remove Shipping Method](https://docs.violet.io/api-reference/orders-and-checkout/cart-shipping/remove-shipping-method.md) - [Cart Pricing](https://docs.violet.io/api-reference/orders-and-checkout/cart-pricing.md) - [Price Cart](https://docs.violet.io/api-reference/orders-and-checkout/cart-pricing/price-cart.md) - [Estimate Cart](https://docs.violet.io/api-reference/orders-and-checkout/cart-pricing/estimate-cart.md) - [Cart Payment](https://docs.violet.io/api-reference/orders-and-checkout/cart-payment.md) - [Apply Payment Method](https://docs.violet.io/api-reference/orders-and-checkout/cart-payment/apply-payment-method.md) - [Update Payment Transaction](https://docs.violet.io/api-reference/orders-and-checkout/cart-payment/update-payment-transaction.md) - [Cart Completion](https://docs.violet.io/api-reference/orders-and-checkout/cart-completion.md) - [Submit Cart](https://docs.violet.io/api-reference/orders-and-checkout/cart-completion/submit-cart.md) - [Orders](https://docs.violet.io/api-reference/orders-and-checkout/orders.md) - [Estimate Order](https://docs.violet.io/api-reference/orders-and-checkout/orders/estimate-order.md) - [Create Order](https://docs.violet.io/api-reference/orders-and-checkout/orders/create-order.md) - [Get Orders](https://docs.violet.io/api-reference/orders-and-checkout/orders/get-orders.md) - [Get Order by ID](https://docs.violet.io/api-reference/orders-and-checkout/orders/get-order-by-id.md) - [Search Orders](https://docs.violet.io/api-reference/orders-and-checkout/orders/search-orders.md) - [Search Bags](https://docs.violet.io/api-reference/orders-and-checkout/orders/search-bags.md) - [Order Refunds](https://docs.violet.io/api-reference/orders-and-checkout/order-refunds.md) - [Refund Bag](https://docs.violet.io/api-reference/orders-and-checkout/order-refunds/refund-bag.md) - [Get Order Refunds](https://docs.violet.io/api-reference/orders-and-checkout/order-refunds/get-order-refunds.md) - [Get Bag Refunds](https://docs.violet.io/api-reference/orders-and-checkout/order-refunds/get-bag-refunds.md) - [Get Order Refund by ID](https://docs.violet.io/api-reference/orders-and-checkout/order-refunds/get-order-refund-by-id.md) - [Order Cancellations](https://docs.violet.io/api-reference/orders-and-checkout/order-cancellations.md) - [Cancel Order](https://docs.violet.io/api-reference/orders-and-checkout/order-cancellations/cancel-order.md) - [Cancel Bag](https://docs.violet.io/api-reference/orders-and-checkout/order-cancellations/cancel-bag.md) - [Get Order Cancellations](https://docs.violet.io/api-reference/orders-and-checkout/order-cancellations/get-order-cancellations.md) - [Order Adjustments](https://docs.violet.io/api-reference/orders-and-checkout/order-adjustments.md) - [Get Order Adjustments](https://docs.violet.io/api-reference/orders-and-checkout/order-adjustments/get-order-adjustments.md) - [Get Bag Adjustments](https://docs.violet.io/api-reference/orders-and-checkout/order-adjustments/get-bag-adjustments.md) - [Create Bag Adjustment](https://docs.violet.io/api-reference/orders-and-checkout/order-adjustments/create-bag-adjustment.md) - [Get Bag Adjustment by ID](https://docs.violet.io/api-reference/orders-and-checkout/order-adjustments/get-bag-adjustment-by-id.md) - [Bag Transaction Fees](https://docs.violet.io/api-reference/orders-and-checkout/bag-transaction-fees.md) - [Submit Transaction Fee for Bag](https://docs.violet.io/api-reference/orders-and-checkout/bag-transaction-fees/submit-bag-transaction-fee.md) - [Transfers](https://docs.violet.io/api-reference/orders-and-checkout/transfers.md) - [Process Transfers for a single Order](https://docs.violet.io/api-reference/orders-and-checkout/transfers/transfer-funds-single-order.md) - [Process Transfers for a single Bag](https://docs.violet.io/api-reference/orders-and-checkout/transfers/transfer-funds-single-bag.md) - [Process Transfers for Orders](https://docs.violet.io/api-reference/orders-and-checkout/transfers/transfer-funds-multiple-orders.md) - [Process Transfers for Bags](https://docs.violet.io/api-reference/orders-and-checkout/transfers/transfer-funds-multiple-bags.md) - [Get Transfer Group for Bag](https://docs.violet.io/api-reference/orders-and-checkout/transfers/get-bag-transfer-group.md) - [Get Transfer Group for Order](https://docs.violet.io/api-reference/orders-and-checkout/transfers/get-order-transfer-group.md) - [Get Bag Transfer Groups](https://docs.violet.io/api-reference/orders-and-checkout/transfers/get-bag-transfer-groups.md) - [Get Order Transfer Groups](https://docs.violet.io/api-reference/orders-and-checkout/transfers/get-order-transfer-groups.md) - [Payout Accounts](https://docs.violet.io/api-reference/payments/payout-accounts.md) - [Get Payout Account](https://docs.violet.io/api-reference/payments/payout-accounts/get-payout-account.md) - [Get all Payout Accounts for a Merchant](https://docs.violet.io/api-reference/payments/payout-accounts/get-payout-accounts.md) - [Get Payout Account by ID](https://docs.violet.io/api-reference/payments/payout-accounts/get-payout-account-by-id.md) - [Delete Payout Account](https://docs.violet.io/api-reference/payments/payout-accounts/delete-payout-account-by-id.md) - [Distributions](https://docs.violet.io/api-reference/payments/distributions.md) - [Get Distributions](https://docs.violet.io/api-reference/payments/distributions/get-distributions.md) - [Search Distributions](https://docs.violet.io/api-reference/payments/distributions/search-distributions.md) - [Transfers](https://docs.violet.io/api-reference/payments/transfers.md) - [Get Transfer](https://docs.violet.io/api-reference/payments/transfers/get-transfer-by-id.md) - [Get Transfer by Payment Provider Transfer ID](https://docs.violet.io/api-reference/payments/transfers/get-transfer-by-payment-provider-transfer-id.md) - [Search Transfers](https://docs.violet.io/api-reference/payments/transfers/search-transfers.md) - [Get Pending Transfers](https://docs.violet.io/api-reference/payments/transfers/get-pending-transfers.md) - [Register an External Transfer made External to Violet](https://docs.violet.io/api-reference/payments/transfers/register-external-transfer.md) - [Transfer Reversals](https://docs.violet.io/api-reference/payments/transfer-reversals.md) - [Get Transfer Reversal](https://docs.violet.io/api-reference/payments/transfer-reversals/get-transfer-reversal-by-id.md) - [Get Transfer Reversals by Transfer ID](https://docs.violet.io/api-reference/payments/transfer-reversals/get-transfer-reversals-by-transfer-id.md) - [Get Transfer Reversal by Payment Provider Transfer ID](https://docs.violet.io/api-reference/payments/transfer-reversals/get-transfer-reversals-by-payment-provider-transfer-id.md) - [Search Transfer Reversals](https://docs.violet.io/api-reference/payments/transfer-reversals/search-transfer-reversals.md) - [Webhooks](https://docs.violet.io/api-reference/events/webhooks.md) - [Get Webhooks](https://docs.violet.io/api-reference/events/webhooks/get-webhooks.md) - [Create Webhook](https://docs.violet.io/api-reference/events/webhooks/create-webhook.md) - [Delete Channel Webhooks](https://docs.violet.io/api-reference/events/webhooks/delete-channel-webhooks.md) - [Update Webhooks Status](https://docs.violet.io/api-reference/events/webhooks/update-webhooks-status.md) - [Get Webhook](https://docs.violet.io/api-reference/events/webhooks/get-webhook.md) - [Update Webhook](https://docs.violet.io/api-reference/events/webhooks/update-webhook.md) - [Delete Webhook](https://docs.violet.io/api-reference/events/webhooks/delete-webhook.md) - [Webhook Events](https://docs.violet.io/api-reference/events/webhook-events.md) - [Get All Webhook Events](https://docs.violet.io/api-reference/events/webhook-events/get-all-webhook-events.md) - [Search All Webhook Events](https://docs.violet.io/api-reference/events/webhook-events/search-all-webhook-events.md) - [Get Webhook Event Types](https://docs.violet.io/api-reference/events/webhook-events/get-webhook-event-types.md) - [Get Webhook Events](https://docs.violet.io/api-reference/events/webhook-events/get-webhook-events.md) - [Get Webhook Event](https://docs.violet.io/api-reference/events/webhook-events/get-webhook-event.md) - [Get Webhook Event Body](https://docs.violet.io/api-reference/events/webhook-events/get-webhook-event-body.md) - [Get Webhook Event Headers](https://docs.violet.io/api-reference/events/webhook-events/get-webhook-event-headers.md) - [Simulate Webhook Event](https://docs.violet.io/api-reference/events/webhook-events/simulate-webhook-event.md) - [Resend Webhook Event by Event ID](https://docs.violet.io/api-reference/events/webhook-events/resend-webhook-event-by-id.md) - [Resend Latest Webhook Event by Entity ID](https://docs.violet.io/api-reference/events/webhook-events/resend-webhook-event-by-entity-id.md) - [Cancel Webhook Event by Event ID](https://docs.violet.io/api-reference/events/webhook-events/cancel-webhook-event-by-id.md) - [Webhook Headers](https://docs.violet.io/api-reference/events/webhook-headers.md) - [Get Webhook Headers](https://docs.violet.io/api-reference/events/webhook-headers/get-webhook-headers.md) - [Create Webhook Header](https://docs.violet.io/api-reference/events/webhook-headers/create-webhook-header.md) - [Get Webhook Header](https://docs.violet.io/api-reference/events/webhook-headers/get-webhook-header.md) - [Update Webhook Header](https://docs.violet.io/api-reference/events/webhook-headers/update-webhook-header.md) - [Delete Webhook Header](https://docs.violet.io/api-reference/events/webhook-headers/delete-webhook-header.md) - [Merchant/App Installs](https://docs.violet.io/api-reference/apps/merchant-app-installs.md) - [Merchant App Uninstall](https://docs.violet.io/api-reference/apps/merchant-app-installs/request-merchant-app-uninstall.md) - [Bulk Merchant App Uninstall](https://docs.violet.io/api-reference/apps/merchant-app-installs/request-merchant-app-uninstall-bulk.md) - [Commission Rates](https://docs.violet.io/api-reference/apps/commission-rates.md) - [Set Merchant/Channel Commission Rate](https://docs.violet.io/api-reference/apps/commission-rates/set-merchant-app-commission-rate.md) - [Search All Commission Rates Change Log](https://docs.violet.io/api-reference/apps/commission-rates/get-commission-rate-change-log.md) - [Connection](https://docs.violet.io/api-reference/operations/connection.md) - [Get Connection Health](https://docs.violet.io/api-reference/operations/connection/get-connection-health.md) - [Search Connection Health](https://docs.violet.io/api-reference/operations/connection/search-connection-health.md) - [Get Connection Health Report](https://docs.violet.io/api-reference/operations/connection/get-connection-health-report-by-merchant-id.md) - [Get Custom Connection Health Report](https://docs.violet.io/api-reference/operations/connection/get-custom-connection-health-report-by-merchant-id.md) - [Shipping](https://docs.violet.io/api-reference/relay/shipping.md) - [Get Shipping Zones](https://docs.violet.io/api-reference/relay/shipping/get-shipping-zones.md) - [Offers](https://docs.violet.io/api-reference/ecom-syncs/offers.md) - [Sync Offer](https://docs.violet.io/api-reference/ecom-syncs/offers/sync-offer-by-id.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, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.violet.io/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.