HYPERLABS

HYPERLABS Products API

The Products API from HYPERLABS — 14 operation(s) for products.

GitHub OpenAPI
Business capability
Electrical Product Catalogue Management BC-1940

Operations 17

GET /v1/products Get products #
GET /v1/products/discontinued Get products discontinued #
GET /v1/products/ztdr Get products ztdr #
GET /v1/products/xtdr Get products xtdr #
GET /v1/products/zcoupon Get products zcoupon #
GET /v1/products/{id} Get products by id #
GET /v1/products/{topSku} Get products by top sku #
GET /v1/products/filter/parameters Get products filter parameters #
POST /v1/products/filter Create products filter #
POST /v1/products/resolve Create products resolve #
GET /v1/admin/products Get admin products #
POST /v1/admin/products Create admin products #
GET /v1/admin/products/catalog Get admin products catalog #
GET /v1/admin/products/{id} Get admin products by id #
PUT /v1/admin/products/{id} Replace admin products by id #
DELETE /v1/admin/products/{id} Delete admin products by id #
POST /v1/admin/products/{id}/move Create admin products by id move #

Documentation

📖
APIReference
https://www.hyperlabs.com/api/swagger/index.html
📖
Authentication
https://artifacts.apis.io/hyperlabs/authentication/hyperlabs-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hyperlabs/openapi/hyperlabs-products-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/hyperlabs/conventions/hyperlabs-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/hyperlabs/errors/hyperlabs-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/hyperlabs/data-model/hyperlabs-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hyperlabs:hyperlabs-products-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hyperlabs-products-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Hyperlabs.Web Products API
  version: '1.0'
