Skip to main content

Discount

A discount that reduces the price of products, an order or shipping.

type Discount {
category: DiscountCategory!
class: DiscountClass!
discountAgreements(
after: String
before: String
first: Int
last: Int
): DiscountAgreementConnection!
discountCodes(
after: String
before: String
first: Int
last: Int
): DiscountCodeConnection!
externalId: String
id: GlobalID!
status: DiscountStatus!
title: String!
type: DiscountType!
value: DiscountValue
}

Fields​

Discount.category ● DiscountCategory! non-null enum types​

The discount's category.

Discount.class ● DiscountClass! non-null enum types​

The discount's class, which sets whether it applies to products, the order or shipping.

Discount.discountAgreements ● DiscountAgreementConnection! non-null object types​

The agreements made to apply the discount.

Discount.discountAgreements.after ● String scalar types​

Returns the elements in the list that come after the specified cursor.

Discount.discountAgreements.before ● String scalar types​

Returns the elements in the list that come before the specified cursor.

Discount.discountAgreements.first ● Int scalar types​

Returns the first _n_ elements from the list.

Discount.discountAgreements.last ● Int scalar types​

Returns the last _n_ elements from the list.

Discount.discountCodes ● DiscountCodeConnection! non-null object types​

The discount's codes.

Discount.discountCodes.after ● String scalar types​

Returns the elements in the list that come after the specified cursor.

Discount.discountCodes.before ● String scalar types​

Returns the elements in the list that come before the specified cursor.

Discount.discountCodes.first ● Int scalar types​

Returns the first _n_ elements from the list.

Discount.discountCodes.last ● Int scalar types​

Returns the last _n_ elements from the list.

Discount.externalId ● String scalar types​

The discount's ID on the platform it came from, such as Shopify.

Discount.id ● GlobalID! non-null scalar types​

The discount's ID.

Discount.status ● DiscountStatus! non-null enum types​

The discount's status.

Discount.title ● String! non-null scalar types​

The discount's title.

Discount.type ● DiscountType! non-null enum types​

The discount's type, such as automatic or code.

Discount.value ● DiscountValue object types​

The discount's value. Empty for app discounts.

Member Of​

DiscountAgreement object ● DiscountCode object ● SubscriptionDiscount object