openapi: 3.2.0
info:
  title: Entur Luggage Allowances API
  version: 2026.10.0
  description: 'Operations tagged luggage-allowances across 2 of this provider''s published API definitions: entur-products-openapi.json, entur-products-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.entur.io/products
  description: Production environment
- url: https://api.staging.entur.io/products
  description: Staging environment
- url: https://api.dev.entur.io/products
  description: Development environment
security:
- jwt: []
tags:
- name: luggage-allowances
paths:
  /luggage-allowances:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - luggage-allowances
      summary: Retrieves all luggage allowances
      operationId: luggage-allowances_getAll
      parameters:
      - name: orgId
        in: query
        description: The unique id to identify an organisation
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: fareFrameId
        in: query
        description: The unique id to identify a dataset to an organisation
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: minimizeDataLoad
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: If-None-Match
        in: header
        description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Returns the info
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LuggageAllowance'
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Authorization failed
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:les
    post:
      tags:
      - luggage-allowances
      summary: Create a luggage allowance
      operationId: luggage-allowances_create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LuggageAllowance'
        required: true
      responses:
        '201':
          description: Entity created successfully
        '400':
          description: Validation errors
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                type: string
        '409':
          description: Already registered
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:endre
    servers:
    - url: https://api.entur.io/products
      description: Production environment
    - url: https://api.staging.entur.io/products
      description: Staging environment
    - url: https://api.dev.entur.io/products
      description: Development environment
  /luggage-allowances/{id}/versions:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - luggage-allowances
      summary: Retrieves luggage allowance versions for a given id
      operationId: luggage-allowances_getVersionsOrActiveById
      parameters:
      - name: id
        in: path
        description: The id to identify a LuggageAllowance
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: active
        in: query
        description: If value is set to true only active versions will be returned, otherwise all versions will be returned
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: If-None-Match
        in: header
        description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Returns the info
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LuggageAllowance'
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Authorization failed
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:les
    servers:
    - url: https://api.entur.io/products
      description: Production environment
    - url: https://api.staging.entur.io/products
      description: Staging environment
    - url: https://api.dev.entur.io/products
      description: Development environment
  /luggage-allowances/{id}/{version}:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - luggage-allowances
      summary: Retrieves luggage allowance for id and version
      operationId: luggage-allowances_getById
      parameters:
      - name: id
        in: path
        description: The id to identify a LuggageAllowance
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: version
        in: path
        description: The id for the version of the LuggageAllowance
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: If-None-Match
        in: header
        description: Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Returns the info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LuggageAllowance'
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Authorization failed
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:les
    put:
      tags:
      - luggage-allowances
      summary: Updates an existing LuggageAllowance
      operationId: luggage-allowances_update
      parameters:
      - name: id
        in: path
        description: The id to identify a LuggageAllowance
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      - name: version
        in: path
        description: The id for the version of the LuggageAllowance
        required: true
        style: simple
        explode: false
        schema:
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LuggageAllowance'
        required: true
      responses:
        '200':
          description: Entity updated successfully
        '400':
          description: Validation errors
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Missing Authorization
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Authorization failed
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found
          content:
            application/problem+json:
              schema:
                type: string
        '409':
          description: Conflict
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:endre
    delete:
      tags:
      - luggage-allowances
      summary: Delete an existing LuggageAllowance
      operationId: luggage-allowances_deleteById
      parameters:
      - name: id
        in: path
        description: The id to identify a LuggageAllowance
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: version
        in: path
        description: The id for the version of the LuggageAllowance
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Entity deleted successfully
        '400':
          description: Validation errors
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Missing Authorization
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Authorization failed
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found
          content:
            application/problem+json:
              schema:
                type: string
        '409':
          description: Conflict
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:endre
    servers:
    - url: https://api.entur.io/products
      description: Production environment
    - url: https://api.staging.entur.io/products
      description: Staging environment
    - url: https://api.dev.entur.io/products
      description: Development environment
