DiscountsCodeFreeShipping

Lists free-shipping discounts available via discount codes.

View-Specific Information

Select

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

Title supports the '=, !=' comparison operators.
DiscountClass supports the '=, !=' comparison operators.
EndsAt supports the '=, !=, <, >, >=, <=' comparison operators.
StartsAt supports the '=, !=, <, >, >=, <=' comparison operators.
CreatedAt supports the '=, <, >, >=, <=' comparison operators.
UpdatedAt supports the '=, <, >, >=, <=' comparison operators.

For example, the following queries are processed server-side:

  SELECT * FROM DiscountsCodeFreeShipping WHERE Title = 'Val1'
  SELECT * FROM DiscountsCodeFreeShipping WHERE DiscountClass = 'Val1'
  SELECT * FROM DiscountsCodeFreeShipping WHERE EndsAt = '2023-01-01 11:10:00'
  SELECT * FROM DiscountsCodeFreeShipping WHERE StartsAt = '2023-01-01 11:10:00'
  SELECT * FROM DiscountsCodeFreeShipping WHERE CreatedAt = '2023-01-01 11:10:00'
  SELECT * FROM DiscountsCodeFreeShipping WHERE UpdatedAt = '2023-01-01 11:10:00'

Columns


Name	Type	References	Description
Id [KEY]	String		The globally unique identifier of the free shipping discount code record.
Title	String		The display title of the discount.
Status	String		The current status of the discount, such as active or expired.
Summary	String		A detailed summary of the discount and how it is applied.
CodesCount	Int		The number of unique discount codes generated for this discount.
CodesCountPrecision	String		The level of precision applied to the discount code count value.
DiscountClass	String		The classification of the discount, used for determining compatibility with other discounts.
EndsAt	Datetime		The date and time when the discount ends. Returns null for open-ended discounts.
ShortSummary	String		A short summary of the free shipping discount (for example, 'Free standard shipping on orders over $50').
StartsAt	Datetime		The date and time when the discount becomes active.
UsageLimit	Int		The maximum number of times this discount can be used across all customers.
AppliesOnSubscription	Bool		Indicates whether the discount applies to shipping lines in subscription orders.
AsyncUsageCount	Int		The number of times the discount has been used. This value is updated asynchronously and might differ from the actual usage count.
HasTimelineComment	Bool		Indicates whether timeline comments have been added to the discount record.
RecurringCycleLimit	Int		The maximum number of billing cycles in which this discount can apply to subscription orders.
AppliesOncePerCustomer	Bool		Indicates whether the discount can be redeemed only once per customer.
AppliesOnOneTimePurchase	Bool		Indicates whether the discount applies to shipping lines in regular one-time purchase orders.
CreatedAt	Datetime		The date and time when the discount record was created.
UpdatedAt	Datetime		The date and time when the discount was last updated.
CombinesWithOrderDiscounts	Bool		Indicates whether the discount can be combined with order-level discounts.
CombinesWithProductDiscounts	Bool		Indicates whether the discount can be combined with product-level discounts.
CombinesWithShippingDiscounts	Bool		Indicates whether the discount can be combined with other shipping-level discounts.
DiscountCustomerAllAllCustomers	Bool		Indicates whether the discount can be applied by all customers. This value is always true.
DiscountCountriesCountries	String		A list of two-letter country codes where the discount can be applied.
DiscountCountriesIncludeRestOfWorld	Bool		Indicates whether the discount applies to all other countries not explicitly included in the shop's shipping zones.
DiscountCountryAllAllCountries	Bool		Indicates whether the discount can be applied to all countries as shipping destinations. This value is always true.
MaximumShippingPriceAmount	Decimal		The maximum shipping price eligible for the discount, expressed as a decimal money amount.
MaximumShippingPriceCurrencyCode	String		The currency code of the maximum shipping price eligible for the discount.
DiscountMinimumQuantityGreaterThanOrEqualToQuantity	String		The minimum number of items required for the discount to apply.
TotalSalesAmount	Decimal		The total sales amount attributed to this discount, expressed as a decimal money value.
TotalSalesCurrencyCode	String		The currency code of the total sales amount attributed to this discount.

Excel Add-In for Shopify

DiscountsCodeFreeShipping

View-Specific Information

Select

Columns