Search offers

Server

Download schema

Endpoints that are available for generating offers by various means.

Update offer with capped discount alternative.

PATCH

https://api.entur.io

/offers/v3/{id}

Update offer with capped discount alternative.

Update offer with capped discount alternative. › path Parameters

id

string · uuid · required · style: simple

Id of the offer

Update offer with capped discount alternative. › Headers

Entur-Distribution-Channel

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

Id of distribution channel requesting offers

ET-Client-Name

string

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> for companies, and <personal name>-<application> for individuals.

X-Correlation-Id

string

Correlation id

Accept-Language

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

The language code from IETF BCP 47

Default: nb

Update offer with capped discount alternative. › Request Body

UpdateOfferWithCappedDiscountAlternativeRequest

selectableId

string · required

Selectable id of the capped discount alternative.

Update offer with capped discount alternative. › Responses

An offer updated with a capped discount alternative.

OfferSummary

id

string · required

The id of an offer. This id will be referenced in recommendations where there are "offersToBuy". Also, the offerId can be used to obtain the original offer-structure from v1.

name

string · required

The name of the SalesPackage that this OfferSummary represents.

Price · required

Price with currency and optional VAT information for this element.

description

string · required

The description of the offer.

salesPackageId

string · required

Id of the SalesPackage.

PreassignedProduct[] · required

All mandatory products that give the buyer a right to travel is found here.

salesPackageVersion

string · required

Version of the SalesPackage.

GeographicalValidity · required

Describes the geographical validity of a product. Includes information on ServiceJourneys, PointToPointValidity and ZonalValidity. In cases of replacement transport, these fields describe the replacement journey.

AvailableFulfilmentMethod[] · required

available

integer

Number of this offer available to buy at this point in time.

TravellerMappingSummary[]

Mapping of which travellers this offer applies to.

ProgramSummary[]

The customer may join the following programs to get points from buying this offer. It is expected that the caller does work to add the customer to the program.

CappedDiscountOption

A discount might be given based on previous transactions if CappedDiscountRequest was specified. A cappingSpecification must be specified in the traveller attribute in the request to the search/ endpoints in order to receive a discount. Capping must also be enabled by the operator of the service journey.

ProgramAccrualSummary[]

Buying this offer may give points in these personalisation programs.

optionalProductsSelectableIds

string[] · minItems: 1

This field contains an array of selectableId's to optional products associated with an offer. The optional products are found in the field "optionalProducts" in the search response.

PATCH/offers/v3/{id}

curl https://api.entur.io/offers/v3/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "selectableId": "selectableId"
}'

Example Request Body

{
  "selectableId": "selectableId"
}

json

Example Responses

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

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

X-Correlation-Id

string

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

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.

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.

notices

string[]

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

tripPatternId

string

OptionalProduct[]

UnavailableProduct[]

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

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

json

application/json

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

X-Correlation-Id

string

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.

GroupConfig

A configuration of how to group travellers in offers.

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].

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.

notices

string[]

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

tripPatternId

string

OptionalProduct[]

UnavailableProduct[]

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"
        ]
      }
    }
  ],
  "groupConfig": {
    "numberOfCompartments": 0
  },
  "tripPattern": {
    "legs": [
      {
        "travelDate": "2020-05-13",
        "toStopPlaceId": "NSR:StopPlace:640",
        "travelDateTime": "2024-02-24T00:00:00+00",
        "fromStopPlaceId": "NSR:StopPlace:635",
        "serviceJourneyId": "ENT:ServiceJourney:1-232-1016-20201117132"
      }
    ]
  },
  "recommendationConfig": {
    "ruleSpec": {
      "journeyOrganizeAlgorithm": "SUBSEQUENT_COMBINATIONS",
      "priceComparisonAlgorithm": "TOTAL_PRICE",
      "onlyIncludeRecommendedOffers": true,
      "mixInOffersWithHigherFlexibility": true,
      "mixInOffersWithOtherFacilitySets": true,
      "onlyKeepUpgradeProductSalesPackages": false,
      "onlyIncludeMostCompleteInCategorySpec": false,
      "onlyIncludeRecommendationsWithOffersToBuy": true
    },
    "categorySpec": {
      "example": {
        "facilitySet": [
          "SLEEPER",
          "SEATING"
        ],
        "fareClasses": [
          "FIRST_CLASS"
        ],
        "durationTypes": [
          "DAY_PASS",
          "SINGLE_TRIP"
        ],
        "typesOfRecommendation": [
          "FLEXIBLE",
          "CHEAPEST"
        ]
      }
    }
  },
  "includeMultiTripOffers": false
}'

Example Request Body

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

json

Example Responses

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

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

X-Correlation-Id

string

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

to

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

The id of the destination stop place or zone.

from

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

The id of the origin stop place or zone.

travelDate

string · date-time · required

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.

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.

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

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.

notices

string[]

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

tripPatternId

string

OptionalProduct[]

UnavailableProduct[]

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

Example Request Body

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

json

Example Responses

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

json

application/json

Build with Entur

Contribute

Terms & Policies

Search offers

Update offer with capped discount alternative.

Update offer with capped discount alternative. › path Parameters

Update offer with capped discount alternative. › Headers

Update offer with capped discount alternative. › Request Body

Update offer with capped discount alternative. › 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

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