Constructors

Properties

Methods

Constructors

Properties

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

Type declaration

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

Methods

  • Gets the current or staged representation of a Product found by Key. 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[];
              localeProjection?: string | string[];
              priceChannel?: string;
              priceCountry?: string;
              priceCurrency?: string;
              priceCustomerGroup?: string;
              staged?: boolean;
              storeProjection?: string;
              [key: string]: QueryParam;
          };
      }
      • Optional headers?: {
            [key: string]: string | string[];
        }
        • [key: string]: string | string[]
      • Optional queryArgs?: {
            expand?: string | string[];
            localeProjection?: string | string[];
            priceChannel?: string;
            priceCountry?: string;
            priceCurrency?: string;
            priceCustomerGroup?: string;
            staged?: boolean;
            storeProjection?: string;
            [key: string]: QueryParam;
        }
        • [key: string]: QueryParam
        • Optional expand?: string | string[]
        • Optional localeProjection?: string | string[]
        • Optional priceChannel?: string
        • Optional priceCountry?: string
        • Optional priceCurrency?: string
        • Optional priceCustomerGroup?: string
        • Optional staged?: boolean
        • Optional storeProjection?: string

    Returns ApiRequest<ProductProjection>

  • Checks if the current or staged representation of a Product exists for a given key. Returns a 200 OK status if the ProductProjection exists or a 404 Not Found otherwise.

    Parameters

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

    Returns ApiRequest<void>