DiscountScheme

A discount scheme.

type DiscountScheme {
  applicableCustomerTypes: String
  applicableRegions: String
  application: DiscountApplication!
  buyQuantity: Float
  code: String!
  createdAt: DateTime!
  currencyId: String
  currentUsage: Int!
  deletedAt: DateTime
  deletedBy: String
  description: String
  enteredBy: String!
  fixedAmountValue: Float
  getQuantity: Float
  id: ID!
  isActive: Boolean!
  isStackable: Boolean!
  isTierManaged: Boolean!
  maxDiscountAmount: Float
  maxUsagePerCustomer: Int
  maxUsageTotal: Int
  minOrderAmount: Float
  name: String!
  organizationId: String!
  partners: [DiscountSchemePartner!]
  percentageValue: Float
  priority: Int!
  products: [DiscountSchemeProduct!]
  scope: DiscountScope!
  type: DiscountType!
  updatedAt: DateTime!
  updatedBy: String!
  validFrom: DateTime!
  validTo: DateTime
}

Fields

DiscountScheme.applicableCustomerTypes ● String scalar

The customer types the scheme applies to.

DiscountScheme.applicableRegions ● String scalar

The regions the scheme applies to.

DiscountScheme.application ● DiscountApplication! non-null enum

Where the discount is applied.

DiscountScheme.buyQuantity ● Float scalar

For a buy-and-get scheme, how many to buy.

DiscountScheme.code ● String! non-null scalar

The code of the scheme.

DiscountScheme.createdAt ● DateTime! non-null scalar

When the record was created.

DiscountScheme.currencyId ● String scalar

The ID of the currency the scheme is for. Empty means the base currency.

DiscountScheme.currentUsage ● Int! non-null scalar

How many times it has been used.

DiscountScheme.deletedAt ● DateTime scalar

When the record was deleted. Empty while the record is live.

DiscountScheme.deletedBy ● String scalar

The ID of the user who deleted the record.

DiscountScheme.description ● String scalar

What the scheme is for.

DiscountScheme.enteredBy ● String! non-null scalar

The ID of the user who created the record.

DiscountScheme.fixedAmountValue ● Float scalar

The fixed discount amount.

DiscountScheme.getQuantity ● Float scalar

For a buy-and-get scheme, how many come free.

DiscountScheme.id ● ID! non-null scalar

The unique ID of this record.

DiscountScheme.isActive ● Boolean! non-null scalar

Whether the record is active.

DiscountScheme.isStackable ● Boolean! non-null scalar

True when the scheme can combine with other discounts.

DiscountScheme.isTierManaged ● Boolean! non-null scalar

True when customers are put on the scheme automatically through customer tier settings.

DiscountScheme.maxDiscountAmount ● Float scalar

The most discount the scheme may give.

DiscountScheme.maxUsagePerCustomer ● Int scalar

The most times one customer may use the scheme.

DiscountScheme.maxUsageTotal ● Int scalar

The most times the scheme may be used in all.

DiscountScheme.minOrderAmount ● Float scalar

The smallest order amount the scheme applies to.

DiscountScheme.name ● String! non-null scalar

The name of the scheme.

DiscountScheme.organizationId ● String! non-null scalar

The ID of the organization the record belongs to.

DiscountScheme.partners ● [DiscountSchemePartner!] list object

The customers on the scheme.

DiscountScheme.percentageValue ● Float scalar

The discount in percent.

DiscountScheme.priority ● Int! non-null scalar

Which scheme wins when several apply. Higher goes first.

DiscountScheme.products ● [DiscountSchemeProduct!] list object

The products on the scheme.

DiscountScheme.scope ● DiscountScope! non-null enum

What the scheme applies to.

DiscountScheme.type ● DiscountType! non-null enum

How the discount is worked out.

DiscountScheme.updatedAt ● DateTime! non-null scalar

When the record was last changed.

DiscountScheme.updatedBy ● String! non-null scalar

The ID of the user who last changed the record.

DiscountScheme.validFrom ● DateTime! non-null scalar

When the scheme starts.

DiscountScheme.validTo ● DateTime scalar

When the scheme ends.

Returned By

activateDiscountScheme mutation ● createDiscountScheme mutation ● deactivateDiscountScheme mutation ● discountScheme query ● discountSchemes query ● duplicateDiscountScheme mutation ● updateDiscountScheme mutation

Member Of

Partner object