commerciallisting#update--sale

Message

sale listing schema

Payload Example(s) (generated)

{
  "topic": "realestate/commerciallisting#update",
  "data": {
    "type": "UpdateAction",
    "object": {
      "type": "SaleListing",
      "addressCountry": "United States",
      "addressLocality": "Cleveland",
      "addressRegion": "OH",
      "description": "Ever dreamed of owning your own business? Opportunity awaits in this combination live and workplace in the Heart of\r\nCleveland's Brooklyn Centre neighborhood! ",
      "hasElevators": "",
      "image": [
        {
          "type": "Property Photo",
          "encodingFormat": "Image/jpg",
          "id": "https://s3.amazonaws.com/buildout-production/datas/32077476/5c019225803b6cbc2e23abffdd35979b6eb15fa0/full.jpg?1742312266"
        }
      ],
      "latitude": 41.4514253,
      "listingAgent": {
        "type": "RealEstateAgent",
        "name": "David",
        "email": "david@gmail.com",
        "telephone": "5543534400",
        "identifier": {},
        "additionalProperty": { "agentId": "369824" }
      },
      "coListingAgent": [
                {
                    "type": "RealEstateAgent",
                    "name": "Joanne VanStry",
                    "email": "joanne.vanstry@verani.com",
                    "identifier": {},
                    "additionalProperty": {
                        "agentId": "1060172"
                    }
                }
       ],
      "listingContractDate": "2025-03-18T10:28:57.000-05:00",
      "listingId": "bo-1499456",
      "listingOffice": {
        "type": "RealEstateCompany",
        "name": "Professional Realty",
        "email": "kow@bhhspro.com",
        "identifier": {},
        "additionalProperty": { "officeId": "OH301-333" }
      },
      "listingOriginatingSystem": {
        "type": "MultipleListingService",
        "name": "Buildout-BHHS",
        "identifier": { "orgId": "bo-bhhs" }
      },
      "listingPrice": {
        "type": "PriceSpecification",
        "priceCurrency": "USD",
        "price": 2000
      },
      "listingStatus": "Active",
      "livingArea": {
        "type": "QuantitativeValue",
        "value": 26,
        "unitCode": "FTK",
        "unitText": "SquareFeet"
      },
      "longitude": -81.71131439999999,
      "lotSize": {
        "type": "QuantitativeValue",
        "value": 0.14,
        "unitCode": "ACR",
        "unitText": "Acre"
      },
      "modificationTimestamp": "2025-04-17T20:45:07.000-05:00",
      "name": "The Ugly Broad Tavern",
      "numberOfBathrooms": "2.0",
      "originatingSystemKey": "bo-1488456",
      "originatingSystemName": "buildout",
      "postalCode": "9109",
      "propertySubType": ["Free Standing Building"],
      "propertyType": "Retail",
      "stories": 2,
      "streetAddress": "3902 Denison Ave",
      "url": "https://www.bhhs.com/professional-realty-oh301/commercial/commercial-search?propertyId=3902-denison-ave-cleveland-sale",
      "yearBuilt": 2163,
      "class": "",
      "highlights": [],
      "documents": [
        {
          "id": 3665667,
          "url": "https://buildout.com/docs/documents/3665667?mtime=1742324354&token=d3b4f49cdeba5e086c843e6de9912e06d54afc3d",
          "name": "Brochure (P)",
          "original_file_name": ""
        }
      ]
    }
  },
  "@id": "https://crexi.bhhs.hsfaffiliates.com/inbox/8a3997be306a4b3c843gf35g5q5b",
  "id": "https://crexi.bhhs.hsfaffiliates.com/inbox/8a3997be306a4b3c843gf35g5q5b",
  "agent": "https://agent.bhhs.hsfaffiliates.com/profile/card#me"
}

Payload

