ImportParser

@vendure/core Source

Validates and parses CSV files into a data structure which can then be used to created new entities. This is used internally by the Importer.

Signature

class ImportParser {    parseProducts(input: string | Stream, mainLanguage: LanguageCode = this.configService.defaultLanguageCode) => Promise<ParseResult<ParsedProductWithVariants>>;}

parseProducts

method

(input: string | Stream, mainLanguage: LanguageCode = this.configService.defaultLanguageCode) => Promise<ParseResult<ParsedProductWithVariants>>

Parses the contents of the product import CSV file and returns a data structure which can then be used to populate Vendure using the FastImporterService.

@vendure/core Source

The intermediate representation of an OptionGroup after it has been parsed by the ImportParser.

Signature

interface ParsedOptionGroup {    code?: string;    translations: Array<{        languageCode: LanguageCode;        name: string;        values: string[];    }>;}

code

propertystring

An optional explicit code for the option group, parsed from the CSV name:code syntax. When two products specify the same code, they will share the option group.

translations

propertyArray<{ languageCode: LanguageCode; name: string; values: string[]; }>

@vendure/core Source

The intermediate representation of a Facet after it has been parsed by the ImportParser.

Signature

interface ParsedFacet {    translations: Array<{        languageCode: LanguageCode;        facet: string;        value: string;    }>;}

translations

propertyArray<{ languageCode: LanguageCode; facet: string; value: string; }>

@vendure/core Source

The intermediate representation of a ProductVariant after it has been parsed by the ImportParser.

Signature

interface ParsedProductVariant {    sku: string;    price: number;    taxCategory: string;    stockOnHand: number;    trackInventory: GlobalFlag;    assetPaths: string[];    facets: ParsedFacet[];    translations: Array<{        languageCode: LanguageCode;        optionValues: string[];        customFields: {            [name: string]: string;        };    }>;}

sku

propertystring

price

propertynumber

taxCategory

propertystring

stockOnHand

propertynumber

trackInventory

propertyGlobalFlag

assetPaths

propertystring[]

propertyParsedFacet[]

translations

property

Array<{         languageCode: LanguageCode;         optionValues: string[];         customFields: {             [name: string]: string;         };     }>

@vendure/core Source

The intermediate representation of a Product after it has been parsed by the ImportParser.

Signature

interface ParsedProduct {    assetPaths: string[];    optionGroups: ParsedOptionGroup[];    facets: ParsedFacet[];    translations: Array<{        languageCode: LanguageCode;        name: string;        slug: string;        description: string;        customFields: {            [name: string]: string;        };    }>;}

assetPaths

propertystring[]

optionGroups

propertyParsedOptionGroup[]

propertyParsedFacet[]

translations

property

Array<{         languageCode: LanguageCode;         name: string;         slug: string;         description: string;         customFields: {             [name: string]: string;         };     }>

@vendure/core Source

The data structure into which an import CSV file is parsed by the ImportParser parseProducts() method.

Signature

interface ParsedProductWithVariants {    product: ParsedProduct;    variants: ParsedProductVariant[];}

product

propertyParsedProduct

variants

propertyParsedProductVariant[]

@vendure/core Source

The result returned by the ImportParser parseProducts() method.

Signature

interface ParseResult<T> {    results: T[];    errors: string[];    processed: number;}

results

propertyT[]

errors

propertystring[]

processed

propertynumber

Was this chapter helpful?

Report Issue

Edited Mar 13, 2026·Edit this page