Sign in

v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
Listings

Creates a commercial listing.

put/v2/listings/commercial

Request body

occupancyType'tenanted' | 'vacant'

Occupancy. Can be 'Tenanted', 'Vacant'

annualReturninteger

Integer value of percentage return on this property or business.

unitsOfferedinteger

Integer value of units offered for sale or lease

nabersnumber double

The NABERS Rating is the energy efficiency rating that the property has been measured to have. This rating is measured in increments of .5 and can range from 0 to 6. The NABERS rating is required for spaces within office buildings of 1000 square metres or more. For more information on the NABERS rating system please visit http://www.nabers.gov.au

saleTermsstring

Information relating to aspects of the sale, such as required deposit, settlement time. Up to 50 characters, optional. Ignored for lease listings

highlightsstring[]

Highlight Items

underOfferOrContractboolean

Set for Sale listings only

domainAdIdinteger

Domain Advertisement Id, not applicable for creating new ads. Mandatory when updating a listing that belongs to an agency that is in the process of being migrated between listing providers.

listingProviderstring

A string identifying the data provider

domainAgencyIDinteger required

The Domain Agency Id number

providerAdIdstring required

External Advertisement Id of up to 50 characters will be stored.<br /> This value is used to identify an Advertisement for updates and should be unique for listing provider.<br /> This value is case-insensitive (meaning AAAA will update aaaa).

featuresstring

Comma-separated list of features. 1000 characters in length. Select as appropriate or write your own. INSIDE: Air conditioning, Ensuite, Floorboards, Indoor Spa, Gym, Alarm System, Intercom, Built in wardrobes, Furnished, Internal Laundry, Pets allowed, Cable or Satellite, Gas, Broadband internet access, Bath, Fireplace(s), Separate Dining Room, Heating, Dishwasher, Study. OUTSIDE: Tennis Court, Secure Parking, Shed, Fully fenced, Balcony / Deck, Garden / Courtyard, Swimming Pool, Outdoor Spa. LOCATION: Ground floor, Water Views, North Facing, City Views. ECO FRIENDLY: Double glazed windows, Energy efficient appliances, Water efficient appliances, Wall / ceiling insulation, Rainwater storage tank, Greywater system, Water efficient fixtures, Solar hot water, Solar panels

descriptionstring

Description of the property. 6000 characters in length. The following HTML elements are permitted: <br />, <p></p>, &nbsp;. HTML must be well-formed. Carriage Returns are interpreted as line breaks. Foreign characters must be HTML encoded, e.g., façade for façade. Unicode characters which are unsupported by Latin-1 (ISO-8859-1 range from U+0080 to U+00FF), will be removed https://en.wikipedia.org/wiki/ISO/IEC_8859-1

summarystring

'Headline' Any HTML stripped out. If the Summary is less than 80 characters long then the description is concatenated to it and the total trimmed to 250 characters.

listingAction'sale' | 'rent' | 'saleAndLease' required

Sale or Rent

contactPreference'byPhone'

Indicates the listing preferred contact method. Default by both phone and email if not provided.

otherEnquiryEmailstring

Sets up to 3 additional email addresses, separated by commas, to which enquiries on the listing will be sent.

receiveEmailsToDefaultAddressboolean

Send email enquiries to the default address for this listing type

isRuralboolean

True if the property is rural

Example request

