stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > DiscountAutomaticBasic

AdminTypes.DiscountAutomaticBasic interface

An automatic discount that offers customers a percentage discount, or fixed amount discount, on specific products, collections, or the entire order.

Signature:

export interface DiscountAutomaticBasic 

Properties

Property	Modifiers	Type	Description
asyncUsageCount		Scalars[‘Int’][‘output’]	The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.
combinesWith		DiscountCombinesWith	Determines which discount classes the discount can combine with.
createdAt		Scalars[‘DateTime’][‘output’]	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.
discountClass		MerchandiseDiscountClass | `${MerchandiseDiscountClass}`	The class of the discount for combining purposes.
endsAt?		Maybe<Scalars[‘DateTime’][‘output’]>	(Optional) 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.
recurringCycleLimit		Scalars[‘Int’][‘output’]	The number of times a discount applies on recurring purchases (subscriptions).
shortSummary		Scalars[‘String’][‘output’]	A short summary of the discount.
startsAt		Scalars[‘DateTime’][‘output’]	The date and time when the discount starts.
status		DiscountStatus | `${DiscountStatus}`	The status of the discount.
summary		Scalars[‘String’][‘output’]	A detailed summary of the discount.
title		Scalars[‘String’][‘output’]	The title of the discount.
updatedAt		Scalars[‘DateTime’][‘output’]	The date and time when the discount was updated.
usageCount		Scalars[‘Int’][‘output’]	The number of times that the discount has been used.