Skip to main content

SystemLog

The SystemLogType object represents a system log entry. It includes fields for the log type (info, error, warning, success), the operation performed, the message associated with the log entry, the ID and type of the entity associated with the log entry, and timestamps for when the log entry was created and updated.

type SystemLog {
  createdAt: ISO8601DateTime!
  details: JSON
  entityId: ID!
  entityName: String
  entityType: LogEntityTypeEnum!
  errorMessage: String
  eventDetails: [[LogsEventDetails!]!] @deprecated
  id: ID!
  logType: LogTypeEnum!
  message: String!
  operation: String!
  performer: LogsPerformer
  updatedAt: ISO8601DateTime!
}

Fields​

SystemLog.createdAt ● ISO8601DateTime! non-null scalar common​

The date and time when the log entry was created.

SystemLog.details ● JSON scalar common​

Raw structured payload for the operation, returned verbatim from the underlying extra_information JSON. Replaces eventDetails and does not impose a fixed shape — consumers should switch on operation (event tag) to interpret the contents.

SystemLog.entityId ● ID! non-null scalar common​

The ID of the entity associated with the log entry.

SystemLog.entityName ● String scalar common​

How the entity associated with the log entry is identified in its own terms, such as the order number of an order or the sku of a product. Null when the entity no longer exists or its kind is not recognized.

SystemLog.entityType ● LogEntityTypeEnum! non-null enum common​

The type of the entity associated with the log entry.

SystemLog.errorMessage ● String scalar common​

Technical detail of a failure, kept separate from the human-readable message.

SystemLog.eventDetails ● [[LogsEventDetails!]!] deprecated list object common​

DEPRECATED

Use details instead. eventDetails only resolves the legacy structured shape; logs written with arbitrary JSON payloads (e.g. fulfillment timeline events) will surface as [].

Legacy structured details for the operation. Returns the structured shape only when extra_information was written as Array<Array<{key_caption, key_value, key_type}>>; returns [] for logs whose payload is in any other shape. Prefer details for new consumers.

SystemLog.id ● ID! non-null scalar common​

The unique identifier for the log entry.

SystemLog.logType ● LogTypeEnum! non-null enum common​

The type of the log entry. Can be INFO, ERROR, WARNING, or SUCCESS.

SystemLog.message ● String! non-null scalar common​

The message associated with the log entry.

SystemLog.operation ● String! non-null scalar common​

The operation that was performed when the log entry was created.

SystemLog.performer ● LogsPerformer object common​

The party that performed the operation associated with the log entry.

SystemLog.updatedAt ● ISO8601DateTime! non-null scalar common​

The date and time when the log entry was last updated.

Member Of​

SystemLogConnection object ● SystemLogEdge object