ProductPricing | Vlocity SDK

Hierarchy

ProductPricing

Index

Constructors

constructor

Properties

config

Methods

Constructors

constructor

new ProductPricing(config: any): ProductPricing

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:43
Parameters
- config: any
Returns ProductPricing

Properties

config

config: any

Configuration for this SDK.

Methods

addContextRuleSetToPriceListEntry

addContextRuleSetToPriceListEntry(input: AddContextRuleSetInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:292
Adds a context rule set on a price list entry.

Parameters
- input: AddContextRuleSetInput
  
  The input used to add a context rule set.
Returns Promise<Result>
- Promise that returns a success or failure message.

createApplicablePriceListInput

createApplicablePriceListInput(params: object): GetApplicablePriceListInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:90
Creates and returns an instance of input class for GetApplicablePriceListInput

Parameters
- params: object
Returns GetApplicablePriceListInput

createAppliedPriceListEntriesInput

createAppliedPriceListEntriesInput(): GetAppliedPriceListEntriesInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:55
Create a default GetAppliedPriceListEntriesInput object.

Returns GetAppliedPriceListEntriesInput
- a GetAppliedPriceListEntriesInput instance.

createAppliedPromotionsInput

createAppliedPromotionsInput(): GetAppliedPromotionsInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:64
Create a default GetAppliedPromotionsInput object.

Returns GetAppliedPromotionsInput
- a GetAppliedPromotionsInput instance.

createContextRuleSetInput

createContextRuleSetInput(params: ContextRuleObject): AddContextRuleSetInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:143
Creates and returns an instance of input class for GetPriceListEntryInput

Parameters
- params: ContextRuleObject
Returns AddContextRuleSetInput

createDeleteContextRuleInput

createDeleteContextRuleInput(contextRuleId: string): DeleteContextRuleInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:231
Creates and returns an instance of input class for DeletePriceListEntryInput

Parameters
- contextRuleId: string
Returns DeleteContextRuleInput

createDeletePriceListEntryInput

createDeletePriceListEntryInput(priceListEntryId: string): DeletePriceListEntryInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:153
Creates and returns an instance of input class for DeletePriceListEntryInput

Parameters
- priceListEntryId: string
Returns DeletePriceListEntryInput

createEditPriceListEntryInput

createEditPriceListEntryInput(params: EditPriceListEntryObject): GetEditPriceListEntryInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:191
Creates and returns an instance of input class for GetEditPriceListEntryInput

Parameters
- params: EditPriceListEntryObject
Returns GetEditPriceListEntryInput

createEditPromotionOfferPriceListEntryInput

createEditPromotionOfferPriceListEntryInput(params: EditPromotionOfferPriceListEntryObject): GetEditPromotionOfferPriceListEntryInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:201
Creates and returns an instance of input class for GetEditPromotionOfferPriceListEntryInput

Parameters
- params: EditPromotionOfferPriceListEntryObject
Returns GetEditPromotionOfferPriceListEntryInput

createExistingPromotionsInput

createExistingPromotionsInput(params: object): GetExistingPromotionsInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:80
Creates and returns an instance of input class for GetExistingPromotionsInput

Parameters
- params: object
Returns GetExistingPromotionsInput

createGetTimePlanPolicyInput

createGetTimePlanPolicyInput(params: TimePlanPolicyObject): GetTimePlanPolicyInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:221
Creates and returns an instance of input class for GetTimePlanPolicyInput

Parameters
- params: TimePlanPolicyObject
Returns GetTimePlanPolicyInput

createOffersInput

createOffersInput(params: object): GetOffersInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:72
Creates and returns an instance of input class for GetOffersInput

Parameters
- params: object
Returns GetOffersInput

createPriceListCurrencyValuesInput

createPriceListCurrencyValuesInput(params: GetPriceListCurrencyValuesObject): GetPriceListCurrencyValuesInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:241
Creates an input to get the price list currency values.

Parameters
- params: GetPriceListCurrencyValuesObject
  
  the object with the id of the price list.
Returns GetPriceListCurrencyValuesInput

createPriceListEntry

createPriceListEntry(input: GetPriceListEntryInput | GetPromotionOfferPriceListEntryInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:396
Creates a price list entry for price, cost, promotion, and offer tables. Aside from the standard price list entry, this method supports overrides and adjustments.

Parameters
- input: GetPriceListEntryInput | GetPromotionOfferPriceListEntryInput
  
  The input used to create a price list entry.
Returns Promise<Result>
- Promise that returns the id of the new price list entry.

createPriceListEntryInput

createPriceListEntryInput(params: PriceListEntryObject): GetPriceListEntryInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:133
Creates and returns an instance of input class for GetPriceListEntryInput

Parameters
- params: PriceListEntryObject
Returns GetPriceListEntryInput

createPriceListInput

createPriceListInput(activeOnly: boolean): GetPriceListInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:100
Creates and returns an instance of input class for GetPriceListInput

Parameters
- activeOnly: boolean
Returns GetPriceListInput

createPricingElementInput

createPricingElementInput(params: object): GetPricingElementInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:125
Creates and returns an instance of input class for GetPricingElementInput

Parameters
- params: object
Returns GetPricingElementInput

createPricingPickListInput

createPricingPickListInput(): GetPricingPickListInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:108
Creates and returns an instance of input class for GetPricingPickListInput

Returns GetPricingPickListInput

createPricingVariableInput

createPricingVariableInput(params: object): GetPricingVariableInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:117
Creates and returns an instance of input class for GetPricingVariableInput

Parameters
- params: object
Returns GetPricingVariableInput

createPromotion

createPromotion(input: CreatePromotionInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:422
Creates a promotion.

Parameters
- input: CreatePromotionInput
  
  The input used to create a promotion.
Returns Promise<Result>
- Promise that returns a success or failure message.

createPromotionInput

createPromotionInput(params: NewPromotionObject): CreatePromotionInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:173
Creates and returns an instance of input class for CreatePromotionInput

Parameters
- params: NewPromotionObject
Returns CreatePromotionInput

createPromotionItem

createPromotionItem(input: CreatePromotionItemInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:433
Creates a promotion item.

Parameters
- input: CreatePromotionItemInput
  
  The input used to create a promotion item.
Returns Promise<Result>
- Promise that returns a success or failure message.

createPromotionItemInput

createPromotionItemInput(params: NewPromotionItemObject): CreatePromotionItemInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:163
Creates and returns an instance of input class for CreatePromotionItemInput

Parameters
- params: NewPromotionItemObject
Returns CreatePromotionItemInput

createPromotionOfferPriceListEntryInput

createPromotionOfferPriceListEntryInput(params: PromotionOfferPriceListEntryObject): GetPromotionOfferPriceListEntryInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:181
Creates and returns an instance of input class for AdjustmentPriceListEntryObject

Parameters
- params: PromotionOfferPriceListEntryObject
Returns GetPromotionOfferPriceListEntryInput

createQuickAddPricingPropertiesInput

createQuickAddPricingPropertiesInput(): GetQuickAddPricingPropertiesInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:252
Creates an input for getting the quick adds pricing properties.

Returns GetQuickAddPricingPropertiesInput
- input to define quick add pricing properties.

createTimePlanPolicyIdsInput

createTimePlanPolicyIdsInput(params: object): GetTimePlanPolicyIdsInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:211
Creates and returns an instance of input class for GetTimePlanPolicyIdsInput

Parameters
- params: object
Returns GetTimePlanPolicyIdsInput

deleteContextRule

deleteContextRule(input: DeleteContextRuleInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:506
Deletes a context rule.

Parameters
- input: DeleteContextRuleInput
  
  The input used to delete context rule.
Returns Promise<Result>
- Promise that returns a success or failure message.

deletePriceListEntry

deletePriceListEntry(input: DeletePriceListEntryInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:409
Deletes a price list entry.

Parameters
- input: DeletePriceListEntryInput
  
  The input used to delete price list entry.
Returns Promise<Result>
- Promise that returns a success or failure message.

editPriceListEntry

editPriceListEntry(input: GetEditPriceListEntryInput | GetEditPromotionOfferPriceListEntryInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:458
Edits a price list entry for price, cost, promotion, and offer tables. Aside from the standard price list entry, this method supports overrides and adjustments.

Parameters
- input: GetEditPriceListEntryInput | GetEditPromotionOfferPriceListEntryInput
  
  The input used to create a price list entry.
Returns Promise<Result>
- Promise that returns the id of the new price list entry.

getApplicablePriceList

getApplicablePriceList(input: GetApplicablePriceListInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:279
method

GetApplicablePriceListInput - Uses a productId to get all the applicable pricelist for it.

example
```
   // Instantiate the input object for getApplicablePriceList using createApplicablePriceListInput method
   const input = productconsole.createApplicablePriceListInput();

   // Invoke API via method getApplicablePriceList()
   productconsole.getApplicablePriceList(input)
  .then(result => {
    Logger.info("getApplicablePriceList() success " + result);
  })
  .catch(error => {
    Logger.info("getApplicablePriceList() failed " + error);
  });
```
throws

{Error} - "GetApplicablePriceListInput is required to get the applicable price list. The input must have a remoteClass, remoteMethod, all parameters and paramsArray()"
Parameters
- input: GetApplicablePriceListInput
  
  The input with the remoteClass, remoteMethod, parameters and paramsArray function.
Returns Promise<Result>
- Promise that returns the list of applicable price list.

getAppliedCostPricelistEntries

getAppliedCostPricelistEntries(input: GetAppliedPriceListEntriesInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:334
This function will return a list of pricelists that are applicable for this product.

Parameters
- input: GetAppliedPriceListEntriesInput
  
  the input with the product id used to display pricelists.
Returns Promise<Result>
- a promise with the pricelists associtated with the product id.

getAppliedPricelistEntries

getAppliedPricelistEntries(input: GetAppliedPriceListEntriesInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:320
This function will return a list of pricelists that are applicable for this product.

Parameters
- input: GetAppliedPriceListEntriesInput
  
  the input with the product id used to display pricelists.
Returns Promise<Result>
- a promise with the pricelists associtated with the product id.

getAppliedPromotions

getAppliedPromotions(input: GetAppliedPromotionsInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:306
This function will return a list of promotions that are applicable for this product.

Parameters
- input: GetAppliedPromotionsInput
  
  the input with the product id used to display promotions.
Returns Promise<Result>
- a promise with the promotions associtated with the product id.

getExistingPromotions

getExistingPromotions(input: GetExistingPromotionsInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:550
method

getExistingPromotions - Gets a productId and all of the existing promotions for it.

example
```
   // Instantiate the input object for getExistingPromotions using createExistingPromotionsInput method
   const input = productconsole.createExistingPromotionsInput();

   // Invoke API via method getExistingPromotions()
   productconsole.getExistingPromotions(input)
  .then(result => {
    Logger.info("getExistingPromotions() success " + result);
  })
  .catch(error => {
    Logger.info("getExistingPromotions() failed " + error);
  });
```
throws

{Error} - "GetExistingPromotionsInput is required to get the existing promotion list. The input must have a remoteClass, remoteMethod, all parameters and paramsArray()"
Parameters
- input: GetExistingPromotionsInput
  
  The existing promotions input with the remoteClass, remoteMethod, parameters and paramsArray function.
Returns Promise<Result>
- Promise that returns the list of existing promotions.

getOffers

getOffers(input: GetOffersInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:446
Gets a productId and all of the offers for it.

Parameters
- input: GetOffersInput
  
  The offers input with the remoteClass, remoteMethod, parameters and paramsArray function.
Returns Promise<Result>
- Promise that returns the list of offers.

getPriceList

getPriceList(input: GetPriceListInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:360
This function returns a list of price list.

Parameters
- input: GetPriceListInput
  
  Input object that contains a query to get the price list.
Returns Promise<Result>
- Promise that returns the price list.

getPriceListCurrencyValues

getPriceListCurrencyValues(input: GetPriceListCurrencyValuesInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:519
Gets the list of currency values for the given price list.

Parameters
- input: GetPriceListCurrencyValuesInput
  
  The currency value input with the remoteClass, remoteMethod, and paramsArray function.
Returns Promise<Result>
- Promise that returns the picklist item labels for the currency field.

getPricingElement

getPricingElement(input: GetPricingElementInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:382
Gets a pricing element and returns it's id.

Parameters
- input: GetPricingElementInput
  
  The pricing element input with the remoteClass, remoteMethod, parameters and paramsArray function.
Returns Promise<Result>
- Promise that returns the pricing element id.

getPricingPicklistItems

getPricingPicklistItems(input: GetPricingPickListInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:347
Gets the list of picklist items for the pricing tab.

Parameters
- input: GetPricingPickListInput
  
  The picklist item input with the remoteClass, remoteMethod, and paramsArray function.
Returns Promise<Result>
- Promise that returns the picklist item labels for the pricing tab.

getPricingVariable

getPricingVariable(input: GetPricingVariableInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:369
Gets the list of pricing variables.

Parameters
- input: GetPricingVariableInput
  
  The pricing variable input with the remoteClass, remoteMethod, parameters and paramsArray function.
Returns Promise<Result>
- Promise that returns the pricing variable(s).

getQuickAddPricingExistingPromotions

getQuickAddPricingExistingPromotions(input: GetQuickAddPricingPropertiesInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:576
This function returns a list of attributes, fields and attribute values that are available for assignment to a given product.

Parameters
- input: GetQuickAddPricingPropertiesInput
  
  Input object that consists of a productId.
Returns Promise<Result>

getQuickAddPricingRules

getQuickAddPricingRules(input: GetQuickAddPricingPropertiesInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:562
This function returns a list of attributes, fields and attribute values that are available for assignment to a given product.

Parameters
- input: GetQuickAddPricingPropertiesInput
  
  Input object that consists of a productId.
Returns Promise<Result>

Private getRemoteInput

getRemoteInput(input: any, inputClass: any): ApexRemoteInput

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:586
Parameters
- input: any
- inputClass: any
Returns ApexRemoteInput

getTimePlan

getTimePlan(input: GetTimePlanPolicyInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:484
Gets Time Plan information.

Parameters
- input: GetTimePlanPolicyInput
  
  The input used to get time plan information.
Returns Promise<Result>
- Promise that returns an object with time plan information.

getTimePlanTimePolicyIds

getTimePlanTimePolicyIds(input: GetTimePlanPolicyIdsInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:471
Assigns the time plan and time policy to a price list entry.

Parameters
- input: GetTimePlanPolicyIdsInput
  
  The pricing variable input with the remoteClass, remoteMethod, parameters and paramsArray function.
Returns Promise<Result>
- Promise that returns the time plan and time policy ids.

getTimePolicy

getTimePolicy(input: GetTimePlanPolicyInput): Promise<Result>

- Defined in src/sdk/productconsole/pricing/productpricing.sdk.ts:495
Gets Time Policy information.

Parameters
- input: GetTimePlanPolicyInput
  
  The input used to get time policy information.
Returns Promise<Result>
- Promise that returns an object with time policy information.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: any

Returns ProductPricing

Properties

config

Methods

addContextRuleSetToPriceListEntry

Parameters

input: AddContextRuleSetInput

Returns Promise<Result>

createApplicablePriceListInput

Parameters

params: object

Returns GetApplicablePriceListInput

createAppliedPriceListEntriesInput

Returns GetAppliedPriceListEntriesInput

createAppliedPromotionsInput

Returns GetAppliedPromotionsInput

createContextRuleSetInput

Parameters

params: ContextRuleObject

Returns AddContextRuleSetInput

createDeleteContextRuleInput

Parameters

contextRuleId: string

Returns DeleteContextRuleInput

createDeletePriceListEntryInput

Parameters

priceListEntryId: string

Returns DeletePriceListEntryInput

createEditPriceListEntryInput

Parameters

params: EditPriceListEntryObject

Returns GetEditPriceListEntryInput

createEditPromotionOfferPriceListEntryInput

Parameters

params: EditPromotionOfferPriceListEntryObject

Returns GetEditPromotionOfferPriceListEntryInput

createExistingPromotionsInput

Parameters

params: object

Returns GetExistingPromotionsInput

createGetTimePlanPolicyInput

Parameters

params: TimePlanPolicyObject

Returns GetTimePlanPolicyInput

createOffersInput

Parameters

params: object

Returns GetOffersInput

createPriceListCurrencyValuesInput

Parameters

params: GetPriceListCurrencyValuesObject

Returns GetPriceListCurrencyValuesInput

createPriceListEntry

Parameters

input: GetPriceListEntryInput | GetPromotionOfferPriceListEntryInput

Returns Promise<Result>

createPriceListEntryInput

Parameters

params: PriceListEntryObject

Returns GetPriceListEntryInput

createPriceListInput

Parameters

activeOnly: boolean

Returns GetPriceListInput

createPricingElementInput

Parameters

params: object

Returns GetPricingElementInput

createPricingPickListInput

Returns GetPricingPickListInput

createPricingVariableInput