OBJECT
Promotion

A promotion, sale, or special discount.
GraphQL Schema definition

type Promotion implements Node {
# Adverts excluded from this promotion.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
advertsExcluded(after: String, before: String, first: Int, last: Int): AdvertsConnection 
# Adverts included in this promotion.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
advertsIncluded(after: String, before: String, first: Int, last: Int): AdvertsConnection 
# Brands excluded from this promotion.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
brandsExcluded(after: String, before: String, first: Int, last: Int): BrandsConnection 
# Brands included in this promotion.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
brandsIncluded(after: String, before: String, first: Int, last: Int): BrandsConnection 
# Categories excluded from this promotion.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
categoriesExcluded(
after: String,
before: String,
first: Int,
last: Int
): TaxonsConnection 
# Categories included in this promotion.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
categoriesIncluded(
after: String,
before: String,
first: Int,
last: Int
): TaxonsConnection 
# Percentage of cost borne by the marketplace.
costPercentageBorneByMarketplace: Float! 
# Description of the promotion used for internal reference.
description: String 
# Amount of the discount. Dollar or percentage value depending on 'discountType'.
discountAmount: Float 
# Type of discount. Options available: 'dollar', 'percentage'.
discountType: String 
# Promotion end date.
endDate: ISO8601DateTime 
# Is free shipping enabled for this promotion?
freeShipping: Boolean! 
# Is free shipping only for domestic orders?
freeShippingDomesticOnly: Boolean! 
id: ID! 
# Loyalty program restriction applied to this promotion.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
loyaltyProgramLevels(
after: String,
before: String,
first: Int,
last: Int
): LoyaltyProgramLevelsConnection 
# Maximum amount over which this promotion will not apply.
maximumSpend: Float 
# Minimum amount required to be spent for this promotion to apply.
minimumSpend: Float 
# Name of the promotion - displayed at cart and checkout, order card, invoice.
name: String! 
# Whether items already on sale are excluded from this promotion.
saleItemsExcluded: Boolean! 
# The seller running the promotion.
seller: Seller 
# Promotion start date.
startDate: ISO8601DateTime 
# Whether the promotion has been suspended.
suspended: Boolean! 
# Text for use as the "teaser" within a banner or similar.
teaser: String 
# Text for use as the "teaser" within a banner or similar.
teaserText: String @deprecated( reason: "Use teaser instead"  )
# URL the Promotion links through to
url: String 
# Variants excluded from this promotion.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
variantsExcluded(after: String, before: String, first: Int, last: Int): VariantsConnection 
# Variants included in this promotion.
# 
# Arguments
# after: Returns the elements in the list that come after the 
# specified cursor.
# before: Returns the elements in the list that come before the 
# specified cursor.
# first: Returns the first _n_ elements from the list.
# last: Returns the last _n_ elements from the list.
variantsIncluded(after: String, before: String, first: Int, last: Int): VariantsConnection 
}
Promotion

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
