Options
All
  • Public
  • Public/Protected
  • All
Menu

Module SearchDiscountsByQueryFilter

Index

Properties

Optional ActiveRange

ActiveRange: DiscountActiveRange

BackendID

BackendID: string

CouponCode

CouponCode: string

CreatedBy

CreatedBy: string

The name of the user who created the discount

CurrencyID

CurrencyID: string

Entity type: Currency

DeactivationReasons

DeactivationReasons: DiscountDeactivationReasons[]

You can filter discounts based on their deactivation reason.The array is interpreted as an 'or' value list To get discounts with a specific deactivation reason, only provide the deactivation reason you want. For example:

  • providing an empty value will return all discounts
  • providing None (0) will return discounts that are active.
  • providing Unverified (1) will return discounts that are inactive because they are unverified.
  • providing Unverified (1) and DisabledByUser (2) will return discounts that are inactive because they are either unverified OR disabled by user.
  • providing Unverified (1) and DisabledByUser (2) as a combined flag (3) will return discounts that are inactive because they are unverified AND disabled by user.

Description

Description: string

Optional DiscountCampaignID

DiscountCampaignID: undefined | number

Entity type: DiscountCampaign

Optional DiscountTemplateID

DiscountTemplateID: undefined | number

Entity type: DiscountTemplate

DiscountTriggerIDs

DiscountTriggerIDs: DiscountTriggers[]

Optional HasRestitutionOrganizationUnit

HasRestitutionOrganizationUnit: undefined | false | true

Optional IsActive

IsActive: undefined | false | true

Filter on active state. Optional values are; null = active and inactive, true = active only, false = inactive.

deprecated

Replaced by the DeactivationReasons. Provide empty value in DeactivationReasons to filter on active/verified discounts

Optional IsActiveAndVerified

IsActiveAndVerified: undefined | false | true
deprecated

Replaced by the DeactivationReasons. Provide empty value in DeactivationReasons to filter on active/verified discounts

Optional IsVerified

IsVerified: undefined | false | true
deprecated

Replaced by the DeactivationReasons. Provide Unverified in DeactivationReasons to filter on unverified discounts

Optional LayerID

LayerID: undefined | number

The discount layer Entity type: DiscountLayer

Optional OrderType

OrderType: OrderTypes

Optional OrganizationUnitID

OrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional OrganizationUnitSetID

OrganizationUnitSetID: undefined | number

Entity type: OrganizationUnitSet

Optional RestitutionOrganizationUnitID

RestitutionOrganizationUnitID: undefined | number

Entity type: OrganizationUnit