stack

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

AdminTypes.DiscountCodeBxgy interface

A code discount that offers customers a Buy X, Get Y (BXGY) discount.

Signature:

export interface DiscountCodeBxgy 

Properties

Property	Modifiers	Type	Description
appliesOncePerCustomer		Scalars[‘Boolean’][‘output’]	Whether the discount can be applied only once per customer.
asyncUsageCount		Scalars[‘Int’][‘output’]	The number of times that the discount has been used.
codeCount		Scalars[‘Int’][‘output’]	The number of redeem codes for the discount.
codes		DiscountRedeemCodeConnection	A list of redeem codes for the discount.
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.
customerSelection		DiscountCustomerSelection	The customers that can use 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.
hasTimelineComment		Scalars[‘Boolean’][‘output’]	Indicates whether there are any timeline comments on the discount.
shareableUrls		Array<DiscountShareableUrl>	URLs that can be used to share 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.
totalSales?		Maybe<MoneyV2>	(Optional) The total sales from orders where the discount was used.
updatedAt		Scalars[‘DateTime’][‘output’]	The date and time when the discount was updated.
usageLimit?		Maybe<Scalars[‘Int’][‘output’]>	(Optional) The maximum number of times that the discount can be used.
usesPerOrderLimit?		Maybe<Scalars[‘Int’][‘output’]>	(Optional) The maximum number of times that the discount can be applied to an order.