Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input for getting offer details .

extends

DigitalCommerceInput

Hierarchy

Index

Constructors

constructor

  • Constructor function for GetCatalogOffersInput class

    Returns GetOfferInput

Properties

actionObj

actionObj: Action

Action object json.

anonymousSiteUrl

anonymousSiteUrl: string

anonymousSiteUrl as the prefix of the API url for Off-Platform deployments.

apiNamespace

apiNamespace: string

API namespace.

Optional attributes

attributes: string

attributes as part of the query string of the API for getting Attribute values chosen for the desired offer.

cacheable

cacheable: boolean = true

Boolean flag to indicate if we should cache the offer in SDK. Default is true to always cache offer in SDK.

catalogCode

catalogCode: string

catalogCode to be used in part of the path of the API to get associated products and promotions.

Optional context

context: string

context params as part of the query string of the API to define which offers qualify in returning result set.

Optional contextDebug

contextDebug: boolean

contextDebug as part of the query string of the API for returning a full context name:value pair array. This parameter only works when a server setting enables contextdebug to be set from the API.

Optional contextKey

contextKey: string

contextKey as part of the query string of the API describes the anonymous or known customer's "context" to be used in rule processing.

Optional fields

fields: string[]

List of fields to be returned.

Optional forceInvalidateCache

forceInvalidateCache: boolean

forceInvalidateCache as part of the query string of the API to refresh the cache for a particular catalog.

Optional includeRelated

includeRelated: string

includeRelated as part of the query string of the API for controlling what data about related products and promotions is included in the response.

Optional isLoggedIn

isLoggedIn: boolean

isLoggedIn as part of the query string of the API.

offerCode

offerCode: string

offerCode to be used in part of the path of the API to get the details of the associated product.

Optional quantity

quantity: number

quantity as part of the query string of the API for getting quantity of the offer desired.

reload

reload: boolean = false

Boolean flag to indicate if we should reload a new offer via API or return the client side cached offer if exists. Default is false to cached offer.

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class that handles this request.

remoteMethod

remoteMethod: string

Remote method that handles this request.

Methods

getAPIPath

  • getAPIPath(): string
  • Function that constructs the API path for ApexRest Handles scenerio when namespace is null

    Returns string

getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string

Protected getEncodedQueryString

  • getEncodedQueryString(): string

getInputMap

  • getInputMap(): any
  • Function that constructs the input map object containing all query parameters for API

    Returns any

getRemoteMethod

  • getRemoteMethod(): string

getRequestPayload

  • getRequestPayload(): any
  • Function that constructs the Request body json for ApexRest and Rest when we are using HTTP methods of POST or PUT.

    Returns any

Generated using TypeDoc