DiscountsAutomaticApp

Returns a list of discounts.

Table-Specific Information

Select

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

Title supports the '=,!=' comparison operators.
Status supports the '=,!=' comparison operators.
DiscountClass supports the '=,!=' comparison operators.
StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
AppDiscountTypeTitle supports the '=,!=' comparison operators.
AppDiscountTypeDiscountClass supports the '=,!=' comparison operators.

For example, the following queries are processed server side:

  SELECT * FROM DiscountsAutomaticApp
  SELECT * FROM DiscountsAutomaticApp WHERE Title = 'Val1'
  SELECT * FROM DiscountsAutomaticApp WHERE Status = 'Val1'
  SELECT * FROM DiscountsAutomaticApp WHERE DiscountClass = 'Val1'
  SELECT * FROM DiscountsAutomaticApp WHERE StartsAt = '2023-01-01 11:10:00'
  SELECT * FROM DiscountsAutomaticApp WHERE AppDiscountTypeTitle = 'Val1'
  SELECT * FROM DiscountsAutomaticApp WHERE AppDiscountTypeDiscountClass = 'Val1'

Insert

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

Title, EndsAt, StartsAt, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts

Update

The following columns can be updated:

Title, EndsAt, StartsAt, AppDiscountTypeFunctionId, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts

Delete

You can delete entries by specifying the following column:

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		A globally-unique ID.
DiscountId	String	True		The ID for the discount.
Title	String	False		The title of the discount.
Status	String	True		The status 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'.
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.
UpdatedAt	Datetime	True		The date and time when the discount was updated.
AppDiscountTypeFunctionId	String	False		The ID of the function providing the app discount type.
AppDiscountTypeTitle	String	True		The title of the app discount type.
AppDiscountTypeDescription	String	True		A description of the app discount type.
AppDiscountTypeAppKey	String	True		The client ID of the app providing the app discount type.
AppDiscountTypeDiscountClass	String	True		The class of the app discount type.
AppDiscountTypeTargetType	String	True		The target type of the app discount type. Possible values: 'SHIPPING_LINE' and 'LINE_ITEM'.
CombinesWithOrderDiscounts	Bool	False		Combines with order discounts.
CombinesWithProductDiscounts	Bool	False		Combines with product discounts.
CombinesWithShippingDiscounts	Bool	False		Combines with shipping discounts.
ErrorHistoryFirstOccurredAt	Datetime	True		The date and time that the first error occurred.
ErrorHistoryErrorsFirstOccurredAt	Datetime	True		The date and time that the first error occurred.
ErrorHistoryHasSharedRecentErrors	Bool	True		Whether the merchant has shared all the recent errors with the developer.
ErrorHistoryHasBeenSharedSinceLastError	Bool	True		Whether the merchant has shared all the recent errors with the developer.