This endpoint is used to update an existing Commercial Sale listing by using Listing GUID or ProviderIdentifier.

Mandatory Fields:

Parameter - id (Listing GUID or ProviderIdentifier)
Property

Location (Address of the property)
TypeCode or TypeDescription (type of the property)
PropertyName(only if brand is SIR).

Listing

Office
PrimaryMLS(only for domestic master franchises)
PrimaryAgent or Team.

ListPrice
Currency (Code or Name).

Business Rules:

All mandatory fields are mandatorily supplied while adding or updating a Listing.
The parameter, idType is mandatory.
If the idType supplied is 'id', the supplied id must have a GUID - 32 hexadecimal digits separated by hyphens (format: 00000000-0000-0000-0000-000000000000).
If a Commercial Sale Listing does not exist in our system for the Listing GUID provided, the method returns an HTTP 404 - Not Found error.
If YearRenovated is supplied, it should not have a date in the future and must not contain a date before YearBuilt.
Listing Office supplied must exist with an open or executed status.
Agent supplied for the listing must exist.
Team supplied for the listing must exist.
Listing Remarks of type - Property Description in English is mandatory.
Provide listing remarks only with 1 Language or Remark Type combination.
OpenHouse StartOn Date/Time must not contain a date/time after the EndOn Date/Time.
OpenHouse StartOn Date/Time and EndOn Date/Time is mandatory.
OpenHouse Remarks must not have multiple records for the same language.
Listing website(URL) cannot have duplicated for the same language and type.
There must not have multiple Media Captions with the same language for each media item.
Property type should not contain value as Residential.
If ExpiresOn date is supplied , value must contain a date greater than ListedDate.
If ClosedOn date is supplied, date must contain a date greater than ListedDate and must not contain a future date.
ContractOn should have greater date than ListedDate.
Listing features must not have multiple records with same feature.
LastSoldOn must not contain a date in the future.
You cannot revoke a listing if closed.
ListPriceInUSD is a read-only field and is always auto calculated based on ListPrice.
The valid Listing Statuses that are supplied:

Pre-Listing
Active
Expired
Withdrawn
Pending (only for Transaction NOT Enabled offices)
Closed (only for Transaction NOT Enabled offices).

While adding a listing, either the Status or equivalent dates or combination of Status and Dates are supplied.
If only Status is supplied, the dates are defaulted/protected (if exists in our system). Dates defaulted (defaulted to current date) for each status is:
- Pre-Listing
- Active
- Expired
- Withdrawn
- Pending
- Closed
If only dates are supplied, the status is derived based on the dates.

ListedDate

Active (If listed date is in the past)
Pre-Listing (If listed date is in the future).

ExpiresOn (along with ListedDate)

Active (If ExpiresOn is in the future)
Expired (If ExpiresOn is in the past).

WithdrawnOn (along with ListedDate)

Withdrawn.

ContractOn (along with ListedDate)

Pending.

ClosedOn (along with ListedDate, ContractOn)

Closed.

If both status and dates are supplied, the status and dates are validated as below.

Pre-Listing - Only Dates that are supplied:

ListedDate (in future).

Active - Only Dates that are supplied:

ListedDate (in Past).

Expired - Only Dates that are supplied:

ListedDate (in Past)
ExpiresOn (in Past).

Withdrawn - Only Dates that are supplied:

ListedDate (in Past)
WithdrawnOn (in Past).

Pending - Only Dates that are supplied:

ListedDate (in Past)
ContractOn.

Closed - Only Dates are supplied:

ListedDate (in Past)
ContractOn
ClosedDate.

Syndication opt-outs are processed based on below criteria:

SyndicationOptOut is an optional collection.
codevalue_Search operation should have referenced to determine the opted-in channels for the brand and submit Listing opt-outs as appropriate.
codevalue_Search should have queried with BrandCode and codeCategoryName as "SyndicationChannel."
During Listing Add and Update, if the collection is passed without channel partner details, system opts-in the channel partners applicable by brand and syndication the Listings. This applies to already opted-out channel partners.
Channel partner opt-out is determined by the ChannelpartnerCode and not by ChannelpartnerDescription. An invalid ChannelpartnerCode in the request is ignored by the system.

Listing Events are processed based on below criteria:

Listing Events is an optional collection .
Supported events are Openhouse, Virtual Openhouse and Livestream Q&A.
codevalue_Search operation should have referenced to determine the accepted Listing events for the brand.
codevalue_Search should have queried with BrandCode and codeCategoryName as "ListingOpenHouseEvents."
ListingEvent StartOn Date/Time and EndOn Date/Time is mandatory.
ListingEvent StartOn Date/Time must not contain a date later than EndOn Date/Time.
ListingEvent Remarks must not have multiple records for the same language.

System Custom Attributes are processed based on below criteria:

SystemCustomAttributes is an optional collection.
SystemCustomAttributes are pre-defined custom attributes supported in dash system.
codevalue_Search operation should have referenced to determine the allowed system custom attributes.
codevalue_Search should have queried with BrandCode and codeCategoryName as "CommercialSaleListingSystemCustomAttribute."
User-defined custom attribute passed in this collection throws a validation and vice-versa.
System custom attributes not supported for the given entity throws a validation.
The unique Number is an optional field.

The unique Number in the Custom attributes collection is an optional field.
Listing Agents are processed based on below criteria:

ListingAgents is an optional collection.
Listing Agent sequencing is available for all brands.
Listing Agent sequence numbers are required and the sequence numbers must contain unique value.
It is a single collection that includes primary agent and other agent details.
primary agent is always set to sequence number 1.
The other agents should not have sequence number as 1.

SDK

BackOffice Read-only

SDK

dash

Need assistance?