Products By SKU Plugin
Storefront plugin config for resolving SKUs to variant IDs, including quick-order strategy integration.
Disclaimer: This module depends on compatible plugin behavior being active in the consumer's Vendure backend instance. Configure the backend first, then register this plugin config in the storefront.
Purpose
Use this module when CSV/manual quick order inputs are SKU-based and must be validated/resolved before adding order lines.
Features
- Exposes
VendureProductsBySkuPluginrequest contract - Exposes
quickOrderVariantSkuValidationStrategyutility - Exposes
ProductVariantBySkuResultand request type definitions
Installation
- npm
- Yarn
npm install @haus-storefront-react/vendure-plugin-configs
yarn add @haus-storefront-react/vendure-plugin-configs
Note: This is not a public package. Contact the Haus Tech Team for access.
API Reference
Utilities
quickOrderVariantSkuValidationStrategy
Returns a QuickOrderVariantValidationStrategy that resolves SKU input to variant IDs through plugin SDK requests.
Exports
VendureProductsBySkuPluginquickOrderVariantSkuValidationStrategyProductVariantBySkuResult,ProductsBySkuPluginRequeststypes
Basic Usage
Example 1: Register Plugin in Data Provider
Use this to register the products-by-sku plugin in your provider pluginConfigs.
- React
- React Native
import { VendureProductsBySkuPlugin } from '@haus-storefront-react/vendure-plugin-configs/products-by-sku'
// This plugin has no configurable feature/settings payload in init.
const pluginConfig = VendureProductsBySkuPlugin
import { VendureProductsBySkuPlugin } from '@haus-storefront-react/vendure-plugin-configs/products-by-sku'
// This plugin has no configurable feature/settings payload in init.
const pluginConfig = VendureProductsBySkuPlugin
Example 2: Consume Plugin Functionality
Use this in quick-order flows after the plugin has been registered.
- React
- React Native
import { QuickOrder } from '@haus-storefront-react/quick-order'
import { quickOrderVariantSkuValidationStrategy } from '@haus-storefront-react/vendure-plugin-configs/products-by-sku'
const skuStrategy = quickOrderVariantSkuValidationStrategy()
export function QuickOrderBySku() {
return <QuickOrder.Manual.Root validationStrategy={skuStrategy} />
}
import { Text } from 'react-native'
import { quickOrderVariantSkuValidationStrategy } from '@haus-storefront-react/vendure-plugin-configs/products-by-sku'
const skuStrategy = quickOrderVariantSkuValidationStrategy()
export function QuickOrderStatus() {
return <Text>{typeof skuStrategy.validate === 'function' ? 'Strategy ready' : 'Not ready'}</Text>
}
Made with ❤️ by Haus Tech Team