List cargo sizes

GET

/cargo-sizes

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

Returns every cargo size, smallest first, with what it adds to a dropoff’s price by the tariff of your company’s city and the heaviest load it covers. Map your own parcels to a size with it and show the difference at checkout.

A dropoff’s price is its distance price plus its size’s surcharge. Discounts apply to the distance price only, never to the surcharge. Each leg of POST /quotes shows its surcharge as cargo_surcharge.

Authorizations

• apiKey

Responses

200

The cargo sizes and their surcharges.

Media typeapplication/json

object

success

boolean

data

object

cargo_sizes

Every size, smallest first.

Array<object>

One cargo size and what it adds to every dropoff of that size.

object

cargo_size

string

Allowed values: S M L XL

surcharge

Amount in RUB added to the distance price of each dropoff of this size.

number

max_weight_kg

The heaviest load this size covers. null for XL, which has no upper limit.

number

nullable

Example

{
  "data": {
    "cargo_sizes": [
      {
        "cargo_size": "S",
        "surcharge": 0,
        "max_weight_kg": 10
      },
      {
        "cargo_size": "M",
        "surcharge": 50,
        "max_weight_kg": 20
      },
      {
        "cargo_size": "L",
        "surcharge": 100,
        "max_weight_kg": 40
      },
      {
        "cargo_size": "XL",
        "surcharge": 150,
        "max_weight_kg": null
      }
    ]
  }
}

401

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

Media typeapplication/json

object

success

boolean

error

object

id

string

code

string

message

string

details

string

Example

{
  "success": false
}