doc-product

Server

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025] List Products

GET

https://api-stag.utilitycloud.app

/pm/product/v2/products

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns all products available for the tenant, optionally filtered by price area, grid area, service type, or product tags.

When gridArea is provided and pricearea is not, the price area is resolved from the grid area. When requiretags is provided, only products matching all specified tags are returned. When tags is provided, only products matching at least one of the specified tags are returned. When primaryonly is set to true, only primary products are returned.

🕚 [DEPRECATED Sunset on 31-March-2025] List Products › query Parameters

pricearea

string

Filters products by price area.

gridArea

string

Filters products by grid area. The corresponding price area is resolved automatically.

serviceType

string

Filters products by service type.

requiretags

string

Comma-separated list of tags that all returned products must have.

tags

string

Comma-separated list of tags where returned products must match at least one.

primaryonly

string

When set to true, only primary products are returned.

🕚 [DEPRECATED Sunset on 31-March-2025] List Products › Headers

uc-request-source

string

The request source identifier.

🕚 [DEPRECATED Sunset on 31-March-2025] List Products › Responses

Success

se_product_SearchResponseProductList[]

se_product_SearchResponseProductList

id

string | null

name

string | null

createdBy

string | null

createdTime

string | null · date-time

visible

boolean

lastChanged

string | null · date-time

lastChangedBy

string | null

tags

array | null

description

string | null

array | null

isSubProduct

boolean

isMainProduct

boolean

object | null

validPeriod

string | null

productIdDefault

string | null

productNameDefault

string | null

serviceType

string | null

se_product_ExpirationInfoDto

hasProduction

boolean

GET/pm/product/v2/products

curl https://api-stag.utilitycloud.app/pm/product/v2/products \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "id",
    "name": "name",
    "createdBy": "createdBy",
    "createdTime": "2024-08-25T15:00:00Z",
    "visible": true,
    "lastChanged": "2024-08-25T15:00:00Z",
    "lastChangedBy": "lastChangedBy",
    "tags": [
      "string"
    ],
    "description": "description",
    "interactiveFields": [
      {
        "name": "name",
        "defaultValue": "defaultValue"
      }
    ],
    "isSubProduct": true,
    "isMainProduct": true,
    "dynamicFields": {
      "key": "string"
    },
    "validPeriod": "validPeriod",
    "productIdDefault": "productIdDefault",
    "productNameDefault": "productNameDefault",
    "serviceType": "serviceType",
    "expirationInfo": {
      "date": "2024-08-25T15:00:00Z",
      "followUpProductId": "followUpProductId"
    },
    "hasProduction": true
  }
]

json

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025] List Product Summaries

GET

https://api-stag.utilitycloud.app

/pm/product/v2/products/slim

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns a summary view of all products available for the tenant, optionally filtered by price area, grid area, service type, or product tags.

Each result contains the key product fields (ID, name, tags, service type, visibility, and dynamic fields) without the full product element detail. Use this endpoint when only basic product catalogue information is needed.

🕚 [DEPRECATED Sunset on 31-March-2025] List Product Summaries › query Parameters

pricearea

string

Filters products by price area.

gridArea

string

Filters products by grid area. The corresponding price area is resolved automatically.

serviceType

string

Filters products by service type.

requiretags

string

Comma-separated list of tags that all returned products must have.

tags

string

Comma-separated list of tags where returned products must match at least one.

primaryonly

string

When set to true, only primary products are returned.

🕚 [DEPRECATED Sunset on 31-March-2025] List Product Summaries › Headers

uc-request-source

string

The request source identifier.

🕚 [DEPRECATED Sunset on 31-March-2025] List Product Summaries › Responses

Success

se_product_ProductDtoSlim[]

se_product_ProductDtoSlim

id

string | null

description

string | null

name

string | null

primaryProduct

boolean

serviceType

string | null

object | null

visible

boolean

validPeriod

string | null

productIdDefault

string | null

tags

array | null

hasProduction

boolean

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025] Get Product

GET

https://api-stag.utilitycloud.app

/pm/product/v2/products/{id}

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns the product with the specified ID, including all product elements, pricing expressions, and configuration.

🕚 [DEPRECATED Sunset on 31-March-2025] Get Product › path Parameters

id

string · required

The product ID.

🕚 [DEPRECATED Sunset on 31-March-2025] Get Product › Responses

Success

se_product_ProductDto

id

string | null

name

string | null

array | null

tags

array | null

description

string | null

isMainProduct

boolean

isSubProduct

boolean

createdBy

string | null

createdTime

string | null · date-time

lastChangedBy

string | null

