Przejdź do głównej zawartości

MailingAddress

A mailing address — shipping or billing — used on a cart, on the resulting order, or saved in a customer address book. Carries optional B2B fields (taxId, vatNumber, regon) and an optional pickupPoint for parcel locker / collection-point delivery.

type MailingAddress implements Node {
  buildingNumber: String
  city: String
  company: String
  country: String
  countryCode: CountryCode
  firstName: String
  flatNumber: String
  formatted: [String!]!
  formattedArea: String
  id: ID!
  isDefault: Boolean!
  lastName: String
  name: String
  phone: String
  pickupPoint: PickupPoint
  postalCode: String
  regon: String
  state: String
  stateCode: String
  streetLine1: String
  streetLine2: String
  taxId: String
  vatNumber: String
}

Fields​

MailingAddress.buildingNumber ● String scalar​

Building / house number as a discrete field, overlaid on streetLine1. Populated for structured addresses (required for PL delivery / billing without a pickup point); null when only the free-form streetLine1 was provided.

MailingAddress.city ● String scalar​

City / town.

MailingAddress.company ● String scalar​

Company name (relevant for B2B addresses).

MailingAddress.country ● String scalar​

Country as stored on the address — normally the ISO 3166-1 alpha-2 code; addresses imported from another platform may hold a country name. For logic use countryCode.

MailingAddress.countryCode ● CountryCode enum​

ISO 3166-1 alpha-2 country code (e.g. PL, DE, US). ZZ when the stored country is not a recognised code; null when the address has no country.

MailingAddress.firstName ● String scalar​

Buyer first name.

MailingAddress.flatNumber ● String scalar​

Flat / apartment number as a discrete field — optional companion to buildingNumber.

MailingAddress.formatted ● [String!]! non-null scalar​

Country-aware ordered address lines, ready to render line by line in UI without manual formatting. The exact line layout depends on country (e.g. PL puts postal code before city, US after state).

MailingAddress.formattedArea ● String scalar​

Single-line summary of the area, e.g. "Warszawa, MZ, Poland". Useful for compact display in lists.

MailingAddress.id ● ID! non-null scalar​

Stable identifier of the address.

MailingAddress.isDefault ● Boolean! non-null scalar​

True when this is the default address for the owning customer.

MailingAddress.lastName ● String scalar​

Buyer last name.

MailingAddress.name ● String scalar​

Convenience full name (firstName + " " + lastName).

MailingAddress.phone ● String scalar​

Phone number associated with the address (free-form).

MailingAddress.pickupPoint ● PickupPoint object​

Selected pickup point when the shipping method delivers to a parcel locker / collection point instead of the street address. Null for home delivery.

MailingAddress.postalCode ● String scalar​

Postal / ZIP code.

MailingAddress.regon ● String scalar​

Buyer business registry number (Polish REGON) carried on a cart address for B2B invoicing. Populated on cart shipping/billing addresses; null on customer address-book entries (REGON is customer-level).

MailingAddress.state ● String scalar​

State / province / region name.

MailingAddress.stateCode ● String scalar​

State / province code (ISO 3166-2 subdivision, e.g. PL-MZ).

MailingAddress.streetLine1 ● String scalar​

First line of the street address (street and house / building number).

MailingAddress.streetLine2 ● String scalar​

Second line of the street address (apartment, suite, floor — optional).

MailingAddress.taxId ● String scalar​

Per-address buyer tax ID for B2B invoicing — Polish NIP, 10 digits with checksum. Lets B2B buyers invoice different addresses to different legal entities. Independent of Customer.taxId (which is the customer-wide default).

MailingAddress.vatNumber ● String scalar​

Per-address EU VAT number (e.g. PL1234567890) for cross-border B2B. Independent of Customer.vatNumber (which is the customer-wide default).

Interfaces​

Node interface​

GraphQL Node interface — universal ID-based lookup

Member Of​

Cart object ● Customer object ● CustomerAddAddressPayload object ● CustomerUpdateAddressPayload object ● MailingAddressConnection object ● MailingAddressEdge object ● Order object ● Shipment object