Product Offerings

Server

Download schema

Operations related to Product Offerings.

Get Product Offering

GET

https://api-stag.utilitycloud.app

/v1/cm/product/{id}

Bearer (JWT)

Retrieves a single Product Offering by its ID.

Get Product Offering › path Parameters

id

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^… · required

The ID of the Product Offering

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Get Product Offering › Responses

cm_contract_cm_GetProduct200

cm_contract_cm_internal_product

GET/v1/cm/product/{id}

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

Example Responses

{
  "Product": {
    "ID": "ID",
    "Name": "Name",
    "PrimaryProduct": true,
    "EnabledForWebOrder": true,
    "Visible": true,
    "PriceAreas": [
      "string"
    ],
    "InteractiveFields": [
      "string"
    ],
    "EndDate": "2024-08-25T15:00:00Z",
    "ProductIdDefault": "ProductIdDefault",
    "ValidPeriod": "ValidPeriod",
    "IsDisabled": true,
    "DatePreRequisites": {
      "pre": "pre",
      "post": "post"
    },
    "WebOrderSubProducts": [
      "string"
    ],
    "Translations": {
      "key": {
        "Description": "Description",
        "Name": "Name"
      }
    },
    "ServiceTypes": [
      "string"
    ],
    "TextTemplateGuid": "TextTemplateGuid"
  }
}

json

application/json

Update Product Offering

PATCH

https://api-stag.utilitycloud.app

/v1/cm/product/{id}

Bearer (JWT)

Updates one or more fields on a Product Offering.

Update Product Offering › path Parameters

id

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^… · required

The ID of the Product Offering to update.

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Update Product Offering › Request Body

cm_contract_cm_PatchProductRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

ID

string

Name

string

PrimaryProduct

boolean

EnabledForWebOrder

boolean

Visible

boolean

PriceAreas

string[]

InteractiveFields

string[]

EndDate

string · date-time

ProductIdDefault

string

ValidPeriod

string

IsDisabled

boolean

object

WebOrderSubProducts

string[]

object

ServiceTypes

string[]

TextTemplateGuid

string

Update Product Offering › Responses

No data returned

PATCH/v1/cm/product/{id}

curl https://api-stag.utilitycloud.app/v1/cm/product/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "RequestId": "ff175a44-90e6-4579-87f1-7e9aa07d57ac",
  "ID": "ID",
  "Name": "Name",
  "PrimaryProduct": true,
  "EnabledForWebOrder": true,
  "Visible": true,
  "PriceAreas": [
    "string"
  ],
  "InteractiveFields": [
    "string"
  ],
  "EndDate": "2024-08-25T15:00:00Z",
  "ProductIdDefault": "ProductIdDefault",
  "ValidPeriod": "ValidPeriod",
  "IsDisabled": true,
  "DatePreRequisites": {
    "pre": "pre",
    "post": "post"
  },
  "WebOrderSubProducts": [
    "string"
  ],
  "Translations": {
    "key": {
      "Description": "Description",
      "Name": "Name"
    }
  },
  "ServiceTypes": [
    "string"
  ],
  "TextTemplateGuid": "TextTemplateGuid"
}'

Example Request Body

{
  "RequestId": "ff175a44-90e6-4579-87f1-7e9aa07d57ac",
  "ID": "ID",
  "Name": "Name",
  "PrimaryProduct": true,
  "EnabledForWebOrder": true,
  "Visible": true,
  "PriceAreas": [
    "string"
  ],
  "InteractiveFields": [
    "string"
  ],
  "EndDate": "2024-08-25T15:00:00Z",
  "ProductIdDefault": "ProductIdDefault",
  "ValidPeriod": "ValidPeriod",
  "IsDisabled": true,
  "DatePreRequisites": {
    "pre": "pre",
    "post": "post"
  },
  "WebOrderSubProducts": [
    "string"
  ],
  "Translations": {
    "key": {
      "Description": "Description",
      "Name": "Name"
    }
  },
  "ServiceTypes": [
    "string"
  ],
  "TextTemplateGuid": "TextTemplateGuid"
}

json

Example Responses

No example specified for this content type

List Product Offerings

GET

https://api-stag.utilitycloud.app

/v1/cm/products

Bearer (JWT)

Returns a paginated list of all Product Offerings for the tenant.

List Product Offerings › Responses

cm_contract_cm_internal_product[]

cm_contract_cm_internal_product

ID

string

Name

string

PrimaryProduct

boolean

EnabledForWebOrder

boolean

Visible

boolean

PriceAreas

string[]

InteractiveFields

string[]

EndDate

string · date-time

ProductIdDefault

string

ValidPeriod

string

IsDisabled

boolean

object

WebOrderSubProducts

string[]

object

ServiceTypes

string[]

TextTemplateGuid

string

GET/v1/cm/products

curl https://api-stag.utilitycloud.app/v1/cm/products \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "ID": "ID",
    "Name": "Name",
    "PrimaryProduct": true,
    "EnabledForWebOrder": true,
    "Visible": true,
    "PriceAreas": [
      "string"
    ],
    "InteractiveFields": [
      "string"
    ],
    "EndDate": "2024-08-25T15:00:00Z",
    "ProductIdDefault": "ProductIdDefault",
    "ValidPeriod": "ValidPeriod",
    "IsDisabled": true,
    "DatePreRequisites": {
      "pre": "pre",
      "post": "post"
    },
    "WebOrderSubProducts": [
      "string"
    ],
    "Translations": {
      "key": {
        "Description": "Description",
        "Name": "Name"
      }
    },
    "ServiceTypes": [
      "string"
    ],
    "TextTemplateGuid": "TextTemplateGuid"
  }
]

json

application/json

Price List Entries Products

