Built by

marcosgomesneto

Category

Shipping

Version

1.0.3

Last updated

Sep 14, 2024, 02:20:18 AM3 months ago

Melhor Envio Fulfillment for MedusaJS

Add integrated shipping calculation in your MedusaJS project with most product carriers in Latin America, such as: Correios (Sedex, PAC, etc.), Buslog, JeT Express, JadLog, Loggi, Azul Cargo among others.

Prerequisites

Contribute with:

How to Install

1. Run the following command in the directory of the Medusa backend:


#Using npm
npm install @marcosgn/medusa-fulfillment-melhor-envio




#Using yarn
yarn add @marcosgn/medusa-fulfillment-melhor-envio
2. Set the following environment variables in Copy to clipboard.env:
MELHOR_ENVIO_API_TOKEN=<your-token>
MELHOR_ENVIO_POSTAL_CODE=<from-postal-code>
Get your token from the Melhor Envio dashboard: https://melhorenvio.com.br.
Set origin zip code in the variable Copy to clipboardMELHOR_ENVIO_POSTAL_CODE with only numbers. This is used for shipping calculation.
3. In Copy to clipboardmedusa-config.js add the following at the end of the Copy to clipboardplugins array:
const plugins = [
  // ...
  {
    resolve: `@marcosgn/medusa-fulfillment-melhor-envio`,
    options: {
      apiToken: process.env.MELHOR_ENVIO_API_TOKEN,
      postalCode: process.env.MELHOR_ENVIO_POSTAL_CODE,
      sandbox: process.env.ENVIRONMENT, // Set true or "development" to use the sandbox environment
    },
  },
];

Test the Plugin

1. Run the following command in the directory of the Medusa backend to run the backend:


#Using npm
npm run dev




#Using
yarn dev
2. Add Shipping Methods in a region in the admin panel. You can refer to this User Guide and this (Manage Shipping) to learn how to do that. Alternatively, you can use the Admin APIs.
3. Get a shipping methods from Cart ID in a storefront or the Store APIs.

Storefront Usage

Nuxt Exaple using MedusaJS client

const client = useMedusaClient(); //with NuxtJS Example...


const shippingOptions = await client.shippingOptions.listCartOptions(
  "cart_EXAMPLE_CART_ID"
);

Support and Contribution

If you encounter any issues or have suggestions for improvements, feel free to open an issue on the GitHub repository.
If you want to contribute, please open a pull request in the repository.

Build your own plugins

Develop your own plugins with our API to speed up your processes.

Make your plugin available via npm for it to be shared in our Plugin Library with the broader Medusa community.