* added customer guides * fixes to sidebar * remove old customer registration guide * fix build error * generate files * run linter
56 lines
1.4 KiB
Plaintext
56 lines
1.4 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 provider modules.
|
|
|
|
When the Medusa application starts, these providers are registered and can be used to process fulfillments.
|
|
|
|
For example:
|
|
|
|
```js title="medusa-config.js"
|
|
const { Modules } = require("@medusajs/modules-sdk")
|
|
|
|
// ...
|
|
|
|
module.exports = defineConfig({
|
|
// ...
|
|
modules: {
|
|
[Modules.FULFILLMENT]: {
|
|
resolve: "@medusajs/fulfillment",
|
|
options: {
|
|
providers: [
|
|
{
|
|
resolve: `@medusajs/fulfillment-manual`,
|
|
options: {
|
|
config: {
|
|
manual: {
|
|
// 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 fulfillment provider module or the path to it relative to the `src` directory.
|
|
- `options`: An optional object of the fulfillment provider module's options. The object must have the following property:
|
|
- `config`: An object whose key is the ID of the fulfillment provider, and its value is an object of options to pass to the provider module. |