Products

Get updated pricing information for a hypothetical listing

post/v1/products/ratefornewsocialboost

Request

Base URL
https://api.domain.com.au
Auth
- API key in header x-api-key
- or OAuth 2
  Authorization codehttps://auth.domain.com.au/v1/connect/authorize
  Client credentials
  Token URLhttps://auth.domain.com.au/v1/connect/token
  Scopesapi_agencies_read
TypeScript
https://skmtc.dev/domain/apis/domain-public-api/docs/v1/products/ratefornewsocialboost/post.ts
A function with typed inputs. Its response is checked against the schema.

agencyIdinteger required

Id of the agency for whom rates are to be calculated.

agentFirstNamestring required

The first name of the primary agent associated with the listing.

agentLastNamestring required

The last name of the primary agent associated with the listing

agentEmailstring required

The email of the primary agent associated with the listing.

suburbstring required

Suburb for which rates are to be calculated.

postcodestring required

Postcode for which rates are to be calculated.

statestring required

State for which rates are to be calculated

The property type of the listing e.g. House

isRuralboolean required

Whether to return the normal or rural rates

listingType'Sale' | 'Rent' | 'None' required

Type of the listing whether sale or rent

pricenumber double required

The value of the listing

channel'Residential' | 'Commercial' | 'Business' required

The intended channel of the listing.

bookingStartDatestring date-time nullable

Date at which the booking will start. Defaults to today. Allows for returning future contracts/price changes.

Pricing information for the given listing details

reason'BasedOnContract' | 'NoContractFound' | 'NoRateFound' | 'PropertyTypeExcluded' nullable

Gets or Sets Reason

No recorded changes to this operation across all 18 revisions of this API.