Class ShopperPromotions<ConfigParameters>

Shopper Promotions

*# API Overview

Retrieve information about active promotions within the context of a shopper and a site. You can use this API to retrieve promotions that you configured in the commerce platform by searching for specific promotion IDs or by searching for promotions associated with a campaign.

Caching is provided for the Shopper Promotions API. For details, see Server-Side Web-Tier Caching.

Authentication & Authorization

The Shopper Promotions API requires a JSON Web Token acquired via the Shopper Customers endpoint:

https://{{shortcode}}.api.commercecloud.salesforce.com/customer/shopper-customers/v1/organizations/{{organizationId}}/customers/actions/login

You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see Authorization Scopes Catalog.

Use Cases

Get Promotion by Promotion ID

Use the Shopper Promotions API to find promotion information by the promotion ID.

For example, a customer who is browsing on a commerce shopping app built using Commerce Cloud APIs can see the details about the applied promotions in the cart.

Get Promotion by Campaign ID

Use the Shopper Promotions API to find promotion information by the campaign ID.

For example, a customer who is browsing on a commerce shopping app built using Commerce Cloud APIs can see the possible promotions that can be applied in the cart.

Use Hooks

For details working with hooks, see Extensibility with Hooks.*

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: 0.0.33
Last Updated:

Type Parameters

Hierarchy

  • ShopperPromotions

Constructors

constructor

Methods

getPromotions getPromotionsForCampaign

Properties

clientConfig apiPaths defaultBaseUri paramKeys

Constructors

constructor

Methods

getPromotions

  • 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 string | number]: (Omit<{
                  ids: string[];
                  locale?: string;
                  organizationId: string;
                  siteId: string;
              } & QueryParameters, keyof ConfigParameters> & Partial<{
                  ids: string[];
                  locale?: string;
                  organizationId: string;
                  siteId: string;
              } & QueryParameters>)[K]
          };
      }>

      An object containing the options for this method.

    Returns Promise<PromotionResult>

    A promise of type PromotionResult.

  • 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 string | number]: (Omit<{
                  ids: string[];
                  locale?: string;
                  organizationId: string;
                  siteId: string;
              } & QueryParameters, keyof ConfigParameters> & Partial<{
                  ids: string[];
                  locale?: string;
                  organizationId: string;
                  siteId: string;
              } & QueryParameters>)[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

  • Retrieves promotion information using 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, and 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 string | number]: (Omit<{
                  campaignId: string;
                  currency?: string;
                  endDate?: string;
                  organizationId: string;
                  siteId: string;
                  startDate?: string;
              } & QueryParameters, keyof ConfigParameters> & Partial<{
                  campaignId: string;
                  currency?: string;
                  endDate?: string;
                  organizationId: string;
                  siteId: string;
                  startDate?: string;
              } & QueryParameters>)[K]
          };
      }>

      An object containing the options for this method.

    Returns Promise<PromotionResult>

    A promise of type PromotionResult.

  • Retrieves promotion information using 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, and 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 string | number]: (Omit<{
                  campaignId: string;
                  currency?: string;
                  endDate?: string;
                  organizationId: string;
                  siteId: string;
                  startDate?: string;
              } & QueryParameters, keyof ConfigParameters> & Partial<{
                  campaignId: string;
                  currency?: string;
                  endDate?: string;
                  organizationId: string;
                  siteId: string;
                  startDate?: string;
              } & QueryParameters>)[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;
}

Type declaration

  • baseUri: string

Static Readonly apiPaths

apiPaths: {
    getPromotions: string;
    getPromotionsForCampaign: string;
}

Type declaration

  • getPromotions: string
  • getPromotionsForCampaign: string

Static Readonly defaultBaseUri

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

Static Readonly paramKeys

paramKeys: {
    getPromotions: readonly ["organizationId", "siteId", "ids", "locale"];
    getPromotionsForCampaign: readonly ["campaignId", "organizationId", "siteId", "startDate", "endDate", "currency"];
    getPromotionsForCampaignRequired: readonly ["campaignId", "organizationId", "siteId"];
    getPromotionsRequired: readonly ["organizationId", "siteId", "ids"];
}

Type declaration

  • Readonly getPromotions: readonly ["organizationId", "siteId", "ids", "locale"]
  • Readonly getPromotionsForCampaign: readonly ["campaignId", "organizationId", "siteId", "startDate", "endDate", "currency"]
  • Readonly getPromotionsForCampaignRequired: readonly ["campaignId", "organizationId", "siteId"]
  • Readonly getPromotionsRequired: readonly ["organizationId", "siteId", "ids"]

Settings

Member Visibility

Theme

On This Page