Search offers

Server

Endpoints that are available for generating offers by various means.

Search for Offers using a specific trip pattern.

POST

https://api.entur.io

/offers/v3/search/trip-pattern

Request offers for a specific departure between two stop places. At least one Traveller, and a TripPatternRequest is required.

Search for Offers using a specific trip pattern. › Headers

Entur-Distribution-Channel

string · pattern: ^[A-Z]{3}:Distributi… · required · style: simple

Id of distribution channel requesting offers

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · minLength: 2 · maxLength: 2 · style: simple

The language code from IETF BCP 47

Default: nb

Entur-POS

string · style: simple

Point-of-sale identifier

Search for Offers using a specific trip pattern. › Request Body

A request used to search for fare products for a specified trip.

SearchTripPatternRequest

Traveller[] · minItems: 1 · required

The travellers.

TripPatternRequest · required

List of legs constituting a suggested sequence of rides and links for a specific trip.

RecommendationConfig

Specify what types of recommendations are returned in the response. For a more in depth explanation of recommendations, see the guide for recommendations at TODO [INSERT NEW LINK].

GroupConfig

A configuration of how to group travellers in offers.

includeMultiTripOffers

boolean

Indicates whether multi-trip offers should be included in the response, such as monthly passes, day passes, and similar options.

Default: false

Search for Offers using a specific trip pattern. › Responses

A selection of Offers valid on parts or the whole of the given trip pattern.

SearchResponse

OfferSummary[] · required

RecommendationResult · required

A set of recommendations matching the provided recommendation configuration.

tripPatternId

string

OptionalProduct[]

UnavailableProduct[]

notices

string[]

Additional information about potentially missing information or functionality due to transient errors.

POST/offers/v3/search/trip-pattern

curl https://api.entur.io/offers/v3/search/trip-pattern \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "travellers": [
    {
      "example": {
        "id": "ID_A",
        "userType": "ADULT",
        "productIds": [
          "ENT:PreassignedFareProduct:StandardFullFlex"
        ],
        "baggageTypes": [
          "BICYCLE"
        ]
      }
    }
  ],
  "recommendationConfig": {
    "categorySpec": {
      "example": {
        "typesOfRecommendation": [
          "FLEXIBLE",
          "CHEAPEST"
        ],
        "durationTypes": [
          "DAY_PASS",
          "SINGLE_TRIP"
        ],
        "fareClasses": [
          "FIRST_CLASS"
        ],
        "facilitySet": [
          "SLEEPER",
          "SEATING"
        ]
      }
    },
    "ruleSpec": {
      "journeyOrganizeAlgorithm": "SUBSEQUENT_COMBINATIONS",
      "priceComparisonAlgorithm": "TOTAL_PRICE",
      "onlyIncludeRecommendedOffers": true,
      "onlyIncludeRecommendationsWithOffersToBuy": true,
      "mixInOffersWithHigherFlexibility": true,
      "mixInOffersWithOtherFacilitySets": true,
      "onlyKeepUpgradeProductSalesPackages": false,
      "onlyIncludeMostCompleteInCategorySpec": false
    }
  },
  "tripPattern": {
    "legs": [
      {
        "travelDate": "2020-05-13",
        "travelDateTime": "2024-02-24T00:00:00+00",
        "fromStopPlaceId": "NSR:StopPlace:635",
        "toStopPlaceId": "NSR:StopPlace:640",
        "serviceJourneyId": "ENT:ServiceJourney:1-232-1016-20201117132"
      }
    ]
  },
  "groupConfig": {
    "numberOfCompartments": 0
  },
  "includeMultiTripOffers": false
}'

Example Request Body

{
  "travellers": [
    {
      "example": {
        "id": "ID_A",
        "userType": "ADULT",
        "productIds": [
          "ENT:PreassignedFareProduct:StandardFullFlex"
        ],
        "baggageTypes": [
          "BICYCLE"
        ]
      }
    }
  ],
  "recommendationConfig": {
    "categorySpec": {
      "example": {
        "typesOfRecommendation": [
          "FLEXIBLE",
          "CHEAPEST"
        ],
        "durationTypes": [
          "DAY_PASS",
          "SINGLE_TRIP"
        ],
        "fareClasses": [
          "FIRST_CLASS"
        ],
        "facilitySet": [
          "SLEEPER",
          "SEATING"
        ]
      }
    },
    "ruleSpec": {
      "journeyOrganizeAlgorithm": "SUBSEQUENT_COMBINATIONS",
      "priceComparisonAlgorithm": "TOTAL_PRICE",
      "onlyIncludeRecommendedOffers": true,
      "onlyIncludeRecommendationsWithOffersToBuy": true,
      "mixInOffersWithHigherFlexibility": true,
      "mixInOffersWithOtherFacilitySets": true,
      "onlyKeepUpgradeProductSalesPackages": false,
      "onlyIncludeMostCompleteInCategorySpec": false
    }
  },
  "tripPattern": {
    "legs": [
      {
        "travelDate": "2020-05-13",
        "travelDateTime": "2024-02-24T00:00:00+00",
        "fromStopPlaceId": "NSR:StopPlace:635",
        "toStopPlaceId": "NSR:StopPlace:640",
        "serviceJourneyId": "ENT:ServiceJourney:1-232-1016-20201117132"
      }
    ]
  },
  "groupConfig": {
    "numberOfCompartments": 0
  },
  "includeMultiTripOffers": false
}

json

Example Responses

{
  "tripPatternId": "5e7cbc83e58e6a00011cecc3",
  "offers": [
    {
      "id": "00faf83-56c3-4f4e-8be9-e793c255a77b",
      "name": "Flex Refunderbar",
      "salesPackageId": "salesPackageId",
      "salesPackageVersion": "salesPackageVersion",
      "description": "Flex Refunderbar",
      "price": {
        "amount": "100.00",
        "vatGroup": "TRANSPORT_AND_TICKETS_VAT",
        "currency": "NOK"
      },
      "availableFulfilmentMethods": [
        {
          "id": "id",
          "version": "version",
          "distributionRights": {
            "example": [
              "SELL",
              "REFUND"
            ]
          }
        }
      ],
      "geographicalValidity": {
        "serviceJourneys": [
          {
            "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
            "serviceJourneyId": "ENT:ServiceJourney:56789"
          }
        ],
        "pointToPointValidity": {
          "fromPlace": {
            "id": "id",
            "name": "name"
          },
          "toPlace": {
            "id": "id",
            "name": "name"
          }
        },
        "zonalValidity": {
          "fromZone": {
            "id": "id",
            "name": "name"
          },
          "toZone": {
            "id": "id",
            "name": "name"
          },
          "viaZones": [
            {
              "id": "id",
              "name": "name"
            }
          ],
          "groupOfTariffZones": [
            {
              "id": "id",
              "name": "name"
            }
          ]
        }
      },
      "preassignedProducts": [
        {
          "id": "ENT:PreassignedFareProduct:StandardFullFlex",
          "version": "ENT:Version:V1",
          "name": "Standard refunderbar",
          "description": "Standard refunderbar",
          "properties": {
            "isExchangeable": true,
            "isRefundable": true,
            "accommodations": [
              {
                "example": {
                  "serviceJourney": {
                    "datedServiceJourneyId": "ENT:DatedServiceJourney:56179534",
                    "serviceJourneyId": "ENT:ServiceJourney:1-435-119-202007111809"
                  },
                  "accommodation": "SLEEPER"
                }
              }
            ],
            "baggageTypes": [
              "BICYCLE"
            ],
            "reservingRequirements": [
              {
                "serviceJourney": {
                  "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
                  "serviceJourneyId": "ENT:ServiceJourney:56789"
                },
                "reservingRequirement": "RESERVATIONS_COMPULSORY",
                "seatMapIsAvailable": true
              }
            ],
            "userProfileSummary": {
              "example": {
                "id": "ENT:UserProfile:Adult",
                "version": "ENT:Version:V1",
                "name": "Ola Nordmann",
                "userType": "ADULT"
              }
            },
            "organisation": {
              "id": "ENT:Authority:TST",
              "name": "Example organisation"
            },
            "duration": "duration",
            "group": {
              "id": "ENT:GroupTicket:Family",
              "version": "ENT:Version:V1",
              "name": "Familiebillett",
              "description": "description",
              "userProfiles": [
                {
                  "id": "id",
                  "version": "version",
                  "numberOfPeople": 0
                }
              ]
            },
            "fareClasses": [
              "STANDARD_CLASS"
            ],
            "carnet": {
              "amount": 10,
              "duration": "PT1H30M"
            },
            "durationType": "DAY_PASS",
            "nuisanceFacilities": [
              "ANIMALS_ALLOWED"
            ]
          },
          "geographicalValidity": {
            "serviceJourneys": [
              {
                "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
                "serviceJourneyId": "ENT:ServiceJourney:56789"
              }
            ],
            "pointToPointValidity": {
              "fromPlace": {
                "id": "id",
                "name": "name"
              },
              "toPlace": {
                "id": "id",
                "name": "name"
              }
            },
            "zonalValidity": {
              "fromZone": {
                "id": "id",
                "name": "name"
              },
              "toZone": {
                "id": "id",
                "name": "name"
              },
              "viaZones": [
                {
                  "id": "id",
                  "name": "name"
                }
              ],
              "groupOfTariffZones": [
                {
                  "id": "id",
                  "name": "name"
                }
              ]
            }
          },
          "discountRights": [
            {
              "example": {
                "id": "ENT:SaleDiscountRight:Premium",
                "version": "ENT:Version:SDR-Premium-1",
                "price": {
                  "amount": "-739.00",
                  "currency": "NOK"
                },
                "name": "Premiumrabatt"
              }
            }
          ]
        }
      ],
      "optionalProductsSelectableIds": [
        "XXFicO"
      ],
      "travellerMapping": [
        {
          "travellerIds": [
            "ID_A"
          ],
          "maxNumberOfTravellers": 0,
          "minNumberOfTravellers": 0,
          "userType": "ADULT"
        }
      ],
      "available": 14,
      "cappedDiscountOption": {
        "cappedDiscountRightRef": {
          "ref": "ref",
          "version": "version"
        },
        "cappedDiscountRuleRef": {
          "ref": "ref",
          "version": "version"
        },
        "alternatives": [
          {
            "selectableId": "selectableId",
            "discount": {
              "amount": "100.00",
              "vatGroup": "TRANSPORT_AND_TICKETS_VAT",
              "currency": "NOK"
            },
            "startDateTime": "2024-08-25T15:00:00Z",
            "endDateTime": "2024-08-25T15:00:00Z"
          }
        ]
      },
      "eligibleForAccrualInPrograms": [
        {
          "id": "9",
          "reference": "entur_reis",
          "name": "Entur Reis",
          "infoLink": "infoLink",
          "paused": false
        }
      ],
      "availablePrograms": [
        {
          "id": "9",
          "reference": "entur_reis",
          "name": "Entur Reis",
          "infoLink": "infoLink"
        }
      ]
    }
  ],
  "recommendations": {
    "coveringEntireJourney": [
      {
        "id": "id",
        "geographicalValidityCovered": {
          "coversEntireJourney": true,
          "serviceJourneys": [
            "string"
          ],
          "pointToPointValidity": {
            "fromPlace": {
              "id": "id",
              "name": "name"
            },
            "toPlace": {
              "id": "id",
              "name": "name"
            }
          },
          "zonalValidity": {
            "fromZone": {
              "id": "id",
              "name": "name"
            },
            "toZone": {
              "id": "id",
              "name": "name"
            },
            "viaZones": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "groupOfTariffZones": [
              {
                "id": "id",
                "name": "name"
              }
            ]
          }
        },
        "typeOfRecommendation": "CHEAPEST",
        "durationType": "DAY_PASS",
        "fareClass": "STANDARD_CLASS",
        "facilitySet": "SLEEPER",
        "offersToBuy": [
          {
            "id": "00faf83-56c3-4f4e-8be9-e793c255a77b",
            "numberToBuy": 2,
            "selectableProductIds": [
              "KEeaHd"
            ],
            "possibleTravellerIds": [
              [
                "Adult-1"
              ]
            ]
          }
        ],
        "combineWithToCoverEntireJourney": [
          {
            "geographicalValidityCovered": {
              "coversEntireJourney": true,
              "serviceJourneys": [
                "string"
              ],
              "pointToPointValidity": {
                "fromPlace": {
                  "id": "id",
                  "name": "name"
                },
                "toPlace": {
                  "id": "id",
                  "name": "name"
                }
              },
              "zonalValidity": {
                "fromZone": {
                  "id": "id",
                  "name": "name"
                },
                "toZone": {
                  "id": "id",
                  "name": "name"
                },
                "viaZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "groupOfTariffZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ]
              }
            },
            "recommendationsToCoverEntireJourney": [
              "string"
            ]
          }
        ]
      }
    ],
    "coveringPartOfJourney": [
      {
        "id": "id",
        "geographicalValidityCovered": {
          "coversEntireJourney": true,
          "serviceJourneys": [
            "string"
          ],
          "pointToPointValidity": {
            "fromPlace": {
              "id": "id",
              "name": "name"
            },
            "toPlace": {
              "id": "id",
              "name": "name"
            }
          },
          "zonalValidity": {
            "fromZone": {
              "id": "id",
              "name": "name"
            },
            "toZone": {
              "id": "id",
              "name": "name"
            },
            "viaZones": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "groupOfTariffZones": [
              {
                "id": "id",
                "name": "name"
              }
            ]
          }
        },
        "typeOfRecommendation": "CHEAPEST",
        "durationType": "DAY_PASS",
        "fareClass": "STANDARD_CLASS",
        "facilitySet": "SLEEPER",
        "offersToBuy": [
          {
            "id": "00faf83-56c3-4f4e-8be9-e793c255a77b",
            "numberToBuy": 2,
            "selectableProductIds": [
              "KEeaHd"
            ],
            "possibleTravellerIds": [
              [
                "Adult-1"
              ]
            ]
          }
        ],
        "combineWithToCoverEntireJourney": [
          {
            "geographicalValidityCovered": {
              "coversEntireJourney": true,
              "serviceJourneys": [
                "string"
              ],
              "pointToPointValidity": {
                "fromPlace": {
                  "id": "id",
                  "name": "name"
                },
                "toPlace": {
                  "id": "id",
                  "name": "name"
                }
              },
              "zonalValidity": {
                "fromZone": {
                  "id": "id",
                  "name": "name"
                },
                "toZone": {
                  "id": "id",
                  "name": "name"
                },
                "viaZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "groupOfTariffZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ]
              }
            },
            "recommendationsToCoverEntireJourney": [
              "string"
            ]
          }
        ]
      }
    ]
  },
  "optionalProducts": [
    {
      "id": "ENT:SupplementProduct:BicycleReserving",
      "version": "ENT:Version:V1",
      "selectableId": "ZO9Qjn",
      "name": "Bike as luggage",
      "description": "Bike as luggage",
      "price": {
        "amount": "100.00",
        "vatGroup": "TRANSPORT_AND_TICKETS_VAT",
        "currency": "NOK"
      },
      "properties": {
        "isExchangeable": true,
        "isRefundable": true,
        "accommodations": [
          {
            "example": {
              "serviceJourney": {
                "datedServiceJourneyId": "ENT:DatedServiceJourney:56179534",
                "serviceJourneyId": "ENT:ServiceJourney:1-435-119-202007111809"
              },
              "accommodation": "SLEEPER"
            }
          }
        ],
        "baggageTypes": [
          "BICYCLE"
        ],
        "reservingRequirements": [
          {
            "serviceJourney": {
              "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
              "serviceJourneyId": "ENT:ServiceJourney:56789"
            },
            "reservingRequirement": "RESERVATIONS_COMPULSORY",
            "seatMapIsAvailable": true
          }
        ],
        "userProfileSummary": {
          "example": {
            "id": "ENT:UserProfile:Adult",
            "version": "ENT:Version:V1",
            "name": "Ola Nordmann",
            "userType": "ADULT"
          }
        },
        "organisation": {
          "id": "ENT:Authority:TST",
          "name": "Example organisation"
        },
        "duration": "duration",
        "group": {
          "id": "ENT:GroupTicket:Family",
          "version": "ENT:Version:V1",
          "name": "Familiebillett",
          "description": "description",
          "userProfiles": [
            {
              "id": "id",
              "version": "version",
              "numberOfPeople": 0
            }
          ]
        },
        "fareClasses": [
          "STANDARD_CLASS"
        ],
        "carnet": {
          "amount": 10,
          "duration": "PT1H30M"
        },
        "durationType": "DAY_PASS",
        "nuisanceFacilities": [
          "ANIMALS_ALLOWED"
        ]
      },
      "geographicalValidity": {
        "serviceJourneys": [
          {
            "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
            "serviceJourneyId": "ENT:ServiceJourney:56789"
          }
        ],
        "pointToPointValidity": {
          "fromPlace": {
            "id": "id",
            "name": "name"
          },
          "toPlace": {
            "id": "id",
            "name": "name"
          }
        },
        "zonalValidity": {
          "fromZone": {
            "id": "id",
            "name": "name"
          },
          "toZone": {
            "id": "id",
            "name": "name"
          },
          "viaZones": [
            {
              "id": "id",
              "name": "name"
            }
          ],
          "groupOfTariffZones": [
            {
              "id": "id",
              "name": "name"
            }
          ]
        }
      },
      "discountRights": [
        {
          "example": {
            "id": "ENT:SaleDiscountRight:Premium",
            "version": "ENT:Version:SDR-Premium-1",
            "price": {
              "amount": "-739.00",
              "currency": "NOK"
            },
            "name": "Premiumrabatt"
          }
        }
      ],
      "available": 4,
      "supplementProductType": "BICYCLE"
    }
  ],
  "unavailableProducts": [
    {
      "id": "ENT:PreassignedFareProduct:StandardFullFlex",
      "name": "Enkeltbillett",
      "unavailableStatus": "NOT_YET_AVAILABLE",
      "serviceJourney": {
        "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
        "serviceJourneyId": "ENT:ServiceJourney:56789"
      },
      "properties": {
        "accommodations": [
          "SLEEPER"
        ],
        "fareClasses": [
          "STANDARD_CLASS"
        ],
        "isExchangeable": true,
        "isRefundable": true,
        "organisation": {
          "id": "ENT:Authority:TST",
          "name": "Example organisation"
        }
      }
    }
  ],
  "notices": [
    "string"
  ]
}

