ADO.NET Provider for Shopify

Build 26.0.9655

DiscountsCodeFreeShipping

Lists free-shipping discounts available via discount codes.

Table-Specific Information

Select

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

  • 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'

Insert

The following columns can be used to create a new record:

Title, EndsAt, StartsAt, UsageLimit, AppliesOnSubscription, RecurringCycleLimit, AppliesOncePerCustomer, AppliesOnOneTimePurchase, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, DiscountCountriesIncludeRestOfWorld, DiscountCountryAllAllCountries, MaximumShippingPriceAmount, DiscountMinimumQuantityGreaterThanOrEqualToQuantity, DiscountMinimumSubtotalGreaterThanOrEqualToSubtotalAmount

The following pseudo-columns can be used to create a new record:

Code, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove, CountriesToAdd, CountriesToRemove

Update

The following columns can be updated:

Title, EndsAt, StartsAt, UsageLimit, AppliesOnSubscription, RecurringCycleLimit, AppliesOncePerCustomer, AppliesOnOneTimePurchase, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, DiscountCountriesIncludeRestOfWorld, DiscountCountryAllAllCountries, MaximumShippingPriceAmount, DiscountMinimumQuantityGreaterThanOrEqualToQuantity, DiscountMinimumSubtotalGreaterThanOrEqualToSubtotalAmount

The following pseudo-columns can be used to update a record:

Code, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove, CountriesToAdd, CountriesToRemove

Delete

You can delete entries by specifying the following column:

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String False

The globally unique identifier of the free shipping discount code record.

Title String False

The display title of the discount.

Status String True

The current status of the discount, such as active or expired.

Summary String True

A detailed summary of the discount and how it is applied.

CodesCount Int True

The number of unique discount codes generated for this discount.

CodesCountPrecision String True

The level of precision applied to the discount code count value.

DiscountClass String True

The classification of the discount, used for determining compatibility with other discounts.

EndsAt Datetime False

The date and time when the discount ends. Returns null for open-ended discounts.

ShortSummary String True

A short summary of the free shipping discount (for example, 'Free standard shipping on orders over $50').

StartsAt Datetime False

The date and time when the discount becomes active.

UsageLimit Int False

The maximum number of times this discount can be used across all customers.

AppliesOnSubscription Bool False

Indicates whether the discount applies to shipping lines in subscription orders.

AsyncUsageCount Int True

The number of times the discount has been used. This value is updated asynchronously and might differ from the actual usage count.

HasTimelineComment Bool True

Indicates whether timeline comments have been added to the discount record.

RecurringCycleLimit Int False

The maximum number of billing cycles in which this discount can apply to subscription orders.

AppliesOncePerCustomer Bool False

Indicates whether the discount can be redeemed only once per customer.

AppliesOnOneTimePurchase Bool False

Indicates whether the discount applies to shipping lines in regular one-time purchase orders.

CreatedAt Datetime True

The date and time when the discount record was created.

UpdatedAt Datetime True

The date and time when the discount was updated.

CombinesWithOrderDiscounts Bool False

Indicates whether the discount can be combined with order-level discounts.

CombinesWithProductDiscounts Bool False

Indicates whether the discount can be combined with product-level discounts.

CombinesWithShippingDiscounts Bool True

Indicates whether the discount can be combined with other shipping-level discounts.

DiscountBuyerSelectionAll Bool True

Whether the discount can be applied by all customers. This value is always 'true'.

DiscountCountriesCountries String True

A list of two-letter country codes where the discount can be applied.

DiscountCountriesIncludeRestOfWorld Bool False

Indicates whether the discount applies to all other countries not explicitly included in the shop's shipping zones.

DiscountCountryAllAllCountries Bool False

Indicates whether the discount can be applied to all countries as shipping destinations. This value is always true.

MaximumShippingPriceAmount Decimal False

The maximum shipping price eligible for the discount, expressed as a decimal money amount.

MaximumShippingPriceCurrencyCode String True

The currency code of the maximum shipping price eligible for the discount.

DiscountMinimumQuantityGreaterThanOrEqualToQuantity String False

The minimum number of items required for the discount to apply.

DiscountMinimumSubtotalGreaterThanOrEqualToSubtotalAmount Decimal False

The minimum subtotal that's required for the discount to be applied.

DiscountMinimumSubtotalGreaterThanOrEqualToSubtotalCurrencyCode String True

The three-letter currency code that represents a world currency used in a store.

TotalSalesAmount Decimal True

The total sales amount attributed to this discount, expressed as a decimal money value.

TotalSalesCurrencyCode String True

The currency code of the total sales amount attributed to this discount.

Pseudo-Columns

Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.

Name Type Description
Code String

The code to use the discount.

AddAllCustomers Bool

Whether all customers can use this discount.

CustomersToAdd String

A simple, comma-separated list of customers IDs to add.

CustomersToRemove String

A simple, comma-separated list of customers IDs to remove.

CustomerSegmentsToAdd String

A simple, comma-separated list of customer segment IDs to add.

CustomerSegmentsToRemove String

A simple, comma-separated list of customer segment IDs to remove.

CountriesToAdd String

A simple, comma-separated list of countries to add.

CountriesToRemove String

A simple, comma-separated list of countries to remove.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655