Sale

Sales allow creating discounts for categories, collections, products, or variants and are visible to all the customers.

type Sale implements Node {
  id: ID!
  name: String!
  type: DiscountValueTypeEnum!
  value: Decimal!
  startDate: DateTime!
  endDate: DateTime
  currency: String!
  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
  saleType: SaleTypeEnum!
}

Show more ↓

Fields

Sale.id ● ID! non-null scalar

The ID of the object

Sale.name ● String! non-null scalar

Sale.type ● DiscountValueTypeEnum! non-null enum

Type of discount

Sale.value ● Decimal! non-null scalar

Sale.startDate ● DateTime! non-null scalar

Sale.endDate ● DateTime scalar

Sale.currency ● String! non-null scalar

Sale.minSpent ● Money object

Sale.minCheckoutItemsQuantity ● Int! non-null scalar

Sale.categories ● CategoryCountableConnection object

List of categories this sale applies to.

Sale.categories.before ● String scalar

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

Sale.categories.after ● String scalar

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

Sale.categories.first ● Int scalar

Return the first n elements from the list.

Sale.categories.last ● Int scalar

Return the last n elements from the list.

Sale.collections ● CollectionCountableConnection object

List of collections this sale applies to.

Sale.collections.before ● String scalar

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

Sale.collections.after ● String scalar

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

Sale.collections.first ● Int scalar

Return the first n elements from the list.

Sale.collections.last ● Int scalar

Return the last n elements from the list.

Sale.products ● ProductCountableConnection object

List of products this sale applies to.

Sale.products.before ● String scalar

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

Sale.products.after ● String scalar

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

Sale.products.first ● Int scalar

Return the first n elements from the list.

Sale.products.last ● Int scalar

Return the last n elements from the list.

Sale.variants ● ProductVariantCountableConnection object

List of variants this sale applies to.

Sale.variants.before ● String scalar

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

Sale.variants.after ● String scalar

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

Sale.variants.first ● Int scalar

Return the first n elements from the list.

Sale.variants.last ● Int scalar

Return the last n elements from the list.

Sale.saleType ● SaleTypeEnum! non-null enum

Determines a type of sale.

Interfaces

Node interface

An object with an 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