Entur Developer
Inventory
Inventory

Inventory Admin

Download schema

Get quota(s)

GET
https://api.entur.io/inventory
/v1/quotas

Retrieve quota(s) for a service journey

Get quota(s) › query Parameters

datedServiceJourney
​string · required · style: form · explode: true

Id for the dated service journey

product
​string · style: form · explode: true

Navn product

origin
​string · style: form · explode: true

Navn origin

destination
​string · style: form · explode: true

Navn destination

quotaConfigId
​integer · int32 · style: form · explode: true

Id for quotaconfig

Get quota(s) › Headers

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

Get quota(s) › Responses

200

OK

QuotaResponseV1
id
​integer · int64 · required
quota
​integer · int32 · required
products
​string[] · required
​OdResponse[] · required
datedServiceJourneyId
​string · required
useStoplist
​boolean · required
quotaConfigurationId
​integer · int32
purchaseWindowStart
​string · date-time
purchaseWindowStop
​string · date-time

Overwrite quota(s)

PUT
https://api.entur.io/inventory
/v1/quotas

Overwrite quota(s) for a dated service journey

Overwrite quota(s) › query Parameters

datedServiceJourney
​string · required · style: form · explode: true

The departure ID (dated service journey) to overwrite quotas for

Overwrite quota(s) › Headers

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

Overwrite quota(s) › Request Body

List of quotas to update for a dated service journey

Quota to update
UpdateQuotaRequestV1
quota
​integer · int32 · required
products
​string[] · required
​OdRequestV1[] · required
useStoplist
​boolean · required
quotaConfigurationId
​integer · int32
purchaseWindowStart
​string · date-time
purchaseWindowStop
​string · date-time

Overwrite quota(s) › Responses

Created

QuotaResponseV1
id
​integer · int64 · required
quota
​integer · int32 · required
products
​string[] · required
​OdResponse[] · required
datedServiceJourneyId
​string · required
useStoplist
​boolean · required
quotaConfigurationId
​integer · int32
purchaseWindowStart
​string · date-time
purchaseWindowStop
​string · date-time

Create quota(s)

POST
https://api.entur.io/inventory
/v1/quotas

Create quota(s) for a service journey

Create quota(s) › Headers

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

Create quota(s) › Request Body

List of quotas to create

One or more quotas for the service journey
QuotaRequestV1
quota
​integer · int32 · required
products
​string[] · required
​OdRequestV1[] · required
datedServiceJourneyId
​string · required
useStoplist
​boolean · required
quotaConfigurationId
​integer · int32
purchaseWindowStart
​string · date-time
purchaseWindowStop
​string · date-time

Create quota(s) › Responses

Created

QuotaResponseV1
id
​integer · int64 · required
quota
​integer · int32 · required
products
​string[] · required
​OdResponse[] · required
datedServiceJourneyId
​string · required
useStoplist
​boolean · required
quotaConfigurationId
​integer · int32
purchaseWindowStart
​string · date-time
purchaseWindowStop
​string · date-time

Get quota

GET
https://api.entur.io/inventory
/v1/quotas/{quotaId}

Retrieve quota by ID

Get quota › path Parameters

quotaId
​integer · int64 · required · style: simple

Id for the quota

Get quota › Headers

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

Get quota › Responses

200

OK

QuotaResponseV1
id
​integer · int64 · required
quota
​integer · int32 · required
products
​string[] · required
​OdResponse[] · required
datedServiceJourneyId
​string · required
useStoplist
​boolean · required
quotaConfigurationId
​integer · int32
purchaseWindowStart
​string · date-time
purchaseWindowStop
​string · date-time

Update quota

PUT
https://api.entur.io/inventory
/v1/quotas/{quotaId}

Updates a quota for a service journey

Update quota › path Parameters

quotaId
​integer · int64 · required · style: simple

ID for the quota

Update quota › Headers

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

Update quota › Request Body

Quota to update
UpdateQuotaRequestV1
quota
​integer · int32 · required
products
​string[] · required
​OdRequestV1[] · required
useStoplist
​boolean · required
quotaConfigurationId
​integer · int32
purchaseWindowStart
​string · date-time
purchaseWindowStop
​string · date-time

Update quota › Responses

200

OK

QuotaResponseV1
id
​integer · int64 · required
quota
​integer · int32 · required
products
​string[] · required
​OdResponse[] · required
datedServiceJourneyId
​string · required
useStoplist
​boolean · required
quotaConfigurationId
​integer · int32
purchaseWindowStart
​string · date-time
purchaseWindowStop
​string · date-time

Delete quota

DELETE
https://api.entur.io/inventory
/v1/quotas/{quotaId}

Delete quota by ID

