DOCSEARCHbyAlgolia
Submit Docs

Byte8 Documentation

website·Indexed 31 days ago

https://docs.byte8.io

Technical documentation for Byte8 products, including Mage2Plenty (an enterprise-grade integration between Magento 2 and PlentyONE), SEO Suite for 404 capture and redirect management, Horizon gateway webhooks, and Orbit agent managed hosts.

Tokens
343.5K
Snippets
1.3K
Records
2.6K
Agent score
49%

What's inside Byte8

  1. Overview of PlentyONE Order Import Profile

    The Order Import Profile (plenty_order_import) is designed to synchronize orders created outside of Magento—specifically from external marketplaces (Amazon, eBay, Otto) and PlentyONE-managed sales channels—into Magento. It ensures that Magento remains the central management system for multi-channel sales.

    Imported Data Includes:

    • Orders and line items
    • Customer information and billing/shipping addresses
    • Order status, payment methods, and transaction data
    • Shipping methods and tracking
    • Invoices and Credit Memos (when configured)
    • Order totals (subtotals, tax, shipping, discounts, grand total)

  2. Overview of Stock Radar for Magento 2

    Stock Radar is a free, MIT-licensed Magento 2 module designed to handle back-in-stock notifications. Unlike traditional modules, it provides per-variant subscriptions (e.g., specific size/color), throttled batched notifications to prevent inventory crashes and spam filters, and a demand heatmap in the admin panel to rank products by pending subscriber count.

  3. Overview of the Stock Export Profile

    The Stock Export Profile (plenty_stock_export) pushes Magento inventory changes (sales, stock receipts, manual corrections, MSI source changes) to PlentyONE. It is designed for high-frequency event-driven synchronization with a periodic drift-reconciliation safety net to ensure physical stock alignment.

  4. Overview of the Stock Import Profile

    The Stock Import Profile (Profile Type ID: plenty_stock_import) synchronizes real-time stock quantities and reservations from PlentyONE warehouses to Magento inventory sources. It supports both single and multiple warehouse sources with full Multi-Source Inventory (MSI) compatibility.

  5. Overview of Byte8 VAT Validation for Magento 2

    The Byte8 VAT module is a free, MIT-licensed Magento 2 extension that validates B2B buyers' VAT numbers against the EU VIES REST API, UK HMRC's 'Check a UK VAT number' v2.0 (OAuth 2.0), and the Swiss UID-Register. It operates during customer registration and checkout, automatically moving validated customers into a configurable 'Zero Tax' customer group to ensure correct tax rules are applied.

  6. Overview of Pulsar synthetic checkout monitoring

    Pulsar's synthetic checkout test simulates a complete purchase journey through a Magento store to identify issues that simple page checks might miss. The simulation follows these steps:

    1. Navigates to a configurable product page
    2. Adds the product to the cart
    3. Proceeds through checkout steps
    4. Verifies each step completes successfully
    5. Stops before actual payment submission.

  7. Overview of Horizon documentation and core components

    Horizon provides a gateway for Magento 2 stores, enabling MCP (Model Context Protocol) tool integration. The documentation covers the following core areas:

    • Quick Start: Guide to making the first MCP tool call within 30 minutes.
    • Magento Extension: Instructions for Composer installation, configuration, and indexer behavior.
    • MCP Gateway: Details on streamable HTTP transport, available tools, and connecting Claude, SDKs, or agent frameworks.
    • Stores & Usage: Management of connected stores, API key rotation, and usage analytics.
    • API: GraphQL admin API and webhook payloads for catalog invalidation.
    • Troubleshooting: Common failure modes and their respective fixes.

  8. Overview of the Product Export Profile

    The Product Export Profile (Profile Type ID: plenty_item_export) synchronizes a Magento product catalog to PlentyONE. It is used for centralized inventory management, fulfillment, and multi-channel sales, moving data from Magento to PlentyONE.

  9. Overview of the Byte8 Magento 2 to FreeAgent Connector

    Byte8 provides a hosted SaaS connector that synchronizes data from Magento 2 to FreeAgent in near real-time. It handles the synchronization of invoices, credit notes, customers, products, and payments, providing a full audit trail and operator-visible failure handling within the Magento admin.

    Key architectural features include:

    • Thin Magento Module: Uses five observers and an outbox with JWT-signed communication; it does not store OAuth tokens or client secrets locally.
    • Hosted Chassis: A Rust-based SaaS handles OAuth token rotation, rate-limiting, retries, dead-letter handling, and API updates.
    • Magento Integration: Status indicators (chips) are visible on the Magento Sales → Invoices and Sales → Credit Memos grids, and info blocks are available on entity detail pages.

  10. Overview of Swissup Checkout Fields plugin for Mage2Plenty

    The byte8/module-plenty-swissup-checkout-fields plugin integrates the Swissup Checkout Fields extension with Mage2Plenty. It ensures that custom checkout fields (such as delivery instructions, gift messages, and PO numbers) and their values are captured from Magento orders and exported as properties to PlentyONE. It supports various field types including text, textarea, select, multiselect, date, and checkboxes, and handles store-specific configurations.

  11. Overview of the Byte8 Magento 2 to Xero Connector

    Byte8 provides a hosted SaaS connector that synchronizes Magento 2 data to Xero in near real-time. It handles the synchronization of invoices, credit notes, customers, and payments. Unlike traditional PHP extensions, Byte8 uses a 'thin' Magento module that sends data via a JWT-signed wire to a centrally hosted Rust-based chassis. This chassis manages OAuth token rotation, rate-limiting, retries, and API maintenance, ensuring that Xero API changes are patched centrally without requiring merchant-side updates.

  12. Overview of Amasty Cash on Delivery (COD) plugin for Mage2Plenty

    The Amasty Cash on Delivery (COD) plugin (byte8/module-plenty-amasty-cash-on-delivery) integrates the Amasty Cash on Delivery Fee extension with Mage2Plenty. It ensures that COD fees are detected, calculated based on Amasty rules, and exported to PlentyONE as separate order line items and included in order totals for accurate accounting. It supports multi-currency and tax handling on fees.