Help

Address Book

Available from SS24

The Address Book is part of Checkout to allow users to add and manage their saved addresses. This is a SwiftUI feature.

overview 

# Address Book
addressbook
addressbook?is_modal=true


# Address
address/{id}

Set Up

The Address Book requires no code, only for the developer to link the PoqCheckout framework. You can skip this if using Native Checkout.

Forms per Country

The Address screen allows you to set custom form styles per country. Countries without a specific style fallback to a generic form.

Out of the box we support UK and US forms with specific validation, field names, and other changes tailored to those countries.

address per country

United States

Our US form has a State picker which instead binds to the stateCode property. All other forms bind to the state property and are free text.

Modes

The Address Book screen supports an alternate selection allowing it to return a contact via a delegate action. You can pass a contact to the Address Book to attempt to preselect if it matches any existing contact.

The Address screen supports an alternate delegation mode that bypasses the Address Book API. In this mode you can directly create or edit a contact, allowing it to return the contact via a delegate action.

History

  • SS25: Changed input validation modes to align with Android.
  • AW24: Added selection modes for address selection.
  • SS24: Initial release.