API Reference

Product Offerings

Server

Download schema

Operations related to Product Offerings.

Get Product Offering

GET

https://api-stag.utilitycloud.app

/v1/cm/product/{id}

Bearer (JWT)

Retrieves a single Product Offering by its ID.

Get Product Offering › path Parameters

id

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^… · required

The ID of the Product Offering

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Get Product Offering › Responses

cm_contract_cm_GetProduct200

cm_contract_cm_internal_product

GET/v1/cm/product/{id}

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

Example Responses

{
  "Product": {
    "ID": "ID",
    "Name": "Name",
    "PrimaryProduct": true,
    "EnabledForWebOrder": true,
    "Visible": true,
    "PriceAreas": [
      "string"
    ],
    "InteractiveFields": [
      "string"
    ],
    "EndDate": "2024-08-25T15:00:00Z",
    "ProductIdDefault": "ProductIdDefault",
    "ValidPeriod": "ValidPeriod",
    "IsDisabled": true,
    "DatePreRequisites": {
      "pre": "pre",
      "post": "post"
    },
    "WebOrderSubProducts": [
      "string"
    ],
    "Translations": {
      "key": {
        "Description": "Description",
        "Name": "Name"
      }
    },
    "ServiceTypes": [
      "string"
    ],
    "TextTemplateGuid": "TextTemplateGuid"
  }
}

json

application/json

Update Product Offering

PATCH

https://api-stag.utilitycloud.app

/v1/cm/product/{id}

Bearer (JWT)

Updates one or more fields on a Product Offering.

Update Product Offering › path Parameters

id

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^… · required

The ID of the Product Offering to update.

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Update Product Offering › Request Body

cm_contract_cm_PatchProductRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

ID

string

Name

string

PrimaryProduct

boolean

EnabledForWebOrder

boolean

Visible

boolean

PriceAreas

string[]

InteractiveFields

string[]

EndDate

string · date-time

ProductIdDefault

string

ValidPeriod

string

IsDisabled

boolean

object

WebOrderSubProducts

string[]

object

ServiceTypes

string[]

TextTemplateGuid

string

Update Product Offering › Responses

No data returned

PATCH/v1/cm/product/{id}

curl https://api-stag.utilitycloud.app/v1/cm/product/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "RequestId": "ff175a44-90e6-4579-87f1-7e9aa07d57ac",
  "ID": "ID",
  "Name": "Name",
  "PrimaryProduct": true,
  "EnabledForWebOrder": true,
  "Visible": true,
  "PriceAreas": [
    "string"
  ],
  "InteractiveFields": [
    "string"
  ],
  "EndDate": "2024-08-25T15:00:00Z",
  "ProductIdDefault": "ProductIdDefault",
  "ValidPeriod": "ValidPeriod",
  "IsDisabled": true,
  "DatePreRequisites": {
    "pre": "pre",
    "post": "post"
  },
  "WebOrderSubProducts": [
    "string"
  ],
  "Translations": {
    "key": {
      "Description": "Description",
      "Name": "Name"
    }
  },
  "ServiceTypes": [
    "string"
  ],
  "TextTemplateGuid": "TextTemplateGuid"
}'

Example Request Body

{
  "RequestId": "ff175a44-90e6-4579-87f1-7e9aa07d57ac",
  "ID": "ID",
  "Name": "Name",
  "PrimaryProduct": true,
  "EnabledForWebOrder": true,
  "Visible": true,
  "PriceAreas": [
    "string"
  ],
  "InteractiveFields": [
    "string"
  ],
  "EndDate": "2024-08-25T15:00:00Z",
  "ProductIdDefault": "ProductIdDefault",
  "ValidPeriod": "ValidPeriod",
  "IsDisabled": true,
  "DatePreRequisites": {
    "pre": "pre",
    "post": "post"
  },
  "WebOrderSubProducts": [
    "string"
  ],
  "Translations": {
    "key": {
      "Description": "Description",
      "Name": "Name"
    }
  },
  "ServiceTypes": [
    "string"
  ],
  "TextTemplateGuid": "TextTemplateGuid"
}

json

Example Responses

No example specified for this content type

List Product Offerings

GET

https://api-stag.utilitycloud.app

/v1/cm/products

Bearer (JWT)

Returns a paginated list of all Product Offerings for the tenant.

List Product Offerings › Responses

cm_contract_cm_internal_product[]

cm_contract_cm_internal_product

ID

string

Name

string

PrimaryProduct

boolean

EnabledForWebOrder

boolean

Visible

boolean

PriceAreas

string[]

InteractiveFields

string[]

EndDate

string · date-time

ProductIdDefault

string

ValidPeriod

string

IsDisabled

boolean

object

WebOrderSubProducts

string[]

object

ServiceTypes

string[]

TextTemplateGuid

string

GET/v1/cm/products

curl https://api-stag.utilitycloud.app/v1/cm/products \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "ID": "ID",
    "Name": "Name",
    "PrimaryProduct": true,
    "EnabledForWebOrder": true,
    "Visible": true,
    "PriceAreas": [
      "string"
    ],
    "InteractiveFields": [
      "string"
    ],
    "EndDate": "2024-08-25T15:00:00Z",
    "ProductIdDefault": "ProductIdDefault",
    "ValidPeriod": "ValidPeriod",
    "IsDisabled": true,
    "DatePreRequisites": {
      "pre": "pre",
      "post": "post"
    },
    "WebOrderSubProducts": [
      "string"
    ],
    "Translations": {
      "key": {
        "Description": "Description",
        "Name": "Name"
      }
    },
    "ServiceTypes": [
      "string"
    ],
    "TextTemplateGuid": "TextTemplateGuid"
  }
]

json

application/json

Price List Entries Products