json

application/json

Search for offers by geographical-locations.

POST

https://api.entur.io

/offers/v3/search/geographical-locations

Request offers that are not associated with any specific departure. The offers returned are period tickets or single tickets that are valid between stop places or zones for a given duration.

Search for offers by geographical-locations. › Headers

Entur-Distribution-Channel

string · pattern: ^[A-Z]{3}:Distributi… · required · style: simple

Id of distribution channel requesting offers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · minLength: 2 · maxLength: 2 · style: simple

The language code from IETF BCP 47

Default: nb

Entur-POS

string · style: simple

Point-of-sale identifier

Search for offers by geographical-locations. › Request Body

A request used to search for fare products between stop places or zones. If two stopPlaces are provided, Offers are calculated for each set of FareZones sharing the same codespace. For any other combination, the common codespace is selected. In either case, transport mode and authority can be used to further refine which Offers are returned. Some combinations of stop places may result in offers that cover parts of the distance. As an example, let's say the "from" stop place is A, and the "to" stop place is C. There may not be a ticket that is valid from A to C, but tickets that are valid from A to B, and B to C. In that case you will receive offers that are valid for A to B and B to C. If you only want offers that cover the whole distance, set "offersForWholeTripOnly" to true.

SearchGeoLocationRequest

travelDate

string · date-time · required

The specific time for when the ticket should be activated. For most purposes it is recommended to use the current time as travel date. That is because most period tickets are activated immediately on purchase. If you want to get a period ticket that should be activated some time in the future, specify the future date.

from

string · pattern: ^[A-Z]{3}:FareZone:.… · required

The id of the origin stop place or zone.

to

string · pattern: ^[A-Z]{3}:FareZone:.… · required

The id of the destination stop place or zone.

Traveller[] · minItems: 1 · required

The travellers the offer should be valid for.

via

string[] · minItems: 1 · pattern: ^[A-Z]{3}:FareZone:.…

Optional sequence of via locations. Mostly useful for zone based searches.

RecommendationConfig

Specify what types of recommendations are returned in the response. For a more in depth explanation of recommendations, see the guide for recommendations at TODO [INSERT NEW LINK].

offersForWholeTripOnly

boolean

Set this flag to true if you only want tickets that are valid all the way between the stop-places specified in the "from" and "to" field. When set to false, you will receive additional offers that are valid for parts of the trip with one of the stop places covered.

Default: false

authority

string · pattern: ^[A-Z]{3}:Authority:…

Optional authority ID, to further refine search. The returned Offers will only contain products allowing or requiring the provided Authority. In the case of two rail stopPlaces, Authority is set from pre-defined rules and this parameter will be ignored.

transportMode

string

Optional transport mode, to further refine search. Most useful when there is a specific use case where there may be overlapping Offers, for instance high speed ferry or rail.

Search for offers by geographical-locations. › Responses

A selection of offers valid between the two geographical locations.

SearchResponse

OfferSummary[] · required

RecommendationResult · required

A set of recommendations matching the provided recommendation configuration.

tripPatternId

string

OptionalProduct[]

UnavailableProduct[]

notices

string[]

Additional information about potentially missing information or functionality due to transient errors.

POST/offers/v3/search/geographical-locations

curl https://api.entur.io/offers/v3/search/geographical-locations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "travelDate": "2020-12-24T14:48:00+0200",
  "from": "NSR:StopPlace:123",
  "to": "NSR:StopPlace:337",
  "via": [
    "ENT:FareZone:3"
  ],
  "travellers": [
    {
      "example": {
        "id": "ID_A",
        "userType": "ADULT",
        "productIds": [
          "ENT:PreassignedFareProduct:StandardFullFlex"
        ],
        "baggageTypes": [
          "BICYCLE"
        ]
      }
    }
  ],
  "recommendationConfig": {
    "categorySpec": {
      "example": {
        "typesOfRecommendation": [
          "FLEXIBLE",
          "CHEAPEST"
        ],
        "durationTypes": [
          "DAY_PASS",
          "SINGLE_TRIP"
        ],
        "fareClasses": [
          "FIRST_CLASS"
        ],
        "facilitySet": [
          "SLEEPER",
          "SEATING"
        ]
      }
    },
    "ruleSpec": {
      "journeyOrganizeAlgorithm": "SUBSEQUENT_COMBINATIONS",
      "priceComparisonAlgorithm": "TOTAL_PRICE",
      "onlyIncludeRecommendedOffers": true,
      "onlyIncludeRecommendationsWithOffersToBuy": true,
      "mixInOffersWithHigherFlexibility": true,
      "mixInOffersWithOtherFacilitySets": true,
      "onlyKeepUpgradeProductSalesPackages": false,
      "onlyIncludeMostCompleteInCategorySpec": false
    }
  },
  "offersForWholeTripOnly": false,
  "authority": "ENT:Authority:ENT",
  "transportMode": "RAIL"
}'

Example Request Body

{
  "travelDate": "2020-12-24T14:48:00+0200",
  "from": "NSR:StopPlace:123",
  "to": "NSR:StopPlace:337",
  "via": [
    "ENT:FareZone:3"
  ],
  "travellers": [
    {
      "example": {
        "id": "ID_A",
        "userType": "ADULT",
        "productIds": [
          "ENT:PreassignedFareProduct:StandardFullFlex"
        ],
        "baggageTypes": [
          "BICYCLE"
        ]
      }
    }
  ],
  "recommendationConfig": {
    "categorySpec": {
      "example": {
        "typesOfRecommendation": [
          "FLEXIBLE",
          "CHEAPEST"
        ],
        "durationTypes": [
          "DAY_PASS",
          "SINGLE_TRIP"
        ],
        "fareClasses": [
          "FIRST_CLASS"
        ],
        "facilitySet": [
          "SLEEPER",
          "SEATING"
        ]
      }
    },
    "ruleSpec": {
      "journeyOrganizeAlgorithm": "SUBSEQUENT_COMBINATIONS",
      "priceComparisonAlgorithm": "TOTAL_PRICE",
      "onlyIncludeRecommendedOffers": true,
      "onlyIncludeRecommendationsWithOffersToBuy": true,
      "mixInOffersWithHigherFlexibility": true,
      "mixInOffersWithOtherFacilitySets": true,
      "onlyKeepUpgradeProductSalesPackages": false,
      "onlyIncludeMostCompleteInCategorySpec": false
    }
  },
  "offersForWholeTripOnly": false,
  "authority": "ENT:Authority:ENT",
  "transportMode": "RAIL"
}

json

Example Responses

