Skip to main content

Get a route by ID

GET 
/v1/rates/flat/:id/routes/:routeId

Get a route by ID

Request​

Path Parameters

    id stringrequired

    Flat rate ID

    routeId stringrequired

    Route ID

Responses​

Route retrieved successfully

Schema
    _id stringrequired

    The ID of the flat route

    name stringrequired

    Route name

    routeType stringrequired

    Possible values: [zone, zipcode]

    Route type.

    from stringrequired

    ID of flat zone (when routeType = "zone") or zip code(s) (when routeType = "zipcode").

      Notes for zip codes:
      - Multiple zip codes can be entered using comma separator: "10001, 10002, 10003"
      - For consecutive zip codes, use '->' symbol: "90001 -> 90099"
      - Example: "90001 -> 90099, 90101, 90102, 90103, 90174, 90185"
    to stringrequired

    ID of flat zone (when routeType = "zone") or zip code(s) (when routeType = "zipcode").

      Notes for zip codes:
      - Multiple zip codes can be entered using comma separator: "10001, 10002, 10003"
      - For consecutive zip codes, use '->' symbol: "90001 -> 90099"
      - Example: "90001 -> 90099, 90101, 90102, 90103, 90174, 90185"
    departureRouteFee numberrequired

    Default value: 0

    Departure route fee

    enableReturnRoute booleanrequired

    Enable return route

    returnRouteFee numberrequired

    Default value: 0

    Return route fee

    isLimited booleanrequired

    Whether limitation is enabled

    coveredDistance numberrequired

    Default value: 0

    Covered distance

    extraDistanceFee numberrequired

    Default value: 0

    Extra distance fee

    coveredTime numberrequired

    Default value: 0

    Covered time

    extraTimeFee numberrequired

    Default value: 0

    Extra time fee

    enableRoundTrip booleanrequired

    Enable round trip

    roundTrip objectrequired
    isLimited boolean

    Whether limitation is enabled

    roundTripFee number

    Default value: 0

    Covered distance

    coveredDistance number

    Default value: 0

    Round trip fee

    extraDistanceFee number

    Default value: 0

    Extra distance fee

    coveredTime number

    Default value: 0

    Covered time

    extraTimeFee number

    Default value: 0

    Extra time fee

Loading...