The WP Rentals API makes it simple for developers to access and manage property listings from the WP Rentals WordPress theme. Built by wprentals.org, this API helps you fetch property data, handle bookings, and update content on WP Rentals websites.
The API lets you request exactly the property information you need - from basic details like prices and titles to complete property data including features, photos, and booking availability. It works smoothly with WP Rentals (https://wprentals.org), a WordPress theme built specifically for vacation rentals and property booking websites.
Developers can use this API to:
Get property details and availability
Manage bookings and reservations
Update property information
Handle payments and invoices
Access property photos and media
Control user access and permissions
If you're building a rental website with WordPress, WP Rentals provides both a full-featured theme and the tools to customize it through this straightforward API. The clear documentation and standard REST format make it quick to start using in your projects.
Visit wprentals.org to learn more about using WP Rentals for your vacation rental or property booking website.
DESCRIPTION:
Authenticates a user and returns a JWT token for API access.
INPUT PARAMETERS:
\nusername
\nType: string
\nRequired
\nWordPress username or email
\npassword
\nType: string
\nRequired
\nUser's password
\nEXAMPLE REQUEST:
{
\"username\": \"user@example.com\",
\"password\": \"user_password\"
}
This endpoint is publicly accessible
No authentication is required
Anyone can make requests to this endpoint
No JWT token is needed in the request header
INPUT PARAMETERS:
\npage
\nType: integer
\nOptional, defaults to 1
\nControls pagination of results
\nposts_per_page
\nType: integer
\nOptional, defaults to 10
\nMaximum value: 100
\nControls number of results per page
\norder
\nType: integer
\nOptional, defaults to 0
\nControls sorting order of results
\nresponse_type
\nType: string
\nOptional, defaults to 'basic'
\nAccepts: 'basic' or 'full'
\nControls detail level of response
\nuserID
\nType: integer
\nOptional
\nFilters properties by owner ID
\ntaxonomies
\nType: object
\nOptional
\nFilters properties by taxonomy terms
\nEach taxonomy can contain multiple terms (OR relationship)
\nAvailable taxonomies:
\nproperty_category
\nproperty_action_category
\nproperty_city
\nproperty_area
\nproperty_features
\n\"property_category\": [\"apartment\", \"house\"],
\n\"property_city\": [\"new-york\"]
\n}
}
meta
\nType: object
\nOptional
\nFilters properties by meta fields
\nEach meta query requires value, compare, and type
\nCompare operators:
\n=, !=
\n\n\n, >=, <, <=
\n
- LIKE, NOT LIKE\n- IN, NOT IN\n- BETWEEN, NOT BETWEEN\n- EXISTS, NOT EXISTS\n\nAvailable types:
\nNUMERIC
\nBINARY
\nCHAR
\nDATE
\nDATETIME
\nDECIMAL
\nSIGNED
\nTIME
\nUNSIGNED
Example:
{
\"meta\": {
\"property_price\": {\n \"value\": \"100000\",\n \"compare\": \"<=\",\n \"type\": \"NUMERIC\"\n }\n\n }
}
fields
\nType: string
\nOptional
\nComma-separated list of fields to include in response
\nSupports dot notation for nested fields
Example: \"id,title,meta.property_price,taxonomies.property_category\"
COMPLETE REQUEST EXAMPLE:
{
\"page\": 1,
\"posts_per_page\": 10,
\"response_type\": \"full\",
\"taxonomies\": {
\"property_category\": [\"apartment\"],
\"property_city\": [\"new-york\"]
},
\"meta\": {
\"property_price\": {
\"value\": [\"50000\", \"200000\"],
\"compare\": \"BETWEEN\",
\"type\": \"NUMERIC\"
}
},
\"fields\": \"id,title,price,location\"
}
POST {{base_url}}/wp-json/wprentals/v1/properties
\nRESPONSE STRUCTURE:
\nstatus
\nType: string
\nValues: \"success\" or \"error\"
\nIndicates if request was successful
\nquery_args
\nType: object
\nContains all parameters used in the query
\nUseful for debugging and query verification
\ndata
\nType: array
\nArray of property objects
\nContent varies based on response_type:
\nBASIC RESPONSE FIELDS (response_type = 'basic'):
\nid: integer (Property ID)
\ntitle: string (Property title)
\nprice: string (Property price)
\nlocation: string (Property address)
\nFULL RESPONSE FIELDS (response_type = 'full'):\n- id: integer (Property ID)\n- title: string (Property title)\n- content: string (Full property description)\n- status: string (Post status)\n- type: string (Post type)\n- author: { \n id: integer (Author ID) \n name: string (Author name) \n email: string (Author email) \n }\n- date: string (Creation date)\n- modified: string (Last modification date)\n- meta: { \n property_price: string \n property_price_per_week: string \n property_price_per_month: string \n property_size: string \n property_rooms: string \n property_bedrooms: string \n property_bathrooms: string \n property_address: string \n property_city: string \n property_area: string \n property_zip: string \n property_country: string \n property_status: string \n property_features: array \n property_label: string \n property_label_before: string \n local_booking_type: string \n ... (additional meta fields) \n }\n- taxonomies: { \n property_category: array \n property_action_category: array \n property_city: array \n property_area: array \n property_features: array \n property_status: array \n }\n- images: array of { \n id: integer (Image ID) \n url: string (Image URL) \n title: string (Image title) \n alt: string (Image alt text) \n }\n\ntotal
\nType: integer
\nTotal number of properties matching the query
\npages
\nType: integer
\nTotal number of pages available
\nEXAMPLE RESPONSE:
{
\"status\": \"success\",
\"query_args\": {
\"page\": 1,
\"posts_per_page\": 10,
\"post_type\": \"estate_property\"
},
\"data\": [
{
\"id\": 123,
\"title\": \"Luxury Apartment\",
\"price\": \"100000\",
\"location\": \"123 Main St, New York\",
\"meta\": {
\"property_price\": \"100000\",
\"property_size\": \"150\",
\"property_bedrooms\": \"2\"
},
\"taxonomies\": {
\"property_category\": [\"apartment\"],
\"property_city\": [\"new-york\"]
}
}
// ... additional properties
],
\"total\": 150,
\"pages\": 15
}
ERROR RESPONSE:
{
\"status\": \"error\",
\"message\": \"Error description\",
\"code\": \"error_code\"
}
Authorization:
\nNo special authorization required
\nURL Parameters:
\nid (required) - The ID of the property to retrieve
\nQuery Parameters:
\nfields (optional) - Comma-separated list of fields to return. Supports dot notation for nested fields
\nExamples:
\nBasic fields: ID, title, content\nMeta fields: meta.property_price, meta.property_size\nTaxonomy terms: terms.property_features, terms.property_category\nMedia: media
\nresponse_type (optional)
\nValues: basic or full (default: full)\nbasic returns only essential property data\nfull returns complete property data
\n","urlObject":{"path":["wp-json","wprentals","v1","property","36604"],"host":["{{base_url}}"],"query":[{"key":"fields","value":"ID,title,meta.property_price,terms.property_features,media"}],"variable":[]}},"response":[{"id":"b7e25802-0c7e-4140-afbf-b87b6b98ffe8","name":"Get a property with hand picked details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/wp-json/wprentals/v1/property/36604?fields=ID,title,meta.property_price,terms.property_features,media","host":["{{base_url}}"],"path":["wp-json","wprentals","v1","property","36604"],"query":[{"key":"fields","value":"ID,title,meta.property_price,terms.property_features,media"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.1","enabled":true},{"key":"Date","value":"Mon, 27 Jan 2025 07:18:04 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Powered-By","value":"PHP/8.2.23","enabled":true},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT","enabled":true},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"X-Robots-Tag","value":"noindex","enabled":true},{"key":"Link","value":"ACCESS RESTRICTIONS:
\nINPUT PARAMETERS:
\nURL Parameters:\nid
\nQuery Parameters:\nresponse_type
\nfields
\nRESPONSE STRUCTURE:
\nBASIC RESPONSE (response_type = 'basic'):\n{\n \"id\": integer,\n \"title\": string,\n \"price\": string,\n \"location\": string\n}
\nFULL RESPONSE (response_type = 'full'):\n{\n \"id\": integer,\n \"title\": string,\n \"content\": string,\n \"status\": string,\n \"type\": string,\n \"author\": {\n \"id\": integer,\n \"name\": string,\n \"email\": string\n },\n \"date\": string,\n \"modified\": string,\n \"meta\": {\n \"property_price\": string,\n \"property_size\": string,\n \"property_rooms\": string,\n \"property_bedrooms\": string,\n \"property_bathrooms\": string,\n \"property_address\": string,\n \"property_city\": string,\n \"property_area\": string,\n \"property_zip\": string,\n \"property_country\": string,\n \"property_status\": string,\n \"property_price_per_week\": string,\n \"property_price_per_month\": string,\n \"property_label\": string,\n \"property_label_before\": string,\n \"local_booking_type\": string\n },\n \"taxonomies\": {\n \"property_category\": array,\n \"property_action_category\": array,\n \"property_city\": array,\n \"property_area\": array,\n \"property_features\": array\n },\n \"images\": [\n {\n \"id\": integer,\n \"url\": string,\n \"title\": string,\n \"alt\": string\n }\n ]\n}
\n","urlObject":{"path":["wp-json","wprentals","v1","property","36604"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f0cc6be5-7c96-4832-a0c5-099e406514e1","name":"Get Property details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/wp-json/wprentals/v1/property/36604"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.1","enabled":true},{"key":"Date","value":"Fri, 24 Jan 2025 14:20:59 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-Powered-By","value":"PHP/8.2.23","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"X-Robots-Tag","value":"noindex","enabled":true},{"key":"Link","value":"ACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must be logged in
\nUser must have 'publish_estate_property' capability
\nUser must be administrator or owner role
\nUser must have available listings in their membership package
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nINPUT PARAMETERS:
\nRequired Fields:
title
Type: string
\nProperty title/name
\nAdditional Fields:
meta_fields (optional):
property_description:string
\nproperty_price: string (Property price)
\nproperty_size: string (Property size)
\nproperty_rooms: string (Number of rooms)
\nproperty_bedrooms: string (Number of bedrooms)
\nproperty_bathrooms: string (Number of bathrooms)
\nproperty_address: string (Property address)
\nproperty_zip: string (ZIP code)
\nproperty_country: string (Country)
\nproperty_price_per_week: string (Weekly price)
\nproperty_price_per_month: string (Monthly price)
\nproperty_label: string (Property label)
\nproperty_label_before: string (Property label before)
\nlocal_booking_type: string (Booking type)
\ntaxonomies (optional):
\nproperty_category: array (Property categories)
\nproperty_action_category: array (Action categories)
\nproperty_city: array (Cities)
\nproperty_area: array (Areas)
\nproperty_features: array (Features/amenities)
\nimages (optional):
\nType: array
\nContains objects with:
\nid: integer (Image ID)
\nurl: string (Image URL)
\nextra_pay_options (optional):
\nType: array
\nFormat: [\"option1|price1\", \"option2|price2\"]
\nbeds_options (optional):
\nType: array
\nContains bed counts for different bed types
\ncustom_fields (optional):
\nType: array
\nContains objects with:
\nslug: string (Field identifier)
\nvalue: string (Field value)
\nical_feeds (optional):
\nType: array
\nContains objects with:
\nfeed: string (iCal URL)
\nname: string (Feed name)
\ncustom_price (optional):
\nType: array
\nContains objects with:
\ndate_range: {
from: string (Start date),
to: string (End date)
}
price: string (Price for period)
\ndetails: object (Additional pricing details)
\nACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must be the property owner OR an administrator
\nProperty must exist in the database
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nINPUT PARAMETERS:
\nAll fields are optional - only provide fields that need to be updated
\ntitle
\nType: string
\nProperty title/name
\nmeta_fields:
\nproperty_description:string
\nproperty_price: string
\nproperty_size: string
\nproperty_rooms: string
\nproperty_bedrooms: string
\nproperty_bathrooms: string
\nproperty_address: string
\nproperty_zip: string
\nproperty_country: string
\nproperty_price_per_week: string
\nproperty_price_per_month: string
\nproperty_label: string
\nproperty_label_before: string
\nlocal_booking_type: string
\ntaxonomies:
\nproperty_category: array
\nproperty_action_category: array
\nproperty_city: array
\nproperty_area: array
\nproperty_features: array
\nimages:
\nType: array
\nFormat: [
{
\"id\": integer (Image ID),\n \"url\": string (Image URL)\n\n }
]
extra_pay_options:
\nType: array
\nFormat: [\"option1|price1\", \"option2|price2\"]
\nbeds_options:
\nType: array
\nContains bed counts for different bed types
\ncustom_fields:
\nType: array
\nFormat: [
{
\"slug\": string,\n \"value\": string\n\n }
]
ical_feeds:
\nType: array
\nFormat: [
{
\"feed\": string (iCal URL),\n \"name\": string (Feed name)\n\n }
]
custom_price:
\nType: array
\n\"date_range\": { \"from\": string (Start date), \"to\": string (End date) }, \"price\": string, \"details\": object }
]
ACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must be the property owner OR an administrator
\nProperty must exist in the database
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nINPUT PARAMETERS:
\nNo body parameters required
\nProperty ID is specified in URL path
\nACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must be logged in
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nREQUIRED INPUT PARAMETERS:
\nproperty_id
\nType: integer
\nID of the property to book
\nMust be a valid estate_property post type
\nfrom_date
\nType: string
\nStart date of booking
\nFormat: WordPress date format (e.g., \"2025-01-24\")
\nto_date
\nType: string
\nEnd date of booking
\nFormat: WordPress date format (e.g., \"2025-01-26\")
\nguests
\nType: integer
\nNumber of guests for booking
\nOPTIONAL INPUT PARAMETERS:
\nadults
\nType: integer
\nNumber of adult guests
\nDefault: 0
\nchilds
\nType: integer
\nNumber of child guests
\nDefault: 0
\ninfants
\nType: integer
\nNumber of infant guests
\nDefault: 0
\nextra_options
\nType: string
\nComma-separated list of selected extra options
\nDefault: empty string
\ncomment
\nType: string
\nBooking comment or special requests
\nDefault: empty string
\ninternal
\nType: integer
\nWhether this is an internal booking
\nValues: 0 or 1
\nDefault: 0
\nVALIDATION CHECKS:
\nProperty must exist and be of type 'estate_property'
\nDates must be in correct format
\nEnd date must be after start date
\nDates cannot be in the past
\nProperty must be available for selected dates
\nGuest numbers must be valid
\nMinimum stay requirements must be met
\nCheck-in/out day restrictions must be followed
\nBOOKING PROCESS:
\nValidates all input parameters
\nChecks property availability
\nCreates booking entry
\nUpdates property's booking dates
\nCreates initial invoice if required
\nSends notifications to property owner and guest
\nUpdates internal booking counters and statistics
\nACCESS RESTRICTIONS:
\nNo authentication required
\nPublicly accessible endpoint
\nREQUIRED INPUT PARAMETERS:
\nlisting_id (property_id)
\nType: integer
\nID of the property to check
\nMust be a valid estate_property post type
\nbook_from
\nType: string
\nStart date to check
\nFormat: WordPress date format (e.g., \"2025-01-24\")
\nbook_to
\nType: string
\nEnd date to check
\nFormat: WordPress date format (e.g., \"2025-01-26\")
\nOPTIONAL INPUT PARAMETERS:
\ninternal
\nType: integer
\nWhether this is an internal availability check
\nValues: 0 or 1
\nDefault: 0
\nWhen set to 1, bypasses some validation rules
\nVALIDATION CHECKS:
\nAll required parameters present
\nProperty exists and is valid
\nDates are in correct format
\nDates are not in the past
\nEnd date is after start date
\nMeets minimum stay requirements
\nComplies with check-in/out day restrictions
\nNo overlap with existing bookings
\nRespects custom period rules
\nProperty is available for booking
\nADDITIONAL NOTES:
\nChecks both regular calendar and custom period restrictions
\nHandles both nightly and hourly bookings
\nConsiders property-specific booking rules
\nValidates against existing reservations
\nChecks seasonal restrictions if applicable
\nACCESS RESTRICTIONS:
\nNo authentication required
\nPublicly accessible endpoint
\nREQUIRED INPUT PARAMETERS:
\nproperty_id
\nType: integer
\nID of the property to estimate
\nMust be a valid estate_property post type
\nguest_no
\nType: integer
\nNumber of guests for booking
\nfromdate
\nType: string
\nStart date for booking
\nFormat: WordPress date format (e.g., \"2025-01-24\")
\ntodate
\nType: string
\nEnd date for booking
\nFormat: WordPress date format (e.g., \"2025-01-26\")
\nOPTIONAL INPUT PARAMETERS:
\nguest_fromone
\nType: integer
\nWhether to count guests from one
\nValues: 0 or 1
\nDefault: 0
\nextra_options
\nType: string
\nComma-separated list of selected extra options
\nDefault: empty string
\nmanual_expenses
\nType: array
\nAdditional manual expenses to include in calculation
\nFormat: [
{
\"name\": string,\n \"value\": number\n\n }
]
CALCULATIONS INCLUDE:
\nBase Price:
\nDaily/weekly/monthly rates
\nCustom period prices if applicable
\nExtra guest fees
\nAdditional Fees:
\nCity fee
\nCleaning fee
\nSecurity deposit
\nService fee
\nExtra options selected
\nManual expenses
\nDiscounts:
\nEarly bird discounts
\nCustom period discounts
\nSpecial offer discounts if applicable
\nTaxes:
\nProperty taxes
\nLocal taxes
\nVAT if applicable
\nPayment Structure:
\nRequired deposit
\nSecurity deposit
\nBalance payment
\nTotal cost
\nNOTES:
\nPrices are calculated based on property settings
\nConsiders seasonal and custom period pricing
\nIncludes all applicable fees and taxes
\nShows both guest payment and host earnings
\nProvides detailed breakdown of all costs
\nHandles different currency formats
\nSupports both nightly and hourly rentals
\nPOST {{base_url}}/wp-json/wprentals/v1/bookings
\nACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must have administrator role
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nOPTIONAL INPUT PARAMETERS:
\npage
\nType: integer
\nPage number for pagination
\nDefault: 1
\nMin: 1
\nposts_per_page
\nType: integer
\nNumber of bookings per page
\nDefault: 30
\nMin: 1
\nMax: 100
\nBOOKING STATUS VALUES:
\npending
\nconfirmed
\ncanceled
\nNOTES:
\nReturns all bookings in system
\nSorted by date in descending order
\nIncludes both active and historical bookings
\nFull booking details for each entry
\nPaginated response for performance
\nIncludes user and property details
\nShows invoice associations
\nIncludes booking timestamps
\nACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must be either:
\nThe booking owner (who made the booking)
\nThe property owner
\nAn administrator
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nINPUT PARAMETERS:
\nNo body parameters
\nBooking ID is specified in URL path
\nBOOKING STATUS VALUES:
\npending
\nconfirmed
\ncanceled
\nNOTES:
\nReturns complete booking details
\nIncludes related property information
\nShows payment and invoice details
\nContains guest information
\nIncludes booking timestamps
\nShows extra options and special requests
\nIncludes security deposit information
\nShows both formatted dates and unix timestamps
\nACCESS RESTRICTIONS:
Authentication required (JWT token)
User must be either:
The owner whose bookings are being requested
An administrator
Valid JWT token required in Authorization header: \"Bearer {token}\"
\nURL PARAMETERS:
user_id
Required
Type: integer
Owner's user ID in the URL path
OPTIONAL QUERY PARAMETERS:
page
Type: integer
Page number for pagination
Default: 1
Min: 1
posts_per_page
Type: integer
Number of bookings per page
Default: 30
Min: 1
Max: 100
NOTES:
Returns all bookings for properties owned by the specified user
Sorted by date in descending order
Only returns bookings for properties where user_id matches the property owner
Includes full booking details for each entry
Paginated response for performance
Includes guest information
Shows related invoice numbers
Includes booking timestamps
Covers all booking statuses (pending, confirmed, canceled)
ACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must be either:
\nThe booking owner (who made the booking)
\nThe property owner
\nAn administrator
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nINPUT PARAMETERS:
\nbooking_status
\nType: string
\nOptional
\nValues: \"request\", \"waiting\", \"pending\", \"confirmed\"
\nNote: Only administrators can set status to \"confirmed\"
\nbooking_status_full
\nType: string
\nOptional
\nValues: \"waiting\", \"confirmed\"
\nNote: Only administrators can set status to \"confirmed\"
\nNOTES:
\nOnly updates booking status fields
\nRecords all changes made
\nReturns both old and new values
\nOnly allows specific status transitions
\nMaintains change history
\nAdmin-only status changes are validated
\nBoth status fields can be updated independently
\nReturns current status even if no changes made
\nACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must have administrator role
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nOPTIONAL INPUT PARAMETERS:
\npage
\nType: integer
\nPage number for pagination
\nDefault: 1
\nMin: 1
\nposts_per_page
\nType: integer
\nNumber of invoices per page
\nDefault: 10
\nMin: 1
\nMax: 100
\ntype
\nType: string
\nFilter by invoice type
\nValues:
\n\"Listing\"
\n\"Upgrade to Featured\"
\n\"Publish Listing with Featured\"
\n\"Package\"
\n\"Reservation fee\"
\nstatus
\nType: string
\nFilter by invoice status
\nValues:
\n\"issued\"
\n\"confirmed\"
\n\"booking canceled by user\"
\nstart_date
\nType: string
\nFilter invoices from this date
\nFormat: YYYY-MM-DD
\nend_date
\nType: string
\nFilter invoices until this date
\nFormat: YYYY-MM-DD
\nNOTES:
\nReturns all invoices in system with filtering options
\nSorted by date in descending order
\nIncludes summary totals for confirmed and issued invoices
\nSupports date range filtering
\nCan filter by type and status
\nPaginated response for performance
\nIncludes related booking and property IDs when applicable
\nShows purchase dates and periods
\nCalculates total amounts for financial overview
\nACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must be either:
\nThe owner whose invoices are being requested
\nAn administrator
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nURL PARAMETERS:
user_id
Required
\nType: integer
\nOwner's user ID in the URL path
\nOPTIONAL QUERY PARAMETERS:
\npage
\nType: integer
\nPage number for pagination
\nDefault: 1
\nMin: 1
\nposts_per_page
\nType: integer
\nNumber of invoices per page
\nDefault: 30
\nMin: 1
\nMax: 100
\ntype
\nType: string
\nFilter by invoice type
\nValues:
\n\"Listing\"
\n\"Upgrade to Featured\"
\n\"Publish Listing with Featured\"
\n\"Package\"
\n\"Reservation fee\"
\nstatus
\nType: string
\nFilter by invoice status
\nValues:
\n\"issued\"
\n\"confirmed\"
\n\"booking canceled by user\"
\nstart_date
\nType: string
\nFilter invoices from this date
\nFormat: YYYY-MM-DD
\nend_date
\nType: string
\nFilter invoices until this date
\nFormat: YYYY-MM-DD
\nNOTES:
\nReturns all invoices where the specified user is the owner of the related property
\nSupports filtering by type, status, and date range
\nIncludes financial summaries (totals)
\nShows both issued and confirmed amounts
\nIncludes related booking and property information
\nSorted by date in descending order
\nPaginated response for performance
\nReturns applied filters in response
\nCalculates totals for confirmed and issued invoices separately
\nACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must be administrator
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nINPUT PARAMETERS:
\ninvoice_status
\nType: string
\nOptional
\nValues: \"issued\", \"confirmed\", \"canceled\"
\nNote: Only administrators can update invoice status
\ninvoice_status_full
\nType: string
\nOptional
\nValues: \"confirmed\", \"pending\", \"canceled\"
\nNote: Only administrators can update full status
\ndepozit_paid
\nType: number
\nOptional
\nMust be non-negative
\nAmount of deposit paid
\nNOTES:
\nOnly updates specified fields
\nRecords all changes made
\nReturns both old and new values
\nValidates status transitions
\nMaintains change history
\nIncludes full invoice details in response
\nReturns current values even if no changes made
\nDeposit amount must be non-negative
\nAll status changes are admin-only
\nACCESS RESTRICTIONS:
\nAuthentication required (JWT token)
\nUser must be either:
\nThe owner of the invoice
\nAn administrator
\nValid JWT token required in Authorization header: \"Bearer {token}\"
\nINPUT PARAMETERS:
\nNo body parameters required
\nInvoice ID is specified in URL path
\nNOTES:
\nPermanently deletes the invoice
\nIf invoice is for a booking, updates the booking's invoice reference to 0
\nReturns deleted invoice details in response
\nValidates invoice exists before deletion
\nChecks post type is correct (wpestate_invoice)
\nIncludes permission validation
\nReturns full details of deleted invoice for reference
\nAuthorization:\nRequires JWT token authentication\nUser must be either:
\nThe customer themselves (user_id matches authenticated user)\nAn administrator
\nURL Parameters:\nuser_id (required) - The ID of the customer whose invoices to retrieve
\nQuery Parameters:\npage (optional) - Page number (default: 1)\nposts_per_page (optional) - Number of invoices per page (default: 10, max: 100)\ntype (optional) - Filter by invoice type:
\n\"Upgrade to Featured\"\n\"Publish Listing with Featured\"\n\"Package\"\n\"Listing\"\n\"Reservation fee\"
\nstatus (optional) - Filter by invoice status:
\n\"issued\"\n\"confirmed\"\n\"booking canceled by user\"
\nstart_date (optional) - Filter invoices from this date\nend_date (optional) - Filter invoices until this date
\n","urlObject":{"path":["wp-json","wprentals","v1","customer","10","invoices"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"37bbc9ae-2b25-4db4-9dbe-29563929b1e2","name":"List customer invoices","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"{{base_url}}/wp-json/wprentals/v1/customer/10/invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.26.1","enabled":true},{"key":"Date","value":"Fri, 24 Jan 2025 14:46:47 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-Powered-By","value":"PHP/8.2.23","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"X-Robots-Tag","value":"noindex","enabled":true},{"key":"Link","value":"StartFragment
\npage (integer, default: 1)
\nThe current results page (1-based index). Used for pagination.
\nposts_per_page (integer, default: 10)
\nNumber of reviews to return per page.
\nproperty_id (integer, optional)
\n Filters reviews by the ID of the property they are attached to (meta_key: attached_to).
min_stars (integer, optional)
\n Filters reviews with a star rating greater than or equal to this value. Uses meta_key: review_stars.
max_stars (integer, optional)
\n If you want to support it, you’d need to add an additional meta_query condition, similar to min_stars, but with compare: '<='. Right now, sending it has no effect.
user_id (integer, optional)
\n Filters reviews by the author (WordPress user ID) via meta_key: review_author.
EndFragment
\n","urlObject":{"path":["wp-json","wprentals","v1","reviews"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"79da0d15-17be-4a1b-92a6-e9553128dacc"},{"name":"Get Review","id":"af79c95e-48a9-4b1a-8407-3ad595e4a935","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}//wp-json/wprentals/v1/review/37135","description":"Retrieves the details of a specific review by its ID.
\n{review_id} (integer | required)
\n The ID of the review to fetch. Example: 37135.
Request Body Parameters
\nproperty_id (string | required)
ID of the property being reviewed. Must reference an existing property.
user_id (string | required)
ID of the user submitting the review. Must reference a valid WordPress user.
ratings (object | required)
A set of rating values for the property. Each key represents a category.
accuracy (float, required) – Rating for listing accuracy (e.g., 1–5).
\ncommunication (float, required) – Rating for host/agent communication.
\ncleanliness (float, required) – Rating for cleanliness.
\nlocation (float, required) – Rating for property location.
\ncheck_in (float, required) – Rating for the check-in process.
\nvalue (float, required) – Rating for overall value.
\ntitle (string | optional)
Short title for the review.
content (string | optional)
Full text content of the review. Supports plain text.
StartFragment
\nEdits an existing review by its ID.
\n{review_id} (integer | required)
\n The ID of the review to update. Example: 37136.
ratings (object | optional)
\nUpdated rating values. Each key represents a category.
\naccuracy (float, optional) – Rating for listing accuracy (e.g., 1–5).
\ncommunication (float, optional) – Rating for host/agent communication.
\ncleanliness (float, optional) – Rating for cleanliness.
\nlocation (float, optional) – Rating for property location.
\ncheck_in (float, optional) – Rating for the check-in process.
\nvalue (float, optional) – Rating for overall value.
\ntitle (string | optional)
\nNew title for the review.
\ncontent (string | optional)
\nUpdated full text content of the review.
\nEndFragment
\n","urlObject":{"path":["wp-json","wprentals","v1","review","edit","37136"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"93301f76-3d88-482e-8d14-393314854caf"},{"name":"delete review","id":"6e62af96-1c40-4889-82c6-fe58a11b7c9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"{{base_url}}/wp-json/wprentals/v1/review/delete/37136","description":"Deletes an existing review by its ID.
\n{review_id} (integer | required)
\n The ID of the review to delete. Example: 37136.