Alokai
You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current

getProduct

Endpoint for fetching filtered, and paginated products. By default, it uses the getProductDefaultQuery GraphQL query

Signature

export declare function getProduct(
	context: SetupContext,
	params: GetProductParams,
	customQuery?: CustomQuery,
	responseOptions?: ResponseOptions
): Promise<GetProductResponse>;

Parameters

NameRequiredTypeDescription
contextRequiredSetupContextAutomatically injected context. Refer to SetupContext
paramsRequiredGetProductParamsFiltering and pagination options
customQueryOptionalCustomQueryCustom queries included in the request
responseOptionsOptionalResponseOptions

Returns

Product data

Referenced Types

On this page