CData Python Connector for Shopify

Build 25.0.9454

DiscountsAutomaticBxgy

Lists automatic buy-X-get-Y discounts.

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

The globally unique identifier of the automatic Buy X, Get Y discount.

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.

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.

StartsAt Datetime False

The date and time when the discount becomes active.

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.

UsesPerOrderLimit Int False

The maximum number of times this discount can be applied to a single order.

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 False

Indicates whether the discount can be combined with shipping-level 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

The number of items discounted as part of the Buy X, Get Y promotion.

DiscountPercentage Double

The percentage value of the discount applied to eligible items.

ProductsToAdd String

A comma-separated list of product Ids to include in the discount.

ProductsToRemove String

A comma-separated list of product Ids to exclude from the discount.

DiscountQuantityToBuy String

The quantity of prerequisite items that must be purchased for the discount to apply.

DiscountAmountToBuy String

The amount or value associated with the prerequisite purchase for the discount.

ProductsBuysToAdd String

A comma-separated list of product IDs to add as eligible prerequisites for the discount.

ProductsBuysToRemove String

A comma-separated list of product IDs to remove from eligible prerequisites for the discount.

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