lastChanged

string | null · date-time

visible

boolean

validPeriod

string | null

productIdDefault

string | null

object | null

reportCons

array | null

reportProd

array | null

elCertExpression

string | null

renewableExpression

string | null

usedPriceListNames

array | null

serviceType

string | null

se_product_ExpirationInfoDto

se_product_PrePaymentValues

GET/pm/product/v2/products/{id}

curl https://api-stag.utilitycloud.app/pm/product/v2/products/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "name": "name",
  "productElements": [
    {
      "productElementName": "productElementName",
      "id": "id",
      "invoiceLineText": "invoiceLineText",
      "invoiceLineGroup": 0,
      "expressionSet": {
        "quantityExpression": "quantityExpression",
        "priceExpression": "priceExpression",
        "quantityResultName": "quantityResultName",
        "priceResultName": "priceResultName",
        "amountExpression": "amountExpression"
      },
      "resolution": "H",
      "productElementType": "Metered",
      "elCertRule": 0,
      "groupId": "groupId",
      "isParent": true,
      "isElcert": true,
      "reportingCategory": "NotDefined",
      "isConsumptionComponent": true,
      "isProductionComponent": true,
      "tags": [
        "string"
      ],
      "quantityUnit": "quantityUnit",
      "amountUnit": "amountUnit",
      "account": "account",
      "altElcert": "altElcert",
      "hasInteractiveVariable": true,
      "usedPriceListNames": [
        "string"
      ],
      "isPreliminary": true,
      "preliminaryRule": 0,
      "skipAveragePrelimPrice": true,
      "usedConstantValues": [
        "string"
      ]
    }
  ],
  "tags": [
    "string"
  ],
  "description": "description",
  "isMainProduct": true,
  "isSubProduct": true,
  "createdBy": "createdBy",
  "createdTime": "2024-08-25T15:00:00Z",
  "lastChangedBy": "lastChangedBy",
  "lastChanged": "2024-08-25T15:00:00Z",
  "visible": true,
  "validPeriod": "validPeriod",
  "productIdDefault": "productIdDefault",
  "dynamicFields": {
    "key": "string"
  },
  "reportCons": [
    "string"
  ],
  "reportProd": [
    "string"
  ],
  "elCertExpression": "elCertExpression",
  "renewableExpression": "renewableExpression",
  "usedPriceListNames": [
    "string"
  ],
  "serviceType": "serviceType",
  "expirationInfo": {
    "date": "2024-08-25T15:00:00Z",
    "followUpProductId": "followUpProductId"
  },
  "prePaymentValues": {
    "profileId": "profileId",
    "profileName": "profileName",
    "useEyc": true,
    "consumption": 0,
    "prePaymentPlan": "Monthly2MonthPrepaid"
  }
}

json

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025] Get Product Summary

GET

https://api-stag.utilitycloud.app

/pm/product/v2/products/{id}/slim

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns a summary view of the specified product, containing the key product fields without the full product element detail.

🕚 [DEPRECATED Sunset on 31-March-2025] Get Product Summary › path Parameters

id

string · required

The product ID.

🕚 [DEPRECATED Sunset on 31-March-2025] Get Product Summary › Responses

Success

se_product_ProductDtoSlim

id

string | null

description

string | null

name

string | null

primaryProduct

boolean

serviceType

string | null

object | null

visible

boolean

validPeriod

string | null

productIdDefault

string | null

tags

array | null

hasProduction

boolean

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025] Search Products

POST

https://api-stag.utilitycloud.app

/pm/product/v2/products/query

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns products matching the specified IDs or product names.

At least one ID or product name must be provided. When both Ids and ProductNames are provided, results from both are combined. Each product is returned only once, even if it matches both criteria.

🕚 [DEPRECATED Sunset on 31-March-2025] Search Products › Request Body

se_product_ProductsQuery

ids

array | null

productNames

array | null

🕚 [DEPRECATED Sunset on 31-March-2025] Search Products › Responses

Success

se_product_Product[]

se_product_Product

id

string | null

name

string | null

invoiceMessageProductName

string | null

description

string | null

array | null

primaryProduct

boolean

createdBy

string | null

createdTime

string · date-time

lastChangedBy

string | null

lastChanged

string · date-time

visible

boolean

array | null

validPeriod

string | null

migration

boolean

productIdDefault

string | null

object | null

tags

array | null

reportCons

array | null

reportProd

array | null

elCertExpression

string | null

renewableExpression

string | null

usedPriceListNames

array | null

serviceType

string | null

se_product_ExpirationInfoRecord

se_product_ProductTranslationsRecord

