ContextQMD
Back to Medusa

{metadata.title}

www/apps/resources/app/commerce-modules/loyalty/module-options/page.mdx

2.18.01.8 KB
Original Source

import { Table } from "docs-ui"

export const metadata = { title: Loyalty Plugin Options, }

{metadata.title}

In this guide, you'll learn about the options you can pass to the Loyalty Plugin.

Options Example

js
module.exports = defineConfig({
  // ...
  plugins: [
    {
      resolve: "@medusajs/loyalty-plugin",
      options: {
        prefix: "GC",
        sections: 3,
      },
    },
  ],
})

All Options

<Table> <Table.Header> <Table.Row> <Table.HeaderCell>Option</Table.HeaderCell> <Table.HeaderCell>Description</Table.HeaderCell> <Table.HeaderCell className="w-[15%]">Required</Table.HeaderCell> <Table.HeaderCell className="w-[15%]">Default</Table.HeaderCell> </Table.Row> </Table.Header> <Table.Body> <Table.Row> <Table.Cell> 
  `prefix`

  </Table.Cell>
  <Table.Cell>

  A string indicating the prefix added to auto-generated gift card codes. For example, setting `prefix` to `GC` generates codes in the format `GC-XXXX-XXXX-XXXX-XXXX`. (Available since [v2.17.2](https://github.com/medusajs/medusa/releases/tag/v2.17.2))

  </Table.Cell>
  <Table.Cell>

  No

  </Table.Cell>
  <Table.Cell>

  `GIFT`

  </Table.Cell>
</Table.Row>
<Table.Row>
  <Table.Cell>

  `sections`

  </Table.Cell>
  <Table.Cell>

  A number indicating how many 4-character sections the generated gift card code contains. For example, setting `sections` to `3` generates codes in the format `GIFT-XXXX-XXXX-XXXX`. (Available since [v2.17.2](https://github.com/medusajs/medusa/releases/tag/v2.17.2))

  </Table.Cell>
  <Table.Cell>

  No

  </Table.Cell>
  <Table.Cell>

  `4`

  </Table.Cell>
</Table.Row>

</Table.Body>

</Table>