Update rental
Update a rental details
Request
PUT https://api.digital-nautic.com/v3/rentals/{rentalId}
Path parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| rentalId | integer | Pass a rental id to update the details. For now, only the status can be updated |
Required |
Request body
The request body takes a complete Rental resource, containing the following writable properties:
{
"commissionPrice": "number",
"contractLink": "string",
"discountPrice": "number",
"orderLink": "string",
"referenceId": "string",
"rentalPrice": "number",
"status": "string"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| commissionPrice | number |
How much you've taken as a commission |
Optional |
| contractLink | string |
A link to the rental contract in your system |
Optional |
| discountPrice | number |
The price for a discount. If not specified, will be zero |
Optional |
| orderLink | string |
A link to the Rental in your system |
Optional |
| referenceId | string |
A reference ID to the Rental in your system |
Optional |
| rentalPrice | number |
The price for the rental. It does not apply to the products. If not specified, the initial price will be defined. |
Optional |
| status | string |
Rental status (accepted values as VALIDATED, CANCELED_BY_CLIENT, CANCELED_BAD_WEATHER, CANCELED_BREAKDOWN, CANCELED_PAYMENT) |
Optional |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK item updated |
Rental |
| 400 | Bad Request bad input parameter |
|
| 401 | Unauthorized authorization information is missing or invalid. |
|
| 404 | Not Found a rental with the specified ID was not found. |