Magento Connector

The Magento Connector allows merchants to effortlessly generate shipments in Carriyo whenever an order is placed on their Magento store. These shipments are initially set in a draft state, offering merchants the flexibility to fulfill them in Carriyo when the shipment is ready.

Additionally, the connector enables merchants to transmit status updates back to Magento via Carriyo webhooks.

The connector is available as an open source Magento module on GitHub. The GitHub repository includes installation and usage instructions in the README file.

Key Features:

The Magento Connector allows merchants to:

  • Delivery and Payment Mapping : Identify and map delivery types and payment methods, such as cash on delivery.
  • Order Status Control : Define which Magento order statuses should trigger shipment creation in Carriyo.
  • Status Synchronization : Map Carriyo shipment statuses to Magento order statuses.

Setting Up the Magento Connector

Setting up the Magento Connector involves three steps:

1. Create a New Magento Connector in Carriyo

  • Navigate to the "Connectors" menu in the Carriyo Dashboard and initiate the creation of a new Magento connector. Configure the following settings:

    Magento API URL: Set the base API URL for your Magento store
    Trigger Settings: Select the Carriyo statuses that you wish to synchronize with Magento.
    Click the "Save" button.
    Magento Connector
    Magento Connector

  • After saving, you will be provided with the credentials needed to complete the Magento setup.
    Magento Connector

2. Install the Carriyo Module in Magento

  • Install the Carriyo Magento module on your Magento store. You can obtain the module from the following location: Carriyo Magento 2 Module . You can install it either via Composer or download it directly from GitHub.

3. Configure the Carriyo Module in Magento

  • After successfully installing the Carriyo module, log in to your Magento Admin panel to finalize the setup.
  • Navigate to "Store" => "Configurations" and locate the "Carriyo" section.
  • Input the credentials copied from the Carriyo Dashboard into the Magento Admin settings.
    Magento Admin
  • Customize other settings as needed, and ensure to save your changes.
    Magento Admin
    Magento Admin

    Once these steps are completed, the connector is ready for use. Magento will automatically initiate shipment creation for new orders.