Skip to main content

CreateDiscountSchemeDto

A new discount scheme.

input CreateDiscountSchemeDto {
  applicableCustomerTypes: String
  applicableRegions: String
  code: String
  currencyId: String
  description: String
  discountRules: [CreateDiscountRuleDto!]!
  isActive: Boolean
  isStackable: Boolean
  isTierManaged: Boolean
  maxUsageCount: Int
  maxUsagePerCustomer: Int
  name: String!
  priority: Int
  scope: DiscountScope
  validFrom: String!
  validUntil: String
}

Fields​

CreateDiscountSchemeDto.applicableCustomerTypes ● String scalar​

The customer types the scheme applies to.

CreateDiscountSchemeDto.applicableRegions ● String scalar​

The regions the scheme applies to.

CreateDiscountSchemeDto.code ● String scalar​

The code of the scheme.

CreateDiscountSchemeDto.currencyId ● String scalar​

The ID of the currency the scheme is for. Fixed amounts and order thresholds depend on the currency, so the scheme only applies to documents in it. Empty means the base currency.

CreateDiscountSchemeDto.description ● String scalar​

What the scheme is for.

CreateDiscountSchemeDto.discountRules ● [CreateDiscountRuleDto!]! non-null input​

The rules that set the discount.

CreateDiscountSchemeDto.isActive ● Boolean scalar​

Whether the record is active.

CreateDiscountSchemeDto.isStackable ● Boolean scalar​

True when the scheme can combine with other discounts.

CreateDiscountSchemeDto.isTierManaged ● Boolean scalar​

True when customers are put on the scheme automatically through customer tier settings instead of by hand. Only customer-scope schemes can be tier-managed.

CreateDiscountSchemeDto.maxUsageCount ● Int scalar​

The most times the scheme may be used in all.

CreateDiscountSchemeDto.maxUsagePerCustomer ● Int scalar​

The most times one customer may use the scheme.

CreateDiscountSchemeDto.name ● String! non-null scalar​

The name of the scheme.

CreateDiscountSchemeDto.priority ● Int scalar​

Which scheme wins when several apply. Higher goes first.

CreateDiscountSchemeDto.scope ● DiscountScope enum​

What the scheme applies to: all customers, selected customers, products or categories.

CreateDiscountSchemeDto.validFrom ● String! non-null scalar​

When the scheme starts.

CreateDiscountSchemeDto.validUntil ● String scalar​

When the scheme ends.

Member Of​

createDiscountScheme mutation