Reserve Offers

Reserve Offers

Server

Download schema

Add regular products to order through offer.

Update order lines in an order with reservable offers

POST

https://api.staging.entur.io/sales

/v1/update-order

Updates a set of order lines on an order with new offer and traveller details

Update order lines in an order with reservable offers › Headers

Entur-Distribution-Channel

string · required · style: simple

A header containing the distribution channel ID.

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

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

Update order lines in an order with reservable offers › Request Body

The holder for a change offer configuration.

ChangeOrderLinesRequest

orderId

string · required

The order to add the offer(s) to

Example: ABCD1234

ChangeOrderLinesConfiguration[] · required

A list of change offer configurations selected for purchase

refundPriceDifference

boolean · required

Experimental value that is used to refund the price difference between the original purchase and the change, if the change is cheaper than the original product.

Default: false

Update order lines in an order with reservable offers › Responses

A wrapper that holds the resulting ids for newly created order lines, reservations and possible replacement order lines

OrderLineIdsAndReservationIds

orderId

string · required

orderLineIds

string[] · required

reservationIds

string[] · required

ReplacedOrderLineIds[] · required

Default: []

POST/v1/update-order

curl https://api.staging.entur.io/sales/v1/update-order \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "orderId": "ABCD1234",
  "offerConfigurations": [
    {
      "offerId": "6b166022-bfca-4b92-b093-34a54ab2063e",
      "orderLineId": "fc93f175-5518-4a72-9618-43ae68804d4a",
      "selectableProductIds": [
        "gjk956"
      ],
      "selectedTravellerIds": [
        "2e761c3f-ce97-4305-a01c-6aef40daafa2"
      ]
    }
  ],
  "refundPriceDifference": false
}'

Example Request Body

{
  "orderId": "ABCD1234",
  "offerConfigurations": [
    {
      "offerId": "6b166022-bfca-4b92-b093-34a54ab2063e",
      "orderLineId": "fc93f175-5518-4a72-9618-43ae68804d4a",
      "selectableProductIds": [
        "gjk956"
      ],
      "selectedTravellerIds": [
        "2e761c3f-ce97-4305-a01c-6aef40daafa2"
      ]
    }
  ],
  "refundPriceDifference": false
}

json

application/json

Example Responses

{
  "orderId": "ABCD1234",
  "orderLineIds": [
    "fc93f175-5518-4a72-9618-43ae68804d4a"
  ],
  "reservationIds": [
    "deeb861c-e732-4689-b148-f575f8ca71c1"
  ],
  "replacedByOrderLineIds": []
}

json

application/json

Add reservable offers to an order

POST

https://api.staging.entur.io/sales

/v1/reserve-offers

Takes a set of offerIds which might need reservations, performs reservations where applicable and adds the offers as orderlines to an existing order

Add reservable offers to an order › Headers

Entur-Distribution-Channel

string · required · style: simple

A header containing the distribution channel ID.

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Add reservable offers to an order › Request Body

The input-holder for reserving offers and add them to an existing order.

ReserveOffersRequest

OfferConfiguration[] · required

A list of offer configurations selected for purchase

orderId

string

The offer to add the order to. If no orderId is specified, a new order is created

Example: ABCD1234

Add reservable offers to an order › Responses

A wrapper that holds the resulting ids for newly created order lines, reservations and possible replacement order lines

OrderLineIdsAndReservationIds

orderId

string · required

orderLineIds

string[] · required

reservationIds

string[] · required

ReplacedOrderLineIds[] · required

Default: []

POST/v1/reserve-offers

curl https://api.staging.entur.io/sales/v1/reserve-offers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "offerConfigurations": [
    {
      "offerId": "5d3e9d2c-f9ab-4dd0-a735-100886278e0b",
      "customers": [
        {
          "customerId": "12345678",
          "entitlements": [
            {
              "contractId": "33370312-aa00-4d22-8ffb-704418d77484",
              "entitlementProductRef": {
                "id": "ABC:Entitlement:abcd1234-ab12-cd34-ef56-abcdef123456"
              }
            }
          ]
        }
      ],
      "distributionDetails": {
        "customerAccountRef": {
          "id": "ABC:CustomerAccount:dcf4df02-aa15-4062-a694-3426dc27d03f"
        },
        "fulfillmentMethodRef": {
          "id": "ENT:FulfilmentMethod:Electronic"
        }
      },
      "selectableProductIds": [
        "frt567"
      ],
      "selectedTravellerIds": [
        "37a07da0-c972-4e8f-b5f3-553856da49d9"
      ]
    }
  ]
}'

