DiscountAutomaticBasic

Version 2019-04

An automatic basic discount.

Required access

read_price_rules access scope

Show definition
"""
An automatic basic discount.
"""
type DiscountAutomaticBasic {
  """
  The date and time when the discount was created.
  """
  createdAt: DateTime!
  """
  The qualifying items in an order, the quantity of each one, and the total value of the discount.
  """
  customerGets: DiscountCustomerGets!
  """
  The date and time when the discount ends. For open-ended discounts, use `null`.
  """
  endsAt: DateTime
  """
  The minimum subtotal or quantity that's required for the discount to be applied.
  """
  minimumRequirement: DiscountMinimumRequirement!
  """
  A short summary of the discount.
  """
  shortSummary: String!
  """
  The date and time when the discount starts.
  """
  startsAt: DateTime!
  """
  The status of the discount.
  """
  status: DiscountStatus!
  """
  A detailed summary of the discount.
  """
  summary: String!
  """
  The title of the discount.
  """
  title: String!
  """
  The number of times that the discount has been used.
  """
  usageCount: Int!
}

Fields

createdAt (DateTime!)

The date and time when the discount was created.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirement!)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of the discount.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageCount (Int!)

The number of times that the discount has been used.

Version 2019-07 (Latest)

An automatic basic discount.

Required access

read_price_rules access scope

Show definition
"""
An automatic basic discount.
"""
type DiscountAutomaticBasic {
  """
  The date and time when the discount was created.
  """
  createdAt: DateTime!
  """
  The qualifying items in an order, the quantity of each one, and the total value of the discount.
  """
  customerGets: DiscountCustomerGets!
  """
  The date and time when the discount ends. For open-ended discounts, use `null`.
  """
  endsAt: DateTime
  """
  The minimum subtotal or quantity that's required for the discount to be applied.
  """
  minimumRequirement: DiscountMinimumRequirement!
  """
  A short summary of the discount.
  """
  shortSummary: String!
  """
  The date and time when the discount starts.
  """
  startsAt: DateTime!
  """
  The status of the discount.
  """
  status: DiscountStatus!
  """
  A detailed summary of the discount.
  """
  summary: String!
  """
  The title of the discount.
  """
  title: String!
  """
  The number of times that the discount has been used.
  """
  usageCount: Int!
}

Fields

createdAt (DateTime!)

The date and time when the discount was created.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirement!)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of the discount.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageCount (Int!)

The number of times that the discount has been used.

Version 2019-10 (Release candidate)

An automatic basic discount.

Required access

read_price_rules access scope

Show definition
"""
An automatic basic discount.
"""
type DiscountAutomaticBasic {
  """
  The date and time when the discount was created.
  """
  createdAt: DateTime!
  """
  The qualifying items in an order, the quantity of each one, and the total value of the discount.
  """
  customerGets: DiscountCustomerGets!
  """
  The date and time when the discount ends. For open-ended discounts, use `null`.
  """
  endsAt: DateTime
  """
  The minimum subtotal or quantity that's required for the discount to be applied.
  """
  minimumRequirement: DiscountMinimumRequirement!
  """
  A short summary of the discount.
  """
  shortSummary: String!
  """
  The date and time when the discount starts.
  """
  startsAt: DateTime!
  """
  The status of the discount.
  """
  status: DiscountStatus!
  """
  A detailed summary of the discount.
  """
  summary: String!
  """
  The title of the discount.
  """
  title: String!
  """
  The number of times that the discount has been used.
  """
  usageCount: Int!
}

Fields

createdAt (DateTime!)

The date and time when the discount was created.

customerGets (DiscountCustomerGets!)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirement!)

The minimum subtotal or quantity that's required for the discount to be applied.

shortSummary (String!)

A short summary of the discount.

startsAt (DateTime!)

The date and time when the discount starts.

status (DiscountStatus!)

The status of the discount.

summary (String!)

A detailed summary of the discount.

title (String!)

The title of the discount.

usageCount (Int!)

The number of times that the discount has been used.

Sign up for a Partner account to get started.

Sign up