Itrk

@sadu-dev/medusa-plugin-itrk

@sadu-dev/medusa-plugin-itrk is a Medusa v2 plugin that keeps your storefront legal pages in sync with updates from IT-Recht Kanzlei (https://www.it-recht-kanzlei.de/), a German legal content provider for ecommerce shops.

In practice, the plugin accepts IT-Recht Kanzlei XML updates, stores the latest document version per sales channel and language, and serves those documents through a store API so your frontend can always show current legal texts (for example terms and conditions, privacy policy, imprint, and withdrawal information).

Maintained by SADU Development e.U. at https://sadu.at.

Compatibility

• Node.js >=20
• Medusa packages >=2.12.0 <3

What it includes

• POST /integrations/itrk for ITRK XML requests
• GET /store/itrk/:doc_type for storefront document retrieval
• A dedicated itrk module with persisted legal-document records
• Medusa plugin option validation via exported Zod schema

Install

pnpm add @sadu-dev/medusa-plugin-itrk

Then register the plugin in your Medusa backend's medusa-config.ts file at the project root (<your-medusa-project>/medusa-config.ts):

1import { defineConfig } from "@medusajs/framework/utils"
2import type { ItrkPluginOptionsInput } from "@sadu-dev/medusa-plugin-itrk/types"
3
4export default defineConfig({
5  plugins: [
6    {
7      resolve: "@sadu-dev/medusa-plugin-itrk",
8      options: {
9        token: "your-itrk-token",
10        channels: [
11          {
12            salesChannelId: "sc_...",
13            accountId: "account-1",
14            accountName: "Main Store",
15            languages: ["de", "en"],
16            countries: ["DE", "AT"],
17            targetUrls: {
18              agb: "https://store.example/legal/agb",
19              datenschutz: "https://store.example/legal/privacy",
20              impressum: "https://store.example/legal/imprint",
21              widerruf: "https://store.example/legal/withdrawal",
22            },
23          },
24        ],
25      } satisfies ItrkPluginOptionsInput,
26    },
27  ],
28})

meta_shopversion is derived automatically from the installed @medusajs/medusa version.

Choose the token value yourself and enter the same value in both Medusa and IT-Recht Kanzlei. IT-Recht Kanzlei does not issue or generate this token for you.

IT-Recht Kanzlei Setup

When configuring the API URL in IT-Recht Kanzlei, enter only your Medusa backend base URL.

Do not append /integrations/itrk manually.

Exported types

• @sadu-dev/medusa-plugin-itrk
• @sadu-dev/medusa-plugin-itrk/types

The package exports itrkPluginOptionsSchema, ItrkPluginOptions, and ItrkPluginOptionsInput.

Development

1pnpm build
2pnpm lint
3pnpm test:unit

Publishing

The package is built with Medusa's plugin build command before publish:

1pnpm build
2npm publish

The published package contains the built .medusa/server output and package metadata only.

License

MIT