stack

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

AdminTypes.DiscountAutomaticFreeShipping interface

An automatic discount that offers customers free shipping on their order.

Signature:

export interface DiscountAutomaticFreeShipping 

Properties

Property	Modifiers	Type	Description
appliesOnOneTimePurchase		Scalars[‘Boolean’][‘output’]	Whether the discount applies on regular one-time-purchase shipping lines.
appliesOnSubscription		Scalars[‘Boolean’][‘output’]	Whether the discount applies on subscription shipping lines.
asyncUsageCount		Scalars[‘Int’][‘output’]	The number of times that 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.
destinationSelection		DiscountShippingDestinationSelection	A shipping destination that qualifies for the discount.
discountClass		ShippingDiscountClass | `${ShippingDiscountClass}`	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.
maximumShippingPrice?		Maybe<MoneyV2>	(Optional) The maximum shipping price amount accepted to qualify for the discount.
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.
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.