Skip to main content

PartnerAddress

An address of a partner.

type PartnerAddress {
  city: String!
  contactEmail: String
  contactName: String
  contactPhone: String
  country: String!
  createdAt: DateTime!
  deletedAt: DateTime
  deletedBy: String
  enteredBy: String!
  id: ID!
  instructions: String
  isActive: Boolean!
  isDefault: Boolean!
  isDualPurpose: Boolean!
  label: String
  latitude: Float
  longitude: Float
  metadata: JSON!
  organizationId: String!
  partnerId: String!
  postalCode: String!
  priority: AddressPriority!
  role: PartnerRole
  state: String!
  street1: String!
  street2: String
  type: String!
  updatedAt: DateTime!
  updatedBy: String!
}

Fields

`PartnerAddress.city` ● `String!` non-null scalar

The city.

`PartnerAddress.contactEmail` ● `String` scalar

The email address of the contact at the address.

`PartnerAddress.contactName` ● `String` scalar

The name of the contact at the address.

`PartnerAddress.contactPhone` ● `String` scalar

The phone number of the contact at the address.

`PartnerAddress.country` ● `String!` non-null scalar

The country.

`PartnerAddress.createdAt` ● `DateTime!` non-null scalar

When the record was created.

`PartnerAddress.deletedAt` ● `DateTime` scalar

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

`PartnerAddress.deletedBy` ● `String` scalar

The ID of the user who deleted the record.

`PartnerAddress.enteredBy` ● `String!` non-null scalar

The ID of the user who created the record.

`PartnerAddress.id` ● `ID!` non-null scalar

The unique ID of this record.

`PartnerAddress.instructions` ● `String` scalar

Delivery or access instructions.

`PartnerAddress.isActive` ● `Boolean!` non-null scalar

Whether the record is active.

`PartnerAddress.isDefault` ● `Boolean!` non-null scalar

Whether this is the default.

`PartnerAddress.isDualPurpose` ● `Boolean!` non-null scalar

True when the one address serves both billing and delivery.

`PartnerAddress.label` ● `String` scalar

A label for the address, such as Head office.

`PartnerAddress.latitude` ● `Float` scalar

The latitude.

`PartnerAddress.longitude` ● `Float` scalar

The longitude.

`PartnerAddress.metadata` ● `JSON!` non-null scalar

Additional data attached to the record, as JSON.

`PartnerAddress.organizationId` ● `String!` non-null scalar

The ID of the organization the record belongs to.

`PartnerAddress.partnerId` ● `String!` non-null scalar

The ID of the partner.

`PartnerAddress.postalCode` ● `String!` non-null scalar

The postal code.

`PartnerAddress.priority` ● `AddressPriority!` non-null enum

Whether the address is the primary or a secondary one.

`PartnerAddress.role` ● `PartnerRole` enum

Whether the address is for a customer or a vendor role.

`PartnerAddress.state` ● `String!` non-null scalar

The state or region.

`PartnerAddress.street1` ● `String!` non-null scalar

The first line of the street address.

`PartnerAddress.street2` ● `String` scalar

The second line of the street address.

`PartnerAddress.type` ● `String!` non-null scalar

The kind of address, for example billing or shipping.

`PartnerAddress.updatedAt` ● `DateTime!` non-null scalar

When the record was last changed.

`PartnerAddress.updatedBy` ● `String!` non-null scalar

The ID of the user who last changed the record.

Member Of

Partner object

Fields
Member Of