Buyer Contact


BuyerContact represents a set of contact information.

{
  "address": {
    "address1": "156 5th Avenue",
    "address2": "string",
    "locality": "New York",
    "postalCode": "10019",
    "region": "US-NY",
    "country": "US",
    "addressType": "Firm"
  },
  "buyerID": "c3f8e97b-2d09-4cb8-a41e-c5b635b0f1e3",
  "contactType": "PRIMARY",
  "createdAt": "2020-12-31T15:10:55Z",
  "email": "[email protected]",
  "id": "f322210a-e814-4b1b-a8bf-007a3e765bb9",
  "name": {
    "givenName": "John",
    "familyName": "Doe",
    "additionalName": "string"
  },
  "phone": "+14539842345",
  "updatedAt": "2020-12-31T15:10:55Z"
}

Properties

NameTypeRequiredRestrictionsDescription
addressobjectfalsenoneRepresents a fully defined address for an entity
➥ address1stringtruenoneFirst address line
➥ address2stringfalsenoneSecond address line
➥ localitystringtruenoneThe locality (e.g. City) of the address.
➥ postalCodestringtruenoneThe administrative postal code (e.g. Zip Code)
➥ regionstringtruenoneThe region or first-level administration division (e.g. State/Province) of the address.
➥ countrystringtruenoneThe two character ISO-3166-1 country code.
➥ addressTypestringfalseread-onlyRepresents the type of address.
buyerIDstring(uuid)falseread-onlyID of the buyer associated with this contact.
contactTypestringfalsenoneOptional. Represents the type of contact.
createdAtstring(date-time)falsenoneTime this entity was created.
emailstring(email)truenoneEmail address.
idstring(uuid)falseread-onlyUnique ID associated with this contact.
nameobjecttruenoneFull name.
➥ givenNamestringtruenoneGiven name
➥ familyNamestringtruenoneFamily name
➥ additionalNamestringfalsenoneAdditional name, if any
phonestringtruenonePhone number.
updatedAtstring(date-time)falsenoneTime this entity was last updated.

Enumerated Values

Value
Firm
GeneralDelivery
HighRise
POBox
RuralRoute
Street
NoMatch
InternationalNone
InternationalAdministrativeArea
InternationalLocality
InternationalThoroughfare
InternationalPremise
InternationalDeliveryPoint
Other
PRIMARY
HOME
WORK
OTHER
BILLING
SHIPPING