Skip to main content
Version: 3.x

SaleToggle

The event informs about the start or end of the sale.

Added in Saleor 3.5

DEPRECATED: this event will be removed in Saleor 4.0. Use PromotionStarted and PromotionEnded events instead.

type SaleToggle implements Event {
  issuedAt: DateTime
  version: String
  issuingPrincipal: IssuingPrincipal
  recipient: App
  sale(channel: String): Sale
}

Fields​

SaleToggle.issuedAt ● DateTime scalar​

Time of the event.

SaleToggle.version ● String scalar​

Saleor version that triggered the event.

SaleToggle.issuingPrincipal ● IssuingPrincipal union​

The user or application that triggered the event.

SaleToggle.recipient ● App object​

The application receiving the webhook.

SaleToggle.sale ● Sale object​

The sale the event relates to.

Added in Saleor 3.5
SaleToggle.sale.channel ● String scalar​

Slug of a channel for which the data should be returned.

Interfaces​

Event interface​

Was this page helpful?