Read the tariff table

GET

/pricing

const url = 'https://api.govza.app/v1/delivery/pricing';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.govza.app/v1/delivery/pricing \
  --header 'Authorization: Bearer <token>'

Returns the distance bands every delivery price is built from, as they stand right now. The table is the same for every account and changes rarely; POST /quotes remains the way to price a concrete trip.

Cargo size is not part of the bands: it adds cargo_size_step_fee per step on top of the band price, the same surcharge POST /quotes applies per dropoff.

Authorizations

apiKey

Responses

200

The current tariff table.

application/json

object

success

boolean

data

The tariff scalars prices are computed from, plus bands — the same ranges rendered as a table. The scalars are included for completeness; rendering bands needs no arithmetic.

object

base_price

Price for any trip under first_threshold_km.

number

first_threshold_km

Distance in kilometres the base price covers.

number

band_width_km

Width in kilometres of each band after the first.

number

band_step

Amount in RUB added per band.

number

max_threshold_km

Distance in kilometres where per-kilometre pricing starts.

number

per_km_over

Amount in RUB per kilometre past max_threshold_km.

number

cargo_size_step_fee

Cargo surcharge per size step — S +0, M +1×, L +2×, XL +3×.

number

bands

Array<object>

One row of the tariff table. A distance belongs to a band when it is at least min_km and less than max_km.

object

min_km

Lower bound of the range in kilometres, inclusive.

number

max_km

Upper bound in kilometres, exclusive. null on the last band only: it has no upper bound, and each kilometre past min_km adds per_km_over on top of price.

number

nullable

price

Flat price in RUB for any distance inside the band.

number

per_km_over

Per-kilometre surcharge; present on the last band, null elsewhere.

number

nullable

Example

{
  "data": {
    "base_price": 200,
    "first_threshold_km": 3,
    "band_width_km": 2,
    "band_step": 50,
    "max_threshold_km": 15,
    "per_km_over": 35,
    "cargo_size_step_fee": 50,
    "bands": [
      {
        "min_km": 0,
        "max_km": 3,
        "price": 200,
        "per_km_over": null
      },
      {
        "min_km": 3,
        "max_km": 5,
        "price": 250,
        "per_km_over": null
      },
      {
        "min_km": 5,
        "max_km": 7,
        "price": 300,
        "per_km_over": null
      },
      {
        "min_km": 7,
        "max_km": 9,
        "price": 350,
        "per_km_over": null
      },
      {
        "min_km": 9,
        "max_km": 11,
        "price": 400,
        "per_km_over": null
      },
      {
        "min_km": 11,
        "max_km": 13,
        "price": 450,
        "per_km_over": null
      },
      {
        "min_km": 13,
        "max_km": 15,
        "price": 500,
        "per_km_over": null
      },
      {
        "min_km": 15,
        "max_km": null,
        "price": 550,
        "per_km_over": 35
      }
    ]
  }
}

401

The key is missing, malformed, revoked, or its account can no longer create orders.

application/json

object

success

boolean

error

object

string

code

string

message

string

details

string

Example

{
  "success": false
}