servers:
- url: /api
tags:
- name: Products
paths:
  /v1/products:
    get:
      tags:
      - Products
      parameters:
      - name: ProductClassIds
        in: query
        schema:
          title: Guid[]
          type: array
          items:
            title: Guid
            type: string
            format: uuid
      - name: CategoryIds
        in: query
        schema:
          title: Guid[]
          type: array
          items:
            title: Guid
            type: string
            format: uuid
      - name: TagIds
        in: query
        schema:
          title: Guid[]
          type: array
          items:
            title: Guid
            type: string
            format: uuid
      - name: SoftwareIds
        in: query
        schema:
          title: Guid[]
          type: array
          items:
            title: Guid
            type: string
            format: uuid
      - name: IsNew
        in: query
        schema:
          title: Nullable`1
          type: boolean
      - name: IsFeatured
        in: query
        schema:
          title: Nullable`1
          type: boolean
      - name: IsPromoted
        in: query
        schema:
          title: Nullable`1
          type: boolean
      responses:
        '200':
          description: OK
      summary: Get products
      x-summary-source: derived
      operationId: getV1Products
      x-operation-id-source: derived
  /v1/products/discontinued:
    get:
      tags:
      - Products
      responses:
        '200':
          description: OK
      summary: Get products discontinued
      x-summary-source: derived
      operationId: getV1ProductsDiscontinued
      x-operation-id-source: derived
  /v1/products/ztdr:
    get:
      tags:
      - Products
      responses:
        '200':
          description: OK
      summary: Get products ztdr
      x-summary-source: derived
      operationId: getV1ProductsZtdr
      x-operation-id-source: derived
  /v1/products/xtdr:
    get:
      tags:
      - Products
      responses:
        '200':
          description: OK
      summary: Get products xtdr
      x-summary-source: derived
      operationId: getV1ProductsXtdr
      x-operation-id-source: derived
  /v1/products/zcoupon:
    get:
      tags:
      - Products
      responses:
        '200':
          description: OK
      summary: Get products zcoupon
      x-summary-source: derived
      operationId: getV1ProductsZcoupon
      x-operation-id-source: derived
  /v1/products/{id}:
    get:
      tags:
      - Products
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: Guid
          type: string
          format: uuid
      responses:
        '200':
          description: OK
      summary: Get products by id
      x-summary-source: derived
      operationId: getV1ProductsById
      x-operation-id-source: derived
  /v1/products/{topSku}:
    get:
      tags:
      - Products
      parameters:
      - name: topSku
        in: path
        required: true
        schema:
          title: String
          type: string
      responses:
        '200':
          description: OK
      summary: Get products by top sku
      x-summary-source: derived
      operationId: getV1ProductsByTopSku
      x-operation-id-source: derived
  /v1/products/filter/parameters:
    get:
      tags:
      - Products
      parameters:
      - name: CategoryId
        in: query
        schema:
          title: Nullable`1
          type: string
          format: uuid
      responses:
        '200':
          description: OK
      summary: Get products filter parameters
      x-summary-source: derived
      operationId: getV1ProductsFilterParameters
      x-operation-id-source: derived
  /v1/products/filter:
    post:
      tags:
      - Products
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Hyperlabs.Web.Areas.Customer.Models.Products.FilterDto'
          text/json:
            schema:
              $ref: '#/components/schemas/Hyperlabs.Web.Areas.Customer.Models.Products.FilterDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Hyperlabs.Web.Areas.Customer.Models.Products.FilterDto'
      responses:
        '200':
          description: OK
      summary: Create products filter
      x-summary-source: derived
      operationId: postV1ProductsFilter
      x-operation-id-source: derived
  /v1/products/resolve:
    post:
      tags:
      - Products
      requestBody:
        content:
          application/json:
            schema:
              title: ResolveProductItemRequestDto[]
              type: array
              items:
                $ref: '#/components/schemas/Hyperlabs.Web.Areas.Customer.Models.Products.ResolveProductItemRequestDto'
          text/json:
            schema:
              title: ResolveProductItemRequestDto[]
              type: array
              items:
                $ref: '#/components/schemas/Hyperlabs.Web.Areas.Customer.Models.Products.ResolveProductItemRequestDto'
          application/*+json:
            schema:
              title: ResolveProductItemRequestDto[]
              type: array
              items:
                $ref: '#/components/schemas/Hyperlabs.Web.Areas.Customer.Models.Products.ResolveProductItemRequestDto'
      responses:
        '200':
          description: OK
      summary: Create products resolve
      x-summary-source: derived
      operationId: postV1ProductsResolve
      x-operation-id-source: derived
  /v1/admin/products:
    get:
      tags:
      - Products
      parameters:
      - name: ProductClassesIds
        in: query
        schema:
          title: Guid[]
          type: array
          items:
            title: Guid
            type: string
            format: uuid
      - name: CategoryIds
        in: query
        schema:
          title: Guid[]
          type: array
          items:
            title: Guid
            type: string
            format: uuid
      - name: Search
        in: query
        schema:
          title: String
          type: string
      - name: SortBy
        in: query
        schema:
          $ref: '#/components/schemas/Hyperlabs.Domain.Products.Models.ProductQuerySortParameter'
      - name: SortDesc
        in: query
        schema:
          title: Boolean
          type: boolean
      - name: PageNo
        in: query
        schema:
          title: Int32
          type: integer
          format: int32
      - name: PageSize
        in: query
        schema:
          title: Int32
          type: integer
          format: int32
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      summary: Get admin products
      x-summary-source: derived
      operationId: getV1AdminProducts
      x-operation-id-source: derived
    post:
      tags:
      - Products
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeProductDto'
          text/json:
            schema:
              $ref: '#/components/schemas/ChangeProductDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ChangeProductDto'
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      summary: Create admin products
      x-summary-source: derived
      operationId: postV1AdminProducts
      x-operation-id-source: derived
  /v1/admin/products/catalog:
    get:
      tags:
      - Products
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      summary: Get admin products catalog
      x-summary-source: derived
      operationId: getV1AdminProductsCatalog
      x-operation-id-source: derived
  /v1/admin/products/{id}:
    get:
      tags:
      - Products
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: Guid
          type: string
          format: uuid
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      summary: Get admin products by id
      x-summary-source: derived
      operationId: getV1AdminProductsById
      x-operation-id-source: derived
    put:
      tags:
      - Products
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: Guid
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeProductDto'
          text/json:
            schema:
              $ref: '#/components/schemas/ChangeProductDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ChangeProductDto'
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      summary: Replace admin products by id
      x-summary-source: derived
      operationId: putV1AdminProductsById
      x-operation-id-source: derived
    delete:
      tags:
      - Products
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: Guid
          type: string
          format: uuid
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      summary: Delete admin products by id
      x-summary-source: derived
      operationId: deleteV1AdminProductsById
      x-operation-id-source: derived
  /v1/admin/products/{id}/move:
    post:
      tags:
      - Products
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: Guid
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Shared.MoveDto'
          text/json:
            schema:
              $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Shared.MoveDto'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Shared.MoveDto'
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2: []
      summary: Create admin products by id move
      x-summary-source: derived
      operationId: postV1AdminProductsByIdMove
      x-operation-id-source: derived
components:
  schemas:
    Hyperlabs.Domain.Products.Models.ProductionStatusCode:
      title: ProductionStatusCode
      enum:
      - 1
      - 2
      type: integer
      format: int32
    Hyperlabs.Domain.Products.Models.PublishingStatusCode:
      title: PublishingStatusCode
      enum:
      - 1
      - 2
      - 3
      type: integer
      format: int32
    Hyperlabs.Web.Areas.Admin.Models.Shared.ChangeAttachedMediaFileDto:
      title: ChangeAttachedMediaFileDto
      type: object
      properties:
        mediaFileId:
          title: Guid
          type: string
          format: uuid
        order:
          title: Int32
          type: integer
          format: int32
      additionalProperties: false
    Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductTagDto:
      title: ChangeProductTagDto
      type: object
      properties:
        tagTypeId:
          title: Guid
          type: string
          format: uuid
      additionalProperties: false
    Hyperlabs.Domain.Products.Models.ProductAttributeTypeCode:
      title: ProductAttributeTypeCode
      enum:
      - 1
      - 2
      type: integer
      format: int32
    Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductSoftwareDto:
      title: ChangeProductSoftwareDto
      type: object
      properties:
        softwareId:
          title: Guid
          type: string
          format: uuid
      additionalProperties: false
    Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductSpecificationDto:
      title: ChangeProductSpecificationDto
      type: object
      properties:
        specificationTypeId:
          title: Guid
          type: string
          format: uuid
        value:
          title: String
          type:
          - string
          - 'null'
        minValue:
          title: String
          type:
          - string
          - 'null'
        maxValue:
          title: String
          type:
          - string
          - 'null'
      additionalProperties: false
    Hyperlabs.Web.Areas.Customer.Models.Products.FilterDto:
      title: FilterDto
      type: object
      properties:
        search:
          title: String
          type:
          - string
          - 'null'
        productClassIds:
          title: Guid[]
          type:
          - array
          - 'null'
          items:
            title: Guid
            type: string
            format: uuid
        categoryIds:
          title: Guid[]
          type:
          - array
          - 'null'
          items:
            title: Guid
            type: string
            format: uuid
        parameters:
          title: FilterSelectedParameterDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Customer.Models.Products.FilterSelectedParameterDto'
      additionalProperties: false
    Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductNoteDto:
      title: ChangeProductNoteDto
      type: object
      properties:
        id:
          title: Nullable`1
          type:
          - string
          - 'null'
          format: uuid
        text:
          title: String
          type:
          - string
          - 'null'
      additionalProperties: false
    Hyperlabs.Web.Areas.Customer.Models.Products.FilterSelectedParameterDto:
      title: FilterSelectedParameterDto
      type: object
      properties:
        code:
          $ref: '#/components/schemas/Hyperlabs.Domain.Products.Models.FilterParameterCode'
        id:
          title: String
          type:
          - string
          - 'null'
        valueIds:
          title: String[]
          type:
          - array
          - 'null'
          items:
            title: String
            type: string
      additionalProperties: false
    Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductApplicationNoteDto:
      title: ChangeProductApplicationNoteDto
      type: object
      properties:
        applicationNoteId:
          title: Guid
          type: string
          format: uuid
      additionalProperties: false
    Hyperlabs.Domain.Products.Models.FilterParameterCode:
      title: FilterParameterCode
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      type: integer
      format: int32
    Hyperlabs.Web.Areas.Admin.Models.Products.ChangeReplacementProductDto:
      title: ChangeReplacementProductDto
      type: object
      properties:
        replacementProductId:
          title: Guid
          type: string
          format: uuid
      additionalProperties: false
    Hyperlabs.Web.Areas.Customer.Models.Products.ResolveProductItemRequestDto:
      title: ResolveProductItemRequestDto
      type: object
      properties:
        productId:
          title: Guid
          type: string
          format: uuid
        productUnitId:
          title: Nullable`1
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductVariableValueDto:
      title: ChangeProductVariableValueDto
      type: object
      properties:
        variableTypeValueId:
          title: Guid
          type: string
          format: uuid
      additionalProperties: false
    Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductVariableDto:
      title: ChangeProductVariableDto
      type: object
      properties:
        variableTypeId:
          title: Guid
          type: string
          format: uuid
        values:
          title: ChangeProductVariableValueDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductVariableValueDto'
      additionalProperties: false
    Hyperlabs.Web.Areas.Admin.Models.Shared.MoveDto:
      title: MoveDto
      type: object
      properties:
        delta:
          title: Int32
          type: integer
          format: int32
      additionalProperties: false
    Hyperlabs.Domain.Products.Models.ProductQuerySortParameter:
      title: ProductQuerySortParameter
      enum:
      - 1
      - 2
      - 3
      - 4
      type: integer
      format: int32
    ChangeProductDto:
      title: ChangeProductDto
      type: object
      properties:
        name:
          title: String
          type:
          - string
          - 'null'
        topSku:
          title: String
          type:
          - string
          - 'null'
        description:
          title: String
          type:
          - string
          - 'null'
        shortDescription:
          title: String
          type:
          - string
          - 'null'
        price:
          title: Nullable`1
          type:
          - number
          - 'null'
          format: double
        productionStatusCode:
          $ref: '#/components/schemas/Hyperlabs.Domain.Products.Models.ProductionStatusCode'
        discontinuedDate:
          title: Nullable`1
          type:
          - string
          - 'null'
          format: date-time
        publishingStatusCode:
          $ref: '#/components/schemas/Hyperlabs.Domain.Products.Models.PublishingStatusCode'
        productAttributeTypeCode:
          $ref: '#/components/schemas/Hyperlabs.Domain.Products.Models.ProductAttributeTypeCode'
        replacementProductId:
          title: Nullable`1
          type:
          - string
          - 'null'
          format: uuid
        categoryId:
          title: Guid
          type: string
          format: uuid
        tags:
          title: ChangeProductTagDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductTagDto'
        variables:
          title: ChangeProductVariableDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductVariableDto'
        specifications:
          title: ChangeProductSpecificationDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductSpecificationDto'
        notes:
          title: ChangeProductNoteDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductNoteDto'
        applicationNotes:
          title: ChangeProductApplicationNoteDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductApplicationNoteDto'
        replacementProducts:
          title: ChangeReplacementProductDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Products.ChangeReplacementProductDto'
        images:
          title: ChangeAttachedMediaFileDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Shared.ChangeAttachedMediaFileDto'
        documents:
          title: ChangeAttachedMediaFileDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Shared.ChangeAttachedMediaFileDto'
        software:
          title: ChangeProductSoftwareDto[]
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Hyperlabs.Web.Areas.Admin.Models.Products.ChangeProductSoftwareDto'
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: apiKey
      description: 'Standard Authorization header using the Bearer scheme. Example: "Bearer {token}"'
      name: Authorization
      in: header