This article serves as a comprehensive reference for the GraphQL API provided by the Messages app. This API enables the internationalization of messages in various store contexts, such as Catalog, Intelligent Search, and VTEX IO apps. For more details about how this API is used, see the Overwriting the Messages app article.

classDiagram
  direction LR
  class Languages {
    supported [String!]!
    default String!
  }

  class Translation {
    lang String!
    translation String!
  }

  class MessageListV2 {
    srcLang String!
    groupContext String
    context String
    translations [Translation!]!
  }

  class Query {
    languages Languages!
    translate(args TranslateArgs!) [String]!
    translateWithDependencies(args TranslateWithDependenciesArgs!) [String]!
    userTranslations(args IndexedMessages!) [MessageListV2]!
    listV2(args ListArgsV2!) [MessageListV2!]!
    authorize Boolean!
  }

  Query --> Languages : languages
  MessageListV2 --> Translation : translations
  Query --> MessageListV2 : userTranslations
  Query --> MessageListV2 : listV2

  click Query href "#query"
  click Languages href "#languages"
  click MessageListV2 href "#messagelistv2"
  click Translation href "#translation"

classDiagram
  direction LR
  class Mutation {
    saveV2(args SaveArgsV2!) Boolean!
  }

  click Mutation href "#mutation"

Arguments must be provided by the user. Required fields are marked with an exclamation mark (!).