Properties
client Config
client Config : ClientConfig < ConfigParameters > & { baseUri : string ; }
Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:36068
Static
Readonly
api Paths
api Paths : { getGiftCertificate : string ; }
Type declaration
get Gift Certificate : string
Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:36072
Static
Readonly
default Base Uri
default Base Uri : "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-gift-certificates/v1" = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-gift-certificates/v1"
Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:36071
Static
Readonly
param Keys
param Keys : { getGiftCertificate : readonly [ "organizationId" , "siteId" ] ; getGiftCertificateRequired : readonly [ "organizationId" , "siteId" ] ; }
Type declaration
Readonly
get Gift Certificate : readonly [ "organizationId" , "siteId" ]
Readonly
get Gift Certificate Required : readonly [ "organizationId" , "siteId" ]
Defined in node_modules/commerce-sdk-isomorphic/lib/index.cjs.d.ts:36076
Shopper Gift Certificates
*# API Overview
Use the Shopper Gift Certificates API to obtain gift certificate details.
Authentication & Authorization
The Shopper Gift Certificates API requires a JSON Web Token acquired via the Shopper Customers endpoint:
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
Retrieve Existing Gift Certificate Details
A shopper who received a code identifying a gift certificate can use the gift certificate code to query information, such as the status or remaining balance.
Use Hooks
For details working with hooks, see Extensibility with Hooks.*
Simple example:
API Version: 0.0.33Last Updated: