Item Logo
Yms apiData models

Address Ext

AddressExt

Properties

Name

Type

Required

Constraints

Chinese Name

Description

id

string

false

none


Unique identifier of the address record

name

string

false

none


Address display name (site/store/consignee)

country

string

false

none


Country name or ISO code

state

string

false

none


State or province

city

string

false

none


City name

zipCode

string

false

none


Postal/ZIP code

fax

string

false

none


Fax number

address1

string

false

none


Primary street address

address2

string

false

none


Secondary street address (apt/suite/unit)

contact

string

false

none


Primary contact person name

phone

string

false

none


Primary contact phone number

extension

string

false

none


Phone extension

email

string

false

none


Contact email address

orgId

string

false

none


Organization identifier associated with this address

orgName

string

false

none


Organization name associated with this address

referenceNo

string

false

none


External reference number from CRM/WMS/ERP

batchCode

string

false

none


Batch code or routing code for delivery

storeNo

string

false

none


Store number or site code

shorthand

string

false

none


Human-friendly shorthand/alias for quick search

toHome

boolean

false

none


Whether the address is a residential (home) delivery

tags

[string]

false

none


Custom tags/labels for the address

latitude

string

false

none


Geolocation latitude in decimal degrees

longitude

string

false

none


Geolocation longitude in decimal degrees

crmAddressId

string

false

none


Identifier of the address in CRM system

On this page