Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Tariff

Retrieve all tariffs.

Required scope: tariffs:read

get/api/v1/tariffs

Query parameters

countryAreaIdinteger

Country area id of the tariff

integer
OR
integer

Operator id of the tariff (taken from the consumer)

string
OR
string

External id of the tariff

integer
OR
integer

Team id of the tariff

integer
OR
integer

Country id of the tariff

string
OR
string

Zip code of the tariff

Response

All tariffs

idinteger

Id of the tariff

externalIdstring required

External id of the tariff

namestring required

Name of the tariff

descriptionstring required

Description of the tariff

countryIdinteger

Country Id of the tariff

countryAreaIdinteger nullable

Country area Id of the tariff

currencyIdinteger

Currency Id of the tariff

teamIdinteger nullable

Team Id of the tariff

operatorIdinteger nullable

Operator Id of the tariff

pricesWithVatboolean

Indicates if VAT is already in the price of the tariff

zipCodesstring[] required

Zip codes of the tariff

tariffType'WEEKLY' | 'DYNAMIC' required
activeboolean

Indicates if the Tariff is active or not

timeZonestring required

Time zone of the tariff

areastring required

Area of the tariff

customerType'A_ZERO' | 'A_HIGH' | 'A_LOW' | 'B_HIGH' | 'B_LOW' | 'C_CUSTOMER'
createdAtstring date-time required

Creation date of the tariff

updatedAtstring date-time nullable

Last update date of the tariff

Example response

[
  {
    "id": 1,
    "externalId": "3143",
    "name": "Cerius",
    "description": "TariffDescription",
    "countryId": 194,
    "countryAreaId": 1,
    "currencyId": 1,
    "teamId": 1,
    "operatorId": 1,
    "pricesWithVat": true,
    "zipCodes": [
      5610,
      5960
    ],
    "active": true,
    "timeZone": "Europe/Copenhagen",
    "area": "Jylland",
    "createdAt": "2023-03-23T14:54:56Z",
    "updatedAt": "2023-03-23T16:54:56Z"
  }
]