Backend API: The account address model

Fields

idobjectId

Unique identifier for the address.

activeboolean

Whether the address is active on the account. Inactive accounts will not be returned in the Storefront API.

address1stringrequired

Primary street address.

address2string

Secondary street address.

citystring

City where the address is located.

countrystring

Country of the residence.

date_createddate

Date of the address creation.

date_updateddate

Date the address was updated.

fingerprintstring

A unique fingerprint hashed from specific address fields that is used to prevent duplicate entries.

first_namestring

First name listed for the address.

last_namestring

Last name listed for the address.

namestring

Combined name listed for the address.

parent_idobjectIdrequired

The corresponding account id for the address.

parentAccount

Expandable link to the customer's account.

phonestring

Phone number listed for the address.

statestring

State of the address.

tax_idstring

Tax identification number of the recipient, where required for customs or delivery.

zipstring

Postal code of the address.

The address model

{
  "parent_id": "6296b0ad8f4d1100129e16c3",
  "name": "Adoring Fan",
  "first_name": "Adoring",
  "last_name": "Fan",
  "address1": "The Arena",
  "address2": "Arena District",
  "city": "Imperial City",
  "state": "CA",
  "zip": "94104",
  "country": "US",
  "phone": null,
  "company": null,
  "fingerprint": "92f130033566d9846522759d54cbf5e5",
  "date_created": "2022-06-07T13:35:12.281Z",
  "active": true,
  "id": "62acbbe0d69a3b0012c7eae5"
}