Initiate the rental process
Add a new rental to block a slot on a resource. Please note that you'll need to confirm it before the timeout (15 minutes). More information is available in the rental workflow guide.
Request
POST https://api.digital-nautic.com/v3/rentals
Request body
The request body takes a complete Rental Creation Object resource, containing the following writable properties:
{
"addMandatoryOptions": "boolean",
"commissionCurrency": "string",
"commissionPrice": "number",
"contractLink": "string",
"discountPrice": "number",
"orderLink": "string",
"referenceId": "integer",
"rentalPrice": "number",
"resourceId": "string",
"slotId": "string"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| addMandatoryOptions | boolean |
If set to true, automatically adds mandatory options to the Rental |
Optional |
| commissionCurrency | string |
The currency used for the commission |
Optional |
| commissionPrice | number |
How much you've taken as a commission |
Optional |
| contractLink | string |
A link to the rental contract in your system |
|
| discountPrice | number |
The price for a discount. If not specified, will be zero |
Optional |
| orderLink | string |
A link to the Rental in your system |
|
| referenceId | integer |
A reference ID to the Rental in your system |
|
| rentalPrice | number |
The price for the rental. It does not apply to the products. If not specified, the initial price will be defined. |
Optional |
| resourceId | string |
The ID of the Resource attached to the Rental |
|
| slotId | string |
The ID of the Slot to use as a schedule base on the Rental |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK item created |
Rental |
| 400 | Bad Request invalid input, object invalid |
|
| 401 | Unauthorized authorization information is missing or invalid. |
|
| 409 | Conflict an existing item already exists |