Create Commercial Listing

HTTP Request

POSThttps://staging.api-gw.propdata.net/listings/api/v1/commercial/

Example Response

{
"id": 0,
"site": 0,
"area": 0,
"meta": {},
"web_ref": "string",
"model": "string",
"created": "2021-03-01T14:10:08.855Z",
"modified": "2021-03-01T14:10:08.855Z",
"deleted": "2021-03-01T14:10:08.855Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"branch": -2147483648,
"agent": -2147483648,
"agent_2": -2147483648,
"agent_3": -2147483648,
"agent_4": -2147483648,
"poa": false,
"owner_viewing_arrangements": "string",
"location": -2147483648,
"is_custom_location": false,
"unit_number": "string",
"street_number": "string",
"street_name": "string",
"mapping_option": "string",
"complex_name": "string",
"publish_street_address": false,
"marketing_heading": "string",
"description": "string",
"map_image": -2147483648,
"map_x_position": "string",
"map_y_position": "string",
"team": -2147483648,
"display_on_website": false,
"feature_on_newsletter": false,
"feature_on_agent_newsletter": false,
"featured": false,
"header_images": [],
"listing_images": [],
"floor_plans": [],
"documents": [],
"private_documents": [],
"on_show": false,
"on_show_directions": "string",
"on_show_date": "string",
"on_show_every_saturday": false,
"on_show_every_sunday": false,
"on_show_start_time": "string",
"on_show_end_time": "string",
"owners": [],
"tenant": -2147483648,
"tenant_lease_ends": "string",
"tenant_notice_period": "string",
"tenant_rental": -2147483648,
"tenant_notes": "string",
"owner_notes": "string",
"deposit": -2147483648,
"lightstone_id": -2147483648,
"lightstone_data": null,
"building_name": "string",
"erf_number": "string",
"feed_to_portals": false,
"matterport_id": "string",
"video_id": "string",
"virtual_tour": "http://www.example.com",
"external_link_name": "string",
"external_link_url": "string",
"property_title": "string",
"developer": "string",
"build_year": -2147483648,
"build_completion_status": "string",
"property_permit": "string",
"status": "string",
"price": "0.00",
"price_reduced_alert": false,
"sold_status_date": "string",
"sold_price": "0.00",
"sold_agent": -2147483648,
"valuation_price": "0.00",
"viewing_contact_person": "string",
"viewing_contact_number": "string",
"viewing_notes": "string",
"extras": "string",
"disable_repayment_calulator": false,
"disable_transfer_calulator": false,
"disable_cost_calulator": false,
"mandate_commission_amount": "0.00",
"mandate_commission_split": "string",
"land_size": "0.00",
"floor_size": "0.00",
"land_size_measurement_type": "string",
"floor_size_measurement_type": "string",
"price_reduced": false,
"mandate_commission_split_notes": "string",
"lease_period": "string",
"lease_excludes": "string",
"enable_offers": false,
"offer_status": "string",
"offers_from": -2147483648,
"offers_increment": -2147483648,
"supporting_status": "string",
"bank_reposessed": false,
"distressed": false,
"public_tender": false,
"no_transfer_cost": false,
"bank_name": "string",
"quick_sell_options": "string",
"quick_sell_ref": "string",
"escalation": "string",
"annual_escalation": -2147483648,
"available_from": "string",
"occupation_date": "string",
"mandate_type": "string",
"mandate_start_date": "string",
"mandate_end_date": "string",
"mandate_reason_for_selling": "string",
"mandate_commission_percentage": "string",
"listing_type": "string",
"security": false,
"auction": false,
"auction_lots": -2147483648,
"auction_venue": "string",
"auction_lat": "string",
"auction_lng": "string",
"auction_date": "string",
"auction_start_time": "string",
"auction_end_time": "string",
"auction_notes": "string",
"monthly_rates": "0.00",
"monthly_levy": "0.00",
"sectional_title_levy": "0.00",
"special_levy": "0.00",
"num_shares": -2147483648,
"share_block_number": "string",
"sectional_scheme_name": "string",
"section_number": "string",
"section_plan_number": "string",
"per_quota": "string",
"body_corp_name": "string",
"body_corp_chairman": "string",
"body_corp_telephone_number": "string",
"supervisor_name": "string",
"supervisor_telephone_number": "string",
"managing_agent": "string",
"managing_agent_telephone_number": "string",
"floor_number": "string",
"payment_frequency": 0,
"kitchen": "0.00",
"kitchen_notes": "string",
"bathrooms": "0.00",
"bathrooms_notes": "string",
"brochures": [],
"gross_monthly_rental": "0.00",
"municipal_value": "0.00",
"zoning": "string",
"property_type": "string",
"office_space": -2147483648,
"office_space_price_per_sqm": "0.00",
"office_space_total_cost": "0.00",
"retail": -2147483648,
"retail_price_per_sqm": "0.00",
"retail_total_cost": "0.00",
"factory_warehouse": -2147483648,
"factory_warehouse_price_per_sqm": "0.00",
"factory_warehouse_total_cost": "0.00",
"yard_size": "0.00",
"yard_price_per_sqm": "0.00",
"yard_total_cost": "0.00",
"property_size_total_cost": "0.00",
"building_height": -2147483648,
"yard_access": "string",
"floor_loading_capacity": "0.00",
"power_3_phase": false,
"power_amps": -2147483648,
"power_notes": "string",
"general_property_remarks": "string",
"open_parking_bays": "0.00",
"open_parkings_cost_per_bay": "0.00",
"open_parkings_total_cost": "0.00",
"covered_parking_bays": "0.00",
"covered_parkings_cost_per_bay": "0.00",
"covered_parkings_total_cost": "0.00",
"basement_parking": "0.00",
"basement_parking_cost_per_bay": "0.00",
"basement_parking_total_cost": "0.00",
"parking_notes": "string",
"air_conditioning": false,
"lease_type": "string",
"multi_tenanted": false,
"lease_includes": "string",
"lease_notes": "string",
"purchase_levy": "0.00",
"purchase_rates": "0.00",
"estimated_monthly_income": "0.00",
"viewing_keys_available_from": "string",
"viewing_instructions": "string",
"mandate_notes": "string",
"feed_client_name": "string",
"parking_ratio_bays": "0.00",
"parking_ratio_per_meter": -2147483648,
"building_grade": "string",
"height_of_eaves": "0.00",
"truck_access": "string",
"boardrooms": "0.00",
"boardrooms_notes": "string",
"statistics": 0,
"project": 0
}

