Address

public protocol Address

Address protocol.

  • Unique identifier for the address.

    Declaration

    Swift

    var resourceId: String

  • First name on the address.

    Declaration

    Swift

    var firstName: String

  • Last name on the address.

    Declaration

    Swift

    var lastName: String

  • First street address field.

    Declaration

    Swift

    var address1: String

  • Second street address field.

    Declaration

    Swift

    var address2: String?

  • City on address.

    Declaration

    Swift

    var city: String

  • State (or region/province) on address. The recommendation for this value is for it to be a standard state/region/province abbreviation so that it can be used with the ‘countries’ endpoint, but implementations may vary depending on requirements.

    Declaration

    Swift

    var state: String?

  • Country on address. The recommendation for this value is for it to be a standard country abbreviation so that it can be used with the ‘countries’ endpoint, but implementations may vary depending on requirements.

    Declaration

    Swift

    var country: String
  • zip

    Postal code on address.

    Declaration

    Swift

    var zip: String

  • Phone number associated with address.

    Declaration

    Swift

    var phone: String?

  • Used by some endpoints to store the address as a resource that can be used later.

    Declaration

    Swift

    var save: Bool

  • Indicates whether or not the address is the default address.

    Declaration

    Swift

    var isPrimary: Bool