Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Component

Hierarchy

  • Component

Index

Properties

Optional CopyPricesFromOtherPriceListData

CopyPricesFromOtherPriceListData: CopyPricesFromOtherPriceListData

The data that accompanies a Component with Type = PricesFromOtherPriceList which is a component to copy prices from another pricelist.

Is useful for example for promotion prices, where you first 'import' the prices from the original pricelist, and then apply a negative markup to them to create a promotion discount.

Which prices you copy can be modified by specifying a ProductSearchTemplateID, only products that are contained in the results of the search will be copied, unless ExcludeProductsInFilter is set to true, in which case the reverse is true; all products except the matching ones will have their prices copied.

Delete

Delete: boolean

If specified as true, the component will be deleted.

Optional EndDate

EndDate: undefined | string

Determines when this component will become inactive. After this date the component will not be included in the calculation of the pricelist.

ID

ID: string

The unique identifier for this component. Required.

Optional MarkupData

MarkupData: MarkupData

The data that accompanies a Component with Type = Markup which is a component that alters the price value of the previusly applied components, either up or down. The markup/markdown can either be an absolute value or a percentage depending on the Type.

Optional Name

Name: undefined | string

The name of the component. If left empty on creation of the component the ID will be used as the name.

Optional PriceEntriesData

PriceEntriesData: PriceEntriesData

The data that accompanies a Component with Type = PriceEntries, so a component that is simply a list of product/price pairs. The simplest and most direct way to give a product a price.

This data consists of either a list of product/price pairs or a BlobID which is a reference to a previously created blob in EVA that contains data of the following format:

[ { "ProductID": "", "Price": }, ... ]

If you only supply a handful of prices, the inline data works well, but for large quantities of prices you may want to use the BlobID method.

This data is ignored for all other Component types.

PriceEntries data is processed asynchronously in the background and will not be immediately visible after the service call returns.

Optional PricingGroupID

PricingGroupID: undefined | string

The PricingGroupID that this component is active for. Components with a PricingGroupID are only active for users that are members of that group. If left empty the component will be active for all users.

Optional SequenceNumber

SequenceNumber: undefined | number

Components are applied in the order of their sequence number, from lowest to highest.

Optional StartDate

StartDate: undefined | string

Determines when this component will become active. Until then the component will not be included in the calculation of the pricelist.

Type

Determines the type of the component. Cannot be changed after creation.