NameDescription

id

integer

ID

site

integer

Site

area

integer

Area

meta

string

Meta

web_ref

stringnon-empty

Web ref

model

stringnon-empty

Model

created

string

Created

modified

string

Modified

deleted

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

branch

required

integer

Branch - The Branch ID this listing is assigned to

agent

required

integer

Agent - The agent ID of the primary listing agent

agent_2

nullable

integer

Agent 2 - The agent ID of the second listing agent

agent_3

nullable

integer

Agent 3 - The agent ID of the third listing agent

agent_4

nullable

integer

Agent 4 - The agent ID of the fourth listing agent

poa

boolean

Poa - Whether the listing price is available on request

owner_viewing_arrangements

nullable

string

Owner viewing arrangements

location

required

integer

Location

is_custom_location

boolean

Is custom location

unit_number

nullable

string<= 10 characters

Unit number

street_number

nullable

string<= 10 characters

Street number

street_name

nullable

string<= 100 characters

Street name

mapping_option

nullable

string

Mapping option

Choices: AddressSuburb

complex_name

nullable

string<= 60 characters

Complex name

publish_street_address

boolean

Publish street address

marketing_heading

nullable

string<= 100 characters

Marketing heading

description

nullable

string

Description

map_image

nullable

integer

Map image

map_x_position

nullable

string<= 50 characters

Map x position

map_y_position

nullable

string<= 50 characters

Map y position

team

nullable

integer

Team

display_on_website

boolean

Display on website

feature_on_newsletter

boolean

Feature on newsletter

feature_on_agent_newsletter

boolean

Feature on agent newsletter

featured

boolean

Featured

header_images

nullable

array of integers

Header images

Choices: [ 1,2,3...2147483648 ]

listing_images

nullable

array of integers

Listing images

Choices: [ 1,2,3...2147483648 ]

floor_plans

nullable

array of integers

Floor plans

Choices: [ 1,2,3...2147483648 ]

documents

nullable

array of integers

Documents

Choices: [ 1,2,3...2147483648 ]

private_documents

nullable

array of integers

Private documents

Choices: [ 1,2,3...2147483648 ]

on_show

boolean

On show

on_show_directions

nullable

string

On show directions

on_show_date

nullable

string

On show date

on_show_every_saturday

boolean

On show every saturday

on_show_every_sunday

boolean

On show every sunday

on_show_start_time

nullable

string

On show start time

on_show_end_time

nullable

string

On show end time

owners

nullable

array of integers

Owners

Choices: [ 1,2,3...2147483648 ]

tenant

nullable

integer

Tenant

tenant_lease_ends

nullable

string

Tenant lease ends

tenant_notice_period

nullable

string<= 50 characters

Tenant notice period

tenant_rental

nullable

integer

Tenant rental

tenant_notes

nullable

string

Tenant notes

owner_notes

nullable

string

Owner notes

deposit

nullable

integer

Deposit

lightstone_id

nullable

integer

Lightstone id

lightstone_data

nullable

object

Lightstone data

building_name

