Get all flat rates

GET 
/v1/rates/flat

Retrieve a paginated list of flat rates with optional name filtering

Request

Query Parameters

page number

Possible values: >= 1

Default value: 1

Page number for pagination

limit number

Possible values: >= 1

Default value: 10

Number of items per page

name string

Filter by flat rate name (case-insensitive)

Responses

200

List of flat rates retrieved successfully

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
The ID of the flat rate
rateName stringrequired
The name of the flat rate
isActive booleanrequired
Whether the flat rate is active
calculationMode numberrequired
The calculation mode of the flat rate
serviceType stringrequired
The service type of the flat rate
]
total numberrequired

The total number of items

page numberrequired

The current page

limit numberrequired

The number of items per page

totalPages numberrequired

The total number of pages

Example (from schema)

{
  "data": [
    {
      "_id": "672d07188234567890123456",
      "rateName": "Standard Flat Rate",
      "isActive": true,
      "calculationMode": 1,
      "serviceType": "transport"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

400

Invalid input data

500

Internal server error

Loading...