Returns a list of discounts.

Table-Specific Information

Select

The driver uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The driver processes other filters client-side within the driver.

• Title supports the '=, !=' comparison operators.
• DiscountClass supports the '=, !=' comparison operators.
• StartsAt supports the '=, !=, <, >, >=, <=' comparison operators.

For example, the following queries are processed server-side:

  SELECT * FROM DiscountsAutomaticBasic WHERE Title = 'Val1'
  SELECT * FROM DiscountsAutomaticBasic WHERE DiscountClass = 'Val1'
  SELECT * FROM DiscountsAutomaticBasic WHERE StartsAt = '2023-01-01 11:10:00'

Insert

The following columns can be used to create a new record:

Title, EndsAt, StartsAt, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts

The following pseudo-columns can be used to create a new record:

AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove, MinimumQuantity, MinimumSubtotal

Update

The following columns can be updated:

Title, EndsAt, StartsAt, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts

The following pseudo-columns can be used to update a record:

AppliesOnEachItem, DiscountAmount, ProductsToAdd, ProductsToRemove

Delete

You can delete entries by specifying the following column:

Id

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A globally-unique ID.
Title	String	False		The title of the discount.
Status	String	True		The status of the discount.
Summary	String	True		A detailed summary of the discount.
DiscountClass	String	True		The class of the discount for combining purposes.
EndsAt	Datetime	False		The date and time when the discount ends. For open-ended discounts, use 'null'.
ShortSummary	String	True		A short summary of the discount.
StartsAt	Datetime	False		The date and time when the discount starts.
AsyncUsageCount	Int	True		The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.
CreatedAt	Datetime	True		The date and time when the discount was created.
CombinesWithOrderDiscounts	Bool	False		Combines with order discounts.
CombinesWithProductDiscounts	Bool	False		Combines with product discounts.
CombinesWithShippingDiscounts	Bool	False		Combines with shipping discounts.
DiscountMinimumQuantityGreaterThanOrEqualToQuantity	String	True		The minimum quantity of items that's required for the discount to be applied.

Pseudo-Columns

Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.

Name	Type	Description
AppliesOnEachItem	Bool	If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.
DiscountAmount	Decimal	The value of the discount.
ProductsToAdd	String	A simple, comma-separated list of products IDs to add.
ProductsToRemove	String	A simple, comma-separated list of products IDs to remove.
MinimumQuantity	String	The minimum quantity of items that's required for the discount to be applied.
MinimumSubtotal	String	The minimum subtotal that's required for the discount to be applied.