Files
medusa-store/www/apps/resources/app/commerce-modules/fulfillment/module-options/page.mdx
Shahed Nasser 6efb5897dc docs: fix package names in module registration (#9590)
* docs: fix package names in module registration

* update references
2024-10-16 09:05:07 +02:00

54 lines
1.2 KiB
Plaintext

---
sidebar_label: "Module Options"
---
import { Table } from "docs-ui"
export const metadata = {
title: `Fulfillment Module Options`,
}
# {metadata.title}
In this document, you'll learn about the options of the Fulfillment Module.
## providers
The `providers` option is an array of fulfillment module providers.
When the Medusa application starts, these providers are registered and can be used to process fulfillments.
For example:
```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
{
resolve: `@medusajs/medusa/fulfillment-manual`,
id: "manual",
options: {
// provider options...
},
},
],
},
},
]
})
```
The `providers` option is an array of objects that accept the following properties:
- `resolve`: A string indicating either the package name of the module provider or the path to it relative to the `src` directory.
- `id`: A string indicating the provider's unique name or ID.
- `options`: An optional object of the module provider's options.