Docs
Sign in

Magento connector

Updated May 26, 20263 min read

Use this connector to create Carriyo shipments automatically whenever a customer places an order in your Magento store. The connector is open source and available on GitHub.

Capabilities

  1. Create shipments, create shipments in draft state for review and manual booking, or automatically book all shipments on creation.
  2. Update shipments, Carriyo automatically applies address changes and status updates from Magento to the corresponding shipment, as long as it hasn't been booked yet. The connector also adds a button in the Magento Admin Order page for a manual push.
  3. Cancel shipments, when a customer cancels an order in Magento, Carriyo automatically cancels the corresponding shipment (provided it hasn't shipped yet).
  4. Order status updates, receive Carriyo shipment status updates back in Magento via webhooks, applied to the corresponding Magento orders based on your configuration.
  5. Mappings & triggers:
    • Delivery and payment mapping: identify and map delivery types and payment methods (e.g. 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 repository includes full installation and usage instructions in the README.

Setting up the Magento connector

1. Create a new Magento connector in Carriyo

In the Carriyo Dashboard, navigate to Connectors and create a new Magento connector. Configure:

  • Magento API URL: the base API URL for your Magento store.
  • Trigger settings: the Carriyo statuses you wish to synchronize with Magento.

Click Save.

Magento connector setup

Magento connector trigger settings

After saving, Carriyo displays the credentials you need to complete the Magento setup.

Magento connector credentials

2. Install the Carriyo module in Magento

Install the Carriyo Magento module on your Magento store. Get the module from the Carriyo Magento 2 GitHub repository. You can install it via Composer or download it directly.

3. Configure the Carriyo module in Magento

After installing, log in to your Magento Admin panel.

  1. Navigate to Stores → Configuration and find the Carriyo section.

  2. Paste the credentials from the Carriyo Dashboard into the Magento Admin settings.

    Magento admin, Carriyo configuration

  3. Configure the remaining settings:

    • Pickup Address: the Carriyo location code for the default pickup location used for shipments.

      Magento admin, pickup address

    • Carriyo / Magento Mappings:

      • Shipping Methods: map Magento shipping methods to Carriyo delivery types (shipment attributes).
      • Allowed Order Statuses (COD) and Allowed Order Statuses (Other Payment Types), the order statuses, by payment type, that should trigger an update to Carriyo. When a Magento order in one of these statuses changes after being pushed to Carriyo, Magento sends a webhook so the Carriyo shipment is updated.
      • Order Status Mapping: the Carriyo statuses to apply on the Magento order when Carriyo sends a status update. For example, cancelled=canceled means that when a shipment is cancelled in Carriyo, the corresponding Magento order is moved to canceled.

    • Additional Prefix: optional. Use this when order IDs are not unique across your merchants.

    Magento admin, mappings

  4. Save the configuration.

Once these steps are complete, the connector is ready. Magento automatically creates shipments in Carriyo for new orders.