Skip to main content

promotion Query

Look up a promotion by ID.

Requires the MANAGE_DISCOUNTSpermission.
promotion(
  id: ID!
): Promotion
Details
type Promotion 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: PromotionTypeEnum
  description: JSON
  startDate: DateTime!
  endDate: DateTime
  createdAt: DateTime!
  updatedAt: DateTime!
  rules: [PromotionRule!]
  translation(
    languageCode: LanguageCodeEnum!
  ): PromotionTranslation
  events: [PromotionEvent!]
}

Arguments​

id ● ID!​

ID of the promotion.

Type​

Promotion​

Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers.