Skip to main content

Magento connector setup

Fatima Harrioui
Last Modified On
The Carriyo Magento Connector makes it easy to create shipments in Carriyo whenever an order is placed on a Magento store. Additionally, the connector enables merchants to send status updates back to Magento through Carriyo webhooks. 

This article will show you how to set up the connector.

 

Setting up

1. Navigate to Settings > Integration > Connectors menu in the Carriyo Dashboard and select the Magento connector.

 

Configure the following settings:

  1. Enter a connector name.
  2. Fill Magento API URL: Set the base API URL of your Magento store.
  3. Trigger Settings: Select the Carriyo statuses that you wish to synchronize with Magento.
  4. Click the "Save" button.




After saving, the necessary credentials required to complete the Magento setup will appear: 

 

Installing Carriyo Module on Magento 

You can access the module from here: Carriyo Magento 2 Module. You have the option to either install it via Composer or download it directly from GitHub.

Configure Magento Setup

Once the Carriyo module is installed on Magento, log in to your Magento Admin panel to complete the setup on the Magento side.
Navigate to Stores > Configuration, then find the "Carriyo" section.
 
Paste the credentials you copied from the Carriyo Dashboard into the Magento Admin settings.

 
Then update the following settings:
  • Pickup Address: Enter the Carriyo location code for the default pickup location you want to use for shipments.

 

  • Carriyo/Magento Mappings: Configure the mappings for shipping methods, allowed order statuses for Cash on Delivery (COD), and statuses mapping.
    1. Shipping Methods in Magento should be mapped to Delivery Types (shipment attributes) in Carriyo.
    2. Allowed Order Statuses (COD) & Allowed Order Statuses (Other Payment Types) - the statuses provided in this list will update orders in Carriyo accordingly i.e., if an order has already been created in Magento and has flown into Carriyo, with any new update made to the order, based on the payment type and allowed order status, it will send a webhook to Carriyo to update the order.
    3. Order Status Mapping - This mapping determines which Carriyo status should be updated to which Magento status when the status update is sent from Carriyo to Magento. For instance, 'cancelled=canceled' indicates that when Cancelled status in Carriyo gets sent to Magento, the order will be updated an canceled in Magento.

 

  • You can also add an additional prefix. This is important to set if the order IDs are not unique across multiple merchants (in case you have several or are planning to have).

 

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

Related articles

Comments

0 comments

Please sign in to leave a comment.