components:
  schemas:
    VersionOfObjectRef:
      required:
      - nameOfClass
      - ref
      - version
      type: object
      properties:
        nameOfClass:
          minLength: 1
          type: string
          description: Name of class.
        ref:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: The netex id reference to the object.
        version:
          type: string
          description: Version.
      description: Fare frame ref.
    FarePrice:
      required:
      - changed
      - created
      - fareFrameRef
      - id
      - modification
      - nameOfClass
      - status
      type: object
      properties:
        amount:
          type: string
          description: Amount
          examples:
          - '164.0'
        canBeCumulative:
          type: boolean
          description: canBeCumulative.
          examples:
          - true
        changed:
          type: string
          description: Changed datetime.
          readOnly: true
        compatibleWithVersionRef:
          type: string
          description: Compatible with version.
        created:
          type: string
          description: Created datetime.
          readOnly: true
        currency:
          type: string
          description: Currency.
          examples:
          - NOK
        derivedFromVersionRef:
          type: string
          description: Derived from version.
        discountPercentageUsed:
          maximum: 100
          minimum: -100
          type: integer
          description: discountPercentageUsed.
          format: int32
          examples:
          - 5
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        id:
          minLength: 1
          type: string
          description: Id.
          examples:
          - NSB:FarePrice:1005TEN
        isAllowed:
          type: boolean
          description: isAllowed.
          examples:
          - true
        limitingRule:
          $ref: '#/components/schemas/LimitingRule'
        modification:
          type: string
          description: Modification status.
          readOnly: true
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        name:
          type: array
          description: Name.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        nameOfClass:
          type: string
          description: Name of class.
          readOnly: true
          examples:
          - FarePrice
        ranking:
          type: integer
          description: Ranking.
          format: int32
          examples:
          - 1
        rounding:
          $ref: '#/components/schemas/Rounding'
        roundingRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        status:
          type: string
          description: Status.
          readOnly: true
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        vatRegisterGroup:
          type: string
          description: vatRegisterGroup.
          enum:
          - EXCEPTION_FROM_VAT
          - GENERAL_VAT
          - FOOD_VAT
          - TRANSPORT_AND_TICKETS_VAT
          examples:
          - TRANSPORT_AND_TICKETS_VAT
        version:
          type: string
          description: Version.
          readOnly: true
          examples:
          - NSB:Version:V1
      description: A description of the price and factor for a set fare
    LimitingRule:
      required:
      - changed
      - created
      - fareFrameRef
      - id
      - modification
      - nameOfClass
      - status
      type: object
      properties:
        canBeCumulative:
          type: boolean
          description: CanBeCumulative.
        changed:
          type: string
          description: Changed datetime.
          readOnly: true
        compatibleWithVersionRef:
          type: string
          description: Compatible with version.
        created:
          type: string
          description: Created datetime.
          readOnly: true
        derivedFromVersionRef:
          type: string
          description: Derived from version.
        description:
          type: array
          description: Description.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        discountAsPercentage:
          type: number
          description: DiscountAsPercentage.
          format: float
        discountAsValue:
          type: number
          description: DiscountAsValue.
          format: float
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Id.
        maximumPrice:
          type: string
          description: MaximumPrice.
          examples:
          - '164.0'
        maximumPriceAsPercentage:
          type: number
          description: MaximumPriceAsPercentage.
          format: double
        minimumLimitPrice:
          type: string
          description: MinimumLimitPrice.
          examples:
          - '164.0'
        minimumPrice:
          type: string
          description: MinimumPrice.
          examples:
          - '164.0'
        modification:
          type: string
          description: Modification status.
          readOnly: true
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        name:
          type: array
          description: Name.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        nameOfClass:
          type: string
          description: Name of class.
          readOnly: true
          examples:
          - LimitingRule
        status:
          type: string
          description: Status.
          readOnly: true
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        version:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Version.
          examples:
          - NSB:Version:V1
      description: A LimitingRule
    TextInLanguage:
      required:
      - lang
      - value
      type: object
      properties:
        lang:
          minLength: 1
          type: string
          description: Language code.
          examples:
          - nob
        value:
          minLength: 1
          type: string
          description: The text.
      description: Text in a specific language.
    LuggageAllowance:
      required:
      - changed
      - created
      - description
      - fareFrameRef
      - id
      - modification
      - name
      - nameOfClass
      - status
      - version
      type: object
      properties:
        baggageType:
          type: string
          description: Baggage Type
          enum:
          - HANDBAG
          - HAND_LUGGAGE
          - SMALL_SUITCASE
          - SUITCASE
          - TRUNK
          - OVERSIZE_ITEM
          - BICYCLE
          - SPORTING_EQUIPMENT
          - SKIS
          - MUSICAL_INSTRUMENT
          - PUSH_CHAIR
          - MOTORIZED_WHEELCHAIR
          - LARGE_MOTORIZED_WHEELCHAIR
          - WHEELCHAIR
          - SMALL_ANIMAL
          - ANIMAL
          - GAME
          - MOTORCYCLE
          - OTHER
        baggageUseType:
          type: string
          description: Baggage Use Type
          enum:
          - CARRY_ON
          - CHECK_IN
          - OVERSIZE_CHECK_IN
        changed:
          type: string
          description: Changed datetime
          readOnly: true
        created:
          type: string
          description: Created datetime
          readOnly: true
        description:
          type: array
          description: Description represented in different languages. Language codes are ISO-639
          items:
            $ref: '#/components/schemas/TextInLanguage'
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Id
          examples:
          - NSB:LuggageAllowance:Bicycle
        luggageAllowanceType:
          type: string
          description: Luggage Allowance Type
          enum:
          - NONE
          - UNLIMITED
          - SINGLE
          - LIMITED
        luggageChargingBasis:
          type: string
          description: Luggage Charging Basis
          enum:
          - FREE
          - CHARGED_BY_ITEM
          - CHARGED_BY_WEIGHT
          - OTHER
        modification:
          type: string
          description: Modification status
          readOnly: true
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        name:
          type: array
          description: The name of the luggage allowance represented in different languages. Language codes are ISO-639
          items:
            $ref: '#/components/schemas/TextInLanguage'
        nameOfClass:
          type: string
          description: Name of class
          readOnly: true
          examples:
          - LuggageAllowance
        organisationId:
          type: string
          description: Organisation related to the userProfile
        prices:
          type: array
          description: Prices for the luggage allowance.
          items:
            $ref: '#/components/schemas/FarePrice'
        status:
          type: string
          description: Status
          readOnly: true
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        version:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Version
          examples:
          - NSB:Version:V1
      description: LuggageAllowance
    Rounding:
      required:
      - changed
      - created
      - fareFrameRef
      - id
      - modification
      - nameOfClass
      - roundingMethod
      - status
      - version
      type: object
      properties:
        changed:
          type: string
          description: Changed datetime.
          readOnly: true
        compatibleWithVersionRef:
          type: string
          description: Compatible with version.
        created:
          type: string
          description: Created datetime.
          readOnly: true
        derivedFromVersionRef:
          type: string
          description: Derived from version.
        description:
          type: array
          description: Description.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        fareFrameRef:
          $ref: '#/components/schemas/VersionOfObjectRef'
        id:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Id.
          examples:
          - NSB:Rounding:Ordinary
        modification:
          type: string
          description: Modification status.
          readOnly: true
          enum:
          - NEW
          - REVISE
          - DELETE
          examples:
          - NEW
        name:
          type: array
          description: Name.
          items:
            $ref: '#/components/schemas/TextInLanguage'
        nameOfClass:
          type: string
          description: Name of class.
          readOnly: true
          examples:
          - Rounding
        roundingMethod:
          type: string
          description: Type of rounding.
          enum:
          - NONE
          - DOWN
          - UP
          - SPLIT
          - STEP_TABLE
          - FIVE
          - NINE
          - TEN
          - FORTY_NINE
        roundingModulus:
          type: number
          description: Amount by which rounding is to be quantised, i.e. results should be quantised to nearest whole multiple of this value.
          format: double
        status:
          type: string
          description: Rounding status.
          readOnly: true
          enum:
          - DRAFT
          - PROPOSED
          - VERSIONED
          - DEPRECATED
          examples:
          - DRAFT
        version:
          minLength: 1
          pattern: ^([A-Z]{3}):([A-Za-z]*):([0-9A-Za-z_\-]*)$
          type: string
          description: Rounding version.
          examples:
          - NSB:Version:V1
      description: A description of how prices are rounded post calculation
      deprecated: true
  parameters:
    X-Correlation-Id:
      name: X-Correlation-Id
      in: header
      description: Correlation id
      required: false
      style: simple
      explode: false
      schema:
        type: string
    ET-Client-Name:
      name: ET-Client-Name
      in: header
      description: '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>`.'
      required: false
      style: simple
      explode: false
      schema:
        type: string
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- entur-products-openapi.json
- entur-products-openapi.yml