--- title: "Creates a commercial listing." method: PUT path: "/v2/listings/commercial" tags: ["Listings"] --- # Creates a commercial listing. `PUT /v2/listings/commercial` ## Request body - ListingAdminV2CommercialListingV2 — Commercial Listing V2 - `salePrice` ListingAdminV2CommercialPrice — Commercial component for price - `priceUnitType` 'totalAmount' | 'perSqm' — Price Unit type. Can have the values "TotalAmount", "PerSqm". Default = "TotalAmount" - `priceType` 'gross' | 'net' — Type can have the values "Gross", "Net". Default "Net" - `gstOptionType` 'nA' | 'inc' | 'ex' — GST Option Type. Can have the values "NA", "Inc", "Ex". Default = "NA" - `priceReduction` boolean — Indicates if this property is under price reduction - `displayText` string — When provided this will be shown instead of the price range, e.g.: "Offers over $450K considered" - `depositTaken` boolean — When provided this will be shown instead of the price range, e.g.: "Offers over $450K considered" - `from` integer, required — Lowest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as To - `to` integer, required — Highest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as From - `leasePrice` ListingAdminV2CommercialPrice — Commercial component for price - `priceUnitType` 'totalAmount' | 'perSqm' — Price Unit type. Can have the values "TotalAmount", "PerSqm". Default = "TotalAmount" - `priceType` 'gross' | 'net' — Type can have the values "Gross", "Net". Default "Net" - `gstOptionType` 'nA' | 'inc' | 'ex' — GST Option Type. Can have the values "NA", "Inc", "Ex". Default = "NA" - `priceReduction` boolean — Indicates if this property is under price reduction - `displayText` string — When provided this will be shown instead of the price range, e.g.: "Offers over $450K considered" - `depositTaken` boolean — When provided this will be shown instead of the price range, e.g.: "Offers over $450K considered" - `from` integer, required — Lowest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as To - `to` integer, required — Highest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as From - `lease` ListingAdminV2Lease — Properties for lease listings - `termOfLeaseFrom` integer — Integer value of lease term range from - `termOfLeaseTo` integer — Integer value of lease term range to - `leaseOutgoings` integer — Outgoing cost of current lease - `eoi` ListingAdminV2EOI — Express of Interest - `address` string — Street address, up to 100 characters - `endDate` string, date-time, required — End date of EOI - `recipientName` string — The recipient name of the EOI, up to 50 characters - `tenant` ListingAdminV2Tenant — Tenant Information - `leaseStart` string, date-time — The date on which the tenants lease began, or is due to begin. - `leaseEnd` string, date-time — The date on which the tenants lease is due to end - `name` string — Name of the current tenant of the property, up to 100 characters - `rentalDetails` string — Information regarding current rental, up to 100 characters - `leaseOptions` string — Leasing options available to a prospective tenant, up to 100 characters - `tenantInfoTermOfLeaseFrom` integer — The from range of the tenant's current lease - `tenantInfoTermOfLeaseTo` integer — The to range of the tenant's current lease - `leaseDateVariable` boolean — Is tenant lease date variable - `tender` ListingAdminV2Tender — Tender Information - `recipientName` string — The recipient name of the tender, up to 50 characters - `address` string — Street address, up to 100 characters. - `endDate` string, date-time — Closing Date - `occupancyType` 'tenanted' | 'vacant' — Occupancy. Can be 'Tenanted', 'Vacant' - `annualReturn` integer — Integer value of percentage return on this property or business. - `unitsOffered` integer — Integer value of units offered for sale or lease - `unitDetails` ListingAdminV2SpecificUnitDetail[] — Units details - `name` string — Unit number - `size` integer — Unit size - `price` number, double — Unit price - `notes` string — Additional notes - `isSoldOrLeased` boolean — Is it available? - `occupancy` 'tenanted' | 'vacant' — Occupancy type - `priceUnit` 'totalAmount' | 'perSqm' — Price unit type - `leasePriceForSaleorLease` number, double — Lease price for sale or lease - `nabers` number, 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 - `saleTerms` string — Information relating to aspects of the sale, such as required deposit, settlement time. Up to 50 characters, optional. Ignored for lease listings - `auction` ListingAdminV2CommercialAuction — Commercial Auction Details - `auctionTerms` string — Terms for the auctions, up to 200 characters. Example: "10% deposit, balance 60 days" - `dateTime` string, date-time, required — Date of the auction. format: yyyy-MM-ddTHH:mm:ss - `location` string — Optional. Venue for the Auction. String max 100 characters. If the Location is omitted, or included but empty, the Venue will default to "On Site". - `url` string — Optional on-line auction URL. Must be a valid URL and maximum 255 characters. If an empty string is received, the property will be re-set. - `propertyDetails` ListingAdminV2CommercialProperty, required — Commercial Property - `propertyType` string[], required — Commercial property types ['aquaculture', 'dairyFarming', 'developmentLand', 'fishingForestry', 'hotelLeisure', 'industrialWarehouse', 'irrigationServices', 'livestock', 'internationalCommercial', 'medicalConsulting', 'offices', 'parkingCarSpace', 'retail', 'ruralCommercialFarming', 'showroomsBulkyGoods', 'servicedOffices', 'other', 'cropping', 'viticulture', 'mixedFarming', 'grazing', 'horticulture', 'equine', 'farmlet', 'orchard', 'ruralLifestyle']. - `buildingType` 'whole' | 'part' | 'nA' — Building Type - `parking` ListingAdminV2Parking — Parking Details - `parkingType` 'onSite' | 'onStreet' | 'noParking' — Can have the value "OnSite", "OnStreet", "NoParking". Default "NoParking" - `numberOnSite` integer — Number On Site - `information` string — Additional information regarding the parking condition - `pdfs` ListingAdminV2PropertyPdf[] — List of PDF files related to the listing - `url` string, required — Url of the PDF - `type` 'commercialPdf' | 'newDevBrochurePdf' | 'floorplanPdf' | 'devProjectPdf' | 'devProjectMasterplanPdf' — Type of the PDF. `DevProjectPdf` PDF files are only visible, if the listing is a child listing of an active development project. - `description` string — Description of the PDF - `propertyName` string — Name of the property up to 70 characters - `location` string — Short location information up to 30 character, e.g.: Greenhills Beach - `images` ListingAdminV2PropertyMedia[] — List of image files, photos or floor plans related to the listing. Supported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP. The file size is restricted to maximum 100MB. We recommend against using transparent backgrounds. Some image formats, such as PNG, support transparency, but when images with transparent areas are resized, they may be converted to a format that doesn’t support transparency, such as JPEG. By default, transparent areas are converted to black, but the application displaying the image may convert the transparent area to the most appropriate colour for the area where the image is being placed. - `resourceType` 'photograph' | 'floorPlan' | 'video' | 'virtualTour' | 'webLink' — Type of the resource - `url` string, required — shows the place from where file can be downloaded - `address` ListingAdminV2Address, required — Address structure for property - `unitNumber` string — Unit number for apartments, maximum 30 characters - `street` string, required — Street name, maximum 100 characters - `displayOption` 'unspecified' | 'fullAddress' | 'streetAndSuburb' | 'suburbOnly' | 'regionOnly' | 'areaOnly' | 'stateOnly' — What granularity to display the properties location at. For residential listings, the accepted displayOption values are "FullAddress", "StreetAndSuburb" or "SuburbOnly". - `suggestedGeoLocation` ListingAdminV2GeoLocation — Contains geocoding of an address - `latitude` number, double — Latitude - `longitude` number, double — Longitude - `streetNumber` string — Street number, maximum 20 characters - `suburb` string, required — Suburb name , maximum 50 characters - `postcode` string, required — Postcode - `state` 'nsw' | 'vic' | 'act' | 'sa' | 'wa' | 'tas' | 'qld' | 'nt', required — State - `area` ListingAdminV2Area — Area information, Either single value or from and To must be provided - `value` number, double — Area. Will be rounded to 2 decimals. - `from` number, double — Minimum area - `to` number, double — Maximum area - `unit` 'squareMetres' | 'acres' | 'hectares' | 'squareFeet' | 'squareYards' | 'squares' — Unit of measure, defaults to SquareMetres if not provided. - `landArea` ListingAdminV2LandArea — Area information, Either single value or from and To must be provided - `unit` 'squareMetres' | 'acres' | 'hectares' | 'squareFeet' | 'squareYards' | 'squares', required — Unit of measure - `value` number, double — Area. Will be rounded to 2 decimals. - `from` number, double — Minimum area - `to` number, double — Maximum area - `conjunctionAgents` ListingAdminV2AgentContact[] — List of conjunction agents - `agencyId` integer, required — Conjunction agent's agency - `domainAgentId` integer — Domain ID of the contact person at the agency - `firstName` string — First name. Maximum 50 characters. - `lastName` string — Last name. Maximum 50 characters. - `phone` string — Phone. Maximum 20 characters. - `fax` string — Fax. Maximum 20 characters. - `mobile` string — Mobile. Maximum 20 characters. - `email` string — Email. Maximum 100 characters. - `receiveEmails` boolean — Indicates whether the contact person should receive emails for the listing - `highlights` string[] — Highlight Items - `underOfferOrContract` boolean — Set for Sale listings only - `domainAdId` integer — 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. - `listingProvider` string — A string identifying the data provider - `domainAgencyID` integer, required — The Domain Agency Id number - `providerAdId` string, required — External Advertisement Id of up to 50 characters will be stored.
This value is used to identify an Advertisement for updates and should be unique for listing provider.
This value is case-insensitive (meaning AAAA will update aaaa). - `features` string — 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 - `description` string — 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 - `summary` string — '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. - `inspectionDetails` ListingAdminV2InspectionDetails — Inspection details - `inspectionDescription` string — Free text field for inspections - `inspections` ListingAdminV2Inspection[] — Inspection times of the listing - `from` string, date-time, required — Format: yyyy-mm-dd HH:mm:ss eg: 2015-10-20 13:30:00 - `to` string, date-time, required — Format: yyyy-mm-dd HH:mm:ss, eg: 2015-10-20 14:30:00 - `repeat` boolean — Specifies if the inspection is recurring weekly - `media` ListingAdminV2PropertyMedia[] — Links to VideoURL, virtual tour or weblink. Maximum length of media URLs is 255 characters. - `resourceType` 'photograph' | 'floorPlan' | 'video' | 'virtualTour' | 'webLink' — Type of the resource - `url` string, required — shows the place from where file can be downloaded - `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. - `contacts` ListingAdminV2Contact[] — Minimum required attributes: First name, last name and E-mail. If the DomainAgentId is provided, contact information will be based on the existing agent found for that id. Otherwise first name, last name and email will be used to find the matching contact. A new contact will be created if no contact can be found. - `domainAgentId` integer — Domain ID of the contact person at the agency - `firstName` string — First name. Maximum 50 characters. - `lastName` string — Last name. Maximum 50 characters. - `phone` string — Phone. Maximum 20 characters. - `fax` string — Fax. Maximum 20 characters. - `mobile` string — Mobile. Maximum 20 characters. - `email` string — Email. Maximum 100 characters. - `receiveEmails` boolean — Indicates whether the contact person should receive emails for the listing - `otherEnquiryEmail` string — Sets up to 3 additional email addresses, separated by commas, to which enquiries on the listing will be sent. - `receiveEmailsToDefaultAddress` boolean — Send email enquiries to the default address for this listing type - `isRural` boolean — True if the property is rural - `supplementary` ListingAdminV2ListingSupplementary[] — Rural attributes *Improvements* (optional) Available `types` (fixed list, optional): * Machinery Shed * Shearing Shed * Workshop * Shearers Quarters * Silos * Other Housing * Managers Accommodation *Fencing* (optional) `description` (string, optional): free text fencing description, maximum 250 characters. *Yards* (optional) Available `types` (fixed list, optional): * Sheep * Cattle *Homestead* (optional) `description` (string, optional): description of the homestead and construction, maximum 250 characters. `metadata` (optional) * `area` (decimal, optional): homestead area in square metres. Available `types` (fixed list, optional): * Office * Ensuite * Tennis Court * Mains Gas * Floorboards * Internal Laundry *Water* (optional) `description` (string, optional): water comments, maximum 250 characters. Available `types` (fixed list, optional): * Tank * Well * Reticulated * Bores * Springs * Creeks * Dams * River *Crops* (optional) `description` (string, optional): description of the crops, maximum 250 characters. `metadata` (optional) * `croppedAnnually` (decimal, optional): average annual area cropped in hectares. * `fallowAnnually` (decimal, optional): average annual fallow area in hectares. * `pastures` (string, optional): description of pastures available, maximum 250 characters. *Livestock* (optional) `description` (string, optional): additional comments, maximum 250 characters. `metadata` (optional) * `capacity` (decimal, optional): property carrying capacity in DSE (unit of carry capacity). Available `types` (fixed list, optional): * Sheep * Pigs * Cattle * Poultry * Horses * Exotic * Goats * Stud *Inclusions* (optional) `description` (string, optional): description of plant and machinery included in sale, maximum 250 characters. `metadata` (optional) * `livestock` (string, optional): description of livestock included in sale, maximum 250 characters. * `crop` (string, optional): description of crops included in sale, maximum 250 characters. *Irrigation* (optional) `description` (string, optional): irrigation comments, maximum 250 characters `metadata` (optional) * `rainfall` (decimal, optional): annual rainfall in millimetres. - `name` string, required — Name - `description` string — Description - `types` string[] — Types - `metadata` ListingAdminV2SupplementaryMetadata[] — Metadata - `name` string, required — Name - `description` string — Description - `measurement` number, double — Measurement - `measurementUnit` 'squareMetres' | 'hectares' | 'millimetres' | 'dse' — Measurement unit ## Response `200` Listing data hasn't been changed - ListingAdminV2ListingResponse — Represent the listing job. - `id` string — The listing job Id. This job will eventually be processed. - `agencyId` integer — Agency Id from Domain. - `providerId` string — Provider Id for the agency. - `providerAdId` string — Listing identifier provided by CRM. - `versionId` string — Version Id - `processStatus` 'queued' | 'processing' | 'processed' | 'searchable' | 'failed' | 'error' — Status of listing been processed ## Other responses - `202` — Listing data has been accepted - `400` — Listing data is not valid --- [API](https://skmtc.net/domain/apis/domain-public-api.md) · [All operations](https://skmtc.net/domain/apis/domain-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/domain/domain-public-api/revisions/24ab78aba827/schema)