Types

ListingOffer

Example

{
  "type": "ListingOffer",
  "agent": {
    "type": "Contact",
    "name": "Bruce Wayne",
    "givenName": "Bruce",
    "familyName": "Wayne",
    "email": "batman@example.com",
    "telephone": "1+888-867-5309",
    "identifier": {
      "hsfconsumerid": "xxxxxxxxxxxxx"
    },
    "sameAs": {
      "amcecrmid": "1234567",
      "salesForceId": "xxxxxxxxxxxxx"
    }
  },
  "offerPrice": {
    "type": "PriceSpecification",
    "minPrice": 75000,
    "maxPrice": 100000,
    "price": 75000,
    "priceCurrency": "USD"
  },
  "propertyListing": {
    "type": "PropertyListing",
    "originatingSystemName": "GOTHAM-MLS",
    "originatingSystemKey": "12345",
    "url": "https://{company-website-url}/{path-to-listing}",
    "streetAddress": "1007 Mountain Gate Rd",
    "addressRegion": "New Jersey",
    "addressLocality": "Gotham City",
    "postalCode": "10010",
    "addressCountry": "USA",
    "listingPrice": {
      "type": "PriceSpecification",
      "price": 7500000,
      "priceCurrency": "USD"
    }
  },
  "recipient": {
    "type": "RealEstateAgent",
    "name": "Randy RealEstateAgent",
    "id": "https://{agentid}.example.com/profile/card#me"
  }
}

Schema

