Skip to main content
View Markdown

Sale Object

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

DEPRECATED: this type will be removed. Use Promotion type instead.

type Sale implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  name: String!
  type: SaleType!
  startDate: DateTime!
  endDate: DateTime
  created: DateTime!
  updatedAt: DateTime!
  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
  translation(
    languageCode: LanguageCodeEnum!
  ): SaleTranslation
  channelListings: [SaleChannelListing!]
  discountValue: Float
  currency: String
}

Fields​

id ● ID!​

The ID of the sale.

privateMetadata ● [MetadataItem!]!​

List of private metadata items. Requires staff permissions to access.

privateMetafield ● String​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

privateMetafields ● Metadata​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

metadata ● [MetadataItem!]!​

List of public metadata items. Can be accessed without permissions.

metafield ● String​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

metafields ● Metadata​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

name ● String!​

The name of the sale.

type ● SaleType!​

Type of the sale, fixed or percentage.

startDate ● DateTime!​

The start date and time of the sale.

endDate ● DateTime​

The end date and time of the sale.

created ● DateTime!​

The date and time when the sale was created.

updatedAt ● DateTime!​

The date and time when the sale was updated.

categories ● CategoryCountableConnection​

List of categories this sale applies to.

before ● String​

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

after ● String​

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

first ● Int​

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last ● Int​

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

collections ● CollectionCountableConnection​

List of collections this sale applies to.

Requires the MANAGE_DISCOUNTSpermission.
before ● String​

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

after ● String​

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

first ● Int​

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last ● Int​

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

products ● ProductCountableConnection​

List of products this sale applies to.

Requires the MANAGE_DISCOUNTSpermission.
before ● String​

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

after ● String​

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

first ● Int​

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last ● Int​

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

variants ● ProductVariantCountableConnection​

List of product variants this sale applies to.

Requires the MANAGE_DISCOUNTSpermission.
before ● String​

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

after ● String​

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

first ● Int​

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last ● Int​

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

translation ● SaleTranslation​

Returns translated sale fields for the given language code.

languageCode ● LanguageCodeEnum!​

A language code to return the translation for sale.

channelListings ● [SaleChannelListing!]​

List of channels available for the sale.

Requires the MANAGE_DISCOUNTSpermission.

discountValue ● Float​

Sale value.

currency ● String​

Currency code for sale.

Interfaces​

Node​

An object with an ID

ObjectWithMetadata​

Returned By​

sale query

Member Of​

SaleAddCatalogues object ● SaleChannelListingUpdate object ● SaleCountableEdge object ● SaleCreate object ● SaleCreated object ● SaleDelete object ● SaleDeleted object ● SaleRemoveCatalogues object ● SaleToggle object ● SaleTranslatableContent object ● SaleTranslate object ● SaleUpdate object ● SaleUpdated object