Entur Developer
Inventory
Inventory

Schemas

Download schema

UpdatedReservationLine

Updated reservation line specification
id
​integer · int64 · required
productId
​string · required
amount
​integer · int32 · required
status
​string · enum · required
Enum values:
DRAFT
CONFIRMED
EXPIRED
CANCELLED
DRAFT_CANCELLATION
CONFIRMED_CANCELLATION
RELEASING

ReservationLineResponseV1

id
​integer · int64 · required
productId
​string · required
amount
​integer · int32 · required
created
​string · date-time · required
changed
​string · date-time · required
status
​string · enum · required
Enum values:
DRAFT
CONFIRMED
EXPIRED
CANCELLED
DRAFT_CANCELLATION
CONFIRMED_CANCELLATION
RELEASING

ReservationLine

Updated spec of reservation line
productId
​string · required
amount
​integer · int32 · required
status
​string · enum · required
Enum values:
DRAFT
CONFIRMED
EXPIRED
CANCELLED
DRAFT_CANCELLATION
CONFIRMED_CANCELLATION
RELEASING

OdRequestV1

origin
​string · required
destination
​string · required

UpdateQuotaRequestV1

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

OdResponse

origin
​string · required
destination
​string · required

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

QuotaConfiguration

Updated quota configuration
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[]

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

StockQuery

datedServiceJourney
​string · required
origin
​string · required
destination
​string · required

MultiStockResponse

origin
​string · required
destination
​string · required
spannedDatedServiceJourneys
​string[] · required
​array · required

NestingComponentResponseV1

aggregatedAvailability
​integer · int32 · required
nestingGroup
​string · required
priority
​integer · int32 · required

ProductCollectionResponseV1

aggregatedAvailability
​integer · int32 · required
nestingGroup
​string · required
priority
​integer · int32 · required
selectionRule
​string · enum · required
Enum values:
COMBINED
SINGLE
consumptionRule
​string · enum · required
Enum values:
DIRECT
BY_PRIORITY
directionRule
​string · enum · required
Enum values:
FROM_RIGHT
FROM_LEFT
​array · required

ProductResponseV1

aggregatedAvailability
​integer · int32 · required
nestingGroup
​string · required
priority
​integer · int32 · required
id
​integer · int32 · required
products
​string[] · required
leftInQuota
​integer · int32 · required
closedBy
​integer[] · required
purchaseWindowStart
​string · date-time
purchaseWindowStop
​string · date-time

SimpleProductResponseV1

products
​string[] · required
leftInQuota
​integer · int32 · required

StockComponentResponseV1

No data returned

Reservation

Specifies what should be reserved, in what quantity, and across what distance
origin
​string · required
destination
​string · required
datedServiceJourneyId
​string · required
​ReservationLine[] · required
orderId
​string

ReservationResponseV1

id
​integer · int64 · required
origin
​string · required
destination
​string · required
datedServiceJourney
​string · required
created
​string · date-time · required
changed
​string · date-time · required
createdBy
​string · required
​ReservationLineResponseV1[] · required
orderId
​string

RepairRequestV1

Specifies which departures we should try to repair
departureIds
​string[] · required

QuotaRequestV1

One or more quotas for the service journey
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

NestingConfigTree

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

NestingConfigTreeNodeRequestV1

​QuotaConfiguration · required

Updated quota configuration

​array · required

NestingConfigTreeNodeResponseV1

​QuotaConfigurationResponseV1 · required
​array · required

NestingConfigTreeResponseV1

​NestingConfigTreeNodeResponseV1 · required

DepartureResponseV1

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

Line

id
​string · required
version
​integer · int32 · required
organisationId
​integer · int64 · required
created
​string · date-time · required
changed
​string · date-time · required
stops
​string[] · required

StockResponseV1

datedServiceJourney
​string · required
origin
​string · required
destination
​string · required
organisationId
​string · required
​array · required

QuotaTemplateQuotaRequestV1

quota
​integer · int32 · required
productIds
​string[] · required
quotaConfigurationId
​integer · int32

QuotaTemplateRequestV1

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

QuotaTemplateUpdateRequestV1

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

QuotaTemplateQuotaResponseV1

quota
​integer · int32 · required
productIds
​string[] · required
quotaConfigurationId
​integer · int32

QuotaTemplateResponseV1

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

UpdateDepartureRequestV1

isClosed
​boolean | null

LineResponse

id
​string · required
version
​integer · int32 · required
organisationId
​integer · int64 · required
created
​string · date-time · required
changed
​string · date-time · required
stops
​string[] · required
Did you find what you were looking for?