NameTypeDescription
(root)objectan offer is made to buy a PropertyListing
typestringconst ("ListingOffer")
agentobjecta website user/visitor
offerPriceobjectthe offer price or range
offerPrice.typestringallowed ("PriceSpecification") PriceSpecification
offerPrice.minPricenumberthe low price offered if price is a range.
offerPrice.maxPricenumberthe high price offered if price is a range.
offerPrice.pricenumberthe offer price.
offerPrice.priceCurrencystringuse ISO4217
propertyListingobjectthe listing on which the offer is made.
recipientoneOflisting agent or offer recipient
recipient.0 (oneOf item)objectA real estate agent who represents buyers and sellers
recipient.0.typestringconst ("RealEstateAgent")
recipient.0.additionalNamestringany other name(s) associated with the entity, i.e. nickname, middle name, maiden name, etc. For multiple names, use a comma without space as a separator.
recipient.0.addressobjectA physical address.
recipient.0.certificationobjectA certification issued by an organization to an individual or business.
recipient.0.certification.typestringallowed ("Certification") Certification
recipient.0.certification.namestringthe name of the Certification
recipient.0.certification.issuedByobjectthe issuing authority
recipient.0.certification.issuedBy.typestringallowed ("RealEstateOrganization") The item type (Linked-Data @type)
recipient.0.certification.issuedBy.idstringLinked-Data URI (@id) format (uri)
recipient.0.certification.issuedBy.namestringname of the issuing organization
recipient.0.certification.issuedToobjectthe subject
recipient.0.certification.issuedTo.typestringallowed ("RealEstateAgent") The item type (Linked-Data @type)
recipient.0.certification.issuedTo.idstringLinked-Data URI (@id) format (uri)
recipient.0.certification.issuedTo.namestring-
recipient.0.contactPointobjectA point of contact for the entity. By convention in the real estate domain, ContactPoints are preferred over telephone, email, and faxNumber so the ContactPoint.name property can be used to label values for example, Work Telephone, Home, as named contactPoint values. >= 3 properties
recipient.0.contactPoint.typestringconst ("ContactPoint")
recipient.0.contactPoint.namestringa label for the contactPoint, i.e. 'Work', or 'Home'
recipient.0.contactPoint.telephonestring-
recipient.0.contactPoint.faxNumberstring-
recipient.0.contactPoint.emailstringan email address for the item. format (email)
recipient.0.contactPoint.urlstringprimary URL for the item. format (uri)
recipient.0.emailstringa valid email address format (email)
recipient.0.familyNamestringLast Name of a person. Family Name <= 50 characters
recipient.0.givenNamestringFirst Name of a person
recipient.0.idstringLinked-Data URI (@id) format (uri)
recipient.0.identifierobject1 properties
recipient.0.imagetuple<object allOf, ...optional<any>>an ImageObject or URI reference to an image on the web.
recipient.0.image.0 (index)object allOf-
recipient.0.image.0.0 (allOf item)allOfan image, video or document availble for download
recipient.0.image.0.0.0 (allOf item)object-
recipient.0.image.0.0.0.typestringThe item type (Linked-Data @type) pattern (^[A-Z][a-zA-Z0-9]+$)
recipient.0.image.0.0.0.@idstringthe liked data uri for the Thing format (uri)
recipient.0.image.0.0.0 (property names)-pattern (^[a-z@$][a-zA-Z0-9-_]+$)
recipient.0.image.0.0.1 (allOf item)--
recipient.0.image.0.0.1.typestringallowed ("MediaObject", "ImageObject", "DigitalDocument")
recipient.0.image.0.0.1.idstringthe URL to access the item. format (uri)
recipient.0.image.0.0.1.namestringthe file name of the object.
recipient.0.image.0.0.1.encodingFormatstringMIME type
recipient.0.image.0.0.1.aboutstringURI to the subject of the image or logo format (uri)
recipient.0.image.0.0.1.urlstringURL of the image content format (uri)
recipient.0.image.0.1 (allOf item)--
recipient.0.image.0.1.typestringallowed ("ImageObject")
recipient.0.image.0.1.idany-
recipient.0.image.0.1.nameany-
recipient.0.image.0.1.encodingFormatany-
recipient.0.jobTitlearray<string>-
recipient.0.jobTitle (single item)stringThe job title of the person (for example, Financial Manager).
recipient.0.memberOfarray<anyOf>an Organization (or ProgramMembership) to which this Person or Organization belongs.
recipient.0.memberOf (single item)anyOf-
recipient.0.memberOf.0 (anyOf item)objectdescribes a role played by a member and a group or organization.
recipient.0.memberOf.0.typestringallowed ("OrganizationRole") a role played by the member in the memberOf group
recipient.0.memberOf.0.roleNamestringthe role name
recipient.0.memberOf.0.memberOfobjectthe org or group where the role is performed
recipient.0.memberOf.0.memberstringmember object or id format (uri)
recipient.0.memberOf.0.startDatestringdate the member began performing this role format (date-time)
recipient.0.memberOf.0.endDatestringdate the member stopped performing the role format (date-time)
recipient.0.memberOf.1 (anyOf item)stringformat (uri)
recipient.0.namestring-
recipient.0.parentOrganizationarray<string>organizations of which this org is a part.
recipient.0.parentOrganization (single item)stringformat (uri)
recipient.0.permitobjectA permit issued by an organization to an individual or business.
recipient.0.permit.typestringallowed ("Permit") Permit type.
recipient.0.permit.namestringCommon or display value of the Permit.
recipient.0.permit.issuedByobjectThe issuing authority
recipient.0.permit.issuedThroughobjectthe service through which the permit was granted
recipient.0.permit.validInobject-
recipient.0.permit.validFromstringstart date format (date-time)
recipient.0.permit.validUntilstringend date format (date-time)
recipient.0.subOrganizationarray<string>child organizations of the organization
recipient.0.subOrganization (single item)stringformat (uri)
recipient.0.urlstringURL of the item. format (uri)
recipient.1 (oneOf item)object-
recipient.1.typestring-
recipient.1.affiliationarray<string>An organization that this person is affiliated with
recipient.1.affiliation (single item)stringformat (uri)
recipient.1.addressarray<object>-
recipient.1.address.typestringconst ("PostalAddress")
recipient.1.address.streetAddressstringthe street address <= 75 characters
recipient.1.address.postOfficeBoxNumberstringThe post office box number for PO box addresses.
recipient.1.address.addressRegionstringabbreviated state or province
recipient.1.address.addressLocalitystringCity, Township. <= 50 characters
recipient.1.address.postalCodestringZip/Post Code <= 12 characters
recipient.1.address.addressCountrystringallowed ("CA", "DE", "GR", "IN", "IT", "MX", "PE", "PT", "ES", "AE", "GB", "US") two-letter ISO 3166-1 alpha-2 country code
recipient.1.address.addressCountystringCounty
recipient.1.address.addressSubdivisionstringthe subdivision or neighborhood (us real estate extension)
recipient.1.birthDatestringdate of birth. format (date)
recipient.1.contactPointarray<object>contact points for the person
recipient.1.contactPoint.typestringconst ("ContactPoint")
recipient.1.contactPoint.namestringa label for the contactPoint, i.e. 'Work', or 'Home'
recipient.1.contactPoint.telephonestring-
recipient.1.contactPoint.faxNumberstring-
recipient.1.contactPoint.emailstringan email address for the item. format (email)
recipient.1.contactPoint.urlstringprimary URL for the item. format (uri)
recipient.1.emailstringa valid email address format (email)
recipient.1.additionalNamestringany other name(s) associated with the entity, i.e. nickname, middle name, maiden name, etc. For multiple names, use a comma without space as a separator.
recipient.1.familyNamestringLast Name of a person. Family Name <= 50 characters
recipient.1.faxNumberstringDo people still use fax machines?
recipient.1.givenNamestringFirst Name of a person
recipient.1.honorificPrefixstringAn honorific prefix preceding a Person's name such as Dr/Mrs/Mr.
recipient.1.honorificSuffixstringAn honorific title following a person's name like M.D.
recipient.1.jobTitlearray<string>job tiles associated with the item
recipient.1.jobTitle (single item)string-
recipient.1.knowsLanguagearray<object>languages spoken by the person
recipient.1.knowsLanguage.typestringconst ("Language")
recipient.1.knowsLanguage.namestringthe display name of the language
recipient.1.knowsLanguage.additionalNamestringBCP 47 language code
recipient.1.namestringFull name of the person.
recipient.1.telephonestringPrimary phone number.
recipient.1.worksForstringOrganizations the person works for.
Previous
Lead
Next
ListingReport