8f:T1bba,# Vendure Klaviyo Plugin An extensible plugin for sending placed orders to the Klaviyo marketing platform. ## Getting started The default setup will only send placed orders to Klaviyo 1. Log in to your Klaviyo account and get your API key 2. Add the following config to your `vendure-config.ts`: ```ts import { KlaviyoPlugin } from '@pinelab/vendure-plugin-klaviyo'; plugins: [ KlaviyoPlugin.init({ apiKey: 'some_private_api_key', }), ]; ``` All placed orders will now be synced. ## Custom event handlers If you want to send more events to Klaviyo, you can implement your own handlers. For example, syncing account verification events to Klaviyo, so that you can send out welcome e-mails: 1. Create a custom handler `klaviyo-account-verified-handler.ts` ```ts import { AccountVerifiedEvent } from '@vendure/core'; import { KlaviyoEventHandler, KlaviyoGenericEvent, } from '@pinelab/vendure-plugin-klaviyo'; /** * Event handler to send Vendure's AccountVerifiedEvent to Klaviyo */ export const accountVerifiedHandler: KlaviyoEventHandler = { vendureEvent: AccountVerifiedEvent, mapToKlaviyoEvent: async (event, injector) => { const { customer } = event; return { // Unique ID per event to make the event idempotent uniqueId: `account-verified-${customer.id}-${Date.now()}`, eventName: 'Account Verified', profile: { emailAddress: customer.emailAddress, externalId: customer.id.toString(), firstName: customer.firstName, lastName: customer.lastName, }, eventProperties: { myCustomProperty: 'my custom value', }, }; }, }; ``` 2. Register the handler in the plugin in your `vendure-config.ts` ```ts import { defaultOrderPlacedEventHandler, KlaviyoPlugin, } from '@pinelab/vendure-plugin-klaviyo'; import { accountVerifiedHandler } from './klaviyo-account-verified-handler.ts'; plugins: [ KlaviyoPlugin.init({ apiKey: 'some_private_api_key', eventHandlers: [defaultOrderPlacedEventHandler, accountVerifiedHandler], }), ]; ``` ## Custom data in Klaviyo's default Order Placed event If you'd like to send custom data in the Klaviyo native Order Placed event, you can also create a custom handler, but make sure to return a `KlaviyoOrderPlacedEvent` instead of a `KlaviyoGenericEvent`. The plugin will recognize your return type and handle it as an Order Placed event. Don't forget to exclude the default order placed handler if you do! ```ts KlaviyoPlugin.init({ apiKey: 'some_private_api_key', // No defaultOrderPlacedHandler here! eventHandlers: [customOrderPlacedHandler], }), ``` ## Abandoned cart emails This plugin includes a mutation `klaviyoCheckoutStarted`, which can be called from your storefront. When called, and an active order is present, it sends a custom event `Checkout Started` to Klaviyo, including basic order and profile data. This event can be used to set up abandoned cart email flows in Klaviyo. ## Refund and Cancellation Events This plugin includes a mutation `klaviyoRefundCreated`, which sends events to Klaviyo whenever a refund is created for an order. To enable the refund event, add the refund handler to the plugin config: ```ts import { KlaviyoPlugin, createRefundHandler, } from '@pinelab/vendure-plugin-klaviyo'; plugins: [ KlaviyoPlugin.init({ apiKey: 'some_private_api_key', eventHandlers: [ createRefundHandler({ getPaymentMethodName: (payment) => { // This sample gets the payment method (like 'iDeal') when a the settled payment was a Mollie payment return payment?.metadata.method; }, }), ], }), ]; ``` ## Newsletter signup The following mutation allows a customer to sign up to a Klaviyo Audience list via the API: ```graphql mutation { subscribeToKlaviyoList( emailAddress: "testing@pinelab.studio" listId: "WpeFJd" ) } ``` This mutation requires an active session, which means a customer should have interacted with the Vendure API already. This can be done for example by fetching an active order. This is to prevent unwanted bot sign ups. The customer will also receive a double opt-in email, asking them to confirm signing up for marketing emails. ## Product Feed You can use this plugin to get the JSON product feed for Klaviyo. This can be used to sync your products to Klaviyo. To enable it, you need to configure the feed settings of the plugin: ```ts import { KlaviyoPlugin } from '@pinelab/vendure-plugin-klaviyo'; plugins: [ KlaviyoPlugin.init({ apiKey: 'some_private_api_key', feed: { // The feed is secured by a password, to prevent abuse, but still able to use it via the shop API in your storefront build. password: 'some_password', enhanceProductFeedItemFn: (ctx, variant, feedItem) => { const asset = variant.product.featuredAsset ?? variant.featuredAsset; return { ...feedItem, image_link: `https://my-storefront.io/assets/${asset?.preview}`, link: `https://my-storefront.io/product/${variant.product.slug}`, // You can add any custom fields you want to the feed item, like so: myCustomField: variant.customFields.myCustomField, // or override any of the default fields, like so: name: variant.product.name + ' - Buy Now!', }; }, }, }), ]; ``` After that, you can call the feed via the shop API, which will return a JSON object. You could stringify that, and use it to save it to a static file. For example `klaviyo_feed.json`, and use the path to that file to have Klaviyo fetch your products. ```graphql query { klaviyoProductFeed(password: "some_password") } ``` Without the `feed.password` set, feed generation is disabled. ## Back In Stock notifications Allow customers to subscribe to back in stock notifications for a given product. Requires an active session, and requires the Klaviyo feed to be connected in your account. ```graphql mutation { subscribeToKlaviyoBackInStock( emailAddress: "testing@pinelab.studio" # This is the catalog item ID, which is the variant ID if you use the generated feed above. catalogItemId: "1" ) } ``` ## Failed to send event to Klaviyo If for some reason an event fails to be sent to Klaviyo, an `FailedToSendToKlaviyoEvent`event is emitted. You can listen to this event to monitor failed events and take action. Example: ```ts import { FailedToSendToKlaviyoEvent } from '@pinelab/vendure-plugin-klaviyo'; this.eventBus.ofType(FailedToSendToKlaviyoEvent).subscribe((event) => { console.log('Failed to send event to Klaviyo:', event.data.eventName); console.log('For profile:', event.data.profile.emailAddress); console.log('Because of reason:', (event.error as Error)?.message); // Maybe send some alerts to your monitoring system }); ``` 90:T869,# 1.13.0 (2026-08-05) - Upgraded to Vendure 3.6.3 # 1.12.0 (2026-02-05) - Upgraded to Vendure 3.5.3 # 1.11.0 (2026-01-27) - Set `customProperties.language` for Klaviyo profiles based on the request context language code from Vendure # 1.10.0 (2026-01-21) - Emitting `FailedToSendToKlaviyoEvent` event when a Klaviyo event fails to be sent # 1.9.3 (2025-11-13) - Documentation update # 1.9.2 (2025-11-06) - Updated official documentation URL # 1.9.1 (2025-06-27) - Don't throw error for products without a price when generating the product feed - Filter out disabled variants from the product feed # 1.9.0 (2025-06-27) - Added query for retrieving the Klaviyo JSON product feed. - Added mutation for subscribing to back in stock notifications for a given product. - Upgrade to Klaviyo Client from 10.1.0 to 18.0.0 # 1.8.0 (2025-06-04) - Upgrade to Vendure to 3.3.2 # 1.7.0 (2025-05-28) - Added `RefundEventHandler` to send events to Klaviyo when a refund is created. # 1.6.2 (2025-05-22) - Fetch order with relations instead of hydrating in CheckoutStartedEvent, to prevent order object modification # 1.6.1 (2025-02-19) - Fetch order with relations instead of hydrating, to prevent `Maximum call stack exceeded` (https://github.com/vendure-ecommerce/vendure/issues/3355) # 1.6.0 (2025-01-14) - Added mutation to sign up to Klaviyo Audience list # 1.5.0 (2024-12-19) - Update Vendure to 3.1.1 # 1.4.0 (2024-12-13) - Include `klaviyoCheckoutStarted` mutation to be able to use abandoned cart email flows # 1.3.1 (2024-12-13) - Don't log push jobs and log errors for channels without api keys # 1.3.0 (2024-12-12) - Allow setting an apiKey per channel # 1.2.1 (2024-12-04) - Add support for DiscountCode on Placed Order event # 1.2.0 (2024-08-14) - Allow setting multiple Klaviyo handlers for Vendure's OrderPlacedEvent - Allow order items to be excluded from 'Ordered Product' events # 1.1.1 (2024-08-04) - Update compatibility range (#480) # 1.1.0 (2024-06-21) - Updated Vendure to 2.2.6 # 1.0.1 (2024-06-19) - Added extra tests for 'Ordered Product' events # 1.0.0 (2024-06-18) - Initial setup of the plugin 91:T10a3,# Google Cloud Tasks Vendure plugin Plugin for using Vendure worker with Google Cloud Tasks. This plugin will show ending, successful and failed jobs in the admin UI under `sytem/jobs`, but not running jobs. Only jobs of the past 7 days are kept in the DB. ## Getting started ## Plugin setup 2. Remove `DefaultJobQueuePlugin` from your vendure-config. Add this plugin to your `vendure-config.ts`: ```ts import { CloudTasksPlugin } from '@pinelab/vendure-plugin-google-cloud-tasks'; plugins: [ CloudTasksPlugin.init({ // Must reachable by Google Cloud Task. Messages are pushed to this endpoint taskHandlerHost: 'https://your-public-host/', projectId: 'your-google-project-id', // Region where the taskqueue should be created location: 'europe-west1', // Used to prevent unauithorized requests to your public endpoint authSecret: 'some-secret-to-authenticate-incoming-messages', /** * Used to distinguish taskQueues within the same * Google Project (if you have OTAP environments in the same project for example) * This suffix will be appended to the queue name: "send-email-plugin-test" */ queueSuffix: 'plugin-test', // Default amount of retries when no job.retries is given defaultJobRetries: 15, // The amount of retries when a job fails to be pushed to the queue createTaskRetries: 3, // Default amount of days to keep jobs in the database. clearStaleJobsAfterDays: 7, }), ]; ``` 2. Run a database migration to add the `JobRecordBuffer` table. 3. Start the Vendure server, log in to the admin dashboard and trigger a reindex job via `Products > (cog icon) > reindex` to test the Cloud Tasks Plugin. This plugin installs the `SQLJobBufferStrategy` from Vendure's default JobQueue plugin, to buffer jobs in the database. This is because most projects that are using Google Cloud Tasks will also have multiple instances of the Vendure server. # Clear jobs You can call the endpoint `/cloud-tasks/clear-jobs/X` with the secret as Auth header to clear jobs older than X days. For example: ```shell curl -H "Authorization: Bearer some-secret-to-authenticate-cloud-tasks" "http://localhost:3050/cloud-tasks/clear-jobs/1" ``` Will clear all jobs older than 1 day. # FAQ ## DEADLINE_EXCEEDED errors when pushing tasks to queue When pushing multiple tasks concurrently to a queue in serverless environments, you might see `DEADLINE_EXCEEDED` errors. If that happens, you can instantiate the plugin with `fallback: true` to make the Google Cloud Tasks client fallback to HTTP instead of GRPC. For more details see https://github.com/googleapis/nodejs-tasks/issues/397#issuecomment-618580649 ```ts CloudTasksPlugin.init({ ... clientOptions: { fallback: true } }); ``` ## Request entity too large This means the Job data is larger than NestJS's configured request limit. You can set a large limit in your `vendure-config.ts`: ```ts import { VendureConfig } from '@vendure/core'; import { json } from 'body-parser'; export const config: VendureConfig = { // ... apiOptions: { middleware: [ { handler: json({ limit: '10mb' }), route: '*', beforeListen: true, }, ], }, }; ``` We don't include this in the plugin, because it affects the entire NestJS instance ## `ER_OUT_OF_SORTMEMORY: Out of sort memory, consider increasing server sort buffer size` on MySQL If you get this error, you should create an index on the `createdAt` column of the job table: ```sql CREATE INDEX idx_job_created_at ON job_record (createdAt); ``` The error is caused by the fact that the `job_record.data` column is a `json` column and can contain a lot of data. More information can be found here: https://stackoverflow.com/questions/29575835/error-1038-out-of-sort-memory-consider-increasing-sort-buffer-size 92:T8f4,# 2.2.0 (2026-08-05) - Upgraded to Vendure 3.6.3 # 2.1.0 (2026-02-05) - Upgraded to Vendure 3.5.3 # 2.0.3 (2025-11-13) - Documentation update # 2.0.2 (2025-11-06) - Updated official documentation URL # 2.0.1 (2025-08-14) - IMPORTANT: Better truncate of job.data, and retry saving without data if it fails. V2.0.0 crashes the Vendure server when job.data is too large. # 2.0.0 (2025-08-11) - BREAKING: Included `SQLJobBufferStrategy`, to buffer jobs in DB instead of in memory, to support multiple instances. A database migration is required. - Added documentation to fix `ER_OUT_OF_SORTMEMORY: Out of sort memory, consider increasing server sort buffer size` on MySQL - Constrain data size to 64kb to prevent `ER_DATA_TOO_LONG` errors on MySQL - Allow configuring deletion of jobs older than X days - Save original queue names in database. Only use suffix for creating queues in Google Cloud. This fixes admin UI job filtering # 1.9.1 (2025-06-24) - Add stack trace to error message when job fails # 1.9.0 (2025-06-04) - Upgrade to Vendure to 3.3.2 # 1.8.0 (2024-12-19) - Update Vendure to 3.1.1 # 1.7.1 (2024-08-04) - Update compatibility range (#480) # 1.7.0 (2024-09-06) - Updated `@google-cloud/tasks` to `"^5.4.0"` - Generates a unique task name; this reduces the latency during creation of the task # 1.6.0 (2024-06-21) - Updated Vendure to 2.2.6 # 1.5.0 (2024-01-30) - Don't store `job.data` when it's too big for MySQL text column - Remove jobs older than 30 days on application startup # 1.4.0 (2023-12-19) - Allow setting `fallback:true` to fallback to HTTP instead of gRPC to prevent DEADLINE_EXCEEDED errors. For more details see https://github.com/googleapis/nodejs-tasks/issues/397#issuecomment-618580649 - Allow setting of all Google Cloud Tasks Client options via `clientOptions: ...` - Removed `bodySizeLimit` option, because body-parser is loaded by NestJs since Vendure V2 # 1.3.0 (2023-11-21) - Only log error when job is not added to queue after configured retries - Apply exponential backoff when adding to queue doesn't work. # 1.2.0 (2023-10-24) - Updated vendure to 2.1.1 # 1.1.2 (2023-09-26) - Added `onJobFailure` option to inspect errors from failed jobs([#262](https://github.com/Pinelab-studio/pinelab-vendure-plugins/pull/262)) 93:T7a7,# Vendure Social Authentication for Administrators Allow admins to login with social accounts like Google. > **Note:** This plugin (v2.0.0+) only works with the React Dashboard. For the Angular Admin UI, use [v1.4.0](https://www.npmjs.com/package/@pinelab/vendure-plugin-admin-social-auth/v/1.4.0). The plugin setup allows for easy extension of other auth providers. Contributions welcome: Contact us via Discord or Github and we'll help you get started on contributing. You will be able to login if an administrator with your email address already exists in Vendure. Roles and permissions are still handled in Vendure. This plugin disables the native authentication method, so you will only be able to login via Google. ![image](https://plugins.pinelab.studio/plugin-images/admin-google.png) ## Set up Google login First, you need to get your Google Client id using these steps: https://developers.google.com/identity/gsi/web/guides/get-google-api-clientid. This should give you a client id that looks something like `xxxxx.apps.googleusercontent.com` 1. Install `google-auth-library`: `npm install google-auth-library` 2. In your `vendure-config.ts`, add the plugin: ```ts import { AdminSocialAuthPlugin } from '@pinelab/vendure-plugin-admin-social-auth'; ... plugins: [ AdminSocialAuthPlugin.init({ google: { oAuthClientId: process.env.GOOGLE_OAUTH_CLIENT_ID!, }, }), ] ``` 3. Run `npx vite build` 4. Start the server and navigate to `localhost:3000/dashboard/` 5. Login with your Google account 6. If an administrator exists with the same email address, you will be redirected to your dashboard. ## Managing administrators Administrators are managed via the default Vendure Admin UI. Just create an administrator with the same email address as the social account. When an admin logs in with a social account for the first time, the social auth method will be added to the `user.authenticationMethods`. 94:T644,# Vendure Limited Products Plugin This plugin allows you to: 1. Limit the amount of a specific product per order. I.E. A customer is only allowed to buy 1 of product "Limited art t-shirt X" per order. 2. Only allow a product to be purchased in multiples of X. E.g. only per 4 items. ## Getting started 1. Add the following config to your `vendure-config.ts`: ```ts import { LimitedProductsPlugin } from '@pinelab/vendure-plugin-limited-products'; plugins: [LimitedProductsPlugin]; ``` The custom field input for `Maximum amount per order` and `Multiple of per order` is provided as a React Dashboard extension — no Admin UI compilation step is needed. 2. Run a database migration to add the custom fields. 3. Start Vendure, login and go to the product you want to limit. 4. Set the custom field `Maximum amount per order` and `Multiple of per order` on a variant and update the product 5. Customers can now only buy X amount of the variant per order. The same customer can still order the product again in a new order. You can fetch `product.limitPurchasePerMultipleOf` and `product.maxQuantityPerOrder` via the Shop API to display messages on your storefront accordingly. ## Migrating to V3.x V3 removes the fields from the variant and places them on a Product, in a different format. This plugin isn't used much, so there is no migration script available. We do it manually: 1. Back up all values of the variants before installing the plugin. 2. Install V4 of this plugin, and run a database migration. 3. Start the server and set the values on the parent products via the Admin UI 95:T464,# 3.5.1 (2026-08-04) - Include dashboard extensions in dist. # 3.5.0 (2026-07-21) - Migrated to React Dashboard # 3.4.0 (2026-08-05) - Upgraded to Vendure 3.6.3 # 3.3.0 (2026-02-05) - Upgraded to Vendure 3.5.3 # 3.2.2 (2025-11-13) - Documentation update # 3.2.1 (2025-11-06) - Updated official documentation URL # 3.2.0 (2025-06-04) - Upgrade to Vendure to 3.3.2 # 3.1.0 (2024-12-19) - Update Vendure to 3.1.1 # 3.0.1 (2024-08-04) - Update compatibility range (#480) # 3.0.0 (2024-07-30) - Refactored this plugin to 'Limited Products' - Moved the limitation custom fields to the product level instead of variant - Made maxPerOrder also channel aware # 2.2.0 (2024-07-25) - Moved custom fields to their own tab 'Limitations' # 2.1.1 (2024-06-21) - Bugfix related to unable to add items: #470 # 2.1.0 (2024-06-21) - Updated Vendure to 2.2.6 # 2.0.0 (2024-04-10) - Added support for channel aware `onlyAllowPer` value per ProductVariant # 1.2.0 (2024-03-08) - Added support for adding a multiple of `onlyAllowPer` of a `ProductVariant` per `Order` # 1.1.0 (2023-10-24) - Updated vendure to 2.1.1 96:Tbee,# Sort by popularity Vendure plugin Sort products and categories by popularity based on previously placed orders. This plugin periodically scores products and categories based on the amount of times they occur in previously placed orders. The goal is to be able to order products and categories by their popularity, so we can present the most popular products and categories to our customers first. ## Getting started 1. Install the plugin in your `vendure-config.ts` ```ts import { PopularityScoresPlugin } from '@pinelab/vendure-plugin-popularity-scores' ... plugins: [ PopularityScoresPlugin.init({ endpointSecret: 'test', productFieldUiTab: 'Scores', collectionFieldUiTab: 'Scores' }), ... ]; ``` 2. [Run a database migration](https://docs.vendure.io/guides/developer-guide/migrations/) to create the custom fields needed for this plugin 3. Start your vendure server 4. Go to `http://localhost:3000/popularity-scores/calculate-scores//` to calculate the popularity scores of products and collections. You can also use the default channel's token to generate scores for all channels. Ideally you would do this periodically, like once a week or so. ## How it works This plugin exposes an endpoint that can be periodically called: `/popularity-scores/calculate-scores/:yourchanneltoken/:yoursecret`. This will push a job named `calculate-popularity` to the worker. The worker will handle this message and do the following: 1. Get all orders from the past 12 months. 2. Calculate the amount of times each Variant has been sold. 3. It then calculates the sum of all variants per Product, so that we have the amount of times a Product has been sold in the past 12 months. 4. It normalizes this value to a score of 0 to 10000, because we don't want to expose our number of sales publicly. 5. The normalized score will the be stored on `Product.customFields.popularityScore` 6. It then calculates the popularity of collections, based on the product scores and it's child collections 7. Collection scores are stored on `Collection.customFields.popularityScore` 8. Both the Product and Collection popularity scores are publicly available in the GraphQL Shop API. ### Popularity scores Popularity scores should only be used to sort products and collections. The actual values are normalized and don't have any absolute meaning. Scores of products are based on the amount sold of the past 12 months and normalized to a score of 0 to 1000. For collections, only the leaf collection scores are normalized. Any parent collection scores are just the sum of their sub-collections. This is to keep the popularity relation between parent/child collection in tact. I.e. a parent's score should be much higher, because it inherits all popularity from it's child collections. You can compare popularity scores of products with those of other products, but it doesn't really make sense to compare collection scores, because each collection will have a different amount of products in them. 97:T620,# 1.11.1 (2026-06-29) - Fixed NaN error when calculating popularity scores with cancelled orders (#676) # 1.11.0 (2026-08-05) - Upgraded to Vendure 3.6.3 # 1.10.0 (2026-02-05) - Upgraded to Vendure 3.5.3 # 1.9.2 (2025-11-13) - Documentation update # 1.9.1 (2025-11-06) - Updated official documentation URL # 1.9.0 (2025-06-04) - Upgrade to Vendure to 3.3.2 # 1.8.0 (2024-12-19) - Update Vendure to 3.1.1 # 1.7.3 (2024-08-04) - Update compatibility range (#480) # 1.7.2 (2024-07-25) - Allow specifying a UI tab for the `popularityScore` custom field # 1.7.1 (2024-07-22) - Fixed issue where in some projects a collection's parentId was set to null. See #478 # 1.7.0 (2024-06-21) - Updated Vendure to 2.2.6 # 1.6.2 (2024-03-29) - Work on #423 and optimizing popularity score calculation # 1.6.1 (2024-03-29) - Fix error when calculating popularity scores for collections (#386) # 1.6.0 (2024-01-21) - Aggregate the child `Product`s of a `Collection` in chunks when calculating its `popularityScore`. This adjustment aims to address [this reported issue](https://github.com/Pinelab-studio/pinelab-vendure-plugins/issues/303) # 1.5.0 (2023-12-15) - Allow manual setting of populairty scores on Products and Collections # 1.4.0 (2023-11-02) - Updated vendure to 2.1.1 # 1.3.0(2023-10-30) - Add condition to check if a collection is empty as specified in (here)[https://github.com/Pinelab-studio/pinelab-vendure-plugins/issues/279] # 1.1.0 - Remove unused select statement's while calculating product popularity scores to support Postgres 98:T1080,# Vendure SendCloud plugin This plugin syncs orders to the SendCloud fulfillment platform. ## How it works 1. When an order is placed, it is automatically sent to SendCloud as a parcel (for label creation). 2. The order stays in `PaymentSettled` state in Vendure — **no fulfillment is created at this point**. 3. Once an order has been sent to SendCloud, SendCloud is responsible for tracking status. The Vendure order will simply be transitioned to `Delivered` by the included scheduled task. This is because orders are sometimes cancelled and duplicated in Sendcloud, resulting in misaligned stock. 4. A private note is added to the order after each sync attempt, indicating success or failure. ## Getting started 1. Add the plugin to your `vendure-config.ts`: ```ts plugins: [ SendcloudPlugin.init({}), ... ] ``` 2. Go to your SendCloud account and go to `Settings > Integrations` and create an integration. 3. Write down the `secret` and `publicKey` of the created integration. 4. Start Vendure and login as admin. 5. Make sure you have the permission `SetSendCloudConfig`. 6. Go to `Settings` > `Channels`, open the channel you want to configure and select the **SendCloud** tab. Fill in your SendCloud `Secret` and `Public key`. Configuration is stored per channel as Channel custom fields, so no Admin UI extension needs to be compiled. 7. Additionally, you can set a `Default phone number`, for when a customer hasn't filled out one. A phone number is required by Sendcloud in some cases. > SendCloud is considered enabled for a channel once both `Secret` and > `Public key` are set. ## Scheduled task: fulfill settled orders An optional scheduled task `fulfillSettledOrdersTask` is included to automatically transition settled orders to `Delivered`. It is **not auto-registered** — you need to add it to your `schedulerOptions.tasks` yourself. The task runs nightly (default 2:00 AM) and processes all `PaymentSettled` orders placed within the last N days (default 7) that use the SendCloud fulfillment handler. Each qualifying order is fulfilled and transitioned to `Delivered`. Do not manually change order statuses in Vendure if you use this scheduled task. The task will fulfill orders and transition to delivered every night. ```ts import { DefaultSchedulerPlugin } from '@vendure/core'; import { SendcloudPlugin, fulfillSettledOrdersTask, } from '@pinelab/vendure-plugin-sendcloud'; const config: VendureConfig = { plugins: [SendcloudPlugin.init({}), DefaultSchedulerPlugin.init()], schedulerOptions: { tasks: [ // Use defaults (every day at 2:00 AM, look back 7 days) fulfillSettledOrdersTask, // Or configure the task fulfillSettledOrdersTask.configure({ schedule: (cron) => cron.everyDayAt(3, 0), params: { settledSinceDays: 14 }, }), ], }, }; ``` ## Additional configuration You can choose to send additional info to SendCloud: `weight`, `hsCode`, `origin_country` and additional parcel items. Parcel items will show up as rows on your SendCloud packaging slips. ```ts import { SendcloudPlugin, getNrOfOrders, } from '@pinelab/vendure-plugin-sendcloud'; plugins: [ SendcloudPlugin.init({ /** * Implement the weightFn to determine the weight of a parcel item, * or set a default value */ weightFn: (line) => (line.productVariant.product?.customFields as any)?.weight || 5, /** * Implement the hsCodeFn to set the hsCode of a parcel item, * or set a default value */ hsCodeFn: (line) => (line.productVariant.product?.customFields as any)?.hsCode || 'test hs', /** * Implement the originCountryFn to set the origin_country of a parcel item, * or set a default value */ originCountryFn: (line) => 'NL', /** * Implement the additionalParcelItemsFn to add additional rows to the SendCloud order. * This example adds the nr of previous orders of the current customer to SendCloud */ additionalParcelItemsFn: async (ctx, injector, order) => { const additionalInputs = []; additionalInputs.push(await getNrOfOrders(ctx, injector, order)); return additionalInputs; }, }), ]; ``` 99:T6a6,# 2.2.0 (2026-07-21) - Moved configurations from DB into code # 2.1.1 (2026-06-10) - Made the number of job queue retries for syncing orders to SendCloud configurable via `maxRetries` plugin option (default: 10, previously hardcoded to 20). # 2.1.0 (2026-08-05) - Upgraded to Vendure 3.6.3 # 2.0.0 (2026-04-12) - **Breaking**: Removed all webhook handling. Sendcloud is responsible for fulfillment. - Added `fulfillSettledOrdersTask` scheduled task (opt-in) to fulfill settled orders to `Delivered` on a nightly basis. - Orders are no longer automatically fulfilled on placement. They stay in `PaymentSettled` until the scheduled task runs to prevent misaligned stock in Vendure. # 1.6.0 (2026-02-05) - Upgraded to Vendure 3.5.3 # 1.5.3 (2025-11-13) - Documentation update # 1.5.2 (2025-11-06) - Updated official documentation URL # 1.5.1 (2025-09-15) - Log existing fulfillments when items are already fulfilled # 1.5.0 (2025-06-04) - Upgrade to Vendure to 3.3.2 # 1.4.0 (2024-12-19) - Update Vendure to 3.1.1 # 1.3.1 (2024-08-04) - Update compatibility range (#480) # 1.3.0 (2024-06-21) - Updated Vendure to 2.2.6 # 1.2.4 (2024-06-13) - Using util.inspect again to log the incoming webhook body # 1.2.4 (2024-06-13) - Check if incoming request is a Buffer or already parsed by other middleware # 1.2.3 (2024-06-13) - Log request body, instead of util.inspect # 1.2.2 (2024-06-13) - Added better logging for failing incoming webhooks # 1.2.1 (2023-01-16) - Correctly transition order to Delivered after it has been Shipped # 1.2.0 (2023-11-16) - Fulfill on order placement, to prevent stock levels going out of sync # 1.1.0 (2023-10-24) - Updated vendure to 2.1.1 9a:T36f1, # Product Import Export Plugin A Vendure plugin for importing and exporting product data via CSV. Supports bulk product management and data migration between environments. ## Features - **Import** – Bulk upload products from CSV with validation, custom fields, assets, facets, and variants - **Export** – Export products to CSV with selected fields; export all products or a selection - **Storage strategies** – Store exported files in S3 or locally on disk (with automatic fallback) - **UI** – Admin UI and Dashboard integration for import and export ![Dashboard UI](assets/Screenshot-dashboard-ui.png) ## Compatibility Vendure **^3.6.0** ## Getting started ```bash npm install @haus-tech/product-import-export-plugin ``` ## Configuration Add the plugin to your Vendure configuration. ```typescript export const config = { plugins: [ ProductImportExportPlugin.init({ importOptions: {}, // Configure import options exportOptions: { storageStrategy: 's3', // 's3' | 'disk' s3Options: { bucket: 'your-bucket', region: 'your-region', credentials: { accessKeyId: '...', secretAccessKey: '...', }, }, }, }), ], } ``` ## Configuration Options ### Import options | Option | Type | Default | Description | | ------------------------ | -------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------- | | `updateProductSlug` | `boolean` | `true` | Update product slug from the `name` field in the CSV | | `restoreSoftDeleted` | `boolean` | `true` | Restore soft-deleted products/variants found by id or SKU during import. If `false`, new products will be created instead. | | `storageStrategy` | `ImportJobStorageStrategy` | local disk | Strategy instance for queued import file storage and retrieval. | | `storageStrategyFactory` | `(injector: Injector) => ImportJobStorageStrategy` | `undefined` | Factory for DI-aware strategy creation (recommended for S3/remote storage). | | `importJobStorage` | `'local' \| 's3'` | `'local'` | Deprecated compatibility flag. Prefer `storageStrategy` / `storageStrategyFactory`. | Available import storage strategies: - `LocalImportJobStorageStrategy` (default) - `S3ImportJobStorageStrategy` ### Export options | Option | Type | Default | Description | | ----------------------- | --------------------- | ----------------------- | ------------------------------------------------------------ | | `defaultFileName` | `string` | `'products_export.csv'` | Default filename for exports | | `exportAssetsAsOptions` | `('url' \| 'json')[]` | `['url', 'json']` | Available formats for asset export | | `defaultExportAssetsAs` | `'url' \| 'json'` | `'url'` | Default asset export format | | `defaultExportFields` | `string[]` | See above | Fields that will be pre-selected in the export UI | | `requiredExportFields` | `string[]` | `['name', 'sku']` | Fields that must always be included | | `storageStrategy` | `'s3' \| 'disk'` | `'disk'` | Where exported files are stored | | `s3Options` | `object` | `undefined` | S3 configuration (required when `storageStrategy` is `'s3'`) | ### Storage strategy The plugin supports configurable storage for exported files: - **S3** – Stores export files in an S3-compatible bucket - **Disk (default)** – Saves files locally on the server ## CSV Format for Import ### Required columns - `name` – Product name (use `name:en`, `name:sv` etc. for multiple languages) - `sku` – Variant SKU (unique per variant) ### Optional columns | Column | Format | Example | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `name`, `slug`, `description` | Text, or `name:en`, `name:sv` for translations | `My Product` | | `assets` | Pipe-separated URLs, or JSON `[{"url":"...","name":"..."}]` | `https://example.com/1.jpg\|https://example.com/2.jpg` | | `facets` | `facet:value` pairs, pipe-separated | `Brand:Acme\|Category:Electronics` | | `optionGroups` | Pipe-separated group names. Use `name:code` to share a group across products (see [Sharing option groups](#sharing-option-groups)) | `Size\|Color` or `size:shoe-size` | | `optionValues` | Pipe-separated values (order matches option groups) | `Large\|Blue` | | `price` | Number (in smallest currency unit) | `9999` | | `taxCategory` | Tax category name | `standard` | | `stockOnHand` | Number | `100` | | `trackInventory` | `true` or `false` | `true` | | `variantAssets` | Same format as `assets` | `https://example.com/variant.jpg` | | `variantFacets` | Same format as `facets` | `Material:Cotton` | | `enabled` | `true` or `false` | `true` | | Custom fields | Column name = custom field name; value depends on field type | Add columns for any Product or ProductVariant custom fields defined in your Vendure config | #### Import behavior rules - If a column is omitted from the CSV header, that field is left unchanged on existing products/variants. - If a column exists in the header but the cell is empty, that field is explicitly cleared. - For products with more than one variant, `optionGroups` and `optionValues` are required. #### Sharing option groups By default, each product gets its own option groups. To **share an option group** across multiple products (e.g. a common "Size" group for all shoes), use the `name:code` syntax in the `optionGroups` column: `size:shoe-size`. All products that reference the same code will share a single option group. Products using a plain name (e.g. just `size`) will each get their own independent option group. ```csv ...optionGroups , optionValues , ... # Each shoe product shares a single "shoe-size" option group: "size:shoe-size" , Small , ... "size:shoe-size" , Medium , ... # This product gets its own independent "size" group: "size" , 4GB , ... ``` The first product to reference a given code defines the full set of option values for that shared group; subsequent products may use any subset of those values. Codes are language- agnostic — only the `name` portion before the colon is translated per language column (`optionGroups:en`, `optionGroups:sv`, etc.). #### Multi-language support Use language-specific columns by suffixing the field name with the language code. The language codes must match those configured in your Vendure instance (e.g. `en`, `sv`). | Column pattern | Example columns | Use case | | ------------------------ | ---------------------- | ------------------------------------------------ | | `name:en`, `name:sv` | Product name per lang | Translated product names | | `slug:en`, `slug:sv` | Slug per lang | Translated URLs | | `description:en` | Description per lang | Translated descriptions | | `facets:en`, `facets:sv` | Facets per lang | Translated facet names and values | | `optionGroups:en` | Option groups per lang | Translated option group names (e.g. Size, Color) | | `optionValues:en` | Option values per lang | Translated option values (e.g. Large, Blue) | Example CSV with English and Swedish: ```csv name:en,name:sv,sku,facets:en,facets:sv "Red Shirt","Röd tröja",SHIRT-001,"Color:Red|Size:Large","Färg:Röd|Storlek:Stor" ``` #### Multiple values (pipe separator) Fields that can have multiple values use the pipe character `|` as a separator: - **Facets**: `Brand:Acme|Category:Electronics` - **Option groups**: `Size|Color` - **Option values**: `Large|Blue` (order matches option groups) - **Assets**: `https://example.com/1.jpg|https://example.com/2.jpg` ## Usage :::note The Admin UI offers basic import and export. Some features such as the export-all option and the list of exported files are only available in the Dashboard. New features will be added to the Dashboard only. ::: ### Importing products 1. Create a CSV with the columns above. 2. Go to the Admin UI or Dashboard and open the Product Import section. 3. Upload the CSV and choose options (update slugs, restore soft-deleted, main language). 4. Select the update strategy: **merge** (keep existing facets/assets) or **replace** (overwrite). 5. Start the import. ### Exporting products 1. In the Admin UI or Dashboard, select products to export (or use bulk export). 2. Configure export fields (assets, facets, custom fields, etc.). - For products with more than one variant, `optionGroups` and `optionValues` must be included. - `productId` is not available as a selectable export field. - If `customFields` are not selected, no custom-field columns are written to the CSV. 3. Choose asset format: URL or JSON. 4. Start the export (it is added to a job queue and runs in the background). 5. Download the CSV when the export is complete. Your downloaded files will be listed in the export view. ![Export settings](assets/Screenshot-export-settings.png) ## Optional: Email notification on export complete If you use `@vendure/email-plugin`, you can add an email notification when an export finishes from the `/email` subpath. The plugin now provides a default fallback template for `product-export-complete/body.hbs`. If you define your own template in your app's template directory, your template takes precedence. Note: templates for `@vendure/email-plugin` should be valid MJML. ```typescript import path from 'path' import { DefaultEmailPlugin, FileBasedTemplateLoader, defaultEmailHandlers, } from '@vendure/email-plugin' import { withProductExportedHandler, withProductExportedTemplateFallback, } from '@haus-tech/product-import-export-plugin/email' export const config = { plugins: [ DefaultEmailPlugin.init({ handlers: withProductExportedHandler(defaultEmailHandlers), templateLoader: withProductExportedTemplateFallback( new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')), ), }), ], } ``` ## Resources - [Vendure Plugin Documentation](https://docs.vendure.io/guides/developer-guide/plugins/) - [Vendure Import/Export Guide](https://docs.vendure.io/guides/developer-guide/importing-data/) 9b:T3d42,## 3.6.0-next.2 ### 🩹 Fixes - **product-import-export-plugin:** poll exports list and restore featured asset on import ([644099a](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/644099a)) ## 3.6.0-next.1 ### 🚀 Features - **product-import-export-plugin:** integrate active channel management into export and import components ([1d3eef1](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1d3eef1)) ## 3.6.0-next.0 ### 🚀 Features - **product-import-export-plugin:** add installation ID and enhance e2e database management ([78eeffb](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/78eeffb)) - **product-import-export-plugin:** add popover help for export asset options ([7aa8373](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/7aa8373)) - **product-import-export-plugin:** implement export configuration panel and enhance export dialog ([d2e1f34](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/d2e1f34)) - **product-import-export-plugin:** enhance product export functionality and update tests ([de56d44](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/de56d44)) - **product-import-export-plugin:** update dependencies and enhance import/export functionality ([9c78665](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/9c78665)) ### 🩹 Fixes - **product-import-export-plugin:** update dashboard and export settings screenshots ([2129b39](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/2129b39)) ## 3.3.2-next.2 ### 🚀 Features - **product-import-export-plugin:** enhance email notification and import/export functionality ([c133dc5](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/c133dc5)) ## 3.3.2-next.1 ### 🚀 Features - **product-import-export-plugin:** enforce import/export acceptance criteria and enhance documentation ([b1a93b6](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/b1a93b6)) - **product-import-export-plugin:** update pre-version command and clean up export artifacts ([1cde024](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1cde024)) ## 3.3.2-next.0 ### 🚀 Features - **product-import-export-plugin:** optimize asset handling and caching in product importer ([9d2888e](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/9d2888e)) - **product-import-export-plugin:** enhance testing and export functionality ([1764eb2](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1764eb2)) - **product-import-export-plugin:** enforce import/export acceptance criteria (column-presence updates, multi-variant option requirements, no ProductID export option, clearer import CTA, and strict required relation custom-field validation) ## 3.3.1 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.3.1-next.0 ### 🚀 Features - enhance file name validation for product export functionality ([f9d5a45](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/f9d5a45)) - enhance export storage strategy configuration ([d589906](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/d589906)) - abstract logic into separate strategies ([1c7d0c7](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/1c7d0c7)) - enhance product export functionality with file name sanitization and S3 region update ([06af120](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/06af120)) - add S3 storage support for product export functionality ([08c0901](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/08c0901)) ### 🩹 Fixes - correct file path handling and ensure consistent file name sanitization in product export ([03a5bb5](https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public/commit/03a5bb5)) ## 3.2.1 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.2.0 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.1.10 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.1.9 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.1.8 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.1.7 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.1.6 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.1.5 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.1.4 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.1.3 ### 🚀 Features - enhance product import logic to handle soft-deleted products ([c88a164](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/c88a164)) ## 3.1.2 ### 🩹 Fixes - correct languageCode reference in slug assignment logic ([6c4d56d](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/6c4d56d)) ## 3.1.1 ### 🩹 Fixes - update slug assignment logic in ProductImporter ([#74](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/74)) ## 3.1.0 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.0.31-0 ### 🩹 Fixes - improve error handling and type safety in import/export plugin ([81ca5cf](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/81ca5cf)) ## 3.0.30 ### 🚀 Features - **product-import-export-plugin:** enhance product export functionality with temporary file handling ([aed754f](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/aed754f)) ## 3.0.29 ### 🚀 Features - **product-import-export-plugin:** add bulk export and exported files list components ([eb56ade](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/eb56ade)) ## 3.0.29-1 ### 🚀 Features - **product-import-export-plugin:** implement product export queue and enhance export functionality ([7e2d9f0](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/7e2d9f0)) ## 3.0.29-0 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.0.28-0 ### 🚀 Features - **product-import-export-plugin:** replace request header logic with channel-specific headers ([dfc781c](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/dfc781c)) - **product-import-export-plugin:** enhance import/export functionality and dashboard integration ([825ee89](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/825ee89)) ## 3.0.27-4 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.0.27-3 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.0.27-2 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.0.27-1 This was a version bump only for product-import-export-plugin to align it with other projects, there were no code changes. ## 3.0.27-0 ### 🚀 Features - **product-import-export-plugin:** add restoreSoftDeleted option for product import ([0458a2a](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/0458a2a)) - **product-importer:** enhance product variant handling ([4af2198](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/4af2198)) - **product-import-export-plugin:** enhance product import service with event bus integration and collection filtering ([#48](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/48)) - **product-import-export-plugin:** implement removal of option groups from product ([39f34ec](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/39f34ec)) - Enhance asset importer with URL and local file stream handling ([2b5ae3d](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/2b5ae3d)) ### 🩹 Fixes - **product-import-export-plugin:** improve import parser handling ([c952c7b](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/c952c7b)) - **product-import-export-plugin:** improve variant enabled handling ([a3a6af3](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/a3a6af3)) - **product-import-export-plugin:** improve option group handling and validate custom fields ([a95db85](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/a95db85)) - **product-import-export-plugin:** handle undefined prices in product variants ([#49](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/49)) - Refactor facetValues and options mapping for consistency in extended fast importer ([3514892](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/3514892)) - Improve asset and product importer logic for better channel handling and data consistency ([bc9416e](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/bc9416e)) - Assign assets to current channel on import ([#41](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/41)) ## 3.0.24-0 ### 🚀 Features - **product-import-export-plugin:** add restoreSoftDeleted option for product import ([0458a2a](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/0458a2a)) - **product-importer:** enhance product variant handling ([4af2198](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/4af2198)) - **product-import-export-plugin:** enhance product import service with event bus integration and collection filtering ([#48](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/48)) - **product-import-export-plugin:** implement removal of option groups from product ([39f34ec](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/39f34ec)) - Enhance asset importer with URL and local file stream handling ([2b5ae3d](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/2b5ae3d)) ### 🩹 Fixes - **product-import-export-plugin:** improve import parser handling ([c952c7b](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/c952c7b)) - **product-import-export-plugin:** improve variant enabled handling ([a3a6af3](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/a3a6af3)) - **product-import-export-plugin:** improve option group handling and validate custom fields ([a95db85](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/a95db85)) - **product-import-export-plugin:** handle undefined prices in product variants ([#49](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/49)) - Refactor facetValues and options mapping for consistency in extended fast importer ([3514892](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/3514892)) - Improve asset and product importer logic for better channel handling and data consistency ([bc9416e](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/bc9416e)) - Assign assets to current channel on import ([#41](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/41)) ## 3.0.23-0 ### 🚀 Features - **product-import-export-plugin:** add restoreSoftDeleted option for product import ([0458a2a](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/0458a2a)) - **product-importer:** enhance product variant handling ([4af2198](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/4af2198)) - **product-import-export-plugin:** enhance product import service with event bus integration and collection filtering ([#48](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/48)) - **product-import-export-plugin:** implement removal of option groups from product ([39f34ec](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/39f34ec)) - Enhance asset importer with URL and local file stream handling ([2b5ae3d](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/2b5ae3d)) ### 🩹 Fixes - **product-import-export-plugin:** improve import parser handling ([c952c7b](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/c952c7b)) - **product-import-export-plugin:** improve variant enabled handling ([a3a6af3](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/a3a6af3)) - **product-import-export-plugin:** improve option group handling and validate custom fields ([a95db85](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/a95db85)) - **product-import-export-plugin:** handle undefined prices in product variants ([#49](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/49)) - Refactor facetValues and options mapping for consistency in extended fast importer ([3514892](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/3514892)) - Improve asset and product importer logic for better channel handling and data consistency ([bc9416e](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/bc9416e)) - Assign assets to current channel on import ([#41](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/41)) ## 3.0.22 ### 🩹 Fixes - **product-import-export-plugin:** improve import parser handling ([c952c7b](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/c952c7b)) ## 3.0.21 ### 🚀 Features - **product-importer:** enhance product variant handling ([4af2198](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/4af2198)) - **product-import-export-plugin:** enhance product import service with event bus integration and collection filtering ([#48](https://github.com/WeAreHausTech/haus-vendure-plugins-public/pull/48)) - **product-import-export-plugin:** implement removal of option groups from product ([39f34ec](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/39f34ec)) - Enhance asset importer with URL and local file stream handling ([2b5ae3d](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/2b5ae3d)) ### 🩹 Fixes - **product-import-export-plugin:** improve variant enabled handling ([a3a6af3](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/a3a6af3)) - **product-import-export-plugin:** improve option group handling and validate custom fields ([a95db85](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/a95db85)) - **product-import-export-plugin:** handle undefined prices in product variants ([#49](https://github.com/WeAreHausTech/haus-vendure-plugins-public/pull/49)) - Refactor facetValues and options mapping for consistency in extended fast importer ([3514892](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/3514892)) - Improve asset and product importer logic for better channel handling and data consistency ([bc9416e](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/bc9416e)) - Assign assets to current channel on import ([#41](https://github.com/WeAreHausTech/haus-vendure-plugins-public/pull/41)) 9c:T9a5,# Vendure Google Sheet Loader plugin This plugin allows you to load data from a Google Sheet and handle the data in Vendure. For example, to load products and prices into Vendure. You can define a single action per channel. This means each channel can have it's own sheet, and it's own way of handling the data from that sheet. ## Getting started You need to have a Google API key to use this plugin. You can get one [here](https://support.google.com/googleapi/answer/6158862?hl=en). 1. Add this to your plugin in `vendure-config.ts`: ```ts import { GoogleSheetLoaderPlugin } from '@pinelab/vendure-plugin-google-sheet-loader'; plugins: [ GoogleSheetLoaderPlugin.init({ strategies: [new MyDataLoadingStrategy()], googleApiKey: 'test-api-key', }), ... ] ``` 2. The "Load Google Sheet data" action is added as a dropdown item in the product list page's action bar via the React Dashboard extension API — no Admin UI compilation step is needed. Before you can use this plugin, you need to implement your own data loading strategy. This strategy determines what will be done with the data from the sheet. ```ts import { RequestContext, Injector } from '@vendure/core'; import { GoogleSheetDataStrategy, SheetContent, } from '@pinelab/vendure-plugin-google-sheet-loader'; export class MyDataLoadingStrategy implements GoogleSheetDataStrategy { code = 'MyDataLoadingStrategy'; getSheetMetadata() { return { sheets: ['My tab'], spreadSheetId: '1gqZpM-Ksxc-xxKJAKNALAFNLLkksdalakml', }; } validateSheetData( ctx: RequestContext, sheets: SheetContent[] ): boolean | string { // Single sheet example const sheet = sheets[0]; const headerRow = sheet.data[0]; if (headerRow[0] !== 'My Header Column') { return 'Expected "My Header Column" for column 1'; } return true; } async handleSheetData( ctx: RequestContext, injector: Injector, sheets: SheetContent[] ): Promise { // Do whatever you want with the data here // This part is executed in the worker return `Successfully processed ${sheets[0].data.length} rows`; } } ``` ## How it works When the data loading is triggered from the product overview page in the admin UI, the plugin will: 1. Get the sheet metadata from the strategy 2. Fetch the content of the sheets 3. Validate the data, and give feedback to the admin user 4. If valid, a job will be created to handle the data 9d:Tc53,# Vendure MyParcel Plugin Plugin for sending placed orders to MyParcel. ## Getting started 1. Add this to your plugins in `vendure-config.ts`: ```ts import { MyparcelPlugin } from '@pinelab/vendure-plugin-myparcel'; plugins: [ MyparcelPlugin.init({ vendureHost: 'https://your-vendure-host.io', syncWebhookOnStartup: true, // If you want to automatically set vendureHost as webhook on MyParcel account }), ... ] ``` 2. Start Vendure and go to `Settings` > `Channels`, open the channel you want to configure and select the **MyParcel** tab. Tick `Enabled` and fill in your MyParcel `API key`. Configuration is stored per channel as Channel custom fields, so no Admin UI extension needs to be compiled. 3. Create a shipmentMethod with `MyParcel fulfillment`. 4. Place an order and select the shippingMethod. 5. Go to the Admin UI and click on `fulfill` 6. Your shipment should be in your MyParcel account. > The `myparcelEnabled` toggle controls whether MyParcel is active for a channel. > When it is off (or no API key is set), the plugin is disabled for that channel. ## Customs information for shipments outside the EU MyParcel requires additional customs information for shipments outside the EU. When you ship outside the EU, you should implement the `getCustomsInformationFn` when initializing the plugin: ```ts MyparcelPlugin.init({ vendureHost: 'https://your-vendure-host.io', getCustomsInformationFn: (orderItem) => { return { weightInGrams: (orderItem.line.productVariant.product.customFields as any) .weight, classification: ( orderItem.line.productVariant.product.customFields as any ).hsCode, countryCodeOfOrigin: 'NL', }; }, }); ``` You can find more information about the classification codes [here](https://myparcelnl.github.io/api/#7_E). ## Custom shipment strategy If you want more control over the data that is send over to MyParcel, then you can implement a custom `shipmentStrategy`. The shipment strategy needs to implement `MyParcelShipmentStrategy` and should containt the `getShipment` method. This method returns the shipment object for MyParcel [API reference](https://developer.myparcel.nl/api-reference/06.shipments.html) If you only need to change the recipient or the options, you can extend the `MyParcalDefaultShipmentStrategy` and overwrite the method you need. - `getOptions` - `getRecipient` ```ts class CustomShipmentStrategy extends MyParcalDefaultShipmentStrategy { getShipment(address: OrderAddress, order: Order, customsContent: string) { const shipment: MyparcelShipment = { carrier: 2, //bpost. Only available on sendmyparcel.be reference_identifier: order.code, options: this.getOptions(address, order, customsContent), recipient: this.getRecipient(address, order, customsContent), }; return shipment; } } ``` Pass you strategy to the MyparcelPlugin config. ```ts MyparcelPlugin.init({ vendureHost: 'https://your-vendure-host.io', shipmentStrategy: new CustomShipmentStrategy(), }); ``` `getCustomsInformationFn` will still be processed after the custom shipment strategy 9e:T6c2,# Vendure E-boekhouden plugin Plugin for syncing orders to the Dutch accounting platform E-boekhouden.nl. ## Getting started Send orders to e-Boekhouden as `GeldOntvangen` mutation and configured `account` and `contraAccount` numbers. Creates a mutation line for each taxrate of the order's tax summary. 1. Add this to your plugin in `vendure-config.ts`: ```ts import { EboekhoudenPlugin } from '@pinelab/vendure-plugin-e-boekhouden' plugins: [ EboekhoudenPlugin.init({ getTaxCode: (ctx, order, taxRate) => { if (order.customFields.VatID && taxRate == 0) { return 'VERL_VERK'; // Reverse charge for EU sales } else if (taxRate == 21) { return 'HOOG_VERK_21'; } else if (taxRate == 9) { return 'LAAG_VERK_9'; } else { Logger.error(`Unknown tax rate ${taxRate} for order ${order.code}`); return 'GEEN'; } }, }), ... ] ``` 2. Start the server and go to `Settings` > `Channels`, open the channel you want to configure and select the **E-boekhouden** tab. Tick `Enabled` and fill in your `Username`, `Security code 1`, `Security code 2`, `Account` and `Contra account`. Configuration is stored per channel as Channel custom fields, so no Admin UI extension needs to be compiled. > The `eBoekhoudenEnabled` toggle controls whether e-Boekhouden is active for a > channel. When it is off (or the config is incomplete), the plugin is disabled > for that channel. ### Development - generate new client 1. Go to https://soap.e-boekhouden.nl/soap.asmx?wsdl and save the wsdl file in `src/client/e-boekhouden-wsdl.xml`. 2. Run `yarn generate-soap-client`. 3. `src/client` will now have an updated and typed soap client for e-Boekhouden. 9f:T18e5,# Vendure UTM Tracker Plugin This plugin aims to fix over attribution when you use multiple different marketing platforms, by connecting UTM parameters directly to orders. ![UTM Tracker Plugin](https://plugins.pinelab.studio/plugin-images/utm-tracker.jpeg) When using multiple marketing platforms, each platform has their own attribution model, and each doesn't know what the other already attributed. This can lead to over attribution, or double-attribution. This means your ROAS or ROI might look better than it actually is. This plugin connects UTM parameters directly to orders, so that attribution can never exceed the actual value of an order. This might lead to slight under-attribution, but never to over attribution. ## Getting started 1. Add the plugin to your `vendure-config.ts` ```ts import { UTMTrackerPlugin, FirstClickAttribution, LastClickAttribution, LinearAttribution, UShapedAttribution } from '@pinelab/vendure-plugin-utm-tracker'; UTMTrackerPlugin.init({ attributionModel: new FirstClickAttribution(), // or LastClickAttribution, or LinearAttribution, or UShapedAttribution maxParametersPerOrder: 5, // The maximum number of UTM parameters that can be added to an order. If a customer adds more than this number, the oldest UTM parameters will be removed. maxAttributionAgeInDays: 10, // The maximum age of a UTM parameter to be attributed. If a UTM parameter is older than this number of days, it will not be attributed. getCampaignDisplayName: (ctx, utmParameters) => { // Allows you to set a custom display name for a campaign, based on the ctx and utm params. // Useful for example with Google Ads, where the campaign is the campaign ID, not the campaign name. if (utmParameters.campaign === '1234567890') { return `Campaign 1`; } else if (utmParameters.campaign === '1234567891') { return `Campaign 2`; } else { return utmParameters.campaign; } } }), ``` 2. Run a database migration to add the new entities to your database. This plugin shows UTM parameters on the order detail page via a React Dashboard extension — no Admin UI compilation step is needed — but doesn't include diagrams or charts. You should use your own data visualization or BI tool to visualize the data. ## Enable UTM parameters in your marketing tools Most platforms like Klaviyo or Google Ads allow you to automatically add UTM parameters to your campaigns. This is needed to extract the parameters on your storefront. ## Storefront usage To add parameters to an order, you can use the `addUTMParametersToOrder` mutation: ```graphql mutation addUTMParametersToOrder($inputs: [UTMParameterInput!]!) { addUTMParametersToOrder(input: $input) } """ Example input: "input": [ { "connectedAt": "2025-01-01T00:00:00.000Z", "source": "test-source1" "medium": "test-medium1", "campaign": "test-campaign1", "term": "test-term1", "content": "test-content1" }, { "connectedAt": "2025-01-02T00:00:00.000Z", "source": "test-source2" "medium": "test-medium2", "campaign": "test-campaign2", "term": "test-term2", "content": "test-content2" } ] """ ``` Keep in mind that UTM parameters can only be added to an active order! On most page visits, an active order is not present yet, so you should save the parameters in a cookie or local storage, along with the connectedAt date, and add them to the order when the order is created. You should not create a new order for each page visit, because this drastically increase the amount of orders in your database (Most visitors will never create an order, so this is a waste of resources). You should do something like this in your storefront: ```js import {storeUtmParameters, clearUtmParameters} from './utm-util.js'; // See script below async mounted() { // Or, `useEffect` in React const utmParameters = storeUtmParameters(window.location.search); // Store params in local storage on page load const activeOrder = await getActiveOrder(); // Or your equivalent of fetching the active order if (activeOrder && utmParameters) { await addUTMParametersToOrder(utmParameters); // The newly added mutation clearUtmParameters(); // Clear the parameters from local storage, so they are not added again later } }, ```