{
  "tripPatternId": "5e7cbc83e58e6a00011cecc3",
  "offers": [
    {
      "id": "00faf83-56c3-4f4e-8be9-e793c255a77b",
      "name": "Flex Refunderbar",
      "salesPackageId": "salesPackageId",
      "salesPackageVersion": "salesPackageVersion",
      "description": "Flex Refunderbar",
      "price": {
        "amount": "100.00",
        "vatGroup": "TRANSPORT_AND_TICKETS_VAT",
        "currency": "NOK"
      },
      "availableFulfilmentMethods": [
        {
          "id": "id",
          "version": "version",
          "distributionRights": {
            "example": [
              "SELL",
              "REFUND"
            ]
          }
        }
      ],
      "geographicalValidity": {
        "serviceJourneys": [
          {
            "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
            "serviceJourneyId": "ENT:ServiceJourney:56789"
          }
        ],
        "pointToPointValidity": {
          "fromPlace": {
            "id": "id",
            "name": "name"
          },
          "toPlace": {
            "id": "id",
            "name": "name"
          }
        },
        "zonalValidity": {
          "fromZone": {
            "id": "id",
            "name": "name"
          },
          "toZone": {
            "id": "id",
            "name": "name"
          },
          "viaZones": [
            {
              "id": "id",
              "name": "name"
            }
          ],
          "groupOfTariffZones": [
            {
              "id": "id",
              "name": "name"
            }
          ]
        }
      },
      "preassignedProducts": [
        {
          "id": "ENT:PreassignedFareProduct:StandardFullFlex",
          "version": "ENT:Version:V1",
          "name": "Standard refunderbar",
          "description": "Standard refunderbar",
          "properties": {
            "isExchangeable": true,
            "isRefundable": true,
            "accommodations": [
              {
                "example": {
                  "serviceJourney": {
                    "datedServiceJourneyId": "ENT:DatedServiceJourney:56179534",
                    "serviceJourneyId": "ENT:ServiceJourney:1-435-119-202007111809"
                  },
                  "accommodation": "SLEEPER"
                }
              }
            ],
            "baggageTypes": [
              "BICYCLE"
            ],
            "reservingRequirements": [
              {
                "serviceJourney": {
                  "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
                  "serviceJourneyId": "ENT:ServiceJourney:56789"
                },
                "reservingRequirement": "RESERVATIONS_COMPULSORY",
                "seatMapIsAvailable": true
              }
            ],
            "userProfileSummary": {
              "example": {
                "id": "ENT:UserProfile:Adult",
                "version": "ENT:Version:V1",
                "name": "Ola Nordmann",
                "userType": "ADULT"
              }
            },
            "organisation": {
              "id": "ENT:Authority:TST",
              "name": "Example organisation"
            },
            "duration": "duration",
            "group": {
              "id": "ENT:GroupTicket:Family",
              "version": "ENT:Version:V1",
              "name": "Familiebillett",
              "description": "description",
              "userProfiles": [
                {
                  "id": "id",
                  "version": "version",
                  "numberOfPeople": 0
                }
              ]
            },
            "fareClasses": [
              "STANDARD_CLASS"
            ],
            "carnet": {
              "amount": 10,
              "duration": "PT1H30M"
            },
            "durationType": "DAY_PASS",
            "nuisanceFacilities": [
              "ANIMALS_ALLOWED"
            ]
          },
          "geographicalValidity": {
            "serviceJourneys": [
              {
                "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
                "serviceJourneyId": "ENT:ServiceJourney:56789"
              }
            ],
            "pointToPointValidity": {
              "fromPlace": {
                "id": "id",
                "name": "name"
              },
              "toPlace": {
                "id": "id",
                "name": "name"
              }
            },
            "zonalValidity": {
              "fromZone": {
                "id": "id",
                "name": "name"
              },
              "toZone": {
                "id": "id",
                "name": "name"
              },
              "viaZones": [
                {
                  "id": "id",
                  "name": "name"
                }
              ],
              "groupOfTariffZones": [
                {
                  "id": "id",
                  "name": "name"
                }
              ]
            }
          },
          "discountRights": [
            {
              "example": {
                "id": "ENT:SaleDiscountRight:Premium",
                "version": "ENT:Version:SDR-Premium-1",
                "price": {
                  "amount": "-739.00",
                  "currency": "NOK"
                },
                "name": "Premiumrabatt"
              }
            }
          ]
        }
      ],
      "optionalProductsSelectableIds": [
        "XXFicO"
      ],
      "travellerMapping": [
        {
          "travellerIds": [
            "ID_A"
          ],
          "maxNumberOfTravellers": 0,
          "minNumberOfTravellers": 0,
          "userType": "ADULT"
        }
      ],
      "available": 14,
      "cappedDiscountOption": {
        "cappedDiscountRightRef": {
          "ref": "ref",
          "version": "version"
        },
        "cappedDiscountRuleRef": {
          "ref": "ref",
          "version": "version"
        },
        "alternatives": [
          {
            "selectableId": "selectableId",
            "discount": {
              "amount": "100.00",
              "vatGroup": "TRANSPORT_AND_TICKETS_VAT",
              "currency": "NOK"
            },
            "startDateTime": "2024-08-25T15:00:00Z",
            "endDateTime": "2024-08-25T15:00:00Z"
          }
        ]
      },
      "eligibleForAccrualInPrograms": [
        {
          "id": "9",
          "reference": "entur_reis",
          "name": "Entur Reis",
          "infoLink": "infoLink",
          "paused": false
        }
      ],
      "availablePrograms": [
        {
          "id": "9",
          "reference": "entur_reis",
          "name": "Entur Reis",
          "infoLink": "infoLink"
        }
      ]
    }
  ],
  "recommendations": {
    "coveringEntireJourney": [
      {
        "id": "id",
        "geographicalValidityCovered": {
          "coversEntireJourney": true,
          "serviceJourneys": [
            "string"
          ],
          "pointToPointValidity": {
            "fromPlace": {
              "id": "id",
              "name": "name"
            },
            "toPlace": {
              "id": "id",
              "name": "name"
            }
          },
          "zonalValidity": {
            "fromZone": {
              "id": "id",
              "name": "name"
            },
            "toZone": {
              "id": "id",
              "name": "name"
            },
            "viaZones": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "groupOfTariffZones": [
              {
                "id": "id",
                "name": "name"
              }
            ]
          }
        },
        "typeOfRecommendation": "CHEAPEST",
        "durationType": "DAY_PASS",
        "fareClass": "STANDARD_CLASS",
        "facilitySet": "SLEEPER",
        "offersToBuy": [
          {
            "id": "00faf83-56c3-4f4e-8be9-e793c255a77b",
            "numberToBuy": 2,
            "selectableProductIds": [
              "KEeaHd"
            ],
            "possibleTravellerIds": [
              [
                "Adult-1"
              ]
            ]
          }
        ],
        "combineWithToCoverEntireJourney": [
          {
            "geographicalValidityCovered": {
              "coversEntireJourney": true,
              "serviceJourneys": [
                "string"
              ],
              "pointToPointValidity": {
                "fromPlace": {
                  "id": "id",
                  "name": "name"
                },
                "toPlace": {
                  "id": "id",
                  "name": "name"
                }
              },
              "zonalValidity": {
                "fromZone": {
                  "id": "id",
                  "name": "name"
                },
                "toZone": {
                  "id": "id",
                  "name": "name"
                },
                "viaZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "groupOfTariffZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ]
              }
            },
            "recommendationsToCoverEntireJourney": [
              "string"
            ]
          }
        ]
      }
    ],
    "coveringPartOfJourney": [
      {
        "id": "id",
        "geographicalValidityCovered": {
          "coversEntireJourney": true,
          "serviceJourneys": [
            "string"
          ],
          "pointToPointValidity": {
            "fromPlace": {
              "id": "id",
              "name": "name"
            },
            "toPlace": {
              "id": "id",
              "name": "name"
            }
          },
          "zonalValidity": {
            "fromZone": {
              "id": "id",
              "name": "name"
            },
            "toZone": {
              "id": "id",
              "name": "name"
            },
            "viaZones": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "groupOfTariffZones": [
              {
                "id": "id",
                "name": "name"
              }
            ]
          }
        },
        "typeOfRecommendation": "CHEAPEST",
        "durationType": "DAY_PASS",
        "fareClass": "STANDARD_CLASS",
        "facilitySet": "SLEEPER",
        "offersToBuy": [
          {
            "id": "00faf83-56c3-4f4e-8be9-e793c255a77b",
            "numberToBuy": 2,
            "selectableProductIds": [
              "KEeaHd"
            ],
            "possibleTravellerIds": [
              [
                "Adult-1"
              ]
            ]
          }
        ],
        "combineWithToCoverEntireJourney": [
          {
            "geographicalValidityCovered": {
              "coversEntireJourney": true,
              "serviceJourneys": [
                "string"
              ],
              "pointToPointValidity": {
                "fromPlace": {
                  "id": "id",
                  "name": "name"
                },
                "toPlace": {
                  "id": "id",
                  "name": "name"
                }
              },
              "zonalValidity": {
                "fromZone": {
                  "id": "id",
                  "name": "name"
                },
                "toZone": {
                  "id": "id",
                  "name": "name"
                },
                "viaZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "groupOfTariffZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ]
              }
            },
            "recommendationsToCoverEntireJourney": [
              "string"
            ]
          }
        ]
      }
    ]
  },
  "optionalProducts": [
    {
      "id": "ENT:SupplementProduct:BicycleReserving",
      "version": "ENT:Version:V1",
      "selectableId": "ZO9Qjn",
      "name": "Bike as luggage",
      "description": "Bike as luggage",
      "price": {
        "amount": "100.00",
        "vatGroup": "TRANSPORT_AND_TICKETS_VAT",
        "currency": "NOK"
      },
      "properties": {
        "isExchangeable": true,
        "isRefundable": true,
        "accommodations": [
          {
            "example": {
              "serviceJourney": {
                "datedServiceJourneyId": "ENT:DatedServiceJourney:56179534",
                "serviceJourneyId": "ENT:ServiceJourney:1-435-119-202007111809"
              },
              "accommodation": "SLEEPER"
            }
          }
        ],
        "baggageTypes": [
          "BICYCLE"
        ],
        "reservingRequirements": [
          {
            "serviceJourney": {
              "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
              "serviceJourneyId": "ENT:ServiceJourney:56789"
            },
            "reservingRequirement": "RESERVATIONS_COMPULSORY",
            "seatMapIsAvailable": true
          }
        ],
        "userProfileSummary": {
          "example": {
            "id": "ENT:UserProfile:Adult",
            "version": "ENT:Version:V1",
            "name": "Ola Nordmann",
            "userType": "ADULT"
          }
        },
        "organisation": {
          "id": "ENT:Authority:TST",
          "name": "Example organisation"
        },
        "duration": "duration",
        "group": {
          "id": "ENT:GroupTicket:Family",
          "version": "ENT:Version:V1",
          "name": "Familiebillett",
          "description": "description",
          "userProfiles": [
            {
              "id": "id",
              "version": "version",
              "numberOfPeople": 0
            }
          ]
        },
        "fareClasses": [
          "STANDARD_CLASS"
        ],
        "carnet": {
          "amount": 10,
          "duration": "PT1H30M"
        },
        "durationType": "DAY_PASS",
        "nuisanceFacilities": [
          "ANIMALS_ALLOWED"
        ]
      },
      "geographicalValidity": {
        "serviceJourneys": [
          {
            "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
            "serviceJourneyId": "ENT:ServiceJourney:56789"
          }
        ],
        "pointToPointValidity": {
          "fromPlace": {
            "id": "id",
            "name": "name"
          },
          "toPlace": {
            "id": "id",
            "name": "name"
          }
        },
        "zonalValidity": {
          "fromZone": {
            "id": "id",
            "name": "name"
          },
          "toZone": {
            "id": "id",
            "name": "name"
          },
          "viaZones": [
            {
              "id": "id",
              "name": "name"
            }
          ],
          "groupOfTariffZones": [
            {
              "id": "id",
              "name": "name"
            }
          ]
        }
      },
      "discountRights": [
        {
          "example": {
            "id": "ENT:SaleDiscountRight:Premium",
            "version": "ENT:Version:SDR-Premium-1",
            "price": {
              "amount": "-739.00",
              "currency": "NOK"
            },
            "name": "Premiumrabatt"
          }
        }
      ],
      "available": 4,
      "supplementProductType": "BICYCLE"
    }
  ],
  "unavailableProducts": [
    {
      "id": "ENT:PreassignedFareProduct:StandardFullFlex",
      "name": "Enkeltbillett",
      "unavailableStatus": "NOT_YET_AVAILABLE",
      "serviceJourney": {
        "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
        "serviceJourneyId": "ENT:ServiceJourney:56789"
      },
      "properties": {
        "accommodations": [
          "SLEEPER"
        ],
        "fareClasses": [
          "STANDARD_CLASS"
        ],
        "isExchangeable": true,
        "isRefundable": true,
        "organisation": {
          "id": "ENT:Authority:TST",
          "name": "Example organisation"
        }
      }
    }
  ],
  "notices": [
    "string"
  ]
}

