Skip to main content

Class: ProductService

Defined in: service/ProductService.ts:544

Backwards-compatible class form. New code should call productService(client).

Constructors​

Constructor​

new ProductService(client): ProductService

Defined in: service/ProductService.ts:546

Parameters​

client​

GraphQLClient

Returns​

ProductService

Methods​

addSurchargesToProduct()​

addSurchargesToProduct(input): Promise<ConfirmationResponse>

Defined in: service/ProductService.ts:591

Adds surcharges to a product

Parameters​

input​

AddSurchargesToProductInput

Surcharges input data

Returns​

Promise<ConfirmationResponse>

baseProductCategoryMoveAbove()​

baseProductCategoryMoveAbove(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ProductService.ts:609

Parameters​

variables​

BaseProductCategoryMoveAboveVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

baseProductCategoryMoveAboveByUuids()​

baseProductCategoryMoveAboveByUuids(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ProductService.ts:610

Parameters​

variables​

BaseProductCategoryMoveAboveByUuidsVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

baseProductCategoryMoveBelow()​

baseProductCategoryMoveBelow(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ProductService.ts:611

Parameters​

variables​

BaseProductCategoryMoveBelowVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

baseProductCategoryMoveBelowByUuids()​

baseProductCategoryMoveBelowByUuids(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ProductService.ts:612

Parameters​

variables​

BaseProductCategoryMoveBelowByUuidsVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

baseProductCategoryMoveToBottom()​

baseProductCategoryMoveToBottom(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ProductService.ts:613

Parameters​

variables​

BaseProductCategoryMoveToBottomVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

baseProductCategoryMoveToBottomByUuids()​

baseProductCategoryMoveToBottomByUuids(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ProductService.ts:614

Parameters​

variables​

BaseProductCategoryMoveToBottomByUuidsVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

baseProductCategoryMoveToTop()​

baseProductCategoryMoveToTop(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ProductService.ts:615

Parameters​

variables​

BaseProductCategoryMoveToTopVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

baseProductCategoryMoveToTopByUuids()​

baseProductCategoryMoveToTopByUuids(variables): Promise<BaseProductCategoryRelationship[]>

Defined in: service/ProductService.ts:616

Parameters​

variables​

BaseProductCategoryMoveToTopByUuidsVariables

Returns​

Promise<BaseProductCategoryRelationship[]>

createProduct()​

createProduct(input): Promise<Product>

Defined in: service/ProductService.ts:574

Creates a new product

Parameters​

input​

CreateProductInput

Product creation input data

Returns​

Promise<Product>

getAttributeResultByProductId()​

getAttributeResultByProductId(productId, input): Promise<AttributeResultResponse>

Defined in: service/ProductService.ts:608

Fetches attribute results for a product

Parameters​

productId​

number

Product ID

input​

AttributeResultSearchInput

Attribute result search input

Returns​

Promise<AttributeResultResponse>

getAttributesByProductId()​

getAttributesByProductId(productId, input): Promise<AttributeResponse>

Defined in: service/ProductService.ts:602

Fetches attributes for a product

Parameters​

productId​

number

Product ID

input​

AttributeSearchInput

Attribute search input

Returns​

Promise<AttributeResponse>

getBaseProducts()​

getBaseProducts(variables): Promise<BaseProductsResponse>

Defined in: service/ProductService.ts:617

Parameters​

variables​

BaseProductsVariables

Returns​

Promise<BaseProductsResponse>

getProduct()​

getProduct(variables, fetchOptions?): Promise<Product>

Defined in: service/ProductService.ts:564

Fetches a single product by ID, slug, or SKU

Parameters​

variables​

ProductQueryVariables

input variables for aproduct to fetch

  • productId: int - Product ID to fetch
    • slug: string - Product slug to fetch
    • sku: string - Product SKU to fetch
    • language: string - Language for localized content
    • applyOrderlists: boolean - Whether to apply orderlist logic
    • orderlistIds: number[] - Array of orderlist IDs to apply
    • priceCalculateProductInput: PriceCalculateProductInput - Price calculation input
    • userBulkPriceProductInput: UserBulkPriceProductInput - User bulk price input
    • attributeResultSearchInput: AttributeResultSearchInput - Attribute search input
    • imageSearchFilters: MediaImageProductSearchInput - Image search filters
    • mediaVideoSearchInput: MediaVideoProductSearchInput - Video search input
    • mediaDocumentSearchInput: MediaDocumentProductSearchInput - Document search input
    • imageVariantFilters: TransformationsInput - Image transformation filters
fetchOptions?​

GraphQLFetchOptions

Returns​

Promise<Product>

getProducts()​

getProducts(variables): Promise<ProductsResponse>

Defined in: service/ProductService.ts:569

Fetches a list of products with search criteria

Parameters​

variables​

ProductsQueryVariables

Product search input parameters

Returns​

Promise<ProductsResponse>

getProductSearchBatchMetrics()​

getProductSearchBatchMetrics(): Promise<BatchMetricsTenantResponse>

Defined in: service/ProductService.ts:629

Returns​

Promise<BatchMetricsTenantResponse>

getProductSearchBatchMetricsFailedJobs()​

getProductSearchBatchMetricsFailedJobs(variables): Promise<BatchMetricsFailedJobsResponse>

Defined in: service/ProductService.ts:630

Parameters​

variables​

ProductSearchBatchMetricsFailedJobsVariables

Returns​

Promise<BatchMetricsFailedJobsResponse>

getProductSearchBatchMetricsHourly()​

getProductSearchBatchMetricsHourly(): Promise<BatchMetricsTenantHourlyResponse>

Defined in: service/ProductService.ts:631

Returns​

Promise<BatchMetricsTenantHourlyResponse>

getProductSearchBatchMetricsQueueStatus()​

getProductSearchBatchMetricsQueueStatus(): Promise<BatchMetricsQueueStatusResponse>

Defined in: service/ProductService.ts:632

Returns​

Promise<BatchMetricsQueueStatusResponse>

getProductSearchByCategory()​

getProductSearchByCategory(variables): Promise<ProductSearchByCategoryResponse>

Defined in: service/ProductService.ts:633

Parameters​

variables​

ProductSearchByCategoryVariables

Returns​

Promise<ProductSearchByCategoryResponse>

getProductSearchReindexLock()​

getProductSearchReindexLock(): Promise<ReindexLockResponse>

Defined in: service/ProductService.ts:639

Returns​

Promise<ReindexLockResponse>

getProductSearchReindexStatus()​

getProductSearchReindexStatus(variables): Promise<ReindexStatusResponse>

Defined in: service/ProductService.ts:641

Parameters​

variables​

ProductSearchReindexStatusVariables

Returns​

Promise<ReindexStatusResponse>

getProductSearchSolr()​

getProductSearchSolr(variables): Promise<ProductSearchResponse>

Defined in: service/ProductService.ts:642

Parameters​

variables​

ProductSearchSolrVariables

Returns​

Promise<ProductSearchResponse>

getProductsRaw()​

getProductsRaw(variables): Promise<ProductsRawResponse>

Defined in: service/ProductService.ts:647

Parameters​

variables​

ProductsRawVariables

Returns​

Promise<ProductsRawResponse>

getProductSurcharges()​

getProductSurcharges(productId): Promise<SurchargeProductResponse>

Defined in: service/ProductService.ts:596

Fetches surcharges for a product

Parameters​

productId​

number

Product ID

Returns​

Promise<SurchargeProductResponse>

importProductsCsv()​

importProductsCsv(input): Promise<CsvImportResponse>

Defined in: service/ProductService.ts:586

Imports products from CSV

Parameters​

input​

ProductCsvInput

CSV import input data

Returns​

Promise<CsvImportResponse>

productAddToCategory()​

productAddToCategory(variables): Promise<ProductCategoryRelationship>

Defined in: service/ProductService.ts:618

Parameters​

variables​

ProductAddToCategoryVariables

Returns​

Promise<ProductCategoryRelationship>

productAssignToCluster()​

productAssignToCluster(variables): Promise<Product>

Defined in: service/ProductService.ts:619

Parameters​

variables​

ProductAssignToClusterVariables

Returns​

Promise<Product>

productCategoryMoveAbove()​

productCategoryMoveAbove(variables): Promise<ProductCategoryRelationship[]>

Defined in: service/ProductService.ts:620

Parameters​

variables​

ProductCategoryMoveAboveVariables

Returns​

Promise<ProductCategoryRelationship[]>

productCategoryMoveBelow()​

productCategoryMoveBelow(variables): Promise<ProductCategoryRelationship[]>

Defined in: service/ProductService.ts:621

Parameters​

variables​

ProductCategoryMoveBelowVariables

Returns​

Promise<ProductCategoryRelationship[]>

productCategoryMoveToBottom()​

productCategoryMoveToBottom(variables): Promise<ProductCategoryRelationship[]>

Defined in: service/ProductService.ts:622

Parameters​

variables​

ProductCategoryMoveToBottomVariables

Returns​

Promise<ProductCategoryRelationship[]>

productCategoryMoveToTop()​

productCategoryMoveToTop(variables): Promise<ProductCategoryRelationship[]>

Defined in: service/ProductService.ts:623

Parameters​

variables​

ProductCategoryMoveToTopVariables

Returns​

Promise<ProductCategoryRelationship[]>

productClusterMoveAbove()​

productClusterMoveAbove(variables): Promise<BaseProductClusterRelationship[]>

Defined in: service/ProductService.ts:624

Parameters​

variables​

ProductClusterMoveAboveVariables

Returns​

Promise<BaseProductClusterRelationship[]>

productClusterMoveBelow()​

productClusterMoveBelow(variables): Promise<BaseProductClusterRelationship[]>

Defined in: service/ProductService.ts:625

Parameters​

variables​

ProductClusterMoveBelowVariables

Returns​

Promise<BaseProductClusterRelationship[]>

productClusterOptionMoveAbove()​

productClusterOptionMoveAbove(variables): Promise<ProductClusterOptionRelationship[]>

Defined in: service/ProductService.ts:626

Parameters​

variables​

ProductClusterOptionMoveAboveVariables

Returns​

Promise<ProductClusterOptionRelationship[]>

productClusterOptionMoveBelow()​

productClusterOptionMoveBelow(variables): Promise<ProductClusterOptionRelationship[]>

Defined in: service/ProductService.ts:627

Parameters​

variables​

ProductClusterOptionMoveBelowVariables

Returns​

Promise<ProductClusterOptionRelationship[]>

productRemoveFromCategory()​

productRemoveFromCategory(variables): Promise<boolean>

Defined in: service/ProductService.ts:628

Parameters​

variables​

ProductRemoveFromCategoryVariables

Returns​

Promise<boolean>

productsBulkAddToCategory()​

productsBulkAddToCategory(variables): Promise<ProductCategoryRelationship[]>

Defined in: service/ProductService.ts:645

Parameters​

variables​

ProductsBulkAddToCategoryVariables

Returns​

Promise<ProductCategoryRelationship[]>

productsBulkRemoveFromCategory()​

productsBulkRemoveFromCategory(variables): Promise<boolean>

Defined in: service/ProductService.ts:646

Parameters​

variables​

ProductsBulkRemoveFromCategoryVariables

Returns​

Promise<boolean>

productSearchCategoriesIndex()​

productSearchCategoriesIndex(variables): Promise<IndexEntitiesResponse>

Defined in: service/ProductService.ts:634

Parameters​

variables​

ProductSearchCategoriesIndexVariables

Returns​

Promise<IndexEntitiesResponse>

productSearchClustersIndex()​

productSearchClustersIndex(variables): Promise<IndexEntitiesResponse>

Defined in: service/ProductService.ts:635

Parameters​

variables​

ProductSearchClustersIndexVariables

Returns​

Promise<IndexEntitiesResponse>

productSearchFullReindexCancel()​

productSearchFullReindexCancel(variables): Promise<CancelReindexResponse>

Defined in: service/ProductService.ts:636

Parameters​

variables​

ProductSearchFullReindexCancelVariables

Returns​

Promise<CancelReindexResponse>

productSearchFullReindexStart()​

productSearchFullReindexStart(variables): Promise<StartReindexResponse>

Defined in: service/ProductService.ts:637

Parameters​

variables​

ProductSearchFullReindexStartVariables

Returns​

Promise<StartReindexResponse>

productSearchProductsIndex()​

productSearchProductsIndex(variables): Promise<IndexEntitiesResponse>

Defined in: service/ProductService.ts:638

Parameters​

variables​

ProductSearchProductsIndexVariables

Returns​

Promise<IndexEntitiesResponse>

productSearchReindexLockForceRelease()​

productSearchReindexLockForceRelease(): Promise<ForceReleaseLockResponse>

Defined in: service/ProductService.ts:640

Returns​

Promise<ForceReleaseLockResponse>

productSetDefaultCategory()​

productSetDefaultCategory(variables): Promise<Product>

Defined in: service/ProductService.ts:643

Parameters​

variables​

ProductSetDefaultCategoryVariables

Returns​

Promise<Product>

productUnassignFromCluster()​

productUnassignFromCluster(variables): Promise<Product>

Defined in: service/ProductService.ts:644

Parameters​

variables​

ProductUnassignFromClusterVariables

Returns​

Promise<Product>

updateProduct()​

updateProduct(variables): Promise<Product>

Defined in: service/ProductService.ts:581

Updates an existing product

Parameters​

variables​

ProductUpdateVariables

Product update input data

  • productId: number - ID of the product to update
  • input: UpdateProductInput - The fields to update for the product

Returns​

Promise<Product>