Skip to content
Nexus Docs

Check rental availability + pricing for a date range

GET
/api/public/{slug}/rental-availability
curl --request GET \
  --url 'https://example.com/api/public/example/rental-availability?itemId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&startDate=example&endDate=example&quantity=1'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Query Parameters

Section titled “Query Parameters”
itemId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
startDate
required
string
/^\d{4}-\d{2}-\d{2}$/
endDate
required
string
/^\d{4}-\d{2}-\d{2}$/
quantity
integer
default: 1 > 0 <= 9007199254740991

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
data
required
object
available
required
boolean
quantityAvailable
required
integer
>= -9007199254740991 <= 9007199254740991
totalCents
required
integer
>= -9007199254740991 <= 9007199254740991
depositCents
required
integer
>= -9007199254740991 <= 9007199254740991
deliveryFeeCents
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
breakdown
required
object
periods
required
integer
>= -9007199254740991 <= 9007199254740991
ratePerPeriod
required
integer
>= -9007199254740991 <= 9007199254740991
quantity
required
integer
>= -9007199254740991 <= 9007199254740991
unit
required
string
minPeriodMet
required
boolean
maxPeriodMet
required
boolean
Examplegenerated
{
  "data": {
    "available": true,
    "quantityAvailable": 1,
    "totalCents": 1,
    "depositCents": 1,
    "deliveryFeeCents": 1,
    "breakdown": {
      "periods": 1,
      "ratePerPeriod": 1,
      "quantity": 1,
      "unit": "example"
    },
    "minPeriodMet": true,
    "maxPeriodMet": true
  }
}