npm.io
2.22.7 • Published 4d ago

@medusajs/fulfillment

Licence
MIT
Version
2.22.7
Deps
0
Size
424 kB
Vulns
0
Weekly
0
Stars
36.6K

Medusa logo

@medusajs/fulfillment

Documentation | Website

Building blocks for digital commerce

Medusa is released under the MIT license. PRs welcome! Discord Chat Follow @medusajs

Fulfillment Module for Medusa: manages fulfillment sets, service zones, geo zones, shipping options and their rules and types, shipping profiles, and fulfillments with their items, labels, and addresses. Fulfillment and shipping-rate logic is delegated to Fulfillment Module Providers, so you can integrate third-party carriers. It ships with @medusajs/medusa and is registered by default; resolve it in your code with container.resolve(Modules.FULFILLMENT).

At a glance

Package @medusajs/fulfillment
Type Commerce Module
Module key Modules.FULFILLMENT ("fulfillment")
Registered by default Yes (with the Manual provider)

Providers

The module accepts multiple providers. Official providers:

Package Register with
@medusajs/fulfillment-manual @medusajs/medusa/fulfillment-manual

Installation

No installation needed. The module ships with @medusajs/medusa.

Usage

To add providers, register the module in medusa-config.ts. Overriding providers replaces the default list, so keep the Manual provider if you still need it:

import { defineConfig } from "@medusajs/framework/utils"

module.exports = defineConfig({
  // ...
  modules: [
    {
      resolve: "@medusajs/medusa/fulfillment",
      options: {
        providers: [
          {
            resolve: "@medusajs/medusa/fulfillment-manual",
            id: "manual",
          },
        ],
      },
    },
  ],
})

Configuration

Option Type Description Default
providers { resolve: string, id: string, options?: Record<string, unknown> }[] Fulfillment providers to register. Providers removed from this list are disabled in the database on startup. Manual provider (id: "manual")

Resources