Skip to content
Nexus Docs

Create a rental reservation (pending)

POST
/api/public/{slug}/rental-reservations
curl --request POST \
  --url https://example.com/api/public/example/rental-reservations \
  --header 'Content-Type: application/json' \
  --data '{ "itemId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "startDate": "example", "endDate": "example", "quantity": 1, "customerName": "example", "customerEmail": "hello@example.com", "customerPhone": "example", "deliveryRequested": true, "deliveryAddress": "example", "notes": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
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
customerName
required
string
>= 1 characters <= 255 characters
customerEmail
required
string format: email
/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
customerPhone
string
<= 50 characters
deliveryRequested
boolean
deliveryAddress
string
notes
string

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
data
required
object
reservationId
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)$/
totalCents
required
integer
>= -9007199254740991 <= 9007199254740991
depositCents
required
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "data": {
    "reservationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "totalCents": 1,
    "depositCents": 1
  }
}