Class ByProjectKeyProductProjectionsRequestBuilder

Constructors

constructor

Properties

args

Methods

get head search suggest withId withKey

Constructors

constructor

Properties

Protected Readonlyargs

args: {
    baseUri?: string;
    executeRequest: executeRequest;
    pathArgs: { projectKey: string };
}

Methods

get

  • get(
        methodArgs?: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: {
                expand?: string | string[];
                limit?: number;
                localeProjection?: string | string[];
                offset?: number;
                priceChannel?: string;
                priceCountry?: string;
                priceCurrency?: string;
                priceCustomerGroup?: string;
                sort?: string | string[];
                staged?: boolean;
                storeProjection?: string;
                where?: string | string[];
                withTotal?: boolean;
                [key: string]: QueryParam;
            };
        },
    ): ApiRequest<ProductProjectionPagedQueryResponse>

    Use the Product Projections query endpoint to get the current or staged representations of Products. When used with an API Client that has the view_published_products:{projectKey} scope, this endpoint only returns published (current) Product Projections.

    Parameters

    • OptionalmethodArgs: {
          headers?: { [key: string]: string | string[] };
          queryArgs?: {
              expand?: string | string[];
              limit?: number;
              localeProjection?: string | string[];
              offset?: number;
              priceChannel?: string;
              priceCountry?: string;
              priceCurrency?: string;
              priceCustomerGroup?: string;
              sort?: string | string[];
              staged?: boolean;
              storeProjection?: string;
              where?: string | string[];
              withTotal?: boolean;
              [key: string]: QueryParam;
          };
      }

    Returns ApiRequest<ProductProjectionPagedQueryResponse>

head

  • head(
        methodArgs?: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
        },
    ): ApiRequest<void>

    Checks if the current or staged representation of a Product exists for a given Query Predicate. Returns a 200 OK status if any ProductProjections match the Query Predicate or a 404 Not Found otherwise.

    Parameters

    • OptionalmethodArgs: {
          headers?: { [key: string]: string | string[] };
          queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
      }

    Returns ApiRequest<void>

search

suggest

withId

withKey

Settings

Member Visibility

On This Page

Constructors
Properties
Methods