{
  "salePrice": {
    "priceUnitType": "totalAmount",
    "priceType": "gross",
    "gstOptionType": "ex",
    "priceReduction": true,
    "displayText": "Price Guide $2,200,000",
    "depositTaken": false,
    "from": 2200000,
    "to": 2200000
  },
  "leasePrice": {
    "priceUnitType": "totalAmount",
    "priceType": "gross",
    "gstOptionType": "ex",
    "priceReduction": true,
    "displayText": "Price Guide $2,200",
    "depositTaken": false,
    "from": 2200,
    "to": 2200
  },
  "lease": {
    "termOfLeaseFrom": 1,
    "termOfLeaseTo": 3,
    "leaseOutgoings": 3200
  },
  "tenant": {
    "leaseStart": "2025-05-08T21:08:47.7658790+10:00",
    "leaseEnd": "2026-05-08T21:08:47.7658790+10:00",
    "name": "John Smith",
    "rentalDetails": "Annual CPI reviews",
    "leaseOptions": "5+5 year lease which commenced May 2013",
    "tenantInfoTermOfLeaseFrom": 2,
    "tenantInfoTermOfLeaseTo": 3,
    "leaseDateVariable": false
  },
  "tender": {
    "recipientName": "Joe Russ",
    "address": "10,Pyrmont st, Pyrmont,NSW 2011",
    "endDate": "2026-04-18T21:08:47.7658790+10:00"
  },
  "occupancyType": "tenanted",
  "annualReturn": 10,
  "unitsOffered": 1,
  "nabers": 4.5,
  "saleTerms": "will be started after 3 days",
  "auction": {
    "auctionTerms": "10% deposit, balance 60 days.",
    "dateTime": "2026-04-08T21:08:47.7658790+10:00",
    "location": "On Site",
    "url": "https://ljhookermosman.agentboxcrm.com.au/www/fp-1-1P3679-1721283621.html"
  },
  "propertyDetails": {
    "propertyType": [
      "retail"
    ],
    "buildingType": "whole",
    "parking": {
      "parkingType": "noParking",
      "numberOnSite": 0
    },
    "pdfs": [],
    "images": [
      {
        "resourceType": "floorPlan",
        "url": "http://www.ljhookermosman.agentboxcrm.com.au/fp-1-1P3679-1721283621.jpg"
      },
      {
        "resourceType": "photograph",
        "url": "http://www.ljhookermosman.agentboxcrm.com.au/lt-1-1P3679-0316165440.jpg"
      },
      {
        "resourceType": "photograph",
        "url": "http://www.ljhookermosman.agentboxcrm.com.au/lt-1-1P3679-0316165441.jpg"
      }
    ],
    "address": {
      "unitNumber": "Suite 11A",
      "street": "Military Road",
      "displayOption": "fullAddress",
      "streetNumber": "287",
      "suburb": "Cremorne",
      "postcode": "2090",
      "state": "nsw"
    },
    "area": {
      "value": 174,
      "unit": "squareMetres"
    },
    "landArea": {
      "unit": "squareMetres",
      "value": 194
    }
  },
  "conjunctionAgents": [
    {
      "agencyId": 12346,
      "domainAgentId": 484442,
      "firstName": "Sam",
      "lastName": "Karri",
      "phone": "02 8356 7127",
      "fax": "23444 444 44",
      "mobile": "0411 345 877",
      "email": "a@a.com",
      "receiveEmails": true
    }
  ],
  "highlights": [
    "Hightlight 1",
    "Hightlight 2",
    "Hightlight 3"
  ],
  "underOfferOrContract": false,
  "listingProvider": "YOUR_LISTING_PROVIDER",
  "domainAgencyID": 13,
  "providerAdId": "YOUR_PROVIDER_AD_ID",
  "features": " Air conditioning, Alarm System, Intercom",
  "description": "Situated within Cremorne Town Shopping Centre, anchored by Supa IGA supermarket, this property represents a fantastic opportunity to own a tenanted strata retail shop in a successful shopping centre.",
  "summary": "Entry Level Investment Opportunity!",
  "inspectionDetails": {
    "inspections": [
      {
        "from": "2026-04-08T17:00:00.0000000+10:00",
        "to": "2026-04-08T18:00:00.0000000+10:00",
        "repeat": false
      },
      {
        "from": "2026-04-10T17:00:00.0000000+10:00",
        "to": "2026-04-10T18:00:00.0000000+10:00",
        "repeat": false
      },
      {
        "from": "2026-04-12T17:00:00.0000000+10:00",
        "to": "2026-04-12T18:00:00.0000000+10:00",
        "repeat": false
      },
      {
        "from": "2026-04-14T17:00:00.0000000+10:00",
        "to": "2026-04-14T18:00:00.0000000+10:00",
        "repeat": false
      },
      {
        "from": "2026-04-16T17:00:00.0000000+10:00",
        "to": "2026-04-16T18:00:00.0000000+10:00",
        "repeat": false
      }
    ]
  },
  "media": [
    {
      "resourceType": "video",
      "url": "http://www.ljhookermosman.agentboxcrm.com.au/fp-1-1P3679-1721283621.mp4"
    },
    {
      "resourceType": "virtualTour",
      "url": "http://www.ljhookermosman.agentboxcrm.com.au/fp-1-1P3679-1721283621.html"
    },
    {
      "resourceType": "webLink",
      "url": "http://www.ljhookermosman.agentboxcrm.com.au/fp-1-1P3679-1721283621.html"
    }
  ],
  "listingAction": "saleAndLease",
  "contacts": [
    {
      "domainAgentId": 881492,
      "firstName": "Jack",
      "lastName": "King",
      "phone": "02 8356 7127",
      "fax": "23444 444 44",
      "mobile": "0411 245 777",
      "email": "a@a.com",
      "receiveEmails": true
    }
  ],
  "otherEnquiryEmail": "b@a.com,d@c.co,f@e.io",
  "receiveEmailsToDefaultAddress": false
}

Response

Listing data hasn't been changed

idstring

The listing job Id. This job will eventually be processed.

agencyIdinteger

Agency Id from Domain.

providerIdstring

Provider Id for the agency.

providerAdIdstring

Listing identifier provided by CRM.

versionIdstring

Version Id

processStatus'queued' | 'processing' | 'processed' | 'searchable' | 'failed' | 'error'

Status of listing been processed