Session Client GraphQL API by vtex

This API manages the vtex_session cookie, which holds session-related data for users. Developers can either interact with the API endpoints directly or declare this app as a dependency to leverage its React functions.

Schema overview

Query

classDiagram
  direction LR

  class Query {
    String version
    session(items [String]) Session
  }

  class SessionError {
    String type
    String message
  }

  class SessionSuccess {
    String! id
    SessionNamespaces namespaces
  }

  %% Links between classes
  Query --> Session : session
  Session --> SessionError : possibleType
  Session --> SessionSuccess : possibleType

  %% Click events
  click Query href "#query"
  click Session href "#session"
  click SessionError href "#sessionerror"
  click SessionSuccess href "#sessionsuccess"

Mutation

classDiagram
    direction LR

    class Mutation {
        updateSession(fields SessionFieldsJSONInput!, items [String]) Session
    }

    class SessionError {
        String type
        String message
    }

    class SessionSuccess {
        String! id
        SessionNamespaces namespaces
    }

    %% Links between classes
    Mutation --> Session : updateSession
    Session --> SessionError : possibleType
    Session --> SessionSuccess : possibleType

    %% Click events
    click Mutation href "#mutation"
    click Session href "#session"
    click SessionError href "#sessionerror"
    click SessionSuccess href "#sessionsuccess"

Schema description

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