Example Request Body

{
  "offerConfigurations": [
    {
      "offerId": "5d3e9d2c-f9ab-4dd0-a735-100886278e0b",
      "customers": [
        {
          "customerId": "12345678",
          "entitlements": [
            {
              "contractId": "33370312-aa00-4d22-8ffb-704418d77484",
              "entitlementProductRef": {
                "id": "ABC:Entitlement:abcd1234-ab12-cd34-ef56-abcdef123456"
              }
            }
          ]
        }
      ],
      "distributionDetails": {
        "customerAccountRef": {
          "id": "ABC:CustomerAccount:dcf4df02-aa15-4062-a694-3426dc27d03f"
        },
        "fulfillmentMethodRef": {
          "id": "ENT:FulfilmentMethod:Electronic"
        }
      },
      "selectableProductIds": [
        "frt567"
      ],
      "selectedTravellerIds": [
        "37a07da0-c972-4e8f-b5f3-553856da49d9"
      ]
    }
  ]
}

json

application/json

Example Responses

{
  "orderId": "ABCD1234",
  "orderLineIds": [
    "fc93f175-5518-4a72-9618-43ae68804d4a"
  ],
  "reservationIds": [
    "e9729837-375b-4369-991f-54adf35dd2fd"
  ],
  "replacedByOrderLineIds": []
}

json

application/json

Update order lines in an order with additional supplement products

POST

https://api.staging.entur.io/sales

/v1/update-order/supplement-products

Updates a set of order lines on an order with additional supplement products. Only products which does not modify current seating are currently supported.

Update order lines in an order with additional supplement products › Headers

Entur-Distribution-Channel

string · required · style: simple

A header containing the distribution channel ID.

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Update order lines in an order with additional supplement products › Request Body

The holder for an add supplement product configuration.

AddSupplementProductsRequest

orderId

string · required

The order to add the supplement product(s) to

Example: ABCD1234

AddSupplementProductsConfiguration[] · required

A list of supplement product configurations selected for purchase

Update order lines in an order with additional supplement products › Responses

A wrapper that holds the resulting ids for newly created order lines, reservations and possible replacement order lines

OrderLineIdsAndReservationIds

orderId

string · required

orderLineIds

string[] · required

reservationIds

string[] · required

ReplacedOrderLineIds[] · required

Default: []

POST/v1/update-order/supplement-products

curl https://api.staging.entur.io/sales/v1/update-order/supplement-products \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "orderId": "ABCD1234",
  "offerConfigurations": [
    {
      "offerId": "6b166022-bfca-4b92-b093-34a54ab2063e",
      "orderLineId": "fc93f175-5518-4a72-9618-43ae68804d4a",
      "selectedProductsConfiguration": [
        {
          "count": 2,
          "selectedProductId": "ybe287"
        }
      ]
    }
  ]
}'

Example Request Body

{
  "orderId": "ABCD1234",
  "offerConfigurations": [
    {
      "offerId": "6b166022-bfca-4b92-b093-34a54ab2063e",
      "orderLineId": "fc93f175-5518-4a72-9618-43ae68804d4a",
      "selectedProductsConfiguration": [
        {
          "count": 2,
          "selectedProductId": "ybe287"
        }
      ]
    }
  ]
}

json

application/json

Example Responses

{
  "orderId": "ABCD1234",
  "orderLineIds": [
    "fc93f175-5518-4a72-9618-43ae68804d4a"
  ],
  "reservationIds": [
    "deeb861c-e732-4689-b148-f575f8ca71c1"
  ],
  "replacedByOrderLineIds": []
}

json

application/json

