DiscountsCodeFreeShipping
Returns a list of discounts.
View-Specific Information
Select
The 本製品 uses the Shopify API to process WHERE clause conditions built with the following columns and operators:
- Title supports the '=,!=' comparison operators.
- DiscountClass supports the '=,!=' comparison operators.
- StartsAt supports the '=,!=,<,>,>=,<=' comparison operators.
The 本製品 processes other filters client-side within the 本製品.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeFreeShipping WHERE Title='VALUE'
SELECT * FROM DiscountsCodeFreeShipping WHERE DiscountClass='VALUE'
SELECT * FROM DiscountsCodeFreeShipping WHERE StartsAt<'2000-01-01 01:00:00.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally-unique ID. | |
| Title | String | The title of the discount. | |
| Status | String | The status of the discount. | |
| Summary | String | A detailed summary of the discount. | |
| CodeCount | Int | The number of redeem codes for the discount. | |
| DiscountClass | String | The class of the discount for combining purposes. | |
| EndsAt | Datetime | The date and time when the discount ends. For open-ended discounts, use 'null'. | |
| ShortSummary | String | A short summary of the discount. | |
| StartsAt | Datetime | The date and time when the discount starts. | |
| UsageLimit | Int | The maximum number of times that the discount can be used. | |
| AppliesOnSubscription | Bool | Whether the discount applies on subscription shipping lines. | |
| AsyncUsageCount | Int | The number of times that the discount has been used. | |
| HasTimelineComment | Bool | Indicates whether there are any timeline comments on the discount. | |
| RecurringCycleLimit | Int | The number of times a discount applies on recurring purchases (subscriptions). | |
| AppliesOncePerCustomer | Bool | Whether the discount can be applied only once per customer. | |
| AppliesOnOneTimePurchase | Bool | Whether the discount applies on regular one-time-purchase shipping lines. | |
| CreatedAt | Datetime | The date and time when the discount was created. | |
| CombinesWithOrderDiscounts | Bool | Combines with order discounts. | |
| CombinesWithProductDiscounts | Bool | Combines with product discounts. | |
| CombinesWithShippingDiscounts | Bool | Combines with shipping discounts. | |
| DiscountCustomerAllAllCustomers | Bool | Whether the discount can be applied by all customers. This value is always 'true'. | |
| DiscountCountriesCountries | String | The codes for the countries where the discount can be applied. | |
| DiscountCountriesIncludeRestOfWorld | Bool | Whether the discount is applicable to countries that have not been defined in the shop's shipping zones. | |
| DiscountCountryAllAllCountries | Bool | Whether the discount can be applied to all countries as shipping destination. This value is always 'true'. | |
| MaximumShippingPriceAmount | Decimal | Decimal money amount. | |
| MaximumShippingPriceCurrencyCode | String | Currency of the money. | |
| DiscountMinimumQuantityGreaterThanOrEqualToQuantity | String | The minimum quantity of items that's required for the discount to be applied. | |
| TotalSalesAmount | Decimal | Decimal money amount. | |
| TotalSalesCurrencyCode | String | Currency of the money. |