Reserve Third Party Products

Server

Download schema

Add external products to order.

Add a third party product to an order

POST

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

/v1beta/reserve-third-party-products

Take one or more third party products and add them as order lines to an existing order

Add a third party product 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 · style: simple

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

X-Correlation-Id

string · style: simple

Correlation id

Add a third party product to an order › Request Body

The requested list of third party products to create and add to the order.

ReserveThirdPartyProductsRequest

orderId

string · required

The orderId the third party products belongs to.

Example: ABCD1234

ThirdPartyProductConfiguration[] · minItems: 1 · unique · required

Add a third party product to an order › Responses

The order lines created when reserving third party product on the given order

ReserveThirdPartyProductsResponse

orderId

string · required

orderLineIds

string[] · required

POST/v1beta/reserve-third-party-products

curl https://api.staging.entur.io/sales/v1beta/reserve-third-party-products \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "orderId": "ABCD1234",
  "thirdPartyProductConfigurations": [
    {
      "productRef": {
        "id": "EXT:ThirdPartyProduct:Baguette"
      },
      "quantity": 2,
      "name": [
        {
          "lang": "eng",
          "value": "La baguette"
        }
      ],
      "price": {
        "amount": "50.00",
        "taxAmount": "2.00",
        "currency": "NOK"
      },
      "priceContribution": {
        "amount": "50.00",
        "taxAmount": "2.00",
        "taxRate": "0.04",
        "currency": "NOK"
      },
      "parameters": {
        "userProfile": {
          "userProfileRef": {
            "id": "EXT:UserProfile:Adult"
          },
          "name": [
            {
              "lang": "eng",
              "value": "Adult"
            }
          ]
        }
      },
      "externalReference": "external-ref-5678"
    }
  ]
}'

Example Request Body

{
  "orderId": "ABCD1234",
  "thirdPartyProductConfigurations": [
    {
      "productRef": {
        "id": "EXT:ThirdPartyProduct:Baguette"
      },
      "quantity": 2,
      "name": [
        {
          "lang": "eng",
          "value": "La baguette"
        }
      ],
      "price": {
        "amount": "50.00",
        "taxAmount": "2.00",
        "currency": "NOK"
      },
      "priceContribution": {
        "amount": "50.00",
        "taxAmount": "2.00",
        "taxRate": "0.04",
        "currency": "NOK"
      },
      "parameters": {
        "userProfile": {
          "userProfileRef": {
            "id": "EXT:UserProfile:Adult"
          },
          "name": [
            {
              "lang": "eng",
              "value": "Adult"
            }
          ]
        }
      },
      "externalReference": "external-ref-5678"
    }
  ]
}

json

application/json

Example Responses

{
  "orderId": "ABCD1234",
  "orderLineIds": [
    "09f682e5-5cb4-4a1a-a2d7-168d95164bf6"
  ]
}

json

application/json

Reserve Offers Change Options

Did you find what you were looking for?

Reserve Third Party Products

Add a third party product to an order

Add a third party product to an order › Headers

Add a third party product to an order › Request Body

Add a third party product to an order › Responses

Build with Entur

Contribute

Terms & Policies