Reserve Third Party Products

Update order lines in an order with reservable offers

POST

https://api.staging.entur.io/sales

/v1/update-order

Updates a set of order lines on an order with new offer and traveller details

Update order lines in an order with reservable offers › Headers

Entur-Distribution-Channel

string · required · style: simple

A header containing the distribution channel ID.

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Update order lines in an order with reservable offers › Request Body

The holder for a change offer configuration.

ChangeOrderLinesRequest

orderId

string · required

The order to add the offer(s) to

Example: ABCD1234

ChangeOrderLinesConfiguration[] · required

A list of change offer configurations selected for purchase

refundPriceDifference

boolean · required

Experimental value that is used to refund the price difference between the original purchase and the change, if the change is cheaper than the original product.

Default: false

Update order lines in an order with reservable offers › Responses

A wrapper that holds the resulting ids for newly created order lines, reservations and possible replacement order lines

OrderLineIdsAndReservationIds

orderId

string · required

orderLineIds

string[] · required

reservationIds

string[] · required

ReplacedOrderLineIds[] · required

Default: []

Add reservable offers to an order

POST

https://api.staging.entur.io/sales

/v1/reserve-offers

Takes a set of offerIds which might need reservations, performs reservations where applicable and adds the offers as orderlines to an existing order

Add reservable offers to an order › Headers

Entur-Distribution-Channel

string · required · style: simple

A header containing the distribution channel ID.

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Add reservable offers to an order › Request Body

The input-holder for reserving offers and add them to an existing order.

ReserveOffersRequest

OfferConfiguration[] · required

A list of offer configurations selected for purchase

orderId

string

The offer to add the order to. If no orderId is specified, a new order is created

Example: ABCD1234

Add reservable offers to an order › Responses

A wrapper that holds the resulting ids for newly created order lines, reservations and possible replacement order lines

OrderLineIdsAndReservationIds

orderId

string · required

orderLineIds

string[] · required

reservationIds

string[] · required

ReplacedOrderLineIds[] · required

Default: []

Update order lines in an order with additional supplement products

POST

https://api.staging.entur.io/sales

/v1/update-order/supplement-products

Updates a set of order lines on an order with additional supplement products. Only products which does not modify current seating are currently supported.

Update order lines in an order with additional supplement products › Headers

Entur-Distribution-Channel

string · required · style: simple

A header containing the distribution channel ID.

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Update order lines in an order with additional supplement products › Request Body

The holder for an add supplement product configuration.

AddSupplementProductsRequest

orderId

string · required

The order to add the supplement product(s) to

Example: ABCD1234

AddSupplementProductsConfiguration[] · required

A list of supplement product configurations selected for purchase

Update order lines in an order with additional supplement products › Responses

A wrapper that holds the resulting ids for newly created order lines, reservations and possible replacement order lines

OrderLineIdsAndReservationIds

orderId

string · required

orderLineIds

string[] · required

reservationIds

string[] · required

ReplacedOrderLineIds[] · required

Default: []

Update order lines in an order with reservable offers

Update order lines in an order with reservable offers › Headers

Update order lines in an order with reservable offers › Request Body

Update order lines in an order with reservable offers › Responses

Add reservable offers to an order

Add reservable offers to an order › Headers

Add reservable offers to an order › Request Body

Add reservable offers to an order › Responses

Update order lines in an order with additional supplement products

Update order lines in an order with additional supplement products › Headers

Update order lines in an order with additional supplement products › Request Body

Update order lines in an order with additional supplement products › Responses

Build with Entur

Contribute

Terms & Policies

Reserve Offers

Update order lines in an order with reservable offers

Update order lines in an order with reservable offers › Headers

Update order lines in an order with reservable offers › Request Body

Update order lines in an order with reservable offers › Responses

Add reservable offers to an order

Add reservable offers to an order › Headers

Add reservable offers to an order › Request Body

Add reservable offers to an order › Responses

Update order lines in an order with additional supplement products

Update order lines in an order with additional supplement products › Headers

Update order lines in an order with additional supplement products › Request Body

Update order lines in an order with additional supplement products › Responses