Create a new rate templates

POST 
/v1/rates/templates

Add a new rate templates to the system

Request

application/json

Body

required

name stringrequired

The name of the rate template

corporateId string

The corporate ID

vehicleTypeRates object[]
The vehicle type rates
Array [
vehicleType string
The vehicle type name
vehicleTypeId string
The vehicle type ID
rates object[]
The rates for the vehicle type
Array [
rateId stringrequired
The rate ID
zoneId string
The operation zone ID
rateType stringrequired
Possible values: [Hourly, Regular, Flat, Sharing, Intercity]
The type of rate
rateActive boolean
Default value: true
Whether the rate is active for the vehicle type
]
]
isCorpCustomPricing boolean

Whether the rate template is corporate custom pricing

Responses

201

Rate templates created successfully

application/json

Schema

Schema

_id stringrequired

The ID of the rate template

name stringrequired

The name of the rate template

corporateId stringrequired

The corporate ID

isDefault booleanrequired

Whether the rate template is the default rate template

vehicleTypeRates object[]required
The vehicle type rates
Array [
vehicleType string
The vehicle type name
vehicleTypeId string
The vehicle type ID
rates object[]
The rates for the vehicle type
Array [
rateId stringrequired
The rate ID
zoneId string
The operation zone ID
rateType stringrequired
Possible values: [Hourly, Regular, Flat, Sharing, Intercity]
The type of rate
rateActive boolean
Default value: true
Whether the rate is active for the vehicle type
]
]
isCorpCustomPricing booleanrequired

Whether the rate template is corporate custom pricing

latestUpdate date-timerequired

The latest update date

Example (from schema)

{
  "_id": "672d07188234567890123456",
  "name": "Standard Rate Template",
  "corporateId": "672d07188234567890123456",
  "isDefault": true,
  "vehicleTypeRates": [
    {
      "vehicleType": "Car",
      "vehicleTypeId": "672d07188234567890123456",
      "rates": [
        {
          "rateId": "672d07188234567890123456",
          "zoneId": "672d07188234567890123456",
          "rateType": "Regular",
          "rateActive": true
        }
      ]
    }
  ],
  "isCorpCustomPricing": true,
  "latestUpdate": "2025-01-01"
}

409

Rate template name already exists

500

Internal server error

Loading...