Create a new flat rate
POST/v1/rates/flat
Add a new flat rate to the system
Request
- application/json
Body
required
Name of the flat rate
Default value: true
Default value: -1
Default value: 0
Default value: 0
Default value: 0
priceAdjustment object
Default value: 0
Possible values: [transport, delivery]
Default value: transport
applyGeniusDiscount object
Default value: 5
Default value: 0
Responses
- 201
- 400
- 409
- 500
Flat rate created successfully
- application/json
- Schema
- Example (from schema)
Schema
The ID of the flat rate
The name of the flat rate
Whether the flat rate is active
The extra wait time fee of the flat rate
The calculation mode of the flat rate
The fee per stop of the flat rate
priceAdjustment objectrequired
Default value: 0
The service type of the flat rate
The start date of the flat rate
The end date of the flat rate
The start time of the flat rate
The end time of the flat rate
The currency ISO of the flat rate
The currency symbol of the flat rate
Whether the fee per seat is active
applyGeniusDiscount objectrequired
Default value: 5
The minimum seat of the flat rate
The created date of the flat rate
The latest update date of the flat rate
{
"_id": "672d07188234567890123456",
"rateName": "Standard Flat Rate",
"isActive": true,
"extraWaitTimeFee": 10,
"calculationMode": 1,
"feePerStop": 10,
"priceAdjustment": {
"isActive": false,
"minimumPercent": 0,
"maximumPercent": 0,
"value": 0
},
"serviceType": "transport",
"startDate": "2025-01-01",
"endDate": "2025-01-01",
"startTime": "00:00",
"endTime": "23:59",
"currencyISO": "USD",
"currencySymbol": "$",
"isFeePerSeatActive": true,
"applyGeniusDiscount": {
"enable": false,
"value": 5
},
"minSeat": 1,
"createdDate": "2025-01-01T00:00:00.000Z",
"latestUpdate": "2025-01-01T00:00:00.000Z"
}
Invalid input data
Flat rate already exists
Internal server error