object | null

POST/pm/product/v2/products/query

curl https://api-stag.utilitycloud.app/pm/product/v2/products/query \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "ids": [
    "string"
  ],
  "productNames": [
    "string"
  ]
}'

Example Request Body

{
  "ids": [
    "string"
  ],
  "productNames": [
    "string"
  ]
}

json

Example Responses

[
  {
    "id": "id",
    "name": "name",
    "invoiceMessageProductName": "invoiceMessageProductName",
    "description": "description",
    "productElements": [
      {
        "id": "id",
        "productElementName": "productElementName",
        "product": "product",
        "invoiceLineText": "invoiceLineText",
        "invoiceLineGroup": 0,
        "expressionSet": {
          "quantityExpression": "quantityExpression",
          "priceExpression": "priceExpression",
          "quantityResultName": "quantityResultName",
          "priceResultName": "priceResultName",
          "amountExpression": "amountExpression"
        },
        "resolution": "H",
        "productElementType": "Metered",
        "primaryProduct": true,
        "quantityUnit": "quantityUnit",
        "amountUnit": "amountUnit",
        "account": "account",
        "altElcert": "altElcert",
        "isPreliminary": true,
        "preliminaryRule": 0,
        "elCertRule": 0,
        "skipAveragePrelimPrice": true,
        "groupId": "groupId",
        "isParent": true,
        "hasInteractiveVariable": true,
        "isElcert": true,
        "reportingCategory": "NotDefined",
        "isConsumptionComponent": true,
        "isProductionComponent": true,
        "tags": [
          "string"
        ],
        "usedPriceListNames": [
          "string"
        ],
        "prePaymentValues": {
          "profileId": "profileId",
          "profileName": "profileName",
          "useEyc": true,
          "consumption": 0,
          "prePaymentPlan": "Monthly2MonthPrepaid"
        },
        "translations": {
          "productElementName": {
            "key": "string"
          },
          "invoiceLineText": {
            "key": "string"
          }
        }
      }
    ],
    "primaryProduct": true,
    "createdBy": "createdBy",
    "createdTime": "2024-08-25T15:00:00Z",
    "lastChangedBy": "lastChangedBy",
    "lastChanged": "2024-08-25T15:00:00Z",
    "visible": true,
    "productElementsDefault": [
      {
        "id": "id",
        "productElementName": "productElementName",
        "product": "product",
        "invoiceLineText": "invoiceLineText",
        "invoiceLineGroup": 0,
        "expressionSet": {
          "quantityExpression": "quantityExpression",
          "priceExpression": "priceExpression",
          "quantityResultName": "quantityResultName",
          "priceResultName": "priceResultName",
          "amountExpression": "amountExpression"
        },
        "resolution": "H",
        "productElementType": "Metered",
        "primaryProduct": true,
        "quantityUnit": "quantityUnit",
        "amountUnit": "amountUnit",
        "account": "account",
        "altElcert": "altElcert",
        "isPreliminary": true,
        "preliminaryRule": 0,
        "elCertRule": 0,
        "skipAveragePrelimPrice": true,
        "groupId": "groupId",
        "isParent": true,
        "hasInteractiveVariable": true,
        "isElcert": true,
        "reportingCategory": "NotDefined",
        "isConsumptionComponent": true,
        "isProductionComponent": true,
        "tags": [
          "string"
        ],
        "usedPriceListNames": [
          "string"
        ],
        "prePaymentValues": {
          "profileId": "profileId",
          "profileName": "profileName",
          "useEyc": true,
          "consumption": 0,
          "prePaymentPlan": "Monthly2MonthPrepaid"
        },
        "translations": {
          "productElementName": {
            "key": "string"
          },
          "invoiceLineText": {
            "key": "string"
          }
        }
      }
    ],
    "validPeriod": "validPeriod",
    "migration": true,
    "productIdDefault": "productIdDefault",
    "dynamicFields": {
      "key": "string"
    },
    "tags": [
      "string"
    ],
    "reportCons": [
      "string"
    ],
    "reportProd": [
      "string"
    ],
    "elCertExpression": "elCertExpression",
    "renewableExpression": "renewableExpression",
    "usedPriceListNames": [
      "string"
    ],
    "serviceType": "serviceType",
    "expirationInfo": {
      "date": "2024-08-25T15:00:00Z",
      "followUpProductId": "followUpProductId"
    },
    "translations": {
      "name": {
        "key": "string"
      },
      "description": {
        "key": "string"
      }
    },
    "customerSpecificVariableDefaultValues": {
      "key": 0
    }
  }
]

json

Signing and Consent doc-product-price