nullable

string<= 60 characters

Building name

erf_number

nullable

string<= 40 characters

Erf number

feed_to_portals

boolean

Feed to portals

matterport_id

nullable

string<= 100 characters

Matterport id

video_id

nullable

string<= 30 characters

Video id

virtual_tour

nullable

string<= 150 characters

Virtual tour

external_link_name

nullable

string<= 20 characters

External link name

external_link_url

nullable

string<= 200 characters

External link url

property_title

nullable

string

Property title

Choices: Sectional TitleFreeholdShare BlockLeasehold

developer

nullable

string<= 50 characters

Developer

build_year

nullable

integer

Build year

build_completion_status

nullable

string

Build completion status

Choices: CompletedOff Plan

property_permit

nullable

string<= 50 characters

Property permit

status

required

string

Status

Choices: ActivePendingRentedSoldArchivedValuation

price

nullable

string

Price

price_reduced_alert

boolean

Price reduced alert

sold_status_date

nullable

string

Sold status date

sold_price

nullable

string

Sold price

sold_agent

nullable

integer

Sold agent

valuation_price

nullable

string

Valuation price

viewing_contact_person

nullable

string<= 50 characters

Viewing contact person

viewing_contact_number

nullable

string<= 50 characters

Viewing contact number

viewing_notes

nullable

string

Viewing notes

extras

nullable

string

Extras

disable_repayment_calulator

boolean

Disable repayment calulator

disable_transfer_calulator

boolean

Disable transfer calulator

disable_cost_calulator

boolean

Disable cost calulator

mandate_commission_amount

nullable

string

Mandate commission amount

mandate_commission_split

nullable

string<= 15 characters

Mandate commission split

land_size

nullable

string

Land size

floor_size

nullable

string

Floor size

land_size_measurement_type

string

Land size measurement type

Choices: Square MetresHectaresSquare FeetAcres

floor_size_measurement_type

string

Floor size measurement type

Choices: Square MetresSquare Feet

price_reduced

boolean

Price reduced

mandate_commission_split_notes

nullable

string

Mandate commission split notes

lease_period

nullable

string

Lease period

Choices: 1 month2 months3 months6 months12 months24 months36 months48 months60 months10 year plus15 year plus25 year plus35 year plusNegotiable

lease_excludes

nullable

string

Lease excludes

enable_offers

boolean

Enable offers

offer_status

nullable

string

Offer status

Choices: Accepting OffersOffer PendingOffer Accepted

offers_from

nullable

integer

Offers from

offers_increment

nullable

integer

Offers increment

supporting_status

nullable

string<= 50 characters

Supporting status

bank_reposessed

boolean

Bank reposessed

distressed

boolean

Distressed

public_tender

boolean

Tender

no_transfer_cost

boolean

No transfer cost

bank_name

nullable

string

Bank name

Choices: Absa BankNedbankStandard BankFNBSA Home Loans

quick_sell_options

nullable

string

Quick sell options

Choices: Sole MandateOpen Mandate

quick_sell_ref

nullable

string<= 30 characters

Quick sell ref

escalation

nullable

string

Escalation

Choices: NegotiableSpecify %

annual_escalation

nullable

integer

Annual escalation

available_from

nullable

string

Available from

Choices: ImmediatelyNegotiableSpecific Date

occupation_date

nullable

string

Occupation date

mandate_type

nullable

string

Mandate type

Choices: SoleOpenCompany ListingSharedExpiredMLSPLNReferral

mandate_start_date

nullable

string

Mandate start date

mandate_end_date

nullable

string

Mandate end date

mandate_reason_for_selling

nullable

string

Mandate reason for selling

mandate_commission_percentage

nullable

string<= 20 characters

Mandate commission percentage

listing_type

required

string

Listing type

Choices: For SaleTo Let

security

boolean

Security

auction

boolean

Auction

auction_lots

nullable

integer

Auction lots

auction_venue

nullable

string<= 200 characters

Auction venue

auction_lat

nullable

string<= 50 characters

Auction lat

auction_lng

nullable

string<= 50 characters

Auction lng

auction_date

nullable

string

Auction date

auction_start_time

nullable

string

Auction start time

auction_end_time

nullable

string

Auction end time

auction_notes

nullable

string

Auction notes

monthly_rates

nullable

string

Monthly rates

monthly_levy

nullable

string

Monthly levy

sectional_title_levy

nullable

string

Sectional title levy

special_levy

nullable

string

Special levy

num_shares

nullable

integer

Num shares

share_block_number

nullable

string<= 15 characters

Share block number

sectional_scheme_name

nullable

string<= 15 characters

Sectional scheme name

section_number

nullable

string<= 15 characters

Section number

section_plan_number

nullable

string<= 15 characters

Section plan number

per_quota

nullable

