GraphQL GraphQL OBJECT

Promotion

Price discount off of the regular product price you offer the customer.

link Definition

  • type Promotion {
  • # Unique ID of the promotion.
  • id: Int!
  • # Date and time when the promotion was created.
  • creationDate: DateTime
  • # User who created the promotion.
  • createdBy: UserAccount!
  • # Date and time when the last edit occurred.
  • lastModifyDate: DateTime
  • # User who last edited the promotion.
  • lastModifiedBy: UserAccount!
  • # Name of the promotion.
  • name: String
  • # Indicates whether the promotion is active.
  • isActive: Boolean!
  • # First date and time in which the promotion is valid.
  • validFrom: DateTime
  • # Last date and time in which the promotion is valid.
  • validTo: DateTime
  • # Indicates whether the promotion is currently active and valid.
  • isActiveAndValid: Boolean
  • # Client who offers the promoted product for sale.
  • client: Client
  • # List of promoted products.
  • productList: PromotionProductList
  • # Coupon settings.
  • couponSettings: PromotionCouponSettings
  • # How much revenue the promotion has generated for the client.
  • clientSalesRevenueStatistics: ClientSalesRevenueStatistics
  • # How many orders for the promoted product have been placed.
  • orderStatistics: OrderStatistics
  • # List of price configurations that limit the promotion.
  • priceConfigurationList: PriceConfigurationList
  • # Options to limit the discount and to specify a pricing model.
  • discount: PriceSettingsInterface
  • # Affiliate who is credited for every purchase made with a coupon from this
  • # promotion.
  • affiliate: Affiliate
  • # X-parameters for the promotion. X-parameters are components of URLs that are
  • # used to pass information through the checkout process.
  • extraParametersString: String
  • # The type of the promotion.
  • type: PromotionType
  • # Minimum number of items for the cart level promotion to be applied.
  • minimumDistinctItemCount: Int
  • }