Skip to main content

PricingRules

Your delivery fee rulebook. Set at least one of base_fee, per_km or per_min.

currencystring
Default value: GHS
base_feenumber
per_kmnumber
per_minnumber

Per minute of traffic-adjusted travel time.

minimumnumber
maximumnumber

0 or absent = no cap.

round_tonumber

Round the final price up to a multiple of this, e.g. 0.5.

mode_multipliers object
property name*number
zones object[]

Possible values: <= 20

  • Array [
  • service_area_idstringrequired
    labelstring
    addnumber
    multiplynumber
  • ]
  • surcharges object[]

    Possible values: <= 20

  • Array [
  • typestringrequired

    Possible values: [unpaved, flood_risk, rain, toll, time_window, weight]

    labelstring
    addnumber
    multiplynumber
    min_sharenumber

    unpaved only, 0-1.

    startstring

    time_window only, HH:MM Ghana time.

    Example: 20:00
    endstring
    Example: 06:00
    min_kgnumber

    weight only.

    max_kgnumber
  • ]
  • PricingRules
    {
    "currency": "GHS",
    "base_fee": 0,
    "per_km": 0,
    "per_min": 0,
    "minimum": 0,
    "maximum": 0,
    "round_to": 0,
    "mode_multipliers": {
    "driving": 1.5,
    "truck": 2
    },
    "zones": [
    {
    "service_area_id": "string",
    "label": "string",
    "add": 0,
    "multiply": 0
    }
    ],
    "surcharges": [
    {
    "type": "unpaved",
    "label": "string",
    "add": 0,
    "multiply": 0,
    "min_share": 0,
    "start": "20:00",
    "end": "06:00",
    "min_kg": 0,
    "max_kg": 0
    }
    ]
    }