Transport - Configurable Railway Products

Configurable Railway Products are predefined railway products which map to a specific preset of stations/options. The difference in the flow to the mountain railway one, is that we retrieve stations, reductions, travel class and other predefined data in a single /catalog/product/{product_id} call.

• OpenAPI Documentation (opens new window)
• JAMES Proxy (opens new window)

1. Get Product

Get general and type specific information for a product

/catalog/products/QkVSR0JBSE4uQU5HRUJPVC5URVNUMQ== (opens new window)

GET /catalog/products/QkVSR0JBSE4uQU5HRUJPVC5URVNUMQ==

{
  "typeSpecific": {
    "from": [
      {
        "id": 1553741,
        "name": "Andermatt",
        "mode": [
          "train"
        ],
        "frequentlyRequested": true
      }
    ],
    "to": [
      {
        "id": 1564132,
        "name": "Gütsch",
        "mode": [
          "train"
        ],
        "frequentlyRequested": true
      }
    ],
    "tariffs": [
      {
        "value": "956",
        "label": "Normaltarif"
      }
    ],
    "tripTypes": [
      {
        "value": "971",
        "label": "Retour"
      }
    ],
    "reductions": [
      {
        "value": "a.974.956",
        "label": "Erwachsener"
      },
      {
        "value": "b.1258.956",
        "label": "Kind (6-15 Jahre)"
      },
      {
        "value": "b.3921.956",
        "label": "Senior"
      },
      {
        "value": "b.3920.956",
        "label": "Schüler/Jugendlicher"
      }
    ],
    "validity": "D",
    "travelClass": "second"
  },
  "id": "QkVSR0JBSE4uQU5HRUJPVC5URVNUMQ==",
  "name": "Configurable Mountain Railway Product 1",
  "images": [],
  "price": {
    "value": 23,
    "currency": "CHF"
  },
  "availability": {
    "start": "2021-03-01",
    "end": "2022-03-01"
  },
  "type": "transport"
}

2. Routes

After retrieving general information about the product and typeSpecific information we need to specify the departureStationId, arrivalStationId, the travelClass and the outwardTravelDate.

If we want to get the routes for a Two Way Ticket, we need to specify also the returnTravelDate.

WARNING

Notice that we need to add the productId to the request endpoint the get the right data for the routes.

POST /transport/routes/QkVSR0JBSE4uQU5HRUJPVC5URVNUMQ==

Request Body

{
  "departureStationId": 1553741,
  "arrivalStationId": 1564132,
  "travelClass": "second",
  "outwardTravelDate": {
    "date": "2021-05-27",
    "type": "departure"
  }
}

{
  "stations": [
    {
      "id": 1553741,
      "name": "Andermatt",
      "mode": [
        "train"
      ],
      "frequentlyRequested": true
    },
    {
      "id": 1564132,
      "name": "Gütsch",
      "mode": [
        "train"
      ],
      "frequentlyRequested": true
    }
  ],
  "outward": [
    [
      {
        "id": "I3N5c3RlbT1zYmIjZnJvbT1BbmRlcm1hdHQjdG89R8O8dHNjaCN2aWE9QW5kZXJtYXR0IC0gR3Vyc2NoZW4jdHJpcFR5cGU9TyN0cmF2ZWxDbGFzcz1zZWNvbmQjdHJhaW5UeXBlPSNyZXNlcnZhdGlvblByaWNlPTAjcmVzZXJ2YXRpb25UeXBlPSNkYXl0cmlwSWQ9I2NvbmZpZ3VyYWJsZUlkPTkxOSNyZXNlcnZEYXl0cmlwSWQ9I3RpbWVzdGFtcD0xNjIyMDczNjAwI2RlcGFydHVyZVRpbWU9I2Fycml2YWxUaW1lPSN0cmFpbk5yPSN0cmF2ZWxUeXBlPU91dHdhcmRUcmF2ZWwjc2VnbWVudHM9",
        "departureStationId": 1553741,
        "arrivalStationId": 1564132,
        "via": "Andermatt - Gurschen",
        "price": {
          "value": 23,
          "currency": "CHF"
        },
        "segmentsId": "730ef2fccec2d8d1af25c725e9e28975",
        "segments": [
          {
            "id": "1",
            "departureStationId": 1553741,
            "arrivalStationId": 1564132,
            "travelClass": "second",
            "mode": "train",
            "reservation": "unavailable"
          }
        ]
      }
    ]
  ]
}

Now we can continue with our normal mountain railway flow at the optional variants or offers call