Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShopperGiftCertificates<ConfigParameters>

Shopper Gift Certificates

Obtain details about a gift certificate.

Simple example:

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

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

Type parameters

Hierarchy

  • ShopperGiftCertificates

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

clientConfig

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

Static Readonly defaultBaseUri

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

Static Readonly paramKeys

paramKeys: { getGiftCertificate: ["organizationId", "siteId"]; getGiftCertificateRequired: ["organizationId", "siteId"] } = {getGiftCertificate: ['organizationId','siteId',],getGiftCertificateRequired: ['organizationId','siteId',],} as const

Type declaration

  • getGiftCertificate: ["organizationId", "siteId"]
  • getGiftCertificateRequired: ["organizationId", "siteId"]

Methods

getGiftCertificate

  • Action to retrieve an existing gift certificate.

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

    Parameters

    Returns Promise<GiftCertificate>

    A promise of type GiftCertificate.

  • Action to retrieve an existing gift certificate.

    Type parameters

    • T: boolean

    Parameters

    Returns Promise<T extends true ? Response : GiftCertificate>

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

Generated using TypeDoc