Fees

Server

Download schema

Services related to fees on order.

Add Fee to Order

POST

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

/v1/orders/{orderId}/fees

Add Fee to specified Order

Add Fee to Order › path Parameters

orderId

string · required · style: simple

Order ID

Add Fee to Order › Headers

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

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Add Fee to Order › Request Body

Fee related to one or more OrderLines

FeeRequest

type

string · required

Type of Fee. Valid types: MANUAL, REFUNDING, ONBOARD, CHANGE, INVOICE, CHANGE_NON_REFUNDABLE, PENALTY, BOOKING, REDUCTION

Example: REFUND

PriceWithTax · required

Price with included tax amounts and an optional rate.

reason

string · required

Explanatory text describing the reason for the Fee, if applicable

Example: VYB:Refunding:HalfRefunded

Default:

orderLineIds

string[] · required

References to the OrderLines this Fee refers to, if applicable. If empty, the fee refers to all order lines

Default: []

RefType

Reference to a resource available in a different APIs

orderVersion

integer · int32

The version of the Order this Fee is added to

Example: 2

RefType

Reference to a resource available in a different APIs

Add Fee to Order › Responses

Fee related to one or more OrderLines

Fee

id

string · uuid · required

ID used to uniquely identify Fee if deletion is necessary

Example: dd3e1d71-1c96-4b88-a683-538a8724ee0d

type

string · required

Type of Fee. Valid types: MANUAL, REFUNDING, ONBOARD, CHANGE, INVOICE, CHANGE_NON_REFUNDABLE, PENALTY, BOOKING, REDUCTION

Example: REFUND

PriceWithTax · required

Price with included tax amounts and an optional rate.

reason

string · required

Explanatory text describing the reason for the Fee, if applicable

Example: VYB:Refunding:HalfRefunded

Default:

orderLineIds

string[] · required

References to the OrderLines this Fee refers to, if applicable. If empty, the fee refers to all order lines

Default: []

RefType

Reference to a resource available in a different APIs

orderVersion

integer · int32

The version of the Order this Fee is added to

Example: 2

RefType

Reference to a resource available in a different APIs

POST/v1/orders/{orderId}/fees

curl https://api.staging.entur.io/sales/v1/orders/:orderId/fees \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "type": "REFUND",
  "price": {
    "amount": "50.00",
    "currency": "NOK",
    "taxAmount": "10.00"
  },
  "reason": "ABC:Refunding:HalfRefunded",
  "orderLineIds": [
    "dd3e1d71-1c96-4b88-a683-538a8724ee0d"
  ],
  "orderVersion": 2
}'

Example Request Body

{
  "type": "REFUND",
  "price": {
    "amount": "50.00",
    "currency": "NOK",
    "taxAmount": "10.00"
  },
  "reason": "ABC:Refunding:HalfRefunded",
  "orderLineIds": [
    "dd3e1d71-1c96-4b88-a683-538a8724ee0d"
  ],
  "orderVersion": 2
}

json

Example Responses

{
  "type": "REFUND",
  "price": {
    "amount": "50.00",
    "currency": "NOK",
    "taxAmount": "10.00"
  },
  "reason": "ABC:Refunding:HalfRefunded",
  "orderLineIds": [
    "dd3e1d71-1c96-4b88-a683-538a8724ee0d"
  ],
  "orderVersion": 2
}

json

application/json

Delete Fee from Order

DELETE

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

/v1/orders/{orderId}/fees/{feeId}

Delete Fee with specified ID from Order with specified ID

Delete Fee from Order › path Parameters

orderId

string · required · style: simple

Order ID

feeId

string · uuid · required · style: simple

Fee ID

Delete Fee from Order › Headers

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Delete Fee from Order › Responses

No Content

No data returned

Order lines Reservations

Add Fee to Order

POST

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

/v1/orders/{orderId}/fees

Add Fee to specified Order

Add Fee to Order › path Parameters

orderId

string · required · style: simple

Order ID

Add Fee to Order › Headers

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Add Fee to Order › Request Body

Fee related to one or more OrderLines

FeeRequest

type

string · required

Type of Fee. Valid types: MANUAL, REFUNDING, ONBOARD, CHANGE, INVOICE, CHANGE_NON_REFUNDABLE, PENALTY, BOOKING, REDUCTION

Example: REFUND

PriceWithTax · required

Price with included tax amounts and an optional rate.

reason

string · required

Explanatory text describing the reason for the Fee, if applicable

Example: VYB:Refunding:HalfRefunded

Default:

orderLineIds

string[] · required

References to the OrderLines this Fee refers to, if applicable. If empty, the fee refers to all order lines

Default: []

RefType

Reference to a resource available in a different APIs

orderVersion

integer · int32

The version of the Order this Fee is added to

Example: 2

RefType

Reference to a resource available in a different APIs

Add Fee to Order › Responses

Fee related to one or more OrderLines

Fee

id

string · uuid · required

ID used to uniquely identify Fee if deletion is necessary

Example: dd3e1d71-1c96-4b88-a683-538a8724ee0d

type

string · required

Type of Fee. Valid types: MANUAL, REFUNDING, ONBOARD, CHANGE, INVOICE, CHANGE_NON_REFUNDABLE, PENALTY, BOOKING, REDUCTION

Example: REFUND

PriceWithTax · required

Price with included tax amounts and an optional rate.

reason

string · required

Explanatory text describing the reason for the Fee, if applicable

Example: VYB:Refunding:HalfRefunded

Default:

orderLineIds

string[] · required

References to the OrderLines this Fee refers to, if applicable. If empty, the fee refers to all order lines

Default: []

RefType

Reference to a resource available in a different APIs

orderVersion

integer · int32

The version of the Order this Fee is added to

Example: 2

RefType

Reference to a resource available in a different APIs

Delete Fee from Order

DELETE

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

/v1/orders/{orderId}/fees/{feeId}

Delete Fee with specified ID from Order with specified ID

Delete Fee from Order › path Parameters

orderId

string · required · style: simple

Order ID

feeId

string · uuid · required · style: simple

Fee ID

Delete Fee from Order › Headers

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Delete Fee from Order › Responses

No Content

No data returned

Fees

Add Fee to Order

Add Fee to Order › path Parameters

Add Fee to Order › Headers

Add Fee to Order › Request Body

Add Fee to Order › Responses

Delete Fee from Order

Delete Fee from Order › path Parameters

Delete Fee from Order › Headers

Delete Fee from Order › Responses

Build with Entur

Contribute

Terms & Policies

Fees

Add Fee to Order

Add Fee to Order › path Parameters

Add Fee to Order › Headers

Add Fee to Order › Request Body

Add Fee to Order › Responses

Delete Fee from Order

Delete Fee from Order › path Parameters

Delete Fee from Order › Headers

Delete Fee from Order › Responses