json

application/json

Search for offers by authority id.

POST

https://api.entur.io

/offers/v3/search/authority

Search for offers by authority id, this will only find offers with a flat tariff basis. Only PurchaseWindow, Authority, DistributionChannel and UserProfile constraints are considered.

Search for offers by authority id. › Headers

Entur-Distribution-Channel

string · pattern: ^[A-Z]{3}:Distributi… · required · style: simple

Id of distribution channel requesting offers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · minLength: 2 · maxLength: 2 · style: simple

The language code from IETF BCP 47

Default: nb

Entur-POS

string · style: simple

Point-of-sale identifier

Search for offers by authority id. › Request Body

A request used to search for fare products without inputting geographic data, but instead use Authority.

SearchAuthorityRequest

travelDate

string · date-time · required

Traveller[] · minItems: 1 · required

The travellers the offer should be valid for.

authorityId

string · pattern: ^[A-Z]{3}:Authority:… · required

NeTEx-id of Authority. Only offers valid for this Authority will be considered.

Search for offers by authority id. › Responses

A selection of offers valid for the given authority.

SearchResponse

OfferSummary[] · required

RecommendationResult · required

A set of recommendations matching the provided recommendation configuration.

tripPatternId

string

OptionalProduct[]

UnavailableProduct[]

notices

string[]

Additional information about potentially missing information or functionality due to transient errors.

POST/offers/v3/search/authority

curl https://api.entur.io/offers/v3/search/authority \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "travelDate": "2022-02-24T00:00:00+00",
  "travellers": [
    {
      "example": {
        "id": "ID_A",
        "userType": "ADULT",
        "productIds": [
          "ENT:PreassignedFareProduct:StandardFullFlex"
        ],
        "baggageTypes": [
          "BICYCLE"
        ]
      }
    }
  ],
  "authorityId": "ENT:Authority:1"
}'

Example Request Body

{
  "travelDate": "2022-02-24T00:00:00+00",
  "travellers": [
    {
      "example": {
        "id": "ID_A",
        "userType": "ADULT",
        "productIds": [
          "ENT:PreassignedFareProduct:StandardFullFlex"
        ],
        "baggageTypes": [
          "BICYCLE"
        ]
      }
    }
  ],
  "authorityId": "ENT:Authority:1"
}

json

Example Responses

