Class ShopperPromotions<ConfigParameters>

Shopper Promotions

View details for active promotions.

Simple example:

  import { ShopperPromotions } from "commerce-sdk-isomorphic";

  const clientConfig = {
    parameters: {
      clientId: "XXXXXX",
      organizationId: "XXXX",
      shortCode: "XXX",
      siteId: "XX"
    }
  };
  const shopperPromotionsClient = new ShopperPromotions(clientConfig);
API Version: 1.0.21
Last Updated:

Type Parameters

Hierarchy

  • ShopperPromotions

Constructors

constructor

Methods

getPromotions getPromotionsForCampaign

Properties

clientConfig defaultBaseUri

Constructors

constructor

Methods

getPromotions

  • Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.

    If you would like to get a raw Response object use the other getPromotions function.

    Parameters

    • Optional options: RequireParametersUnlessAllAreOptional<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              [K in "organizationId" | "siteId" | "locale" | "ids"]: (Omit<{
                  ids: string;
                  locale?: string;
                  organizationId: string;
                  siteId: string;
              }, keyof ConfigParameters> & Partial<{
                  ids: string;
                  locale?: string;
                  organizationId: string;
                  siteId: string;
              }>)[K]
          };
      }>

      An object containing the options for this method.

    Returns Promise<PromotionResult>

    A promise of type PromotionResult.

  • Returns an array of enabled promotions for a list of specified IDs. In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters. Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.

    Type Parameters

    • T extends boolean

    Parameters

    • Optional options: RequireParametersUnlessAllAreOptional<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              [K in "organizationId" | "siteId" | "locale" | "ids"]: (Omit<{
                  ids: string;
                  locale?: string;
                  organizationId: string;
                  siteId: string;
              }, keyof ConfigParameters> & Partial<{
                  ids: string;
                  locale?: string;
                  organizationId: string;
                  siteId: string;
              }>)[K]
          };
      }>

      An object containing the options for this method.

    • Optional rawResponse: T

      Set to true to return entire Response object instead of DTO.

    Returns Promise<T extends true
        ? Response
        : PromotionResult>

    A promise of type Response if rawResponse is true, a promise of type PromotionResult otherwise.

getPromotionsForCampaign

  • Handles get promotion by filter criteria. Returns an array of enabled promotions matching the specified filter criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date range by providing start_date and end_date parameters. Both parameters are required to specify a date range, as omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled promotions, since the server does not consider promotion qualifiers or schedules.

    If you would like to get a raw Response object use the other getPromotionsForCampaign function.

    Parameters

    • Optional options: RequireParametersUnlessAllAreOptional<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              [K in "organizationId" | "siteId" | "currency" | "campaignId" | "startDate" | "endDate"]: (Omit<{
                  campaignId: string;
                  currency?: string;
                  endDate?: string;
                  organizationId: string;
                  siteId: string;
                  startDate?: string;
              }, keyof ConfigParameters> & Partial<{
                  campaignId: string;
                  currency?: string;
                  endDate?: string;
                  organizationId: string;
                  siteId: string;
                  startDate?: string;
              }>)[K]
          };
      }>

      An object containing the options for this method.

    Returns Promise<PromotionResult>

    A promise of type PromotionResult.

  • Handles get promotion by filter criteria. Returns an array of enabled promotions matching the specified filter criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date range by providing start_date and end_date parameters. Both parameters are required to specify a date range, as omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled promotions, since the server does not consider promotion qualifiers or schedules.

    Type Parameters

    • T extends boolean

    Parameters

    • Optional options: RequireParametersUnlessAllAreOptional<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              [K in "organizationId" | "siteId" | "currency" | "campaignId" | "startDate" | "endDate"]: (Omit<{
                  campaignId: string;
                  currency?: string;
                  endDate?: string;
                  organizationId: string;
                  siteId: string;
                  startDate?: string;
              }, keyof ConfigParameters> & Partial<{
                  campaignId: string;
                  currency?: string;
                  endDate?: string;
                  organizationId: string;
                  siteId: string;
                  startDate?: string;
              }>)[K]
          };
      }>

      An object containing the options for this method.

    • Optional rawResponse: T

      Set to true to return entire Response object instead of DTO.

    Returns Promise<T extends true
        ? Response
        : PromotionResult>

    A promise of type Response if rawResponse is true, a promise of type PromotionResult otherwise.

Properties

clientConfig

clientConfig: ClientConfig<ConfigParameters> & {
    baseUri: string;
}

Static Readonly defaultBaseUri

defaultBaseUri: "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-promotions/{version}" = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-promotions/{version}"

Settings

Member Visibility

Theme

On This Page