SaleInput

Input for creating or updating a sale.

input SaleInput {
  name: String
  type: DiscountValueTypeEnum
  value: PositiveDecimal
  products: [ID!]
  variants: [ID!]
  categories: [ID!]
  collections: [ID!]
  startDate: DateTime
  endDate: DateTime
  minSpentAmount: PositiveDecimal
  minCheckoutItemsQuantity: Int
  saleType: SaleTypeEnum
}

Fields

SaleInput.name ● String scalar

Sale name.

SaleInput.type ● DiscountValueTypeEnum enum

Discount type: fixed or percentage.

SaleInput.value ● PositiveDecimal scalar

Value of the sale discount.

SaleInput.products ● [ID!] list scalar

Products related to the sale.

SaleInput.variants ● [ID!] list scalar

Variants related to the sale.

SaleInput.categories ● [ID!] list scalar

Categories related to the sale.

SaleInput.collections ● [ID!] list scalar

Collections related to the sale.

SaleInput.startDate ● DateTime scalar

Start date of the sale in ISO 8601 format.

SaleInput.endDate ● DateTime scalar

End date of the sale in ISO 8601 format.

SaleInput.minSpentAmount ● PositiveDecimal scalar

Minimum purchase amount required to apply the sale.

SaleInput.minCheckoutItemsQuantity ● Int scalar

Minimum quantity of checkout items required to apply the sale.

SaleInput.saleType ● SaleTypeEnum enum

Sale type: SPECIFIC_PRODUCT or SHIPPING.

Member Of

saleCreate mutation ● saleUpdate mutation