Third Party Products by Order

Server

Download schema

Get third party products for an order

GET

https://api.entur.io/sales

/v1/third-party-products/orders/{orderId}

Returns third party products for given orderId

Get third party products for an order › path Parameters

orderId

string · required · style: simple

The id of the order.

Get third party products for an order › Headers

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

Get third party products for an order › Responses

Response containing third party products.

ThirdPartyProductsResponse

ThirdPartyProduct[] · required

GET/v1/third-party-products/orders/{orderId}

curl https://api.entur.io/sales/v1/third-party-products/orders/:orderId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "thirdPartyProducts": [
    {
      "name": [
        {
          "lang": "eng",
          "value": "Wayfare luggage space reservation"
        },
        {
          "lang": "nob",
          "value": "Wayfare bagasjeplassreservasjon"
        }
      ],
      "price": {
        "amount": "59.00",
        "taxCode": "03",
        "taxRate": "25.00",
        "currency": "NOK",
        "taxAmount": "11.80"
      },
      "orderId": "WAYFARE-ORDER-98765",
      "parameters": {},
      "productRef": {
        "id": "WAYFARE:ThirdPartyProduct:LuggageReservation",
        "version": "WAYFARE:Version:LuggageReservation-1"
      },
      "authorityId": "WAYFARE:Authority:WAYFARE",
      "orderLineId": "WAYFARE-ORDERLINE-2",
      "orderVersion": 1,
      "orderLineVersion": 1,
      "priceContribution": {
        "amount": "59.00",
        "taxCode": "03",
        "taxRate": "25.00",
        "currency": "NOK",
        "taxAmount": "11.80"
      }
    }
  ]
}

json

application/json

Get specific third party product for an orderLine

GET

https://api.entur.io/sales

/v1/third-party-products/orders/{orderId}/order-lines/{orderLineId}

Returns third party products for given orderId, orderLineId and orderLineVersion. A Third party product is a product in the system that belongs to an external provider/operator, but is sold or handled through our platform.

Get specific third party product for an orderLine › path Parameters

orderId

string · required · style: simple

The id of the order.

orderLineId

string · required · style: simple

The id of the order line.

Get specific third party product for an orderLine › query Parameters

orderLineVersion

integer · style: form · explode: true

Get specific third party product for an orderLine › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Get specific third party product for an orderLine › Responses

A third party product for given order and order line.

ThirdPartyProduct

TextInLanguage[] · required

A human-readable list of names for the product

PriceWithTax · required

Price with included tax amounts and an optional rate.

orderId

string · required

The orderId for which the product belongs to.

Parameters · required

Similar to OrderLine.fareProducts.parameters, but with additional fields for third party products.

RefType · required

Versioned ID of the product.

orderLineId

string · required

The orderLineId for which the product belongs to.

orderVersion

integer · required

The version of the order for which the product belongs to.

orderLineVersion

integer · required

The version of the order line for which the product belongs to.

PriceWithTax · required

Price with included tax amounts and an optional rate.

authorityId

string

Owner of the product.

GET/v1/third-party-products/orders/{orderId}/order-lines/{orderLineId}

curl https://api.entur.io/sales/v1/third-party-products/orders/:orderId/order-lines/:orderLineId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "name": [
    {
      "lang": "eng",
      "value": "Wayfare luggage space reservation"
    },
    {
      "lang": "nob",
      "value": "Wayfare bagasjeplassreservasjon"
    }
  ],
  "price": {
    "amount": "59.00",
    "taxCode": "03",
    "taxRate": "25.00",
    "currency": "NOK",
    "taxAmount": "11.80"
  },
  "orderId": "WAYFARE-ORDER-98765",
  "parameters": {},
  "productRef": {
    "id": "WAYFARE:ThirdPartyProduct:LuggageReservation",
    "version": "WAYFARE:Version:LuggageReservation-1"
  },
  "authorityId": "WAYFARE:Authority:WAYFARE",
  "orderLineId": "WAYFARE-ORDERLINE-2",
  "orderVersion": 1,
  "orderLineVersion": 1,
  "priceContribution": {
    "amount": "59.00",
    "taxCode": "03",
    "taxRate": "25.00",
    "currency": "NOK",
    "taxAmount": "11.80"
  }
}

json

application/json

Get third party products for an order

GET

https://api.entur.io/sales

/v1/third-party-products/orders/{orderId}

Returns third party products for given orderId

Get third party products for an order › path Parameters

orderId

string · required · style: simple

The id of the order.

Get third party products for an order › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Get third party products for an order › Responses

Response containing third party products.

ThirdPartyProductsResponse

ThirdPartyProduct[] · required

Get specific third party product for an orderLine

GET

https://api.entur.io/sales

/v1/third-party-products/orders/{orderId}/order-lines/{orderLineId}

Get specific third party product for an orderLine › path Parameters

orderId

string · required · style: simple

The id of the order.

orderLineId

string · required · style: simple

The id of the order line.

Get specific third party product for an orderLine › query Parameters

orderLineVersion

integer · style: form · explode: true

Get specific third party product for an orderLine › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Get specific third party product for an orderLine › Responses

A third party product for given order and order line.

ThirdPartyProduct

TextInLanguage[] · required

A human-readable list of names for the product

PriceWithTax · required

Price with included tax amounts and an optional rate.

orderId

string · required

The orderId for which the product belongs to.

Parameters · required

Similar to OrderLine.fareProducts.parameters, but with additional fields for third party products.

RefType · required

Versioned ID of the product.

orderLineId

string · required

The orderLineId for which the product belongs to.

orderVersion

integer · required

The version of the order for which the product belongs to.

orderLineVersion

integer · required

The version of the order line for which the product belongs to.

PriceWithTax · required

Price with included tax amounts and an optional rate.

authorityId

string

Owner of the product.

Third Party Products by Order

Get third party products for an order

Get third party products for an order › path Parameters

Get third party products for an order › Headers

Get third party products for an order › Responses

Get specific third party product for an orderLine

Get specific third party product for an orderLine › path Parameters

Get specific third party product for an orderLine › query Parameters

Get specific third party product for an orderLine › Headers

Get specific third party product for an orderLine › Responses

Build with Entur

Contribute

Terms & Policies

Third Party Products by Order

Get third party products for an order

Get third party products for an order › path Parameters

Get third party products for an order › Headers

Get third party products for an order › Responses

Get specific third party product for an orderLine

Get specific third party product for an orderLine › path Parameters

Get specific third party product for an orderLine › query Parameters

Get specific third party product for an orderLine › Headers

Get specific third party product for an orderLine › Responses