Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input for cart operations.

extends

DigitalCommerceInput

Hierarchy

Index

Constructors

constructor

  • Constructor function for GetCatalogOffersInput class

    Returns AddToCartInput

Properties

actionObj

actionObj: Action

Action object json.

Optional actionParams

actionParams: any

An POST Body object for the api requests.

anonymousSiteUrl

anonymousSiteUrl: string

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

apiNamespace

apiNamespace: string

API namespace.

basketAction

basketAction: string

A required POST Body param to provide one of the three possible actions for the underlying API: AddWithNoConfig - if adding directly from offerCode; requires POST Body param 'offer'. AddAfterConfig - if adding from configured offerDetails; requires POST Body param 'productConfig'

Optional cartContextKey

cartContextKey: string

Persisting cartContext hash key to be used in part of the path of the API to maintain existing cart. For fresh cart, no need to pass this.

catalogCode

catalogCode: string

catalogCode to be used in part of the path of the API.

Optional context

context: string

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

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 offerCode

offerCode: string

An optional POST Body param to specify offer code to be added to cart; only needed if offer is being added without any configuration, in which case basketAction is "AddWithNoConfig".

Optional offerConfiguration

offerConfiguration: any

An optional POST Body param to provide configured offer details taken from response of configure API to add configured offer to cart, in which case basketAction is "AddAfterConfig". This can be provided as a Map (direct response of configure API) or as a stringified version of the Map.

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class that handles this request.

remoteMethod

remoteMethod: string

Remote method that handles this request.

Optional transactionKey

transactionKey: any

An optional POST Body object to store offer into cart for the further api requests.

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

    Returns any

Generated using TypeDoc