`utm-util.js` file

```js /** * Local storage key for storing UTM parameters. */ const key = 'vendure_utm_parameters'; /** * Parses the given path name, and saves the UTM parameters to the local storage. * Does nothing if the path name doesn't contain any UTM parameters. * * Do not pass full url, but use window.location.search instead. */ export function storeUtmParameters(queryParams) { const urlParams = new URLSearchParams(queryParams); const storedParameters = localStorage.getItem(key); const utmParameters = storedParameters ? JSON.parse(storedParameters) : []; if (!queryParams.includes('utm_')) { // Return existing parameters if no new ones are found. Or undefined if no parameters are stored. return utmParameters.length > 0 ? utmParameters : undefined; } utmParameters.push({ connectedAt: new Date().toISOString(), source: urlParams.get('utm_source') || undefined, medium: urlParams.get('utm_medium') || undefined, campaign: urlParams.get('utm_campaign') || undefined, term: urlParams.get('utm_term') || undefined, content: urlParams.get('utm_content') || undefined, }); localStorage.setItem(key, JSON.stringify(utmParameters)); return utmParameters; } /** * Clears the UTM parameters from the local storage. */ export function clearUtmParameters() { localStorage.removeItem(key); } ```

## Insights and visualizations This plugin doesn't include any visualization by default, but you can easily write your own insights with SQL. For example, this query will give you the total attributed revenue per source: ```sql SELECT utm.utmSource, utm.utmMedium, utm.utmCampaign, utm.utmTerm, utm.utmContent, SUM(utm.attributedRevenue) AS totalAttributedRevenue FROM utm_order_parameter utm JOIN `order` o ON utm.orderId = o.id WHERE o.orderPlacedAt IS NOT NULL AND o.state != 'Cancelled' GROUP BY utm.utmSource; ``` You can use different GROUP BY clauses to get the total attributed revenue per medium, campaign, term, content, etc. a0:T2c71,# Vendure Accept Blue Subscriptions Create recurring subscriptions with the Accept Blue platform. # How it works 1. A customer places an order with products that represent subscriptions 2. Customer adds a payment to order with `addPaymentToOrder` and supplies credit card details: - A customer is created in Accept Blue - A payment method with the card details is added to the customer - A charge is created for the customer with the initial amount due - A recurring subscription(s) for that customer is created 3. If all succeed, the order is transitioned to `PaymentSettled` # Getting started 1. Add to your Vendure config: ```ts AcceptBluePlugin.init({ vendureHost: 'https://my-vendure-backend.io' }), ``` 2. Start the server, create a payment method and select Accept Blue as handler 3. Place an order and use one of the payment methods below: :warning: Set `Use test mode` in your payment handler in the admin UI to use Accept Blue in test mode. ## Payment methods These are the different payment methods you can use to pay for an order. Keep in mind that these examples use sample input data. You can use the query `eligibleAcceptBluePaymentMethods` to check what payment methods and card types are enabled. This is configured in Vendure: your Accept Blue API Key should have all methods enabled for this to work. ### Pay with Saved Payment Method If a customer already has a payment method saved in Accept Blue, you can use that to pay for an order. ```graphql mutation { addPaymentToOrder( input: { method: "accept-blue", metadata: { paymentMethodId: 15087 } } ) { ... on Order { id code } } } ``` ### Pay with Check ```graphql mutation { addPaymentToOrder( input: { method: "accept-blue" metadata: { name: "Hayden Zieme" routing_number: "011000138" account_number: "49000002087" account_type: "Checking" sec_code: "PPD" } } ) { ... on Order { id code } } } ``` ### Pay with Nonce/Tokenized card With the hosted tokenization form, you can obtain a token that represents a credit card, and use that to pay for an order. More info on hosted tokenization here: https://docs.accept.blue/tokenization/v0.2 ```graphql mutation { addPaymentToOrder( input: { method: "accept-blue" metadata: { source: "nonce-z5frsiogt4kce2paljeb" last4: "1115" expiry_year: 2030 expiry_month: 3 } } ) { ... on Order { id code } } } ``` ### Managing payment methods You can fetch payment methods on a customer: on active customer when you are logged in, or on any customer via the Admin API. ```graphql query { activeCustomer { id emailAddress savedAcceptBluePaymentMethods { __typename ... on AcceptBlueCardPaymentMethod { id created_at avs_address avs_zip name expiry_month expiry_year payment_method_type card_type last4 } ... on AcceptBlueCheckPaymentMethod { id name last4 sec_code account_type routing_number } } } } ``` To update payment methods, you can use the following mutations. For the Shop API, you need to be logged in as the customer and be owner of the payment method. For the Admin API, you only need to be logged in as an admin and have `UpdateCustomer` permissions. ```graphql mutation { updateAcceptBlueCardPaymentMethod( input: { id: 14969 address: "Test street 12" zip: "test zip" name: "My Name Pinelab" expiryMonth: 5 expiryYear: 2040 } ) { id avs_address avs_zip name expiry_month expiry_year } } ``` Or for a check payment method: ```graphql mutation { updateAcceptBlueCheckPaymentMethod( input: { id: 15012 name: "My Name Pinelab" account_type: "savings" routing_number: "011000138" sec_code: "PPD" } ) { id name routing_number account_type sec_code } } ``` For creating a a card payment method, you need to use Hosted Tokenization (see `Pay with Nonce/Tokenized card` above). After getting a nonce token, you can use the following mutation to create a card payment method. For the Shop API, you need to be logged in. For the Admin API, you need to pass an Accept Blue customer ID into the mutation. ```graphql mutation { createAcceptBlueCardPaymentMethod( input: { nonce: "nonce-z5frsiogt4kce2paljeb" } ) { id } } ``` To create a check payment method, you can use the `createAcceptBlueCheckPaymentMethod` mutation. To connect a new payment method to a subscription, you can use the `updateAcceptBlueSubscription` mutation. ```graphql mutation { updateAcceptBlueSubscription(input: { id: 12345, paymentMethodId: 67890 }) { id paymentMethodId } } ``` For the Shop API, you need to be logged in as the customer and be owner of the payment method and the recurring schedule. For the Admin API, you only need to be logged in as an admin and have `UpdateOrder` permissions. ## Fetching Transactions and Subscriptions for placed orders After an order is placed, the `order.lines.acceptBlueSubscriptions` is populated with the actual subscription values from the Accept Blue platform, so it will not call your strategy anymore. This is to better reflect the subscription that was actually created at the time of ordering. This means you can now also get the transactions per subscriptions with the field `order.lines.acceptBlueSubscriptions.transactions`. To refund a transaction, you first need to get the transaction id. ```graphql # Sample query { orderByCode(code: "NQWHJ7FNYV7M348Z") { id code lines { acceptBlueSubscriptions { name variantId amountDueNow priceIncludesTax recurring { amount interval intervalCount startDate endDate } transactions { id createdAt settledAt amount status errorCode errorMessage checkDetails { # This object is populated when the transaction was made with Check name routingNumber last4 } cardDetails { # This object is populated when the transaction was made with a Credit Card name last4 expiryMonth expiryYear } } } } } } ``` ## Refunding Only the initial payment is handled as a Vendure payment, any other refunds are done via a dedicated mutation: 1. Fetch transactions for a customer or a subscription as explained above 2. Use the transaction ID to create a refund: ```graphql mutation { refundAcceptBlueTransaction(transactionId: 123, amount: 4567, cvv2: "999") { referenceNumber version status errorMessage errorCode errorDetails } } ``` The arguments `amount` and `cvv2` are optional, see [the Accept Blue Docs for more info](https://docs.accept.blue/api/v2#tag/processing-credit/paths/~1transactions~1refund). ## Updating Subscriptions You can update created subscriptions in Accept Blue as Admin via de admin-api with `UpdateOrder` permissions: ```graphql mutation { updateAcceptBlueSubscription( input: { id: 11820 title: "New Title For Updated Subscription" frequency: daily } ) { id name variantId recurring { interval intervalCount } # ... additional subscription fields } } ``` This wil emit an `AcceptBlueSubscriptionEvent` of type `updated`. ## Accept Blue Surcharges You can use the query `acceptBlueSurcharge` to see what surcharges your account has configured. ## CORS If you run into CORS issues loading the Accept Blue hosted tokenization javascript library, you might need to remove the `cross-origin` key on your `script` tag. ## Incoming events and webhooks This plugin emits an `AcceptBlueTransactionEvent` whenever it receives a webhook with a transaction update from Accept Blue. ```ts import { AcceptBlueTransactionEvent } from '@pinelab/vendure-plugin-accept-blue'; // In your project's application bootstrap this.eventBus.ofType(AcceptBlueTransactionEvent).subscribe((event) => { // Do your magic here // Please see the JS docs of `AcceptBlueTransactionEvent` for more information on this object. // Event.orderLine may be undefined, for example when refund transactions come in. Refunds are currently not connected to an orderLine }); ``` ## Google Pay This plugin also allows you to integration Google Pay. You will need to implement the Google Pay button on your storefront first. - Checkout the video to get a good understanding of the flow: https://developers.google.com/pay/api/web/overview - The complete script is available here: https://developers.google.com/pay/api/web/guides/tutorial#full-example - Integrate the Google Pay button on your storefront: https://docs.accept.blue/digital-wallet/google-pay After that, you end up with a `token` you receive from Google. Send that data to Vendure like so: ```graphql mutation { addPaymentToOrder( input: { method: "accept-blue" metadata: { source: "googlepay" amount: 10.8 token: "{\"signature\":\"MEUCIFZG..." } } ) { ... on Order { id code state } } } ``` Make sure that your amount equals the amount of the order! The amount is passed in as whole amount, not in cents, because this is how you will receive it from Google. You can configure the Merchant ID and Gateway Merchant ID on the payment method in Vendure, and fetch them via `eligiblePaymentMethods` or `eligibleAcceptBluePaymentMethods`. ## Additional Charge Input For the initial charge, you can pass additional input to the charge creation. This is useful if you want to add additional information to the charge, such as tax, surcharges,shipping information, etc. In your plugin initialization, you can pass a function that returns the additional input: ```ts AcceptBluePlugin.init({ additionalChargeInput: async (ctx, injector, order) => { // Here you can construct the additional input based on the order and the context // See https://docs.accept.blue/api/v2#tag/processing-charges for the fields available return { amount_details: { surcharge: 1, }, transaction_details: { description: 'Test description', }, billing_info: { first_name: 'John', last_name: 'Doe', street: '123 Main St', city: 'Anytown', state: 'CA', zip: '12345', country: 'US', phone: '1234567890', }, shipping_info: { first_name: 'John', last_name: 'Doe', street: '123 Main St', city: 'Anytown', state: 'CA', zip: '12345', country: 'US', phone: '1234567890', }, line_items: [ { sku: '1234567890', name: 'Test item', description: 'Test description', cost: 100, quantity: 1, tax_rate: 0.1, tax_amount: 10, }, ], }; }, }); ``` a1:T1ab7,# 3.9.1 (2026-06-29) - Fix `additionalChargeInput` monetary amounts not being divided by 100 before sending to Accept Blue. Amounts in `amount_details` and `line_items` are now automatically converted from Vendure cents to dollars. # 3.9.0 (2026-08-05) - Upgraded to Vendure 3.6.3 # 3.8.0 (2026-02-05) - Upgraded to Vendure 3.5.3 # 3.7.0 (2026-01-06) - Allow passing additional input when creating a charge via the `additionalChargeInput` option. - Use parent `order` instead of `orderLine.order` in `getSubscriptionsForOrderLine` to prevent hydration issues. # 3.6.2 (2025-11-13) - Documentation update # 3.6.1 (2025-11-06) - Updated official documentation URL # 3.6.0 (2025-09-23) - Allow disabling sending receipt emails to the customer via the Accept Blue platform. # 3.5.0 (2025-09-18) - Breaking: `amountDueNow` was not actually being used to calculate the line price! If you used `variant.price` in your subscription strategy, or used the default subscription strategy, everything still works as expected. - Allow subscriptions with `amount=0` - Delete created subscriptions if the one-time charge fails after that. # 3.4.0 (2025-08-18) - Store payment metadata for declined transactions. Create recurring schedule after successful charge. - POTENTIALLY BREAKING: Creating a card payment method now accepts a Vendure customer ID, which changed the input from `Int!` to `ID!`. # 3.3.1 (2025-07-17) - Prevent empty metadata for orders with $0 # 3.3.0 (2025-06-10) - Enable updating payment method on a subscription via the Shop API for logged in customers - Bug fix: Prevent updating a subscription to a payment method type (Visa, MasterCard, etc) that is not allowed. Only allow the methods set via the Admin UI. # 3.2.0 (2025-06-06) - Enable creating and deleting payment methods via the Shop API for logged in customers - Enable creating and deleting payment methods via the Admin API for all customers # 3.1.0 (2025-06-05) - Upgraded to Vendure 3.3.2 - Added updating of payment methods via the Shop API for logged in customers - Added updating of payment methods via the Admin API for all customers - Changed `testMode` log statement from warn to verbose - BREAKING: Removed `account_number` from `UpdateCheckPaymentMethodInput` as it is never returned by Accept Blue # 3.0.1 (2025-05-27) - Correctly encode email addresses when looking up customers in Accept Blue. This prevents incorrect `Customer not found` errors when using email addresses with `+` in them. - Fixed typo in error message # 3.0.0 (2025-05-13) - BREAKING: `AcceptBlueSubscription.recurring.endDate` is removed. - BREAKING: `AcceptBlueSubscription.recurring.startDate` is now optional. - The fields `createdAt`, `nextRunDate`, `previousRunDate` and `numLeft` have been added to `AcceptBlueSubscription.recurring`. # 2.6.1 (2025-04-28) - Prevent throwing an error when no enabled Accept Blue payment method is found when fetching other eligible Payment Methods. # 2.6.2 (2025-04-22) - Don't expose Accept Blue config on non Accept Blue Payment Method Quotes # 2.6.1 (2025-04-18) - Expose `acceptBlueTestMode` on Payment Method Quotes # 2.6.0 (2025-04-03) - Expose tokenization key, and Google merchant id's on payment method quote and eligible Accept Blue methods. # 2.5.2 (2025-04-01) - Added `Apple Pay` and `Google Pay` to eligible Accept Blue payment methods # 2.5.1 (2025-04-01) - Fixed typo `Allow Pay` to `Apple Pay` # 2.5.0 (2025-03-27) - Added Google Pay and Apple pay for creating subscriptions # 2.4.0 (2025-03-13) - Renamed internals to Amex as well - Not checking for `sec_code` input anymore, as it is an optional argument # 2.3.1 (2025-03-12) - Renamed payment method American Express to Amex # 2.3.0 (2025-03-06) - Allow disabling certain payment methods, e.g. 'visa' or 'check', via the Vendure Admin UI - Expose surcharges used by Accept Blue via GraphQL query # 2.2.0 (2025-01-14) - Update a customer's shipping and billing details in Accept Blue on subscription creation # 2.1.0 (2025-01-10) - Allow updating created subscriptions via the Admin API - Moved refunding to admin-api, and only allow with permission UpdateOrder # 2.0.2 (2025-01-09) - Publicly expose ctx in AcceptBlueTransactionEvent # 2.0.1 (2025-01-09) - Add ctx to AcceptBlueTransactionEvent # 2.0.0 (2024-12-19) - Update Vendure to 3.1.1 # 1.9.1 (2024-12-04) - Recurring amounts divided by 100 # 1.9.0 (2024-11-21) - Round up `nrOfBillingCyclesLeft`, to prevent unwanted never-ending subscriptions. See #532 - Made both custom fields `customer.acceptBlueCustomerId` and `orderLine.acceptBlueSubscriptionIds` nullable and readonly. DB migration needed - Included custom field type declaration file in published package - Return Declined when payment handling fails, instead of throwing # 1.8.1 (2024-11-03) - Bug fix: Return Settled state for successful refunds # 1.8.0 (2024-11-01) - Implemented refunding via admin UI for initial AC transaction # 1.7.2 (2024-10-29) - Export `AcceptBlueTransactionEvent` from package # 1.7.1 (2024-09-18) - Don't throw error while resolving `PaymentMethodQuote.acceptBlueHostedTokenizationKey` if there is no `AcceptBlue` method (#452) # 1.7 (2024-09-24) - Automatically register webhooks with Accept Blue on payment method creation and update - Emit `AcceptBlueTransactionEvent` on incoming webhooks from Accept Blue # 1.6.1 (2024-08-04) - Update compatibility range (#480) # 1.6.0 (2024-07-10) - Convert `biannually` to every 6 months instead of once every 2 years # 1.5.0 (2024-07-08) - Allow test mode to be set at payment method level. - Removed the usage of env var ACCEPT_BLUE_TEST_MODE for test mode. Use the setting on payment method. # 1.4.0 (2024-06-21) - Update Version to 2.2.6 # 1.3.1 (2024-06-06) - Return subscription id in Graphql type for created Accept Blue subscriptions # 1.3.0 (2024-05-21) - Allow refunding a transaction via `refundAcceptBlueTransaction` mutation. # 1.2.0 (2024-05-02) - `Order.lines.acceptBlueSubscriptions` now fetches created subscriptions from Accept Blue for placed orders, instead of calling your subscription strategy - `Order.lines.acceptBlueSubscriptions.transactions` shows the transactions made for the given subscriptions # 1.1.0 (2024-03-12) - Refactored order line custom field `subscriptionIds` to `acceptBlueSubscriptionIds` to avoid conflicts with for example the Stripe Plugin # 1.0.1 (2024-03-08) - Correctly check given input types # 1.0.0 (2024-03-07) - Always save payment methods and create recurring schedules and one time charges with a saved payment method - Allow payment for order with a saved payment method ID # 0.1.0 (2024-02-20) - Implement Charge Transaction with e2e tests - Implement Tokenized Credit Card Payment with e2e tests # 0.0.1 (2024-02-02) - Initial release 8d:{"data":{"items":[{"id":"ccb3cfb3-cb11-4deb-9908-83bfd0670fe5","packageName":"@pinelab/vendure-plugin-klaviyo","slug":"klaviyo","name":"Klaviyo","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/28dc6533-278f-40b4-a649-cde5e23a8d59/original.png","downloadCount":545,"latestVersion":"1.13.0","lastPublish":"2026-07-22T08:22:01.490Z","compatibility":">=2.2.0","readme":"$8f","changelog":"$90","docs":null,"metadataVersion":"1.13.0","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["marketing-seo"],"createdAt":"2026-05-22T12:36:54.040Z"},{"id":"e0da3649-83d5-4961-9794-cc740e4efcb2","packageName":"@pinelab/vendure-plugin-google-cloud-tasks","slug":"google-cloud-tasks","name":"Google Cloud Tasks","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/267fcac3-e672-4abd-ad76-9f21e717fbb4/original.png","downloadCount":534,"latestVersion":"2.2.0","lastPublish":"2026-07-22T08:21:30.515Z","compatibility":">=2.2.0","readme":"$91","changelog":"$92","docs":null,"metadataVersion":"2.2.0","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["infrastructure"],"createdAt":"2026-05-22T12:36:46.279Z"},{"id":"0cfd742f-387e-4660-b9a4-804aab1e6807","packageName":"@pinelab/vendure-plugin-admin-social-auth","slug":"admin-social-auth","name":"Admin Social Auth","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/a5346787-7951-4e13-b75a-a78bf6d9c20e/original.png","downloadCount":514,"latestVersion":"2.4.1","lastPublish":"2026-08-04T11:14:12.380Z","compatibility":">=3.2.0","readme":"$93","changelog":null,"docs":null,"metadataVersion":"2.4.1","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["admin-extensions"],"createdAt":"2026-05-22T12:36:25.995Z"},{"id":"6733de6a-d7f4-4c46-b782-6aa6b8ebda14","packageName":"@pinelab/vendure-plugin-limited-products","slug":"limited-products","name":"Limited Products","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/7f631d7c-e2be-41e5-9486-fb1d8008b63c/original.png","downloadCount":478,"latestVersion":"3.5.1","lastPublish":"2026-08-04T11:16:33.280Z","compatibility":">=2.2.0","readme":"$94","changelog":"$95","docs":null,"metadataVersion":"3.5.1","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["storefront"],"createdAt":"2026-05-22T12:36:55.796Z"},{"id":"21b69a68-17f3-4524-9d06-0b7a189e9df6","packageName":"@pinelab/vendure-plugin-popularity-scores","slug":"popularity-scores","name":"Popularity Scores","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/d6dcaeec-d048-4457-af1d-0ff088692576/original.png","downloadCount":476,"latestVersion":"1.11.1","lastPublish":"2026-06-30T10:21:22.074Z","compatibility":">=2.2.0","readme":"$96","changelog":"$97","docs":null,"metadataVersion":"1.11.1","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["analytics-reporting"],"createdAt":"2026-05-22T12:37:13.410Z"},{"id":"6a05c3e4-ef2e-4530-bda6-df799830cb8c","packageName":"@pinelab/vendure-plugin-sendcloud","slug":"sendcloud","name":"SendCloud","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/882c65c4-f855-4666-bc64-958b72acf76c/original.png","downloadCount":465,"latestVersion":"2.2.0","lastPublish":"2026-07-21T13:59:18.254Z","compatibility":">=3.1.0","readme":"$98","changelog":"$99","docs":null,"metadataVersion":"2.2.0","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["shipping-fulfillment"],"createdAt":"2026-05-22T12:37:24.371Z"},{"id":"9dd5b53c-f66e-4707-9342-68b82320f32e","packageName":"@haus-tech/product-import-export-plugin","slug":"product-import-export","name":"Product Import & Export","description":null,"registry":"npm","repositoryUrl":"https://github.com/WeAreHausTech/haus-tech-vendure-plugins-public","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/79d5ea89-a7b5-4c4a-8687-4552033ef826/original.png","downloadCount":453,"latestVersion":"3.6.2","lastPublish":"2026-06-22T10:06:42.953Z","compatibility":"^3.6.0","readme":"$9a","changelog":"$9b","docs":null,"metadataVersion":"3.6.2","partnerId":"b3f85c03-d34c-494e-af34-a2a9a55ca163","categories":["import-export"],"createdAt":"2026-06-22T10:10:52.017Z"},{"id":"ad55885f-b98f-4469-9398-70d470329176","packageName":"@pinelab/vendure-plugin-google-sheet-loader","slug":"google-sheet-loader","name":"Google Sheet Loader","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/cf1258ed-510e-4b32-8928-ba9ab092bfc6/original.png","downloadCount":420,"latestVersion":"1.3.1","lastPublish":"2026-08-04T11:11:54.087Z","compatibility":"^3.0.0","readme":"$9c","changelog":"# 1.3.1 (2026-08-04)\n\n- Include dashboard extensions in dist.\n\n# 1.3.0 (2026-07-21)\n\n- Migrated to React Dashboard\n\n# 1.2.1 (2026-07-10)\n\n- Fixed URL encoding of sheet names in Google Sheets API requests\n\n# 1.2.0 (2026-08-05)\n\n- Upgraded to Vendure 3.6.3\n\n# 1.1.0 (2026-02-05)\n\n- Upgraded to Vendure 3.5.3\n\n# 1.0.2 (2025-11-13)\n\n- Documentation update\n\n# 1.0.1 (2025-11-06)\n\n- Updated official documentation URL\n\n# 1.0.0 (2025-10-14)\n\n- Initial release\n","docs":null,"metadataVersion":"1.3.1","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["import-export"],"createdAt":"2026-05-22T12:36:48.641Z"},{"id":"73af5576-e28b-49e6-a11d-c324765cb7f0","packageName":"@pinelab/vendure-plugin-myparcel","slug":"myparcel","name":"MyParcel","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/5bfef668-f762-413b-80e6-5843c39089c9/original.png","downloadCount":302,"latestVersion":"1.8.0","lastPublish":"2026-07-21T13:59:51.453Z","compatibility":">=2.2.0","readme":"$9d","changelog":"# 1.8.0 (2026-07-21)\n\n- Moved configurations from DB into code\n\n# 1.7.1 (2026-06-17)\n\n- Improved error logging when fulfilling to MyParcel fails\n\n# 1.7.0 (2026-08-05)\n\n- Upgraded to Vendure 3.6.3\n\n# 1.6.0 (2026-02-05)\n\n- Upgraded to Vendure 3.5.3\n\n# 1.5.2 (2025-11-13)\n\n- Documentation update\n\n# 1.5.1 (2025-11-06)\n\n- Updated official documentation URL\n\n# 1.5.0 (2025-06-04)\n\n- Upgrade to Vendure to 3.3.2\n\n# 1.4.0 (2024-12-19)\n\n- Update Vendure to 3.1.1\n\n# 1.3.1 (2024-08-04)\n\n- Update compatibility range (#480)\n\n# 1.3.0 (2024-06-21)\n\n- Updated Vendure to 2.2.6\n\n# 1.2.0 (2024-01-15)\n\n- Add shipmentStrategy\n- Cleanup of types\n\n# 1.1.0 (2023-10-24)\n\n- Updated vendure to 2.1.1\n","docs":null,"metadataVersion":"1.8.0","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["shipping-fulfillment"],"createdAt":"2026-05-22T12:37:02.673Z"},{"id":"436cc38e-fe37-49b4-aba1-3a3a3fc3aee6","packageName":"@pinelab/vendure-plugin-e-boekhouden","slug":"e-boekhouden","name":"E-boekhouden","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/44031381-4f5c-4a96-a523-750ea66aaab3/original.png","downloadCount":289,"latestVersion":"2.3.0","lastPublish":"2026-07-21T17:32:09.926Z","compatibility":">=2.2.0","readme":"$9e","changelog":"# 2.3.0 (2026-07-21)\n\n- Moved configurations from DB into code\n\n# 2.2.0 (2026-08-05)\n\n- Upgraded to Vendure 3.6.3\n\n# 2.1.0 (2026-02-05)\n\n- Upgraded to Vendure 3.5.3\n\n# 2.0.0 (2025-11-25)\n\n- Add support for custom VAT code strategy to define the VAT code to send to e-boekhouden\n\n# 1.4.2 (2025-11-13)\n\n- Documentation update\n\n# 1.4.1 (2025-11-06)\n\n- Updated official documentation URL\n\n# 1.4.0 (2025-06-04)\n\n- Upgrade to Vendure to 3.3.2\n\n# 1.3.0 (2024-12-19)\n\n- Update Vendure to 3.1.1\n\n# 1.2.1 (2024-08-04)\n\n- Update compatibility range (#480)\n\n# 1.2.0 (2024-06-21)\n\n- Updated Vendure to 2.2.6\n\n# 1.1.0 (2023-10-24)\n\n- Updated vendure to 2.1.1\n","docs":null,"metadataVersion":"2.3.0","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["tax-compliance"],"createdAt":"2026-05-22T12:36:38.530Z"},{"id":"76b7ac24-c151-45ea-8c6b-f40cb2a29251","packageName":"@pinelab/vendure-plugin-utm-tracker","slug":"utm-tracker","name":"UTM Tracker","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/56a6632c-3d32-4009-b4a2-f881cb39feb8/original.png","downloadCount":287,"latestVersion":"1.6.0","lastPublish":"2026-07-21T13:59:44.115Z","compatibility":"^3.0.0","readme":"$9f","changelog":"# 1.6.0 (2026-07-21)\n\n- Migrated to React Dashboard\n\n# 1.5.0 (2026-08-05)\n\n- Upgraded to Vendure 3.6.3\n\n# 1.4.0 (2026-02-05)\n\n- Upgraded to Vendure 3.5.3\n\n# 1.3.1 (2026-01-06)\n\n- Fix type error in `getCampaignDisplayName`\n- Fixed typo in UI\n\n# 1.3.0 (2026-01-06)\n\n- Allow setting a custom display name for a campaign.\n\n# 1.2.2 (2025-11-13)\n\n- Documentation update\n\n# 1.2.1 (2025-11-06)\n\n- Updated official documentation URL\n\n# 1.2.0 (2025-10-30)\n\n- Added UI to view UTM parameters on the order detail page.\n- Added U-Shaped Attribution model.\n- Reversed orders of UTM parameters in API: Most recent parameters are now first.\n\n# 1.1.1 (2025-10-27)\n\n- Add `utm-util.js` file to the README.md\n\n# 1.1.0 (2025-10-24)\n\n- Allow adding bulk UTM parameters to an order, and de-duplicate parameters on the backend.\n- Allow passing `connectedAt` date from client, because UTM parameters are saved on the client first\n\n# 1.0.0 (2025-10-23)\n\n- Initial release\n","docs":null,"metadataVersion":"1.6.0","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["marketing-seo"],"createdAt":"2026-05-22T12:37:35.634Z"},{"id":"8ae559fe-ed9d-42d2-a4bc-5b8dec4c3f83","packageName":"@pinelab/vendure-plugin-accept-blue","slug":"accept-blue","name":"Accept Blue","description":null,"registry":"npm","repositoryUrl":"https://github.com/Pinelab-studio/pinelab-vendure-plugins","iconUrl":"https://minio.minio--wq6vpbzhh2fw.addon.code.run/api-public/plugin-icon/e293a158-705a-4546-82c1-28b489ccbd66/original.png","downloadCount":274,"latestVersion":"3.9.1","lastPublish":"2026-06-30T10:14:25.468Z","compatibility":">=3.2.0","readme":"$a0","changelog":"$a1","docs":null,"metadataVersion":"3.9.1","partnerId":"a87615d5-735c-494b-b572-84feaab866d8","categories":["other"],"createdAt":"2026-05-22T12:36:22.313Z"}],"total":38,"page":2,"pageSize":12},"error":"$undefined"}

Plugin Directory

Plugin Directory