For the complete documentation index, see llms.txt. This page is also available as Markdown.

Magento

Overview of Violet's Magento (Adobe Commerce) integration for channel developers

Magento (now Adobe Commerce) is an open-source ecommerce platform for mid-market and enterprise merchants. Violet supports Magento 2.x via its REST API, with enhanced functionality available through an optional Violet Magento extension.

Connection

Merchants provide an API Token, API Secret, and their Store URL.

The Violet Magento extension unlocks additional capabilities and is recommended for most merchants. When the extension is installed, Violet can:

  • Access store admin contact information

  • Receive real-time webhook notifications for product and order changes

  • Sync Violet's internal token directly to the merchant's store

Without the extension, Violet operates in API-only mode, which provides full order submission and product sync but relies on scheduled sync jobs rather than real-time events.

The extension is installed via Composer 2+ and requires Magento 2.4.x.

Bearer Tokens (Magento 2.4.4+)

Magento 2.4.4 and newer may require standalone Bearer tokens to be enabled. Merchants should verify this setting if they encounter authentication errors after providing valid credentials.

Notable Behavior

  • Multi-store: Magento supports complex multi-store and multi-website configurations. Violet connects to the default store view unless merchant configuration specifies otherwise.

  • No native scopes: Unlike other platforms, Magento does not have granular API access scopes. Valid credentials provide full API access.

Last updated

Was this helpful?