Skip to main content

FreightPatchRequest

Request to update freight pickup/delivery times and carrier settlement

pickupLocationTimes object

Time window update for a pickup or delivery location

fromDateTimestring<date-time>nullable

Earliest point in time (UTC or LocalTime), if null the update will not change this value.

Example: UTC: 2026-01-19T08:00:00Z or Local: 2026-01-19T08:00:00+01:00
toDateTimestring<date-time>nullable

Latest point in time (UTC or LocalTime), if null the update will not change this value.

Example: UTC: 2026-01-19T08:00:00Z or Local: 2026-01-19T08:00:00+01:00
deliveryLocationTimes object

Time window update for a pickup or delivery location

fromDateTimestring<date-time>nullable

Earliest point in time (UTC or LocalTime), if null the update will not change this value.

Example: UTC: 2026-01-19T08:00:00Z or Local: 2026-01-19T08:00:00+01:00
toDateTimestring<date-time>nullable

Latest point in time (UTC or LocalTime), if null the update will not change this value.

Example: UTC: 2026-01-19T08:00:00Z or Local: 2026-01-19T08:00:00+01:00
carrierPriceSettlement object

Carrier price settlement information for a freight

pricenumber<double>nullable

Settlement unit price

quantitynumber<double>nullable

Quantity to be multiplied by the unit price

fuelPercentagenumber<double>nullable

Fuel surcharge percentage applied to the unit price

Example: 12.5
tollAndFerryCostnumber<double>nullable

Total toll and ferry costs in NOK

Example: 450
totalLoadingTimeCostnumber<double>nullable

Total loading time cost in NOK

Example: 200
totalUnloadingTimeCostnumber<double>nullable

Total unloading time cost in NOK

Example: 200
additionalExpenses object[]nullable

Additional expenses not covered by the standard settlement fields

  • Array [
    • descriptionstringrequired

    Description of the additional expense

    Possible values: non-empty and <= 500 characters

    Example: Waiting time surcharge
    amountnumber<double>

    Amount in NOK

    Example: 350
    includeInFuelExpenseboolean

    Whether this expense should be included in the fuel surcharge calculation

    Example: false
  • ]
    • finalboolean

    If set to true the carrier settlement will be confirmed

    FreightPatchRequest
    {
      "pickupLocationTimes": {
        "fromDateTime": "UTC: 2026-01-19T08:00:00Z or Local: 2026-01-19T08:00:00+01:00",
        "toDateTime": "UTC: 2026-01-19T08:00:00Z or Local: 2026-01-19T08:00:00+01:00"
      },
      "deliveryLocationTimes": {
        "fromDateTime": "UTC: 2026-01-19T08:00:00Z or Local: 2026-01-19T08:00:00+01:00",
        "toDateTime": "UTC: 2026-01-19T08:00:00Z or Local: 2026-01-19T08:00:00+01:00"
      },
      "carrierPriceSettlement": {
        "price": 0,
        "quantity": 0,
        "fuelPercentage": 12.5,
        "tollAndFerryCost": 450,
        "totalLoadingTimeCost": 200,
        "totalUnloadingTimeCost": 200,
        "additionalExpenses": [
          {
            "description": "Waiting time surcharge",
            "amount": 350,
            "includeInFuelExpense": false
          }
        ],
        "final": true
      }
    }