Sale

Represents a sale (automatic discount) on products.

type Sale implements Node {
  id: ID!
  name: String!
  currency: String
  type: DiscountValueTypeEnum!
  value: Float!
  startDate: DateTime!
  endDate: DateTime
  saleType: SaleTypeEnum!
  minSpent: Money
  minCheckoutItemsQuantity: Int
  categories(
    before: String
    after: String
    first: Int
    last: Int
  ): CategoryCountableConnection!
  collections(
    before: String
    after: String
    first: Int
    last: Int
  ): CollectionCountableConnection!
  products(
    before: String
    after: String
    first: Int
    last: Int
  ): ProductCountableConnection!
  variants(
    before: String
    after: String
    first: Int
    last: Int
  ): ProductVariantCountableConnection!
}

Show more ↓

Fields

Sale.id ● ID! non-null scalar

The Globally Unique ID of this object

Sale.name ● String! non-null scalar

Name of the sale

Sale.currency ● String scalar

Currency code for this sale

Sale.type ● DiscountValueTypeEnum! non-null enum

Discount type: fixed or percentage

Sale.value ● Float! non-null scalar

Discount value amount

Sale.startDate ● DateTime! non-null scalar

Start date

Sale.endDate ● DateTime scalar

End date

Sale.saleType ● SaleTypeEnum! non-null enum

Sale type: SPECIFIC_PRODUCT or SHIPPING

Sale.minSpent ● Money object

Minimum amount spent to apply this sale

Sale.minCheckoutItemsQuantity ● Int scalar

Minimum number of items in checkout to apply this sale

Sale.categories ● CategoryCountableConnection! non-null object

List of categories this sale applies to

Sale.categories.before ● String scalar

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

Sale.categories.after ● String scalar

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

Sale.categories.first ● Int scalar

Returns the first n items from the list.

Sale.categories.last ● Int scalar

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

Sale.collections ● CollectionCountableConnection! non-null object

List of collections this sale applies to

Sale.collections.before ● String scalar

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

Sale.collections.after ● String scalar

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

Sale.collections.first ● Int scalar

Returns the first n items from the list.

Sale.collections.last ● Int scalar

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

Sale.products ● ProductCountableConnection! non-null object

List of products this sale applies to

Sale.products.before ● String scalar

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

Sale.products.after ● String scalar

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

Sale.products.first ● Int scalar

Returns the first n items from the list.

Sale.products.last ● Int scalar

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

Sale.variants ● ProductVariantCountableConnection! non-null object

List of product variants this sale applies to

Sale.variants.before ● String scalar

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

Sale.variants.after ● String scalar

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

Sale.variants.first ● Int scalar

Returns the first n items from the list.

Sale.variants.last ● Int scalar

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

Interfaces

Node interface

An object with a Globally Unique ID

Returned By

sale query

Member Of

CheckoutLine object ● Collection object ● NauticalOrderLine object ● Product object ● ProductVariant object ● SaleAddCatalogues object ● SaleCountableEdge object ● SaleCreate object ● SaleDelete object ● SaleRemoveCatalogues object ● SaleUpdate object