DiscountsCodeBxgy
Holds 'Buy X Get Y' discount code configurations tied to specific product eligibility conditions.
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.
- DiscountClass supports the '=, !=' comparison operators.
- StartsAt supports the '=, !=, <, >, >=, <=' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM DiscountsCodeBxgy WHERE Title = 'Val1'
SELECT * FROM DiscountsCodeBxgy WHERE DiscountClass = 'Val1'
SELECT * FROM DiscountsCodeBxgy WHERE StartsAt = '2023-01-01 11:10:00'
Insert
The following columns can be used to create a new record:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to create a new record:
Code, DiscountOnQuantity, DiscountPercentage, ProductsToAdd, ProductsToRemove, DiscountAmountToBuy, DiscountQuantityToBuy, ProductsBuysToAdd, ProductsBuysToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
Update
The following columns can be updated:
Title, EndsAt, StartsAt, UsageLimit, AppliesOncePerCustomer, UsesPerOrderLimit, CombinesWithOrderDiscounts, CombinesWithProductDiscounts, CombinesWithShippingDiscounts
The following pseudo-columns can be used to update a record:
Code, DiscountOnQuantity, DiscountPercentage, ProductsToAdd, ProductsToRemove, DiscountAmountToBuy, DiscountQuantityToBuy, ProductsBuysToAdd, ProductsBuysToRemove, AddAllCustomers, CustomersToAdd, CustomersToRemove, CustomerSegmentsToAdd, CustomerSegmentsToRemove
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 discount code record. | |
| Title | String | False |
The display name or title of the Buy X Get Y discount as it appears 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 explanation of the discount, describing the conditions under which it applies and the benefits offered. | |
| CodesCount | Int | True |
The total number of redemption codes created for this discount. | |
| CodesCountPrecision | String | True |
Specifies how precise or approximate the total count of redemption codes is. | |
| DiscountClass | String | True |
Defines how this discount interacts with others when combined, such as whether it can be stacked with order, product, or shipping discounts. | |
| EndsAt | Datetime | False |
The date and time when the discount ends. Returns 'null' for discounts with no expiration date. | |
| StartsAt | Datetime | False |
The date and time when the discount becomes active and available for use. | |
| UsageLimit | Int | False |
The maximum number of times this discount can be redeemed across all customers. | |
| AsyncUsageCount | Int | True |
The total number of times the discount has been used. This value is updated asynchronously and may differ slightly from real-time usage. | |
| HasTimelineComment | Bool | True |
Indicates whether any timeline comments or admin notes exist for this discount record. | |
| AppliesOncePerCustomer | Bool | False |
If true, each customer can redeem the discount code only once. | |
| UsesPerOrderLimit | Int | False |
Specifies how many times the discount can be applied within a single order. | |
| CreatedAt | Datetime | True |
The date and time when the discount record was created in Shopify. | |
| CombinesWithOrderDiscounts | Bool | False |
Indicates whether this discount can be combined with order-level discounts. | |
| CombinesWithProductDiscounts | Bool | False |
Indicates whether this discount can be combined with product-level discounts. | |
| CombinesWithShippingDiscounts | Bool | False |
Indicates whether this discount can be combined with shipping-related discounts. | |
| CustomerGetsAppliesOnSubscription | Bool | True |
Specifies whether the discount applies to subscription-based products that renew on a recurring schedule. | |
| CustomerGetsAppliesOnOneTimePurchase | Bool | True |
Specifies whether the discount applies to one-time purchase items. | |
| DiscountCustomerAllAllCustomers | Bool | True |
Indicates whether all customers are eligible to use this discount. This value is always 'true'. | |
| TotalSalesAmount | Decimal | True |
The total sales revenue associated with orders that used this discount. | |
| TotalSalesCurrencyCode | String | True |
The ISO currency code representing the currency of the total sales amount. |
Pseudo-Columns
疑似カラムは、明示的にリストされているタイプのステートメントでのみ使用できるフィールドです。これらは標準的なカラムではなく、特定の操作のための追加機能を提供するものです。
| Name | Type | Description |
| Code | String |
The alphanumeric discount code customers enter at checkout to redeem the discount. |
| DiscountOnQuantity | String |
The number of free or discounted items given as part of the promotion (the 'Get Y' portion). |
| DiscountPercentage | Double |
The percentage discount applied to the qualifying items (for example, 50% off the free product). |
| ProductsToAdd | String |
A comma-separated list of product IDs to include in the discount's eligible item set. |
| ProductsToRemove | String |
A comma-separated list of product IDs to exclude from the discount's eligible item set. |
| DiscountAmountToBuy | String |
The value threshold customers must reach to qualify for the discount, such as a minimum purchase amount. |
| DiscountQuantityToBuy | Double |
The number of qualifying items customers must purchase to trigger the discount (the 'Buy X' portion). |
| ProductsBuysToAdd | String |
A comma-separated list of product IDs that count toward the qualifying purchase set. |
| ProductsBuysToRemove | String |
A comma-separated list of product IDs to remove from the qualifying purchase set. |
| AddAllCustomers | Bool |
If true, the discount is automatically available to all customers without restriction. |
| CustomersToAdd | String |
A comma-separated list of customer IDs to grant access to this discount. |
| CustomersToRemove | String |
A comma-separated list of customer IDs to revoke access to this discount. |
| CustomerSegmentsToAdd | String |
A comma-separated list of customer segment IDs to include in the discount's eligibility. |
| CustomerSegmentsToRemove | String |
A comma-separated list of customer segment IDs to exclude from the discount's eligibility. |