stack

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

AdminTypes.DiscountAutomaticBxgy interface

An automatic discount that offers customers a Buy X, Get Y (BXGY) discount.

Signature:

export interface DiscountAutomaticBxgy extends HasEvents, Node 

Extends: HasEvents, Node

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.
customerBuys		DiscountCustomerBuys	The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.
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.
events		EventConnection	The paginated list of events associated with the host subject.
id		Scalars[‘ID’][‘output’]	A legacy unique ID for 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.
usesPerOrderLimit?		Maybe<Scalars[‘Int’][‘output’]>	(Optional) The maximum number of times that the discount can be applied to an order.