CreateAddressInput

An address of a partner.

input CreateAddressInput {
  city: String!
  contactEmail: String
  contactName: String
  contactPhone: String
  country: String!
  id: ID
  instructions: String
  isActive: Boolean!
  isDefault: Boolean!
  isDualPurpose: Boolean
  label: String
  latitude: Float
  longitude: Float
  postalCode: String!
  priority: AddressPriority!
  role: PartnerRole
  state: String!
  street1: String!
  street2: String
  type: AddressType!
}

Fields

CreateAddressInput.city ● String! non-null scalar

The city.

CreateAddressInput.contactEmail ● String scalar

The email address of the contact at the address.

CreateAddressInput.contactName ● String scalar

The name of the contact at the address.

CreateAddressInput.contactPhone ● String scalar

The phone number of the contact at the address.

CreateAddressInput.country ● String! non-null scalar

The country.

CreateAddressInput.id ● ID scalar

The ID of an existing address to update in place, so its ID is kept. Leave out for a new address.

CreateAddressInput.instructions ● String scalar

Delivery or access instructions.

CreateAddressInput.isActive ● Boolean! non-null scalar

Whether the record is active.

CreateAddressInput.isDefault ● Boolean! non-null scalar

Whether this is the default.

CreateAddressInput.isDualPurpose ● Boolean scalar

True when the one address serves both billing and delivery.

CreateAddressInput.label ● String scalar

A label for the address, such as Head office.

CreateAddressInput.latitude ● Float scalar

The latitude.

CreateAddressInput.longitude ● Float scalar

The longitude.

CreateAddressInput.postalCode ● String! non-null scalar

The postal code.

CreateAddressInput.priority ● AddressPriority! non-null enum

Whether the address is the primary or a secondary one.

CreateAddressInput.role ● PartnerRole enum

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

CreateAddressInput.state ● String! non-null scalar

The state or region.

CreateAddressInput.street1 ● String! non-null scalar

The first line of the street address.

CreateAddressInput.street2 ● String scalar

The second line of the street address.

CreateAddressInput.type ● AddressType! non-null enum

The kind of address, for example billing or shipping.

Member Of

CreatePartnerInput input ● UpdatePartnerInput input