Delete quota › path Parameters

quotaId
​integer · int64 · required · style: simple

Id for the quota

Delete quota › Headers

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

Delete quota › Responses

No Content

No data returned

Get quota templates for a line

GET
https://api.entur.io/inventory
/v1/quota-templates

Retrieve all quota templates for a given line

Get quota templates for a line › query Parameters

lineId
​string · required · style: form · explode: true

Id of the line to get quota templates for

Get quota templates for a line › Headers

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

Get quota templates for a line › Responses

200

OK

QuotaTemplateResponseV1
id
​integer · int64 · required
lineId
​string · required
​QuotaTemplateQuotaResponseV1[] · required
privateCode
​string

Create quota template

POST
https://api.entur.io/inventory
/v1/quota-templates

Create a new quota template for a line

Create quota template › Headers

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

Create quota template › Request Body

Request to create a quota template
QuotaTemplateRequestV1
lineId
​string · required
​QuotaTemplateQuotaRequestV1[] · required
privateCode
​string

Create quota template › Responses

Created

QuotaTemplateResponseV1
id
​integer · int64 · required
lineId
​string · required
​QuotaTemplateQuotaResponseV1[] · required
privateCode
​string

Get quota template by id

GET
https://api.entur.io/inventory
/v1/quota-templates/{id}

Retrieve a quota template by its ID

Get quota template by id › path Parameters

id
​integer · int64 · required · style: simple

Id of the quota template

Get quota template by id › Headers

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

Get quota template by id › Responses

200

OK

QuotaTemplateResponseV1
id
​integer · int64 · required
lineId
​string · required
​QuotaTemplateQuotaResponseV1[] · required
privateCode
​string

Update quota template

PUT
https://api.entur.io/inventory
/v1/quota-templates/{id}

Update an existing quota template

Update quota template › path Parameters

id
​integer · int64 · required · style: simple

Id of the quota template

Update quota template › Headers

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

Update quota template › Request Body

Request to update a quota template
QuotaTemplateUpdateRequestV1
​QuotaTemplateQuotaRequestV1[] · required

Update quota template › Responses

200

OK

QuotaTemplateResponseV1
id
​integer · int64 · required
lineId
​string · required
​QuotaTemplateQuotaResponseV1[] · required
privateCode
​string

Delete quota template

DELETE
https://api.entur.io/inventory
/v1/quota-templates/{id}

Delete a quota template by its ID

Delete quota template › path Parameters

id
​integer · int64 · required · style: simple

Id of the quota template

Delete quota template › Headers

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

Delete quota template › Responses

No Content

No data returned

Get quota configuration

GET
https://api.entur.io/inventory
/v1/quota-configurations/{id}

Retrieve quota configurations by ID

Get quota configuration › path Parameters

id
​integer · int32 · required · style: simple

Id for the quota configuration to get

Get quota configuration › Headers

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

Get quota configuration › Responses

200

OK

QuotaConfigurationResponseV1
id
​integer · int32 · required
organisationId
​integer · int64 · required
name
​string · required
priority
​integer · int32 · required
closedBy
​integer[] · required
selectionRule
​string · enum
Enum values:
COMBINED
SINGLE
consumptionRule
​string · enum
Enum values:
DIRECT
BY_PRIORITY
directionRule
​string · enum
Enum values:
FROM_RIGHT
FROM_LEFT
parent
​integer · int32

Update quota configuration

PUT
https://api.entur.io/inventory
/v1/quota-configurations/{id}

Update a quota configuration

Update quota configuration › path Parameters

id
​integer · int32 · required · style: simple

The id of the quota configuration to update

Update quota configuration › Headers

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

Update quota configuration › Request Body

Updated quota configuration
QuotaConfiguration
name
​string · required
priority
​integer · int32 · required
selectionRule
​string · enum
Enum values:
COMBINED
SINGLE
consumptionRule
​string · enum
Enum values:
DIRECT
BY_PRIORITY
directionRule
​string · enum
Enum values:
FROM_RIGHT
FROM_LEFT
parent
​integer · int32
id
​integer · int32
closedBy
​integer[]

Update quota configuration › Responses

200

OK

QuotaConfigurationResponseV1
id
​integer · int32 · required
organisationId
​integer · int64 · required
name
​string · required
priority
​integer · int32 · required
closedBy
​integer[] · required
selectionRule
​string · enum
Enum values:
COMBINED
SINGLE
consumptionRule
​string · enum
Enum values:
DIRECT
BY_PRIORITY
directionRule
​string · enum
Enum values:
FROM_RIGHT
FROM_LEFT
parent
​integer · int32

Delete quota configuration

DELETE
https://api.entur.io/inventory
/v1/quota-configurations/{id}

