Typescript SDK Type Docs
    Preparing search index...

    Class ByProjectKeyProductProjectionsKeyByKeyRequestBuilder

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

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

    Methods

    • Retrieves the projected representation of a Product by its Key.

      By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
      If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
      
      Required access scopes:
      
      - To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
      
      - To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
      

      Parameters

      • OptionalmethodArgs: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: {
                expand?: string | string[];
                "filter[attributes]"?: string | string[];
                localeProjection?: string | string[];
                priceChannel?: string;
                priceCountry?: string;
                priceCurrency?: string;
                priceCustomerGroup?: string;
                priceCustomerGroupAssignments?: string | string[];
                priceRecurrencePolicy?: string;
                staged?: boolean;
                storeProjection?: string;
                [key: string]: QueryParam;
            };
        }

      Returns ApiRequest<ProductProjection>