CData Python Connector for Shopify

Build 25.0.9454

DiscountsAutomaticBxgy

Represents 'Buy X Get Y' automatic discount configurations and their qualifying item relationships.

Table-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.
  • Status 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 DiscountsAutomaticBxgy WHERE Title = 'Val1'
  SELECT * FROM DiscountsAutomaticBxgy WHERE Status = 'Val1'
  SELECT * FROM DiscountsAutomaticBxgy WHERE DiscountClass = 'Val1'
  SELECT * FROM DiscountsAutomaticBxgy WHERE StartsAt = '2023-01-01 11:10:00'

Insert

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

Title, EndsAt, StartsAt, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts

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

DiscountOnQuantity, DiscountPercentage, ProductsToAdd, ProductsToRemove, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsBuysToAdd, ProductsBuysToRemove

Update

The following columns can be updated:

Title, EndsAt, StartsAt, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts

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

DiscountOnQuantity, DiscountPercentage, ProductsToAdd, ProductsToRemove, DiscountQuantityToBuy, DiscountAmountToBuy, ProductsBuysToAdd, ProductsBuysToRemove

Delete

You can delete entries by specifying the following column:

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A globally unique identifier for the automatic Buy X Get Y discount record.

Title String False

The display title of the discount, as shown in the Shopify admin or storefront.

Status String True

The current operational state of the discount, such as active, scheduled, or expired.

Summary String True

A detailed summary describing the Buy X Get Y promotion, including the qualifying and reward criteria.

DiscountClass String True

Defines how this discount interacts with other discounts when combined, such as order-level or product-level classification.

EndsAt Datetime False

The date and time when the discount expires. Returns 'null' if the discount has no end date.

StartsAt Datetime False

The date and time when the discount becomes active and available to customers.

AsyncUsageCount Int True

The total number of times this discount has been used. The value is updated asynchronously and may differ from real-time counts.

UsesPerOrderLimit Int False

The maximum number of times the discount can be applied within a single order.

CreatedAt Datetime True

The date and time when the Buy X Get Y discount was created in Shopify.

CombinesWithOrderDiscounts Bool False

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

CombinesWithProductDiscounts Bool False

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

CombinesWithShippingDiscounts Bool False

Indicates whether this discount can be combined with shipping-related discounts.

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
DiscountOnQuantity String

Specifies the number of reward items (the 'Y' portion) that are discounted when the promotion applies.

DiscountPercentage Double

The percentage value of the discount applied to the reward items.

ProductsToAdd String

A comma-separated list of product IDs to include in the eligible reward group for the discount.

ProductsToRemove String

A comma-separated list of product IDs to remove from the eligible reward group.

DiscountQuantityToBuy String

Specifies the quantity of prerequisite items (the 'X' portion) that must be purchased for the discount to activate.

DiscountAmountToBuy String

Defines the total value or spending threshold required to qualify for the discount.

ProductsBuysToAdd String

A comma-separated list of product IDs to include in the qualifying (buy) group for the discount.

ProductsBuysToRemove String

A comma-separated list of product IDs to remove from the qualifying (buy) group for the discount.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454