getProductsWithFilter
Feteches product data by applying filters.
It receives data from the BigCommerce getProductsWithFilter GraphQL API.
Signature
declare function getProductsWithFilter(
context: BigcommerceIntegrationContext,
params: GetProductsWithFilterParameters
): Promise<ProductsResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | BigcommerceIntegrationContext | |
params | Required | GetProductsWithFilterParameters |
Returns
Returns a response with the products data
Referenced Types
Examples
Fetch products by applying a filter.
import { sdk } from '~/sdk.config.ts';
const products = await sdk.bigcommerce.getProductsWithFilter({
filters: {
searchTerm: 'cup'
}
})