Delete quota configuration

Delete quota configuration › path Parameters

id
​integer · int32 · required · style: simple

The id of the quota configuration to delete

Delete quota configuration › Headers

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

Delete quota configuration › Responses

No Content

No data returned

Get a departure

GET
https://api.entur.io/inventory
/v1/dated-service-journeys/{id}

Retrieves a departure for transportation.

Get a departure › path Parameters

id
​string · required · style: simple

Id for the departure

Get a departure › Headers

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

Get a departure › Responses

200

OK

DepartureResponseV1
id
​string · required
invertedDirection
​string · required
​Line · required
organisationId
​integer · int64 · required
departureDate
​string · date · required
isClosed
​boolean · required

Update a departure

PATCH
https://api.entur.io/inventory
/v1/dated-service-journeys/{id}

Updates inactive flag on departure

Update a departure › path Parameters

id
​string · required · style: simple

Id for the departure

Update a departure › Headers

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

Update a departure › Request Body

UpdateDepartureRequestV1
isClosed
​boolean | null

Update a departure › Responses

200

OK

DepartureResponseV1
id
​string · required
invertedDirection
​string · required
​Line · required
organisationId
​integer · int64 · required
departureDate
​string · date · required
isClosed
​boolean · required

Get quota configurations

GET
https://api.entur.io/inventory
/v1/quota-configurations

Get all registered quota configurations

Get quota configurations › query Parameters

ownerOrganisationId
​string · style: form · explode: true

Not applicable for Partners/operators. Used to filter between operator organisations

Get quota configurations › Headers

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

Get quota configurations › Responses

default response

string

Create quota configuration

POST
https://api.entur.io/inventory
/v1/quota-configurations

Create a quota configuration

Create quota configuration › query Parameters

ownerOrganisationId
​string · style: form · explode: true

Not applicable for Partners/operators. Used to filter between operator organisations

Create quota configuration › Headers

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

Create quota configuration › Request Body

Updated quota configuration
QuotaConfiguration
name
​string · required
priority
​integer · int32 · required
selectionRule
​string · enum
Enum values:
COMBINED
SINGLE
consumptionRule
​string · enum
Enum values:
DIRECT
BY_PRIORITY
directionRule
​string · enum
Enum values:
FROM_RIGHT
FROM_LEFT
parent
​integer · int32
id
​integer · int32
closedBy
​integer[]

Create quota configuration › Responses

Created

QuotaConfigurationResponseV1
id
​integer · int32 · required
organisationId
​integer · int64 · required
name
​string · required
priority
​integer · int32 · required
closedBy
​integer[] · required
selectionRule
​string · enum
Enum values:
COMBINED
SINGLE
consumptionRule
​string · enum
Enum values:
DIRECT
BY_PRIORITY
directionRule
​string · enum
Enum values:
FROM_RIGHT
FROM_LEFT
parent
​integer · int32

Get nesting config trees

GET
https://api.entur.io/inventory
/v1/nesting-config-tree

Retrieves all nesting config trees

Get nesting config trees › query Parameters

ownerOrganisationId
​string · style: form · explode: true

Not applicable for Partners/operators. Used to filter between operator organisations

Get nesting config trees › Headers

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

Get nesting config trees › Responses

Create/Update a nesting config tree.

POST
https://api.entur.io/inventory
/v1/nesting-config-tree

Create/Update a nesting config tree.

Create/Update a nesting config tree. › query Parameters

ownerOrganisationId
​string · style: form · explode: true

Not applicable for Partners/operators. Used to filter between operator organisations

Create/Update a nesting config tree. › Headers

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

Create/Update a nesting config tree. › Request Body

A NestingConfigTree
NestingConfigTree
​NestingConfigTreeNodeRequestV1 · required
​QuotaConfiguration[] · required

Create/Update a nesting config tree. › Responses

Refresh departure with live journey data

POST
https://api.entur.io/inventory
/v1/dated-service-journeys/{departureId}/refresh

Refresh departure with journey data, which can possibly merge multiple existing departures

Refresh departure with live journey data › path Parameters

departureId
​string · required · style: simple

The datedServiceJourneyId to refresh

Refresh departure with live journey data › query Parameters

multiPrivateCodeOverride
​boolean · style: form · explode: true

If true, the refresh will merge departures event with different privateCodes

Default: false

Refresh departure with live journey data › Headers

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

Refresh departure with live journey data › Responses

200

OK

DepartureResponseV1
id
​string · required
invertedDirection
​string · required
​Line · required
organisationId
​integer · int64 · required
departureDate
​string · date · required
isClosed
​boolean · required
Inventory Clientreadiness-controller
Did you find what you were looking for?