POST/ondemand

OnDemand Rates

Standard API endpoint for OnDemand Rates.

POST/ondemand

Mandatory Fields

body
websiteCode
cob
lor
currency
horizon
pickupTime
dropTime

Optional Fields

shopId
markets
»pickupLocation
»dropLocation
horizonDow

Note

For any technical assistance or feature requests, please contact our API support team.

Important Notes

Always use HTTPS for API requests.
Access tokens are valid for a limited time and should be refreshed periodically.
Rate limiting applies to all endpoints to ensure system stability.

Parameter Details

Name	In	Type	Required	Description
`body`	body	`object`	Required	none
`» shopId`	body	`integer`	Optional	Unique identifier for the shop.
`» markets`	body	`[object]`	Optional	none
`»» pickupLocation`	body	`string`	Optional	Pickup location.
`»» dropLocation`	body	`string`	Optional	Drop location
`» websiteCode`	body	`[integer]`	Required	none
`» cob`	body	`string`	Required	Country of booking details.
`» lor`	body	`integer`	Required	Length of rent details.
`» currency`	body	`string`	Required	Currency code (e.g., USD, EUR).
`» horizon`	body	`string`	Required	Number of days (if not using start and end dates).
`» horizonDow`	body	`[integer]`	Optional	none
`» pickupTime`	body	`string(time)`	Required	Pickup time of the trip.
`» dropTime`	body	`string(time)`	Required	Drop time of the trip.

All parameters should be formatted according to the types specified in the table above.

Responses

Status	Meaning	Description	Schema
200	OK	Success	`Inline`
400	Bad Request	Bad Request	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden - Access denied	None
429	Too Many Requests	Too Many Requests	None
500	Internal Server Error	Internal Server Error	None

Response Notes

The response will include a status field indicating success or failure, along with the requested data or relevant error messages. Standard HTTP status codes are used to indicate the outcome of the request.

Example Request

# You can also use wget
curl -X POST /ondemand/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -d '{"shopId":0,"markets":"string","»pickupLocation":"string","»dropLocation":"string","websiteCode":"string","cob":"string","lor":0,"currency":"string","horizon":"string","horizonDow":"string","pickupTime":"string","dropTime":"string"}'

Body parameter

{
  "shopId": 25,
  "markets": [
    {
      "pickupLocation": "",
      "dropLocation": ""
    }
  ],
  "websiteCode": [],
  "cob": "",
  "lor": 0,
  "currency": "",
  "horizon": "",
  "horizonDow": [],
  "pickupTime": "",
  "dropTime": ""
}

Example responses

200 Response

{
  "message": "queue processed successfully."
}

PreviousCar Rates

NextGet Shop Status

Need Support?

Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.

Contact Support