Skip to main content

Note

The NoteType is a GraphQL object type that represents a note in the system.

type Note {
  archivedAt: ISO8601DateTime
  author: Party
  authorId: ID
  content: String!
  createdAt: ISO8601DateTime!
  deletedAt: ISO8601DateTime @deprecated
  id: ID!
  notable: Notable!
  notableId: ID!
  notableType: NotableObjectEnum!
  noteType: NoteTypeEnum
  updatedAt: ISO8601DateTime!
}

Fields​

Note.archivedAt ● ISO8601DateTime scalar common​

The date and time when the note was archived.

Note.author ● Party object common​

The party associated with the note.

Note.authorId ● ID scalar common​

The ID of the party associated with the note.

Note.content ● String! non-null scalar common​

The content of the note.

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

The date and time when the note was created.

Note.deletedAt ● ISO8601DateTime deprecated scalar common​

DEPRECATED

Use archived_at instead. This field will be removed in the future.

The date and time when the note was deleted.

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

The unique identifier of the note.

Note.notable ● Notable! non-null union common​

The object that the note is attached to.

Note.notableId ● ID! non-null scalar common​

The ID of the object that the note is attached to.

Note.notableType ● NotableObjectEnum! non-null enum common​

The type of the object that the note is attached to.

Note.noteType ● NoteTypeEnum enum common​

The type of the note.

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

The date and time when the note was last updated.

Returned By​

addNote mutation ● removeNote mutation

Member Of​

ASN object ● NoteConnection object ● NoteEdge object ● Order object ● SupplyShipment object