Class ProductVariantDataService

constructor

• new ProductVariantDataService(db, attachmentService): ProductVariantDataService

• Parameters

  • db: Db

  • attachmentService: AttachmentDefaultService

  Returns ProductVariantDataService

bulkWriteProductVariants

• bulkWriteProductVariants(bulkUpdateList): Promise<number>

• Run a series of updates on multiple product variants. Updates will be performed using the bulkWrite method.

  Parameters

  • bulkUpdateList: {
        data: Partial<ProductVariantBasicInfo & ProductVariantReferences>;
        ids: string[];
    }[]

    List of product variants to update and their ids

    TODO: Add transaction support in the future

  Returns Promise<number>

copyProductVariants

• copyProductVariants(sourceProductId, targetProductId): Promise<number>

• Copy product variants from one product to another.

  Parameters

  • sourceProductId: string

    id of the source product

  • targetProductId: string

    id of the target product

  Returns Promise<number>

  count of records copied

createManyProductVariants

• createManyProductVariants(productVariantList): Promise<{
      id: string;
  }[]>

• Create many Product variants

  Parameters

  • productVariantList: Partial<ProductVariantBasicInfo & WithPartialPriceField & ProductVariantReferences>[]

    List of product variants

  Returns Promise<{
      id: string;
  }[]>

  object containing the id of the created record blocks-58c1

createProductVariant

• createProductVariant(productVariant): Promise<{
      id: string;
  }>

• Create Product variant

  Parameters

  • productVariant: Partial<ProductVariantBasicInfo & ProductVariantReferences & WithPartialPriceField>

    Data of product variant

  Returns Promise<{
      id: string;
  }>

  object containing the id of the created record blocks-58c1

deleteManyProductVariants

• deleteManyProductVariants(variantIds): Promise<number>

• Delete product variants as a batch.

  Parameters

  • variantIds: string[]

    ids of variants to delete

  Returns Promise<number>

  count of records deleted

deleteProductVariant

• deleteProductVariant(variantId): Promise<boolean>

• Delete product variant by variantId

  Parameters

  • variantId: string

  Returns Promise<boolean>

  true if variant delete successfully blocks-3f1c

deleteProductVariantsByProductIds

• deleteProductVariantsByProductIds(productIds): Promise<number>

• Delete product variants by a list of productIds.

  Parameters

  • productIds: string[]

    id of the product

  Returns Promise<number>

  count of records deleted

expandImages

• expandImages(variants, expand?): Promise<ProductVariantResponse[]>

• Expand a list of product variants with image data from the attachment service

  Note: This expand always expands, as images are expanded by default

  Parameters

  • variants: ProductVariantResponse[]

  • Optional expand: Expand

  Returns Promise<ProductVariantResponse[]>

expandProductVariants

• expandProductVariants(variants, expand?): Promise<ProductVariantResponse[]>

• Expand the products varients with other microservices and data types

  Parameters

  • variants: ProductVariantResponse[]

  • Optional expand: Expand

  Returns Promise<ProductVariantResponse[]>

  ProductResponse[]

getProductVariant

• getProductVariant(productVariantId, forProductId?): Promise<null | ProductVariantEntity>

• Get product variant from database. Optionally, you can pass forProductId to filter by product id.

  Parameters

  • productVariantId: string

  • Optional forProductId: string

  Returns Promise<null | ProductVariantEntity>

  Promise<Product | undefined> Product Variant data if fetched successfully, or null if data not found by id

getProductVariants

• getProductVariants(ids): Promise<ProductVariantEntity[]>

• Get product variants from database for a list of ids.

  Parameters

  • ids: string[]

  Returns Promise<ProductVariantEntity[]>

getProductVariantsByProductId

• getProductVariantsByProductId(productId): Promise<ProductVariantEntity[]>

• Get product variants from database for a single product.

  Parameters

  • productId: string

  Returns Promise<ProductVariantEntity[]>

listPaginatedProductVariants

• listPaginatedProductVariants(opts, extraFilters?): Promise<PaginatedFindResult<ProductVariantEntity>>

• List paginated product variants

  Parameters

  • opts: ParsedPaginatedListQuery

    paginated list query options

  • Optional extraFilters: {
        productId?: string;
    }

    • Optional productId?: string

  Returns Promise<PaginatedFindResult<ProductVariantEntity>>

  paginated product variants list query result

normalizeProductVariantResponse

• normalizeProductVariantResponse(variant): Promise<ProductVariantResponse>

• Normalize a single product variant response

  Parameters

  • variant: ProductVariantBasicInfo & ProductVariantReferences

  Returns Promise<ProductVariantResponse>

normalizeProductVariantResponses

• normalizeProductVariantResponses(variants): Promise<ProductVariantResponse[]>

• Normalize a list of product variant responses

  Parameters

  • variants: (ProductVariantBasicInfo & ProductVariantReferences)[]

  Returns Promise<ProductVariantResponse[]>

updateProductVariant

• updateProductVariant(variantId, productVariant): Promise<{
      id: string;
  }>

• Update product variant by productId and variantId

  Parameters

  • variantId: string

  • productVariant: Partial<ProductVariantBasicInfo & ProductVariantReferences>

    data to update

  Returns Promise<{
      id: string;
  }>

  true if variant updated successfully blocks-3f1c

upsertProductVariantsForProduct

• upsertProductVariantsForProduct(productId, variants): Promise<void>

• Update product variants for a product, deleting the variants that are not in the list

  Parameters

  • productId: string

  • variants: Partial<PrimaryKey & ProductVariantBasicInfo & ProductVariantReferences & WithPartialPriceField>[]

  Returns Promise<void>

Static Readonly COLLECTION_PRODUCT_VARIANT