NameTypeDescription
topicstringconst ("realestate/commerciallisting#update")
dataobject-
data.typestringconst ("UpdateAction")
data.objectobjecta real estate property listed for sale
data.object.typestringallowed ("SaleListing")
data.object.addressCountrystringallowed ("Other" , "United States" , "Bahamas", "Canada" , "Mexico" , "Turkey" , "Australia" , "Switzerland" , "France","Monaco" , "Spain" , "Germany" , "Italy", "UnitedKingdom", "Poland" , "Romania" , "Netherlands" , "Hungary")
data.object.addressLocalitystringCity, Township.
data.object.addressRegionstringabbreviated state or province
data.object.hasElevatorsstring-
data.object.buyerAgentobjectthe buyer's RealEstateAgent
data.object.buyerOfficeobjectthe buyer's RealEstateOffice
data.object.closeDatestringlisting close date format (date-time)
data.object.imageobjan ImageObject or URI reference to an image on the web.
data.object.image[0].typestringconst ("Property Photo")
data.object.image[0].encodingFormatstringimage type ("Image/jpg")
data.object.image[0]..idformat (uri)image url
data.object.internetAddressDisplayYNstringallowed ("Y", "N")
data.object.latitudenumberThe latitude of a location.
data.object.longitudenumberThe longitude of a location.
data.object.listingAgent.typestringconst ("RealEstateAgent")
data.object.listingAgent.namestringlistings agent name
data.object.listingAgent.emailstringlistings agent email
data.object.listingAgent.telephonestringlistings agent telephone
data.object.listingAgent.identifierobjlistings agent identifier
data.object.listingAgent.additionalProperty.agentIdstringlistings agentid
data.object.colistingAgentarraylist of coListing Agents
data.object.listingContractDatestringThe effective date of the agreement between the seller and the seller's broker. format (date-time)
data.object.listingIdstringthe local identifier for the listing
data.object.listingOffice.typestringconst ("RealEstateAgent")
data.object.listingOffice.namestringlistings office name
data.object.listingOffice.emailstringlistings office email
data.object.listingOffice.telephonestringlistings office telephone
data.object.listingOffice.identifierobjlistings office identifier
data.object.listingOffice.additionalProperty.officeIdstringlistings office Id
data.object.listingOriginatingSystem.typestringOriginatingSystem type
data.object.listingOriginatingSystem.namestringOriginatingSystem name
data.object.listingOriginatingSystem.identifier.orgIdstringOriginatingSystem identifier orgId
data.object.listingPrice.typestringconst ("PriceSpecification")
data.object.listingPrice.priceCurrencystringconst ("USD")
data.object.listingPrice.valuenumberlisting pricevalue
data.object.soldPrice.typestringconst ("PriceSpecification")
data.object.soldPrice.priceCurrencystringconst ("USD")
data.object.soldPrice.valuenumbersold pricevalue
data.object.listingStatusstringallowed ("Active", "Closed")
data.object.livingArea.typestringconst (""QuantitativeValue"")
data.object.livingArea.valuenumberlivingAreavalue
data.object.livingArea.unitCodestringconst("FTK")
data.object.livingArea.unitTextstringconst("SquareFeet")
data.object.lotSize.typestringconst ("QuantitativeValue")
data.object.lotSize.valuenumberlostSize value
data.object.lotSize.unitCodestringconst("ACR")
data.object.lotSize.unitTextstringconst("Acre")
data.object.modificationTimestampstringlast modified date of listing format(date-time)
data.object.namestringname
data.object.numberOfBathroomsstringtotal number of bathrooms
data.object.originatingSystemKeystringthe listing identifier fro
data.object.originatingSystemNamestringconst ("buildout")
data.object.postalCodestringZip/Post Code <= 12 characters
data.object.propertyTypestringallowed ( "Office", "Retail","Industrial","Land","Multifamily","Special Purpose","Hospitality")
data.object.propertySubTypestringallowed ( "Office Building" , "Creative/Loft" , "Executive Suites" , "Medical" , "Institutional/Governmental" , "Office Warehouse" ,"Office Condo" , "Coworking" , "Lab" , "Street Retail" , "Strip Center" , "Free Standing Building" , "Regional Mall" , "Retail Pad" , "Vehicle Related" , "Outlet Center" , "Power Center" , "Neighborhood Center" , "Community Center" , "Specialty Center" , "Theme/Festival Center" , "Restaurant" , "Post Office" , "Retail Condo" , "Lifestyle Center" , "Manufacturing" , "Warehouse" , "Distribution" , "Flex Space" , "Research & Development" , "Refrigerated/Cold Storage" , "Office Showroom" , "Truck Terminal/Hub/Transit" , "Self Storage" , "Industrial Condo" , "Data Center" , "Office" , "Retail" , "Retail-Pad" , "Industrial" , "Residential" , "Multifamily" , "Other" , "High-Rise" , "Mid-Rise" , "Low-Rise/Garden" , "Government Subsidized" , "Mobile Home Park" , "Senior Living" , "Skilled Nursing" , "Single Family Rental Portfolio" , "School" , "Marina" , "Other" , "Golf Course" , "Church" , "Full Service" , "Limited Service" , "Select Service" , "Resort" , "Economy" , "Extended Stay" , "Casino")
data.object.storiesnumberthe number of floors in the property
data.object.streetAddressstringthe street address
data.object.urlstringURL of the item. format (uri)
data.object.yearBuiltnumberthe year the structure was
data.object.classstringproperty class
data.object.highlightsarrayhighlights
data.object.documents[0].idnumberdocument id
data.object.documents[0].urlstringdocument url format(uri)
data.object.documents[0].namestringdocument name
data.object.documents[0].original_file_namestringdocument file name
idformat (uri)the Event ID (aka "Publish ID") is the immutable canonical identifier for the event. it is a URI that is unique to the event and will not change. all subscribers will receive the same id for the same event. format (uri)
@idformat (uri)format(uri)
agentstringif you are a multi-tenant app, then the agent is the user associated with the event data. any future events related to this message will be sent to the same agent/recipient format (uri)

Headers

NameTypeDescription
(root)object-
timestringdate & time the event was produced format (date-time)
agentstringif you are a multi-tenant app, then the agent is the user associated with the event data. any future events related to this message will be sent to the same agent/recipient format (uri)
instrumentstringthe app or service that produced the event on behalf of the agent/user format (uri)
sourcestringa copy of the event was sent to the source(s). format (uri)
originalRecipientstringthe originalRecipient helps you determine the subscription that delivered the event to you. if the originalRecipient is the same as the agent, then the you are subscribed to the agent. if the originalRecipient is different from the agent, then you are subscribed to the event source format (uri)
idstringthe Event ID (aka "Publish ID") is the immutable canonical identifier for the event. it is a URI that is unique to the event and will not change. all subscribers will receive the same id for the same event. format (uri)
@idstringformat (uri)

Tools

Next
Getting started