string<= 15 characters

Per quota

body_corp_name

nullable

string<= 50 characters

Body corp name

body_corp_chairman

nullable

string<= 50 characters

Body corp chairman

body_corp_telephone_number

nullable

string<= 30 characters

Body corp telephone number

supervisor_name

nullable

string<= 50 characters

Supervisor name

supervisor_telephone_number

nullable

string<= 30 characters

Supervisor telephone number

managing_agent

nullable

string<= 50 characters

Managing agent

managing_agent_telephone_number

nullable

string<= 30 characters

Managing agent telephone number

floor_number

nullable

string<= 20 characters

Floor number

payment_frequency

nullable

integer

Payment frequency

Choices: 123456789101112

kitchen

nullable

string

Kitchen

kitchen_notes

nullable

string

Kitchen notes

bathrooms

nullable

string

Bathrooms

bathrooms_notes

nullable

string

Bathrooms notes

brochures

nullable

array of integers

Brochures

Choices: [ 1,2,3...2147483648 ]

gross_monthly_rental

nullable

string

Gross monthly rental

municipal_value

nullable

string

Municipal value

zoning

nullable

string

Zoning

Choices: IndustrialCommercialRetailAgriculturalMixed Use

property_type

required

string

Property type

Choices: Airport HangerApartment BlockBar/PubBed & BreakfastBuildingBusiness CentreBusinessCo-working SpaceFactoryFarmFull FloorGuesthouseHalf FloorHotelIndustrial YardInvestmentMedical SuiteMini FactoryOfficePlace of WorshipRestaurantRetailService StationServiced OfficeShowroomSmall HoldingStorage UnitTraining FacilityVacant LandWarehouseWorkshop

office_space

nullable

integer

Office space

office_space_price_per_sqm

nullable

string

Office space price per sqm

office_space_total_cost

nullable

string

Office space total cost

retail

nullable

integer

Retail

retail_price_per_sqm

nullable

string

Retail price per sqm

retail_total_cost

nullable

string

Retail total cost

factory_warehouse

nullable

integer

Factory warehouse

factory_warehouse_price_per_sqm

nullable

string

Factory warehouse price per sqm

factory_warehouse_total_cost

nullable

string

Factory warehouse total cost

yard_size

nullable

string

Yard size

yard_price_per_sqm

nullable

string

Yard price per sqm

yard_total_cost

nullable

string

Yard total cost

property_size_total_cost

nullable

string

Property size total cost

building_height

nullable

integer

Building height

yard_access

nullable

string

Yard access

floor_loading_capacity

nullable

string

Floor loading capacity

power_3_phase

boolean

Power 3 phase

power_amps

nullable

integer

Power amps

power_notes

nullable

string

Notes

general_property_remarks

nullable

string

General property remarks

open_parking_bays

nullable

string

Open parking bays

open_parkings_cost_per_bay

nullable

string

Open parkings cost per bay

open_parkings_total_cost

nullable

string

Open parkings total cost

covered_parking_bays

nullable

string

Covered parking bays

covered_parkings_cost_per_bay

nullable

string

Covered parkings cost per bay

covered_parkings_total_cost

nullable

string

Covered parkings total cost

basement_parking

nullable

string

Basement parking

basement_parking_cost_per_bay

nullable

string

Basement parking cost per bay

basement_parking_total_cost

nullable

string

Basement parking total cost

parking_notes

nullable

string

Parking notes

air_conditioning

boolean

Air conditioning

lease_type

nullable

string

Lease type

Choices: PercentageNetDouble NetTriple NetFully Serviced Lease Gross

multi_tenanted

boolean

Multi tenanted

lease_includes

nullable

string

Lease includes

lease_notes

nullable

string

Lease notes

purchase_levy

nullable

string

Purchase levy

purchase_rates

nullable

string

Purchase rates

estimated_monthly_income

nullable

string

Estimated monthly income

viewing_keys_available_from

nullable

string<= 50 characters

Viewing keys available from

viewing_instructions

nullable

string

Viewing instructions

mandate_notes

nullable

string

Mandate notes

feed_client_name

nullable

string<= 30 characters

Feed client name

parking_ratio_bays

nullable

string

Parking ratio bays

parking_ratio_per_meter

nullable

integer

Parking ratio per meter

building_grade

nullable

string

Building grade

Choices: AAAABCP

height_of_eaves

nullable

string

Height of eaves

truck_access

nullable

string

Truck access

Choices: NoneSmall TrucksSingle TrailerInterlinkSuperlink

boardrooms

nullable

string

Boardrooms

boardrooms_notes

nullable

string

Boardrooms notes

statistics

nullable

integer

Statistics

project

nullable

integer

Project

Responses

201
400 Bad request body
403 You do not have permission to perform this action
500 Internal server error
503 This website is not active