RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Admin / POS

address

A shipping or billing address.

Attached to a customer and/or as order shipping/billing address.

Exposure

Used in Admin, POS, or Storefront. Not exposed on Merchant API v1 routes yet.

What

The address object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

13 fields on address. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Address id.

Type
id: string

type

AddressType

Address role.

Type
type: SHIPPING | BILLING

firstName

string

Recipient first name.

Type
firstName: string

lastName

string

Recipient last name.

Type
lastName: string

company

string | null

Company name.

Type
company: string | null

address1

string

Street line 1.

Type
address1: string

address2

string | null

Street line 2.

Type
address2: string | null

city

string

City.

Type
city: string

state

string

State / region.

Type
state: string

country

string

Country.

Type
country: string

zipCode

string

Postal / ZIP code.

Type
zipCode: string

phone

string | null

Contact phone.

Type
phone: string | null

isDefault

boolean

Default address for the customer when true.

Type
isDefault: boolean

Related