Address

View normalized Markdown

Address data available to a scoped Management API integration.

graphql
type Address {
  careOf: String
  city: String
  contactId: ID
  country: String
  createdAt: DateTime!
  customerId: ID
  defaultBilling: Boolean
  defaultShipping: Boolean
  department: String
  discardedAt: DateTime
  id: ID!
  label: String
  name: String
  number: String
  postalCode: String
  recipientName: String
  region: String
  street: String
  streetAdditionalInfo: String
  tombstone: Boolean!
  updatedAt: DateTime!
}

Fields

Address.careOf · String scalar

Care of.

Address.city · String scalar

City.

Address.contactId · ID scalar

Contact id.

Address.country · String scalar

Country.

Address.createdAt · DateTime! non-null scalar

Record creation timestamp.

Address.customerId · ID scalar

Customer id.

Address.defaultBilling · Boolean scalar

Default billing.

Address.defaultShipping · Boolean scalar

Default shipping.

Address.department · String scalar

Department.

Address.discardedAt · DateTime scalar

When the record was discarded; null for an active record.

Address.id · ID! non-null scalar

Stable record identifier.

Address.label · String scalar

Label.

Address.name · String scalar

Display name when the resource provides one.

Address.number · String scalar

External-facing record number when the resource provides one.

Address.postalCode · String scalar

Postal code.

Address.recipientName · String scalar

Recipient name.

Address.region · String scalar

Region.

Address.street · String scalar

Street.

Address.streetAdditionalInfo · String scalar

Street additional info.

Address.tombstone · Boolean! non-null scalar

True when the discarded record represents a removal to propagate locally.

Address.updatedAt · DateTime! non-null scalar

Timestamp used for incremental synchronization and cursor ordering.

Returned By

address query

Member Of

AddressCollection object

Ready to Get Started?

Book a free demo or reach out — we’d love to hear from you.