Skip to main content

Campaign

type Campaign {
id: ID!
applicableCustomerGroupIds: [String!]
applicableCustomerIds: [String!]
applicablePrice: CampaignApplicablePriceEnum!
applyCampaignToProductPrice: Boolean
buyXThenGetY: BuyXThenGetY
canCombineWithOtherCampaigns: Boolean!
createdFor: CampaignCreatedForEnum
currencyCodes: [String!]
dateRange: CampaignDateRangeField
fixedDiscount: FixedDiscount
hasCoupon: Boolean!
includeDiscountedProducts: Boolean
isFreeShipping: Boolean
onlyUseCustomer: Boolean
salesChannelIds: [String!]
title: String!
translations: [CampaignTranslation!]
type: CampaignTypeEnum!
usageCount: Int!
usageLimit: Int
usageLimitPerCustomer: Int
}

Fields

idID!required
applicableCustomerGroupIds[String!]
applicableCustomerIds[String!]
applicablePriceCampaignApplicablePriceEnum!required
applyCampaignToProductPriceBoolean
buyXThenGetYBuyXThenGetY
canCombineWithOtherCampaignsBoolean!required
currencyCodes[String!]
fixedDiscountFixedDiscount
hasCouponBoolean!required
includeDiscountedProductsBoolean
isFreeShippingBoolean
onlyUseCustomerBoolean
salesChannelIds[String!]
titleString!required
typeCampaignTypeEnum!required
usageCountInt!required
usageLimitInt
usageLimitPerCustomerInt