API Docs
YMS API
Data Models
Address Ext

AddressExt

{
  "id": "string",
  "name": "string",
  "country": "string",
  "state": "string",
  "city": "string",
  "zipCode": "string",
  "fax": "string",
  "address1": "string",
  "address2": "string",
  "contact": "string",
  "phone": "string",
  "extension": "string",
  "email": "string",
  "orgId": "string",
  "orgName": "string",
  "referenceNo": "string",
  "batchCode": "string",
  "storeNo": "string",
  "shorthand": "string",
  "toHome": true,
  "tags": [
    "string"
  ],
  "latitude": "string",
  "longitude": "string",
  "crmAddressId": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idstringfalsenoneUnique identifier of the address record
namestringfalsenoneAddress display name (site/store/consignee)
countrystringfalsenoneCountry name or ISO code
statestringfalsenoneState or province
citystringfalsenoneCity name
zipCodestringfalsenonePostal/ZIP code
faxstringfalsenoneFax number
address1stringfalsenonePrimary street address
address2stringfalsenoneSecondary street address (apt/suite/unit)
contactstringfalsenonePrimary contact person name
phonestringfalsenonePrimary contact phone number
extensionstringfalsenonePhone extension
emailstringfalsenoneContact email address
orgIdstringfalsenoneOrganization identifier associated with this address
orgNamestringfalsenoneOrganization name associated with this address
referenceNostringfalsenoneExternal reference number from CRM/WMS/ERP
batchCodestringfalsenoneBatch code or routing code for delivery
storeNostringfalsenoneStore number or site code
shorthandstringfalsenoneHuman-friendly shorthand/alias for quick search
toHomebooleanfalsenoneWhether the address is a residential (home) delivery
tags[string]falsenoneCustom tags/labels for the address
latitudestringfalsenoneGeolocation latitude in decimal degrees
longitudestringfalsenoneGeolocation longitude in decimal degrees
crmAddressIdstringfalsenoneIdentifier of the address in CRM system