Region

A region such as a country, state or city.

type Region {
  cityName: String
  code: String!
  countryCode: String
  createdAt: DateTime!
  deletedAt: DateTime
  deletedBy: String
  enteredBy: String!
  id: ID!
  isActive: Boolean!
  name: String!
  parentRegionId: String
  postalCodePattern: String
  stateCode: String
  timezone: String
  type: RegionType!
  updatedAt: DateTime!
  updatedBy: String!
}

Fields

Region.cityName ● String scalar

The name of the city.

Region.code ● String! non-null scalar

The region code.

Region.countryCode ● String scalar

The country code.

Region.createdAt ● DateTime! non-null scalar

When the record was created.

Region.deletedAt ● DateTime scalar

When the record was deleted. Empty while the record is live.

Region.deletedBy ● String scalar

The ID of the user who deleted the record.

Region.enteredBy ● String! non-null scalar

The ID of the user who created the record.

Region.id ● ID! non-null scalar

The unique ID of this record.

Region.isActive ● Boolean! non-null scalar

Whether the record is active.

Region.name ● String! non-null scalar

The name of the region.

Region.parentRegionId ● String scalar

The ID of the region this one is inside.

Region.postalCodePattern ● String scalar

The pattern postal codes follow.

Region.stateCode ● String scalar

The state code.

Region.timezone ● String scalar

The time zone of the region.

Region.type ● RegionType! non-null enum

The kind of region.

Region.updatedAt ● DateTime! non-null scalar

When the record was last changed.

Region.updatedBy ● String! non-null scalar

The ID of the user who last changed the record.

Returned By

createRegion mutation ● deleteRegion mutation ● region query ● regions query ● updateRegion mutation