Class ByProjectKeyProductProjectionsRequestBuilder

Constructors

constructor

Properties

args

Methods

get head search suggest withId withKey

Constructors

constructor

Properties

Protected Readonly args

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

Type declaration

  • Optional baseUri?: string
  • executeRequest: executeRequest
  • pathArgs: {
        projectKey: string;
    }
    • projectKey: string

Methods

get

  • get(methodArgs?): 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

    • Optional 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;
          };
      }
      • Optional headers?: {
            [key: string]: string | string[];
        }
        • [key: string]: string | string[]
      • Optional 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;
        }
        • [key: string]: QueryParam
        • Optional expand?: string | string[]
        • Optional limit?: number
        • Optional localeProjection?: string | string[]
        • Optional offset?: number
        • Optional priceChannel?: string
        • Optional priceCountry?: string
        • Optional priceCurrency?: string
        • Optional priceCustomerGroup?: string
        • Optional sort?: string | string[]
        • Optional staged?: boolean
        • Optional storeProjection?: string
        • Optional where?: string | string[]
        • Optional withTotal?: boolean

    Returns ApiRequest<ProductProjectionPagedQueryResponse>

head

  • head(methodArgs?): 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

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

    Returns ApiRequest<void>

search

suggest

withId

withKey

Settings

Member Visibility

Theme

On This Page

constructorargsgetheadsearchsuggestwithIdwithKey