{
  "tripPatternId": "5e7cbc83e58e6a00011cecc3",
  "offers": [
    {
      "id": "00faf83-56c3-4f4e-8be9-e793c255a77b",
      "name": "Flex Refunderbar",
      "salesPackageId": "salesPackageId",
      "salesPackageVersion": "salesPackageVersion",
      "description": "Flex Refunderbar",
      "price": {
        "amount": "100.00",
        "vatGroup": "TRANSPORT_AND_TICKETS_VAT",
        "currency": "NOK"
      },
      "availableFulfilmentMethods": [
        {
          "id": "id",
          "version": "version",
          "distributionRights": {
            "example": [
              "SELL",
              "REFUND"
            ]
          }
        }
      ],
      "geographicalValidity": {
        "serviceJourneys": [
          {
            "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
            "serviceJourneyId": "ENT:ServiceJourney:56789"
          }
        ],
        "pointToPointValidity": {
          "fromPlace": {
            "id": "id",
            "name": "name"
          },
          "toPlace": {
            "id": "id",
            "name": "name"
          }
        },
        "zonalValidity": {
          "fromZone": {
            "id": "id",
            "name": "name"
          },
          "toZone": {
            "id": "id",
            "name": "name"
          },
          "viaZones": [
            {
              "id": "id",
              "name": "name"
            }
          ],
          "groupOfTariffZones": [
            {
              "id": "id",
              "name": "name"
            }
          ]
        }
      },
      "preassignedProducts": [
        {
          "id": "ENT:PreassignedFareProduct:StandardFullFlex",
          "version": "ENT:Version:V1",
          "name": "Standard refunderbar",
          "description": "Standard refunderbar",
          "properties": {
            "isExchangeable": true,
            "isRefundable": true,
            "accommodations": [
              {
                "example": {
                  "serviceJourney": {
                    "datedServiceJourneyId": "ENT:DatedServiceJourney:56179534",
                    "serviceJourneyId": "ENT:ServiceJourney:1-435-119-202007111809"
                  },
                  "accommodation": "SLEEPER"
                }
              }
            ],
            "baggageTypes": [
              "BICYCLE"
            ],
            "reservingRequirements": [
              {
                "serviceJourney": {
                  "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
                  "serviceJourneyId": "ENT:ServiceJourney:56789"
                },
                "reservingRequirement": "RESERVATIONS_COMPULSORY",
                "seatMapIsAvailable": true
              }
            ],
            "userProfileSummary": {
              "example": {
                "id": "ENT:UserProfile:Adult",
                "version": "ENT:Version:V1",
                "name": "Ola Nordmann",
                "userType": "ADULT"
              }
            },
            "organisation": {
              "id": "ENT:Authority:TST",
              "name": "Example organisation"
            },
            "duration": "duration",
            "group": {
              "id": "ENT:GroupTicket:Family",
              "version": "ENT:Version:V1",
              "name": "Familiebillett",
              "description": "description",
              "userProfiles": [
                {
                  "id": "id",
                  "version": "version",
                  "numberOfPeople": 0
                }
              ]
            },
            "fareClasses": [
              "STANDARD_CLASS"
            ],
            "carnet": {
              "amount": 10,
              "duration": "PT1H30M"
            },
            "durationType": "DAY_PASS",
            "nuisanceFacilities": [
              "ANIMALS_ALLOWED"
            ]
          },
          "geographicalValidity": {
            "serviceJourneys": [
              {
                "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
                "serviceJourneyId": "ENT:ServiceJourney:56789"
              }
            ],
            "pointToPointValidity": {
              "fromPlace": {
                "id": "id",
                "name": "name"
              },
              "toPlace": {
                "id": "id",
                "name": "name"
              }
            },
            "zonalValidity": {
              "fromZone": {
                "id": "id",
                "name": "name"
              },
              "toZone": {
                "id": "id",
                "name": "name"
              },
              "viaZones": [
                {
                  "id": "id",
                  "name": "name"
                }
              ],
              "groupOfTariffZones": [
                {
                  "id": "id",
                  "name": "name"
                }
              ]
            }
          },
          "discountRights": [
            {
              "example": {
                "id": "ENT:SaleDiscountRight:Premium",
                "version": "ENT:Version:SDR-Premium-1",
                "price": {
                  "amount": "-739.00",
                  "currency": "NOK"
                },
                "name": "Premiumrabatt"
              }
            }
          ]
        }
      ],
      "optionalProductsSelectableIds": [
        "XXFicO"
      ],
      "travellerMapping": [
        {
          "travellerIds": [
            "ID_A"
          ],
          "maxNumberOfTravellers": 0,
          "minNumberOfTravellers": 0,
          "userType": "ADULT"
        }
      ],
      "available": 14,
      "cappedDiscountOption": {
        "cappedDiscountRightRef": {
          "ref": "ref",
          "version": "version"
        },
        "cappedDiscountRuleRef": {
          "ref": "ref",
          "version": "version"
        },
        "alternatives": [
          {
            "selectableId": "selectableId",
            "discount": {
              "amount": "100.00",
              "vatGroup": "TRANSPORT_AND_TICKETS_VAT",
              "currency": "NOK"
            },
            "startDateTime": "2024-08-25T15:00:00Z",
            "endDateTime": "2024-08-25T15:00:00Z"
          }
        ]
      },
      "eligibleForAccrualInPrograms": [
        {
          "id": "9",
          "reference": "entur_reis",
          "name": "Entur Reis",
          "infoLink": "infoLink",
          "paused": false
        }
      ],
      "availablePrograms": [
        {
          "id": "9",
          "reference": "entur_reis",
          "name": "Entur Reis",
          "infoLink": "infoLink"
        }
      ]
    }
  ],
  "recommendations": {
    "coveringEntireJourney": [
      {
        "id": "id",
        "geographicalValidityCovered": {
          "coversEntireJourney": true,
          "serviceJourneys": [
            "string"
          ],
          "pointToPointValidity": {
            "fromPlace": {
              "id": "id",
              "name": "name"
            },
            "toPlace": {
              "id": "id",
              "name": "name"
            }
          },
          "zonalValidity": {
            "fromZone": {
              "id": "id",
              "name": "name"
            },
            "toZone": {
              "id": "id",
              "name": "name"
            },
            "viaZones": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "groupOfTariffZones": [
              {
                "id": "id",
                "name": "name"
              }
            ]
          }
        },
        "typeOfRecommendation": "CHEAPEST",
        "durationType": "DAY_PASS",
        "fareClass": "STANDARD_CLASS",
        "facilitySet": "SLEEPER",
        "offersToBuy": [
          {
            "id": "00faf83-56c3-4f4e-8be9-e793c255a77b",
            "numberToBuy": 2,
            "selectableProductIds": [
              "KEeaHd"
            ],
            "possibleTravellerIds": [
              [
                "Adult-1"
              ]
            ]
          }
        ],
        "combineWithToCoverEntireJourney": [
          {
            "geographicalValidityCovered": {
              "coversEntireJourney": true,
              "serviceJourneys": [
                "string"
              ],
              "pointToPointValidity": {
                "fromPlace": {
                  "id": "id",
                  "name": "name"
                },
                "toPlace": {
                  "id": "id",
                  "name": "name"
                }
              },
              "zonalValidity": {
                "fromZone": {
                  "id": "id",
                  "name": "name"
                },
                "toZone": {
                  "id": "id",
                  "name": "name"
                },
                "viaZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "groupOfTariffZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ]
              }
            },
            "recommendationsToCoverEntireJourney": [
              "string"
            ]
          }
        ]
      }
    ],
    "coveringPartOfJourney": [
      {
        "id": "id",
        "geographicalValidityCovered": {
          "coversEntireJourney": true,
          "serviceJourneys": [
            "string"
          ],
          "pointToPointValidity": {
            "fromPlace": {
              "id": "id",
              "name": "name"
            },
            "toPlace": {
              "id": "id",
              "name": "name"
            }
          },
          "zonalValidity": {
            "fromZone": {
              "id": "id",
              "name": "name"
            },
            "toZone": {
              "id": "id",
              "name": "name"
            },
            "viaZones": [
              {
                "id": "id",
                "name": "name"
              }
            ],
            "groupOfTariffZones": [
              {
                "id": "id",
                "name": "name"
              }
            ]
          }
        },
        "typeOfRecommendation": "CHEAPEST",
        "durationType": "DAY_PASS",
        "fareClass": "STANDARD_CLASS",
        "facilitySet": "SLEEPER",
        "offersToBuy": [
          {
            "id": "00faf83-56c3-4f4e-8be9-e793c255a77b",
            "numberToBuy": 2,
            "selectableProductIds": [
              "KEeaHd"
            ],
            "possibleTravellerIds": [
              [
                "Adult-1"
              ]
            ]
          }
        ],
        "combineWithToCoverEntireJourney": [
          {
            "geographicalValidityCovered": {
              "coversEntireJourney": true,
              "serviceJourneys": [
                "string"
              ],
              "pointToPointValidity": {
                "fromPlace": {
                  "id": "id",
                  "name": "name"
                },
                "toPlace": {
                  "id": "id",
                  "name": "name"
                }
              },
              "zonalValidity": {
                "fromZone": {
                  "id": "id",
                  "name": "name"
                },
                "toZone": {
                  "id": "id",
                  "name": "name"
                },
                "viaZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ],
                "groupOfTariffZones": [
                  {
                    "id": "id",
                    "name": "name"
                  }
                ]
              }
            },
            "recommendationsToCoverEntireJourney": [
              "string"
            ]
          }
        ]
      }
    ]
  },
  "optionalProducts": [
    {
      "id": "ENT:SupplementProduct:BicycleReserving",
      "version": "ENT:Version:V1",
      "selectableId": "ZO9Qjn",
      "name": "Bike as luggage",
      "description": "Bike as luggage",
      "price": {
        "amount": "100.00",
        "vatGroup": "TRANSPORT_AND_TICKETS_VAT",
        "currency": "NOK"
      },
      "properties": {
        "isExchangeable": true,
        "isRefundable": true,
        "accommodations": [
          {
            "example": {
              "serviceJourney": {
                "datedServiceJourneyId": "ENT:DatedServiceJourney:56179534",
                "serviceJourneyId": "ENT:ServiceJourney:1-435-119-202007111809"
              },
              "accommodation": "SLEEPER"
            }
          }
        ],
        "baggageTypes": [
          "BICYCLE"
        ],
        "reservingRequirements": [
          {
            "serviceJourney": {
              "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
              "serviceJourneyId": "ENT:ServiceJourney:56789"
            },
            "reservingRequirement": "RESERVATIONS_COMPULSORY",
            "seatMapIsAvailable": true
          }
        ],
        "userProfileSummary": {
          "example": {
            "id": "ENT:UserProfile:Adult",
            "version": "ENT:Version:V1",
            "name": "Ola Nordmann",
            "userType": "ADULT"
          }
        },
        "organisation": {
          "id": "ENT:Authority:TST",
          "name": "Example organisation"
        },
        "duration": "duration",
        "group": {
          "id": "ENT:GroupTicket:Family",
          "version": "ENT:Version:V1",
          "name": "Familiebillett",
          "description": "description",
          "userProfiles": [
            {
              "id": "id",
              "version": "version",
              "numberOfPeople": 0
            }
          ]
        },
        "fareClasses": [
          "STANDARD_CLASS"
        ],
        "carnet": {
          "amount": 10,
          "duration": "PT1H30M"
        },
        "durationType": "DAY_PASS",
        "nuisanceFacilities": [
          "ANIMALS_ALLOWED"
        ]
      },
      "geographicalValidity": {
        "serviceJourneys": [
          {
            "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
            "serviceJourneyId": "ENT:ServiceJourney:56789"
          }
        ],
        "pointToPointValidity": {
          "fromPlace": {
            "id": "id",
            "name": "name"
          },
          "toPlace": {
            "id": "id",
            "name": "name"
          }
        },
        "zonalValidity": {
          "fromZone": {
            "id": "id",
            "name": "name"
          },
          "toZone": {
            "id": "id",
            "name": "name"
          },
          "viaZones": [
            {
              "id": "id",
              "name": "name"
            }
          ],
          "groupOfTariffZones": [
            {
              "id": "id",
              "name": "name"
            }
          ]
        }
      },
      "discountRights": [
        {
          "example": {
            "id": "ENT:SaleDiscountRight:Premium",
            "version": "ENT:Version:SDR-Premium-1",
            "price": {
              "amount": "-739.00",
              "currency": "NOK"
            },
            "name": "Premiumrabatt"
          }
        }
      ],
      "available": 4,
      "supplementProductType": "BICYCLE"
    }
  ],
  "unavailableProducts": [
    {
      "id": "ENT:PreassignedFareProduct:StandardFullFlex",
      "name": "Enkeltbillett",
      "unavailableStatus": "NOT_YET_AVAILABLE",
      "serviceJourney": {
        "datedServiceJourneyId": "ENT:DatedServiceJourney:12345",
        "serviceJourneyId": "ENT:ServiceJourney:56789"
      },
      "properties": {
        "accommodations": [
          "SLEEPER"
        ],
        "fareClasses": [
          "STANDARD_CLASS"
        ],
        "isExchangeable": true,
        "isRefundable": true,
        "organisation": {
          "id": "ENT:Authority:TST",
          "name": "Example organisation"
        }
      }
    }
  ],
  "notices": [
    "string"
  ]
}

json

application/json

Did you find what you were looking for?

Build with Entur

Contribute

Terms & Policies

Search offers

Search for Offers using a specific trip pattern.

Search for Offers using a specific trip pattern. › Headers

Search for Offers using a specific trip pattern. › Request Body

Search for Offers using a specific trip pattern. › Responses

Search for offers by geographical-locations.

Search for offers by geographical-locations. › Headers

Search for offers by geographical-locations. › Request Body

Search for offers by geographical-locations. › Responses

Search for offers by authority id.

Search for offers by authority id. › Headers

Search for offers by authority id. › Request Body

Search for offers by authority id. › Responses