DiscountsCodeFreeShipping
Displays free-shipping discount code data, including minimum purchase requirements and applicable regions.
View-Specific Information
Select
The connector uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The connector processes other filters client-side within the connector.
- Title supports the '=, !=' comparison operators.
- DiscountClass supports the '=, !=' comparison operators.
- StartsAt 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 StartsAt = '2023-01-01 11:10:00'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally unique identifier for the free shipping discount code record. | |
| Title | String | The display name or title of the free shipping discount as shown in the Shopify admin or storefront. | |
| Status | String | The current operational state of the discount, such as active, scheduled, or expired. | |
| Summary | String | A detailed explanation of the free shipping promotion, including its conditions and eligible regions or products. | |
| CodesCount | Int | The total number of redemption codes created for this free shipping discount. | |
| CodesCountPrecision | String | Indicates how precise or approximate the count of redemption codes is. | |
| DiscountClass | String | Defines how this discount can combine with others, such as order-level, product-level, or shipping-level discounts. | |
| EndsAt | Datetime | The date and time when the discount expires. Returns 'null' for ongoing discounts with no end date. | |
| ShortSummary | String | A brief overview of the discount, highlighting its primary benefit (free shipping). | |
| StartsAt | Datetime | The date and time when the free shipping discount becomes active. | |
| UsageLimit | Int | The maximum number of times this discount can be redeemed across all customers. | |
| AppliesOnSubscription | Bool | Specifies whether the free shipping discount applies to subscription-based shipping lines. | |
| AsyncUsageCount | Int | The total number of times the discount has been used. This count is updated asynchronously and may not reflect real-time usage. | |
| HasTimelineComment | Bool | Indicates whether there are any timeline comments or internal notes related to this discount record. | |
| RecurringCycleLimit | Int | Specifies how many recurring billing cycles the free shipping benefit applies to for subscription orders. | |
| AppliesOncePerCustomer | Bool | If true, each customer can redeem this discount code only once. | |
| AppliesOnOneTimePurchase | Bool | Specifies whether the free shipping discount applies to regular, one-time purchase orders. | |
| CreatedAt | Datetime | The date and time when the free shipping discount record was created in Shopify. | |
| CombinesWithOrderDiscounts | Bool | Indicates whether the free shipping discount can be combined with other order-level discounts. | |
| CombinesWithProductDiscounts | Bool | Indicates whether the free shipping discount can be combined with product-level discounts. | |
| CombinesWithShippingDiscounts | Bool | Indicates whether the free shipping discount can be combined with other shipping-related discounts. | |
| DiscountCustomerAllAllCustomers | Bool | Specifies whether all customers are eligible to use this discount. This value is always 'true'. | |
| DiscountCountriesCountries | String | A comma-separated list of ISO country codes specifying where the free shipping discount is valid. | |
| DiscountCountriesIncludeRestOfWorld | Bool | If true, the discount applies to shipping destinations not specifically defined in the shop's configured shipping zones. | |
| DiscountCountryAllAllCountries | Bool | Indicates whether the free shipping discount applies to all countries. This value is always 'true'. | |
| MaximumShippingPriceAmount | Decimal | The maximum shipping cost threshold eligible for free shipping. Orders with a higher shipping cost do not qualify. | |
| MaximumShippingPriceCurrencyCode | String | The ISO currency code representing the currency of the maximum eligible shipping cost. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | The minimum number of items required in the order for the free shipping discount to apply. | |
| TotalSalesAmount | Decimal | The total value of sales generated from orders that used this discount code. | |
| TotalSalesCurrencyCode | String | The ISO currency code representing the currency of the total sales amount. |