CData Python Connector for BigCommerce

Build 21.0.7930


Lists all coupons.

Table Specific Information


The provider will use the BigCommerce API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the provider.

  • Id supports the '=, >, <, >=, <=' comparison.
  • Name supports the '=' comparison.
  • Type supports the '=' comparison.
  • Code supports the '=' comparison.

For example, the following queries are processed server side:


SELECT * FROM Coupons WHERE Id = 1 

SELECT * FROM Coupons WHERE Id >= 1 AND Id <= 5

SELECT * FROM Coupons WHERE Name = "test"


Name Type Description
Id [KEY] Integer The coupons ID.
Name String The name of the coupon.
Type String Type of the coupon.
Amount Decimal The discount to apply to an order, as either an amount or a percentage.
MinPurchase Decimal Specifies a minimum value that an order must have before the coupon can be applied to it.
Expires Datetime Specifies when a coupon expires.
Enabled Boolean If the coupon is enabled, this fields value is true; otherwise, false.
Code String The coupon code that customers will use to receive their discounts.
AppliesToEntity String What the discount applies to. Can be products or categories.
AppliesToIds String ID of either the products or categories
NumUses Integer Number of times this coupon has been used.
MaxUses Integer Maximum number of times this coupon can be used.
MaxUsesPerCustomer Integer Maximum number of times each customer can use this coupon.
DateCreated Datetime Date Created

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930