Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input to initialise checkout cart associated with a catalogCode and accountId.

extends

DigitalCommerceInput

Hierarchy

Index

Constructors

constructor

  • Constructor function for GetCatalogOffersInput class

    Returns CheckoutCartInput

Properties

accountId

accountId: string

accountId as part of the POST body of the API for creating cart.

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 assetReferenceKey

assetReferenceKey: string

assetReferenceKey as part of the POST body of the API for creating cart. assetReferenceKey which is used during the createCart API to sync the assetReferenceIds in the orderItems.

Optional cacheExpiration

cacheExpiration: Date

Expiration Date time of the cached item. Default is current time plus 5 minutes.

Optional cacheable

cacheable: boolean = false

Flag to indicate if the sdk call should be cached.

Optional callSecureServer

callSecureServer: boolean = false

boolean value to decide if secure server needs to be called.

cartContextKey

cartContextKey: string

Persisting cartContext hash key to be used in part of the path of the API to maintain existing cart.

catalogCode

catalogCode: string

catalogCode to be used in part of the POST body of the API for creating cart.

Optional contentType

contentType: string = "application/json"

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 customFields

customFields: string[] = []

List of custom fields to be returned.

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 integrationProcedureKey

integrationProcedureKey: string = ""

integration procedure name - optional

Optional isLoggedIn

isLoggedIn: boolean

isLoggedIn as part of the query string of the API.

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

Optional orderFields

orderFields: any

orderFields will be part of request payload where we can specify available order fields for update like Description, Order Name etc

Optional orderItemFields

orderItemFields: any

orderItemFields will be part of request payload where we can specify available order item fields for update like Line Description, Item Name etc

Optional reload

reload: boolean = false

Boolean flag to discard cache and call the api again. Default is false.

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class that handles this request.

remoteMethod

remoteMethod: string

Remote method that handles this request.

Optional requestCredentials

requestCredentials: boolean

value indicating whether the user agent should send cookies from the other domain in the case of cross-origin requests

Optional secureServerEndPointUrl

secureServerEndPointUrl: string

optional input param used as secure Server rest URL end point when Proxy SDK is used

Optional timeoutInMillis

timeoutInMillis: number = 20000

Flag to indicate if the sdk call should be cached.

Optional validateAction

validateAction: boolean = true

validateAction is part of the query string of the API todo context rule validation check.

Optional validatePrice

validatePrice: boolean = true

validatePrice is part of the query string of the API todo price validation check.

Methods

getAPIPath

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

    Returns string

getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string

getAuthToken

  • Function to return authorization token

    Parameters

    Returns Promise<string>

getAuthorisationType

  • getAuthorisationType(): 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
  • Function to return VF Remoting method name.

    Returns string

getRequestCredentials

  • getRequestCredentials(): RequestCredentials
  • The credentials read-only property of the Request interface indicates whether the user agent should send cookies from the other domain in the case of cross-origin requests.

    Returns RequestCredentials

getRequestPayload

  • getRequestPayload(): any
  • Function that constructs the Request body json for ApexRest Handles scenerio when JSONResult, accountId and catalogCode is null

    Returns any

getSecureServerRestUrl

  • getSecureServerRestUrl(): string

Generated using TypeDoc