Telenor Sverige Product Inventory API

openapi: 3.2.0
info:
  title: Management Product Inventory API
  description: 'The Product Inventory Management API provides a standardized mechanism to manage product inventory information. The API consists of a simple set of operations that interact with Inventory systems in a consistent manner.''

    ### Notifications

    When a Request is sent to the backend systems, its lifecycle state changes and an event is sent to the Event Notification API. The notification `detailedMessage` attribute will have the following content, depending on the type of request:

    #### General requests

    ```

    {

    "message": "The request is in progress.",

    "requestId": "bf13697e-ab73-4a75-bc1b-903147594d11"

    }

    ```

    #### Termination requests

    ```

    {

    "message": "The request is in progress.",

    "id": "bf13697e-ab73-4a75-bc1b-903147594d11",

    "type": "termination",

    "products": [

    {

    "productId": "SID2532144",

    "state": "IN_PROGRESS"

    }

    ]

    }'
  termsOfService: https://www.telenor.se/globalassets/mediabibliotek/telenor-foretag/pdfer/priser-och-villkor/general-terms-and-conditions-october-2012.pdf
  contact:
    name: Telenor Support
    url: https://www.telenor.se/foretag/kundservice/
  version: 2.4.17
servers:
- url: https://apis-test.telenor.se
  description: Test environment
tags:
- name: Product Inventory
  description: Endpoint for management of the product inventory.
paths:
  /corporate/fixed-network/product-inventory-management/v1/product/{productId}:
    get:
      tags:
      - Product Inventory
      summary: Fetches information about an installed product
      description: Fetches information about an installed product.
      operationId: getProduct
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        schema:
          type: string
        example: 5564210309
      - name: productId
        in: path
        description: The ID of the product in Telenor's systems.
        required: true
        schema:
          type: string
        example: SID1225639
      responses:
        '200':
          description: Successful invocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceDetails'
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
  /corporate/fixed-network/product-inventory-management/v1/product/site/{siteId}:
    get:
      tags:
      - Product Inventory
      summary: List the product inventory for a site
      description: List the product inventory for a site.
      operationId: listAll
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        schema:
          type: string
        example: 5564210309
      - name: siteId
        in: path
        description: The ID of the site in Telenor's systems.
        required: true
        schema:
          type: string
        example: 56434
      responses:
        '200':
          description: Successful invocation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ListProductInventory'
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /corporate/fixed-network/product-inventory-management/v2/products:
    get:
      tags:
      - Product Inventory
      summary: Paginated list the product inventory for the account
      description: Paginated list the product inventory for the account.
      operationId: listAllByOrganization
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        schema:
          type: string
        example: 5564210309
      - name: limit
        in: query
        description: The number of items each page should contain.
        schema:
          type: integer
          format: int32
          default: 100
        example: 100
      - name: next
        in: query
        description: A continuation token used to fetch the next page when the number of results is larger that the limit
        schema:
          type: string
        example: 269444400
      responses:
        '200':
          description: Successful invocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
  /corporate/fixed-network/product-inventory-management/v3/products:
    get:
      tags:
      - Product Inventory
      summary: Paginated list the product inventory for the account
      description: Paginated list the product inventory for the account.
      operationId: listAllProductInventory
      parameters:
      - name: X-On-Behalf-Of-Org-Nr
        in: header
        description: The organization number when the request is on behalf of another party.
        schema:
          type: string
        example: 5564210309
      - name: limit
        in: query
        description: The number of items each page should contain.
        schema:
          type: integer
          format: int32
          default: 100
        example: 100
      - name: next
        in: query
        description: A continuation token used to fetch the next page when the number of results is larger that the limit
        schema:
          type: string
        example: 269444400
      - name: additionalServiceData
        in: query
        description: When true, includes assetTag and serialNumber for each service. The additional data may be cached for up to 24 hours.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Successful invocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductInventoryListItemPaginatedResponse'
        '400':
          description: Invocation failed because of wrong header and/or query parameters
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    VpnAttributes:
      type: object
      properties:
        id:
          type: string
          description: The ID of the VPN.
          example: '73838492'
        name:
          type: string
          description: The name of the VPN.
          example: internet
      description: The VPN information. Applicable for VPN products.
    ProductInventoryListItemPaginatedResponse:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/PaginatedResultMeta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProductInventoryListItem'
    PaginatedResultMeta:
      type: object
      properties:
        limit:
          type: integer
          description: The number of results to return.
          format: int32
          example: 100
        next:
          type: string
          description: A continuation token used to fetch the next page when the number of results is larger that the limit
          example: '269444400'
        total:
          type: integer
          description: The total number of records found.
          format: int32
          example: 3534
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: The reason that caused the error.
          example: The provided product offer does not exist.
        code:
          type: string
          description: An application specific error code to differentiate error responses.
          example: MISSING_REQUIRED_PARAMETER
          enum:
          - MISSING_REQUIRED_PARAMETER
          - INVALID_INPUT
          - CANCELLATION_OF_TERMINATION_NOT_POSSIBLE
          - TERMINATION_REQUEST_ALREADY_CANCELLED
          - TERMINATION_REQUEST_RETRIGGER_NOT_POSSIBLE
          - TERMINATION_OF_PRODUCT_NOT_POSSIBLE
          - TERMINATION_PRODUCTS_MUST_BELONG_TO_THE_SAME_SITE
          - INVALID_JWT
          - UNAUTHORIZED_HEADER_USAGE
          - UNAUTHORIZED
          - LAN_PORT_REQUEST_NOT_FOUND
          - STATIC_ROUTE_REQUEST_NOT_FOUND
          - DHCP_RELAY_REQUEST_NOT_FOUND
          - TERMINATION_REQUEST_NOT_FOUND
          - PRODUCT_NOT_FOUND
          - AGREEMENT_NOT_FOUND
          - AGREEMENT_STRUCTURE_NOT_FOUND
          - VPN_REQUEST_NOT_FOUND
          - SITE_NOT_FOUND
          - REQUEST_NOT_FOUND
          - TOO_MANY_REQUESTS
          - INTERNAL_ERROR
          - CLARIFY_ERROR
          - MISSING_AGREEMENT_IN_CAS
          - SALESFORCE_ERROR
        timestamp:
          type: integer
          description: The date and time using the epoch standard of when the error occurred.
          format: int64
          example: 1615292025
    ServiceDetails:
      type: object
      properties:
        id:
          type: string
          description: The ID of the product inventory item.
          example: SID1233563
        productOfferingId:
          type: integer
          description: The ID of the product offering from Product Catalog.
          format: int32
          example: 234
        state:
          type: string
          description: The state in which the product inventory item is.
          example: INSTALLED
          enum:
          - TO_BE_INSTALLED
          - INSTALLED
          - TO_BE_DEINSTALLED
          - DEINSTALLED
          - CANCELLED
          - TO_BE_CHANGED
          - TO_BE_DOWNGRADED
          - TO_BE_MIGRATED
          - TO_BE_MOVED
          - TO_BE_UPGRADED
          - OTHER
        name:
          type: string
          description: The name of the product inventory item.
          example: Nordic Connect Mobile Gateway
        installedDate:
          type: string
          description: The date when the product was installed on the site.
          format: date-time
          example: '2009-12-29T23:59:59+01:00'
        partNumber:
          type: string
          description: The part number associated to the installation.
          example: NC Mobile Gateway
        modelNumber:
          type: string
          description: The model number associated to the installation.
          example: 800003326-01
        contractLength:
          type: string
          description: The contract length of the product instance in months.
          example: '12'
        installedInstanceName:
          type: string
          description: The name given to the installed instance.
          example: NC Mobile Gateway
        slaContractType:
          type: string
          description: The SLA contract type of the product instance.
          example: 0800-1600NWD/99,00/24
        luNumber:
          type: string
          description: The LU number associated to product instance.
          example: '80484342'
        vpnAttributes:
          $ref: '#/components/schemas/VpnAttributes'
        siteId:
          type: string
          description: The ID of the site to which the product is associated.
          example: '345672'
        assetTag:
          type: string
          description: The label of a hardware device. Usually present on the back of the device.
        serialNumber:
          type: string
          description: The serial number of the device.
    ProductInventoryListItem:
      type: object
      properties:
        id:
          type: string
          description: The ID of the product inventory item.
          example: SID1233563
        state:
          type: string
          description: The state in which the product inventory item is.
          example: INSTALLED
          enum:
          - TO_BE_INSTALLED
          - INSTALLED
          - TO_BE_DEINSTALLED
          - DEINSTALLED
          - CANCELLED
          - TO_BE_CHANGED
          - TO_BE_DOWNGRADED
          - TO_BE_MIGRATED
          - TO_BE_MOVED
          - TO_BE_UPGRADED
          - OTHER
        partNumber:
          type: string
          description: The part number associated to the installation.
          example: NC Mobile Gateway
        siteObjectId:
          type: string
          description: The object id of service's site.
          example: '1234554321'
        name:
          type: string
          description: The name of the product inventory item.
          example: Nordic Connect Mobile Gateway
        contractLength:
          type: string
          description: The contract length of the product inventory item.
          example: '12'
        installedDate:
          type: string
          description: The date when the product was installed on the site.
          format: date-time
          example: '2024-12-29T23:59:59+01:00'
        childrenIds:
          type: array
          description: The list of service ids of child services.
          example:
          - SID123
          - SID456
          items:
            type: string
            description: The list of service ids of child services.
            example: '["SID123","SID456"]'
        assetTag:
          type: string
          description: The label of a hardware device. Usually present on the back of the device. Only present when additionalServiceData=true is requested.
        serialNumber:
          type: string
          description: The serial number of the device. Only present when additionalServiceData=true is requested.
    PaginatedResponse:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/PaginatedResultMeta'
        data:
          type: array
          items:
            type: object
    ListProductInventory:
      type: object
      properties:
        id:
          type: string
          description: The ID of the product inventory item.
          example: SID1233563
        state:
          type: string
          description: The state in which the product inventory item is.
          example: INSTALLED
          enum:
          - TO_BE_INSTALLED
          - INSTALLED
          - TO_BE_DEINSTALLED
          - DEINSTALLED
          - CANCELLED
          - TO_BE_CHANGED
          - TO_BE_DOWNGRADED
          - TO_BE_MIGRATED
          - TO_BE_MOVED
          - TO_BE_UPGRADED
          - OTHER
        name:
          type: string
          description: The name of the product inventory item.
          example: Nordic Connect Mobile Gateway
        installedDate:
          type: string
          description: The date when the product was installed on the site.
          format: date-time
          example: '2009-12-29T23:59:59+01:00'
        partNumber:
          type: string
          description: The part number associated to the installation.
          example: NC Mobile Gateway
        modelNumber:
          type: string
          description: The model number associated to the installation.
          example: 800003326-01
x-tagGroups:
- name: API Operations
  tags:
  - Product Inventory
  - VPN
  - Static Routes
  - DHCP Relay
  - LAN Ports
  - Termination
x-provenance:
  method: harvested
  publisher: Telenor Sverige
  source: https://developer.telenor.se/product-inventory/openapi
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)