Athos plugin
Medusa Athos Integration Plugin.
@weareseeed/medusa-athos-plugin
Medusa v2 plugin that generates a streaming NDJSON product feed for Athos Commerce integration.
Features
- Streaming NDJSON product feed (one line per variant + one product summary line)
- Token-based feed authentication
- Price filtering by region
- Product filtering by sales channel
- Configurable swatch options
- Extensible via and hooks
- Admin API to manage plugin configuration
Requirements
- Medusa v2
- Node.js >= 20
Installation
Setup
1. Register the plugin
2. Run migrations
npx medusa db:migrate3. Configure via Admin API
Set the plugin configuration through the authenticated admin endpoint:
| Field | Type | Required | Description |
|---|---|---|---|
| Yes | Base URL prepended to for each product URL | ||
| Yes | Secret token required to access the feed endpoint | ||
| No | When set, prices are filtered to the region's currency | ||
| No | When set, only products in these sales channels are included | ||
| No | Option titles treated as swatches (default: ) |
Feed Endpoint
GET /athos/feed?token=<feed_token>Returns an stream. Each product produces:
- One variant line per variant
- One product summary line
Variant line fields
| Field | Description |
|---|---|
| Variant ID | |
| Variant SKU | |
| Variant title | |
| Lowest price for the variant (filtered by region if configured) | |
| Product thumbnail | |
| Product description | |
| Array of category path strings (e.g. ) | |
| Array of category IDs | |
| Comma-separated product tags | |
| Parent product ID | |
| Parent product title | |
| Parent product thumbnail | |
| 1-based position within the product | |
| if the variant is available | |
| % of variants in stock across the product | |
| All product options with positions and values | |
| This variant's chosen option values | |
| Values of configured swatch options (product-level) |
Product summary line fields
Same as variant line minus all private fields, with set to the product ID and set to the lowest price across all variants.
Example
Plugin Options
Pass options when registering the plugin in to extend the feed.
โ Additional Medusa product fields to fetch and make available inside . Uses the same dot-notation field paths as Medusa's .
Called for every line written to the feed. Use it to add, remove, or transform fields. The argument provides typed access to the raw product and variant data:
Fields that resolve to are automatically stripped from the output.
Admin API
Both endpoints require an authenticated admin JWT.
| Method | Path | Description |
|---|---|---|
| Retrieve the current configuration | ||
| Create or update the configuration |
License
MIT โ Seeed

