Magento Connector

The Carriyo Magento Connector allows merchants to effortlessly generate shipments in Carriyo whenever an order is placed on their Magento store. The connector offers the following capabilities

1. Create Shipments The connector allows merchants to create shipments in a draft state, giving them the flexibility to review and book shipments at their convenience. Alternatively, merchants can opt to automatically book all shipments upon creation.
2. Update Shipments Any updates made to an order in Magento, such as address changes or status updates, are automatically reflected in the corresponding shipment in Carriyo, provided the shipment is not yet booked with a carrier. The connector also includes a button in the Magento Admin Order page for manual pushing of shipment updates to Carriyo.
3. Cancel Shipments If an order is canceled in Magento, the corresponding shipment in Carriyo is also automatically canceled, provided that the shipment has not already been shipped.
4. Order Status Updates The connector supports transmitting status updates from Carriyo back to Magento using webhooks. The statuses are automatically applied to the corresponding Magento orders based on your configuration, ensuring your order statuses stay synchronized.
5. Mappings & Triggers : 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 Triggers : Define which Magento order statuses should trigger shipment creation in Carriyo.
   • Order Status Mapping : Map Carriyo shipment statuses to Magento order statuses.

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

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.
  
  
  

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

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.
  
  
• Customize other settings as needed, and ensure to save your changes.
  
  
  

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