DiscountCodeBasic

object

A code discount that offers customers a percentage or fixed amount discount on specific products, collections or the entire order.

Fields

appliesTimesPerCustomer ● Int

Applies times limits per customer

asyncUsageCount ● Int

The number of times that the discount has been used.

codeCount ● Int

The number of redeem codes for the discount.

codes ● [String]

It returns the first 20 codes of the discount

combinesWith ● DiscountCombinesWith

Determines which discount classes the discount can combine with.

createdAt ● Date

The date and time when the discount was created.

customerGets ● DiscountCustomerGets

The qualifying items in an order, the quantity of each one, and the total value of the discount.

customerSelection ● DiscountCustomerSelection

The customers that can use the discount.

discountClass ● MerchandiseDiscountClass

The class of the discount for combining purposes.

endsAt ● Date

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement ● DiscountMinimumRequirement

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

shareableUrls ● [DiscountShareableUrl]

URLs that can be used to share the discount.

shortSummary ● String

A short summary of the discount.

startsAt ● Date

The date and time when the discount starts.

status ● DiscountStatus

Status of discount

summary ● String

A detailed summary of the discount.

title ● String

The title of the discount.

totalSales ● MoneyV2

The total sales from orders where the discount was used.

updatedAt ● Date

The date and time when the discount was updated.

usageLimit ● Int

The maximum number of times that the discount can be used.

Status and error codes

For detailed information about common codes, see Status and error codes.

Was this article helpful to you?

SHOPLINE

Legal