HiveCPQ Product Configurator (Preview)

HiveCPQ is a comprehensive Configure Price Quote (CPQ) solution that empowers sales teams to generate accurate quotes for complex products. Streamline your sales process by seamlessly integrating HiveCPQ to automate workflows, sync data, and optimize your operations using our connector. Maximize efficiency and deliver exceptional sales experiences with HiveCPQ's powerful connector.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name HiveCPQ Support
URL https://hivecpq.com/en/integrations
Email support@hivecpq.com
Connector Metadata
Publisher NimbleOps NV
Website https://hivecpq.com/
Privacy policy https://hivecpq.com/en/privacy-policy
Categories Productivity;Sales and CRM

The HiveCPQ connector allows easy access to a suite of public facing APIs. It allows managing the master-data inside your HiveCPQ environment. It assists in integrating accounts and contacts while also providing the ability to fully automate the sales and quotation process.

Prerequisites

You have to:

  • be an active customer of HiveCPQ
  • have access to a HiveCPQ environment

How to get credentials

A request needs to be made to support@hivecpq.com requesting API credentials in the form of a username & password.

Get started with your connector

In order to use the connector in your own workflows please find it under the following name: HiveCPQ Product Configurator The connector only provides actions, it does not contain any triggers and will require the workflow builder to decide their own trigger mechanism.

The "Get manufacturers" action is the most basic action that any workflow will require. It will provide the ID of the manufacturer company to which you are connected, this ID will be required in all the other available actions.

Additional information on how to start with the connector can be gained by reading through our online documentation here. Access to our documentation is protected with a password only provided to known customers, request access from support@hivecpq.com

Known issues and limitations

Query parameters which allow to pass a list of values will only have the first value respected by the underlying service. This is because of a conflict between the supported formats which powerautomate can use to send multi-value parameters and the format the underlying service accepts.

Common errors and remedies

  • 400 Bad Request:
    • Indicates an issue in the payload received by the service: it is recommended to re-check the inputs used in the connector for invalid values
  • 401 Not Authorized:
    • Indicates an issue with the authentication to the service: it is recommended to renew the connection of the connector
  • 403 Forbidden:
    • Indicates that the access level is not high enough to access a certain resource or perform a specific action: it is recommended to request elevated permissions for the connector user account to support@hivecpq.com
  • 404 Not Found:
    • Indicates that the requested resource does not exist: it is recommended to check the inside of the underlying service if the resource exists

FAQ

How long is the connection to HiveCPQ valid after entering the supplied credentials?

The credentials will remain valid indefinitely. It is possible to request password renewals. The connection itself works based on inactivity expiration. If the connection was not used in any workflow runs for more than 2 weeks it will expire and the credentials will have to be re-entered.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add a complaint

Add a new complaint for a manufacturer.

Add a complaint attachment

Add a new attachment to a specific complaint.

Add a complaint comment

Add a new comment to a specific complaint.

Add a component

Add a component to master data.

Add a component attachment

Add a new attachment to a component in master data.

Add a component price

Add a new price to a component in master data.

Add a configuration to a project

Add a new V2 configuration to a project.

Add a configuration to a segment

Add a V1 configuration to a specific project segment.

Add a custom object

Add a new custom object of a specific type. This type will be created if it does not exist.

Add a distributor account

Add an account to the address book of a distributor.

Add a distributor contact

Add a new contact to the address book of a distributor.

Add a feature to a feature group

Add a new feature to a specific feature group in master data.

Add a new company

Add a new company to a manufacturer.

Add a new default address

Add a new default address to a company.

Add a new property

Add a new property to master data.

Add a price catalog

Add a price catalog for a manufacturer.

Add a project

Add a new project for a company.

Add a standalone configuration

Create a standalone configuration by launching a configuration check for a V2 configurator

Add a unit

Add a new unit to master data.

Add a webhook

Add a new webhook for a manufacturer.

Add a webhook trigger

Add a new trigger to a specific webhook.

Add an invite

Add an invite for a contact to join a company.

Add integrated system link

Add a new integrated system link for a resource.

Add manufacturer contact

Add a new contact to a company of a manufacturer or its companies.

Add new feature group

Add a new feature group to master data.

Add products to a project

Add one or more products to a project of a manufacturer.

Add webhook header

Add a new header to a specific webhook.

Archive a company

Archive a company together with all of its contacts.

Archive a contact

Archive a specific contact and remove its invites.

Archive a project segment

Archive a specific project segment of a manufacturer.

Cancel order process of a project segment

Cancel the order process and move a project segment back to step 2.

Change the feature group of a feature

Change the feature group of a specific feature in master data.

Change the settings of a project segment

Change the settings of a project segment. Settings are only available if a segment configurator is configured.

Copy a project

Copies all data of a project to a new project.

Copy project segment item to another project

Copies a project segment item to another project. If the item has a configuration attached it will automatically be upgraded to the newest version.

Delete a complaint

Delete a specific complaint of a manufacturer.

Delete a component

Delete a component from master data.

Delete a component attachment

Delete an attachment from a component in master data.

Delete a component price

Delete a price from a component in master data.

Delete a component tooltip

Delete a component tooltip from master data.

Delete a component tooltip image

Delete a component tooltip image from master data.

Delete a custom object

Delete a custom object of a specific type.

Delete a default address of a company

Delete a specific default address of a company.

Delete a distributor account

Delete a specific account from the address book of a distributor. An account can only be removed if it is not used in any projects and has no contacts.

Delete a distributor contact

Delete a specific contact from the address book of a distributor.

Delete a feature

Delete a feature from a specific feature group in master data.

Delete a feature group

Delete a specific feature group from master data.

Delete a price catalog

Delete a specific price catalog.

Delete a project segment item

Delete a specific project segment item from a project.

Delete a property

Delete a specific property from master data.

Delete a unit

Delete a specific unit from master data.

Delete a webhook

Delete a specific webhook of a manufacturer.

Delete a webhook trigger

Delete a specific trigger of a webhook.

Delete an integrated system link

Delete a specific integrated system link.

Delete components in bulk

Delete multiple components in master data.

Delete the header of a webhook

Delete the header of a specific webhook.

Generate a document for a project

Generate a PDF document for a specific project. The template ID is optional only if the document type is QUOTE and a default template has been configured.

Get a company

Get a specific company linked to a manufacturer.

Get a complaint

Get a specific complaint of a manufacturer.

Get a complaint attachment

Get an attachment of a specific complaint.

Get a component

Get a specific component in master data.

Get a component tooltip

Get a specific component tooltip in master data.

Get a component tooltip image

Get a specific component tooltip image from master data.

Get a configuration

Get a specific configuration of a manufacturer.

Get a custom object

Get a custom object of a specific type.

Get a default address of a company

Get a specific default address of a company.

Get a feature from a feature group

Get a feature in a specific feature group in master data.

Get a feature group

Get a specific feature group in master data.

Get a manufacturer contact

Get a specific contact of a manufacturer or its companies.

Get a price catalog

Get a specific price catalog of a manufacturer.

Get a project

Get a specific project of a manufacturer.

Get a project segment

Get a specific project segment of a manufacturer.

Get a unit

Get a specific unit from master data.

Get a user account

Get a specific user account connected to the given manufacturer.

Get a webhook

Get a specific webhook of a manufacturer.

Get a webhook trigger

Get a specific trigger of a webhook.

Get file from a configuration

Get the file attached to a file node in the configuration.

Get manufacturers

Get all manufacturers to which you are connected.

Get plugin token information

Get information about the user who is currently using a plugin from within HiveCPQ.

Get project segment item

Get a specific project segment item of a manufacturer.

Link a feature to a component

Links one feature to a component in master data.

Link features to a component

Links one or more features to a component in master data. Existing links will be overwritten or deleted.

Move a project segment to step 1

Move a specific project segment to step 1. This starts the order process.

Move a project segment to step 2

Move a specific project segment to step 2. This creates an order for the project segment.

Move a project segment to step 3

Move a specific project segment to step 3.

Move a project segment to step 4

Move a specific project segment to step 4.

Recalculate a project

Start an asynchronous recalculation of the project.

Refresh the prices in running projects

Refresh prices of all projects which have not yet reached step 2 in the order process with master data.

Removes the attachment from a complaint

Removes the attachment from a complaint

Render a configuration screenshot

Render a screenshot of a configuration.

Reorder features in a feature group

Reorder the features in a specific feature group to change how they are displayed in the product store. All existing features in the group must be part of the request.

Reorder the feature groups

Reorder the feature groups to change how they are displayed in the product store. All existing groups must be part of the request.

Replace complaint comments

Replace all comments of a specific complaint.

Reset custom objects cache

Configurators may use caching when handling custom objects. Calling this endpoint will reset those caches.

Search companies

Search companies linked to a manufacturer.

Search complaint attachments

Search attachments of a specific complaint.

Search complaint comments

Search comments of a specific complaint.

Search complaints

Search complaints of a manufacturer

Search component attachments

Search attachments of a component in master data.

Search component prices

Search prices of a component in master data.

Search component property values

Search property values of a component in master data.

Search components

Search components in master data.

Search container versions

Search container versions of a manufacturer.

Search custom object types

Search custom object types of a manufacturer.

Search custom objects

Search custom objects of a specific type.

Search default addresses of a company

Search the default invoice and delivery addresses of a company.

Search delivery conditions

Search delivery conditions of a manufacturer.

Search distributor accounts

Search accounts in the address book of a distributor.

Search distributor contacts

Search contacts in the address book of a distributor.

Search event subscriptions

Search event subscriptions to which you are subscribed.

Search events

Search platform events of a manufacturer.

Search feature groups

Search feature groups in master data.

Search features

Search features in a specific feature group in master data.

Search integrated system links

Search integrated system links of a manufacturer. An Integrated System link stores a link between a Hive entity and an external system entity.

Search invites

Search invites of a manufacturer.

Search manufacturer contacts

Search contacts linked to a manufacturer or its companies.

Search output document templates

Search output document templates of a manufacturer.

Search payment conditions

Search payment conditions of a manufacturer.

Search permissions

Search permissions of a manufacturer.

Search price catalogs

Search price catalogs of a manufacturer.

Search project segment items

Search project segment items of a specific manufacturer.

Search project segments

Search project segments of a manufacturer.

Search projects

Search projects of a manufacturer.

Search properties

Search properties in master data.

Search roles

Search roles the manufacturer has defined for its own contacts and those of its distributors.

Search tax conditions

Search tax conditions of a manufacturer.

Search units

Search units in master data.

Search webhook headers

Search headers of a specific webhook.

Search webhook triggers

Search triggers of a specific webhook.

Search webhooks

Search webhooks configured for a manufacturer.

Send invitation email

Send an invitation email using the HiveCPQ email system.

Set component property value

Set a single property value on a component in master data.

Set component property values

Set multiple property values on a component in master data. Existing values are overwritten or deleted.

Subscribe to events

Subscribe to events of a manufacturer. Existing subscriptions will be overwritten or deleted.

Unarchive a company

Unarchive a company without unarchiving its contacts.

Unarchive a project segment

Unarchive a specifc project segment of a manufacturer.

Unlink a feature from a component

Unlinks a feature from a specific component in master data.

Update a company

Update a specific company of a manufacturer.

Update a complaint

Update a specific complaint of a manufacturer.

Update a component

Update a specific component in master data.

Update a component tooltip

Update a specific component tooltip in master data.

Update a component tooltip image

Update a specific component tooltip image in master data.

Update a custom object

Update a specific custom object of a specific type.

Update a default address of a company

Update a specific default address of a company.

Update a distributor contact

Update a specific contact in the address book of a distributor.

Update a feature

Update a feature in a specific feature group in master data.

Update a feature group

Update a specific feature group in master data.

Update a integrated system link

Update a specific integrated system link of a manufacturer.

Update a manufacturer contact

Update a specific contact of a manufacturer or its companies.

Update a price catalog

Update a specific price catalog of a manufacturer.

Update a project

Update a specific project of a manufacturer.

Update a project segment

Update a specific project segment of a manufacturer.

Update a project segment item

Update a specific project segment item of a manufacturer.

Update a property

Update a specific property in master data.

Update a unit

Update a specific unit in master data.

Update a webhook

Update a webhook of a manufacturer.

Update a webhook trigger

Update a specific trigger of a webhook.

Update configuration

Update the values of the nodes in a configuration.

Update distributor account

Update a specific account in the address book of a distributor.

Upsert component prices in bulk

Create or update multiple component prices in master data.

Add a complaint

Add a new complaint for a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

title
title True string

The title of the complaint.

description
description True string

The description of the complaint.

companyId
companyId True string

The ID of the company that opened the complaint.

articleNumber
articleNumber string

The identifier of an article.

quantity
quantity integer

The quantity of the article.

type
type True string

The type of a complaint.

status
status string

The status of a complaint.

orderReference
orderReference True string

Reference to an order.

claimNumber
claimNumber True string

Number or identifier of this claim.

createdByContactId
createdByContactId string

ID of the contact who created the complaint.

createdAt
createdAt string

Timestamp of object creation.

updatedByContactId
updatedByContactId string

ID of the contact who updated the complaint.

updatedAt
updatedAt string

Timestamp of the latest update.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a complaint attachment

Add a new attachment to a specific complaint.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

File
file True file

The file to upload.

Add a complaint comment

Add a new comment to a specific complaint.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

comment
comment True string

The comment of a user.

createdByContactId
createdByContactId string

ID of the contact who created the comment.

createdAt
createdAt string

Timestamp of object creation.

updatedByContactId
updatedByContactId string

ID of the contact who updated the comment.

updatedAt
updatedAt string

Timestamp of the latest update.

Add a component

Add a component to master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

articleCode
articleCode True string

The unique article code.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

eanCode
eanCode string

The European Article Number.

gtinCode
gtinCode string

The Global Trade Item Number.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

productGroup
productGroup string

The group to which your component belongs.

features
features array of string

A collection of feature codes.

code
code True string

The property code for which the new value should be set.

value
value string

The new value of the property if it is not of an array type.

arrayValues
arrayValues array of string

The new collection of values of the property if it is an array type.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a component attachment

Add a new attachment to a component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

File
file True file

The file to upload.

Is An image
isImage boolean

Indicate whether the uploaded file is an image or an info file.

Add a component price

Add a new price to a component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

costPrice
costPrice float

Cost price of the component.

listPrice
listPrice True float

List price of the component.

purchasePrice
purchasePrice float

Purchase price of the component.

subDistributorPurchasePrice
subDistributorPurchasePrice float

Sub-distributor purchase price of the component.

priceCatalogId
priceCatalogId True string

Price catalog ID to which this price belongs.

currency
currency True string

The currency in ISO 4217 format.

unitId
unitId True string

ID of the unit to be used with the price.

Add a configuration to a project

Add a new V2 configuration to a project.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project ID
projectId True string

ID of the project you want to access.

quantity
quantity integer

The quantity of this configuration to be added.

configuratorId
configuratorId True string

ID of a V2 configurator.

name
name string

Name of the configuration.

uniqueLabel
uniqueLabel string

The unique identifier of the node.

value
value string

The textual representation of the node value.

quantity
quantity integer

The quantity of items represented by this node used to calculate the total node price.

optional
optional boolean

Mark the node as optional.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a configuration to a segment

Add a V1 configuration to a specific project segment.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

configuratorId
configuratorId True string

ID of a V1 configurator.

initialValues
initialValues object

The input values used to initialize the configuration.

quantity
quantity integer

The quantity of the item.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a custom object

Add a new custom object of a specific type. This type will be created if it does not exist.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Custom Object Type
customObjectType True string

Name of the custom object type you want to access.

key
key True string

A unique key which will be used to identify a value inside of a single custom object.

value
value

A textual representation of the value to be saved for the key.

dataType
dataType string

The data types which can be used for custom object values.

Add a distributor account

Add an account to the address book of a distributor.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Distributor ID
distributorId True string

ID of the distributor you want to access.

name
name string

The company name.

description
description string

Additional info about the company.

vatNumber
vatNumber string

VAT number of the company.

phone
phone string

Phone number of the company.

email
email string

E-mail address of the company.

websiteUrl
websiteUrl string

URL to the website of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a distributor contact

Add a new contact to the address book of a distributor.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Distributor ID
distributorId True string

ID of the distributor you want to access.

firstName
firstName True string

First name of the contact.

lastName
lastName True string

Last name of the contact.

email
email True string

E-mail address of the contact.

salutation
salutation string

Salutation of the contact.

function
function string

Job title of the contact.

phone
phone string

Phone number of the contact.

mobile
mobile string

Mobile phone number of the contact

preferredLanguageIso
preferredLanguageIso string

Default language of the contact in ISO 639-1 format.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

vatNumber
vatNumber string

VAT number for the contact.

vatCondition
vatCondition string

The default VAT condition code for this contact. Available codes are defined inside your HiveCPQ environment.

deliveryCondition
deliveryCondition string

The default delivery condition code for this contact. Available codes are defined inside your HiveCPQ environment.

paymentCondition
paymentCondition string

The default payment condition code for for this contact. Available codes are defined inside your HiveCPQ environment.

accountId
accountId string

ID of the distributor account to which the contact should be added.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a feature to a feature group

Add a new feature to a specific feature group in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

code
code True string

Unique code for the feature.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

serialSearchFunction
serialSearchFunction string

A JavaScript function which determines the visibility in the product store.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a new company

Add a new company to a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

name
name True string

Name of the company.

description
description string

Additional info about the company.

vatNumber
vatNumber string

VAT number of the company.

email
email email

E-mail address of the company.

telephone
telephone string

Phone number of the company.

websiteUrl
websiteUrl string

URL to the website of the company.

preferredLanguage
preferredLanguage string

The default language for the company in ISO 639-1 format.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

externalSystemId1
externalSystemId1 string

An ID used to identify the company in an external system. It is usually recommended to use a system link instead.

externalSystemId2
externalSystemId2 string

An ID used to identify the company in an external system. It is usually recommended to use a system link instead.

salesRepresentativeContactId
salesRepresentativeContactId string

ID of a contact who functions as sales representative.

techSupportManagerContactId
techSupportManagerContactId string

ID of a contact who functions as technical support manager.

orderProcessingManagerContactId
orderProcessingManagerContactId string

ID of a contact who functions as order processing manager.

shippingManagerContactId
shippingManagerContactId string

ID of a contact who functions as shipping support manager.

vatConditionCode
vatConditionCode string

The default VAT condition code to use in projects of this company. Available codes are defined inside your HiveCPQ environment.

deliveryConditionCode
deliveryConditionCode string

The default delivery condition code to use in projects of this company. Available codes are defined inside your HiveCPQ environment.

paymentConditionCode
paymentConditionCode string

The default payment condition code to use in projects of this company. Available codes are defined inside your HiveCPQ environment.

baseDiscount
baseDiscount float

The default discount to use for configurations in projects of this company.

orderCurrency
orderCurrency string

Default order currency of the company.

fee
fee float

The fee applied if a project for this company does not reach the fee threshold.

threshold
threshold float

The minimum price below which a fee will be applied.

enabled
enabled boolean

Allow this company to access the product store

storeDiscountPercentage
storeDiscountPercentage float

The discount percentage applied to product store items in a project of this company.

defaultVatConditionCode
defaultVatConditionCode string

The default VAT condition code to use in projects for this company. Available codes are defined inside your HiveCPQ environment.

defaultPaymentConditionCode
defaultPaymentConditionCode string

The default payment condition code to use in projects for this company. Available codes are defined inside your HiveCPQ environment.

salesPricingStrategy
salesPricingStrategy string

The default pricing strategy to use in projects for this company.

distributorId
distributorId True string

ID of the distributor company to which this sub-distributor will be linked.

orderEmails
orderEmails array of email

All sub-distributor e-mails which will receive order e-mails.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a new default address

Add a new default address to a company.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Company ID
companyId True string

ID of the company you want to access.

companyName
companyName True string

Name of the default delivery or invoice company.

type
type True string

The default address type.

addressLine1
addressLine1 True string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city True string

The city.

postalCode
postalCode True string

The postal code.

countryIso
countryIso True string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

contactPerson
contactPerson True string

Name of a contact at the default delivery or invoice company.

contactPhone
contactPhone True string

Phone number of a contact at the default delivery or invoice company.

email
email True email

Contact e-mail of the default delivery or invoice company.

vatNumber
vatNumber string

VAT number to be used for the default invoice company.

canChangeAddress
canChangeAddress boolean

Allow the distributor to modify their default delivery and invoice addresses.

canChangeAddressOnPlaceOrder
canChangeAddressOnPlaceOrder boolean

Allow the distributor to modify their default delivery and invoice addresses during the order process.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a new property

Add a new property to master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

code
code True string

Unique code for the property.

type
type True string

Type of the property

arrayType
arrayType string

Type of the array property.

info
info string

General info about the property.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a price catalog

Add a price catalog for a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

name
name True string

Unique name for the price catalog.

defaultPriceCatalog
defaultPriceCatalog boolean

Set the price catalog as default.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a project

Add a new project for a company.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

companyId
companyId True string

ID of the distributor to which the project belongs.

name
name string

Name of the project.

sellToCustomerReference
sellToCustomerReference string

A reference for the end customer.

accountId
accountId string

ID of an account in the address book.

contactId
contactId string

ID of a contact in the given account.

accountId
accountId string

ID of an account in the address book.

contactId
contactId string

ID of a contact in the given account.

accountId
accountId string

ID of an account in the address book.

contactId
contactId string

ID of a contact in the given account.

accountId
accountId string

ID of an account in the address book.

contactId
contactId string

ID of a contact in the given account.

taxCondition
taxCondition string

The VAT condition code of the project. Available codes are defined inside your HiveCPQ environment.

deliveryCondition
deliveryCondition string

The delivery condition code of the project. Available codes are defined inside your HiveCPQ environment.

paymentCondition
paymentCondition string

The payment condition code of the project. Available codes are defined inside your HiveCPQ environment.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a standalone configuration

Create a standalone configuration by launching a configuration check for a V2 configurator

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

configuratorId
configuratorId True string

ID of a V2 configurator

versionId
versionId string

ID of the container version to which the master data in the configuration belongs.

uniqueLabel
uniqueLabel string

The unique identifier of the node.

value
value string

The textual representation of the node value.

quantity
quantity integer

The quantity of items represented by this node used to calculate the total node price.

optional
optional boolean

Mark the node as optional.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a unit

Add a new unit to master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

code
code True string

The unique code of the unit.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add a webhook

Add a new webhook for a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

code
code True string

A unique code for the webhook.

url
url True string

The callback URL of the webhook.

description
description string

Additional info about the webhook.

eventSubscriptions
eventSubscriptions string

The events to which a webhook can subscribe.

Add a webhook trigger

Add a new trigger to a specific webhook.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

code
code True string

A unique code for the trigger.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

confirmationRequired
confirmationRequired boolean

Enable or disable the confirmation modal when a user activates a webhook trigger.

openInSameTab
openInSameTab boolean

Enable opening the URL in the same browser tab when using the OPEN_URL type.

location
location True string

The location of the webhook trigger in the UI of HiveCPQ.

type
type True string

The type of the webhook trigger.

permissionIds
permissionIds array of string

A collection of permission IDs which have access to the trigger.

Add an invite

Add an invite for a contact to join a company.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

contactId
contactId string

ID of the contact.

integratedSystemName
integratedSystemName string

Name of an external system where the contact is known. This must be used together with integratedSystemId.

integratedSystemId
integratedSystemId string

ID of the contact in the external system. This must be used together with integratedSystemName.

contactId
contactId string

ID of the contact.

integratedSystemName
integratedSystemName string

Name of an external system where the contact is known. This must be used together with integratedSystemId.

integratedSystemId
integratedSystemId string

ID of the contact in the external system. This must be used together with integratedSystemName.

enableSSO
enableSSO boolean

Enable Single-Sign-On for this contact.

Add a new integrated system link for a resource.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

integratedSystemName
integratedSystemName True string

Name of the external system.

integratedSystemId
integratedSystemId True string

ID of the integrated resource.

resourceType
resourceType True string

The types of resources for which integrated system links can be created.

hiveId
hiveId True string

ID of the HiveCPQ resource.

Returns

Name Path Type Description
integratedSystemName
integratedSystemName string

integratedSystemName

integratedSystemId
integratedSystemId string

integratedSystemId

resourceType
resourceType enumSystemLinkResourceType

The types of resources for which integrated system links can be created.

hiveId
hiveId string

hiveId

Add manufacturer contact

Add a new contact to a company of a manufacturer or its companies.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

companyId
companyId True string

ID of the company in which the contact should be created.

roleIds
roleIds True array of string

IDs of all roles which should be assigned to the contact.

firstName
firstName string
lastName
lastName string
email
email email
phone
phone string
mobile
mobile string
preferredLanguage
preferredLanguage string

The default language of the contact in ISO 639-1 format.

functionTitle
functionTitle string
addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

salutation
salutation string
externalSystemId
externalSystemId string

An ID which can identify the contact in an external system. It is usually recommended to use a system link instead.

avatarUrl
avatarUrl string

A publicly accessible URL to an image which will be used as the avatar.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add new feature group

Add a new feature group to master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

code
code True string

Unique code for the feature group.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Add products to a project

Add one or more products to a project of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project ID
projectId True string

ID of the project you want to access.

articleCode
articleCode True string

The article code of the product that should be added.

quantity
quantity True integer

The quantity of this product to be added.

serialNumber
serialNumber string

A serial number to identify the product in external systems.

serialMatched
serialMatched boolean

Match the serial number with the product when using product histories.

mainCategoryName
mainCategoryName string

Code of the main category in which to find the product.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Returns

Name Path Type Description
array of string

List of IDs of all created project segment items.

Add webhook header

Add a new header to a specific webhook.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

key
key True string

An HTTP header key which the webhook adds during a callback.

value
value True string

An HTTP header value for the key which the webhook adds during a callback.

Archive a company

Archive a company together with all of its contacts.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Company ID
companyId True string

ID of the company you want to access.

Archive a contact

Archive a specific contact and remove its invites.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Contact ID
contactId True string

ID of the contact you want to access.

Archive a project segment

Archive a specific project segment of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

Cancel order process of a project segment

Cancel the order process and move a project segment back to step 2.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

Change the feature group of a feature

Change the feature group of a specific feature in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

Feature ID
featureId True string

ID of the feature you want to access.

newFeatureGroupId
newFeatureGroupId True string

ID of the new feature group.

Change the settings of a project segment

Change the settings of a project segment. Settings are only available if a segment configurator is configured.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

inputs
inputs object

A map of keys and values used as input for a segment configurator.

Copy a project

Copies all data of a project to a new project.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project ID
projectId True string

ID of the project you want to access.

projectName
projectName True string

Name of the new project.

distributorId
distributorId string

Distributor for the new project. Distributor of the original project will be used if not provided.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Copy project segment item to another project

Copies a project segment item to another project. If the item has a configuration attached it will automatically be upgraded to the newest version.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment Item ID
projectSegmentItemId True string

ID of the project segment item you want to access.

projectId
projectId True string

ID of the target project.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the integrated resource.

Delete a complaint

Delete a specific complaint of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

Delete a component

Delete a component from master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Delete a component attachment

Delete an attachment from a component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Attachment ID
attachmentId True string

ID of the attachment you want to access.

Delete a component price

Delete a price from a component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Component Price ID
componentPriceId True string

The component price you want to access.

Delete a component tooltip

Delete a component tooltip from master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Delete a component tooltip image

Delete a component tooltip image from master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Delete a custom object

Delete a custom object of a specific type.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Custom Object Type
customObjectType True string

Name of the custom object type you want to access.

Custom Object ID
customObjectKey True string

ID of the custom object you want to access.

Delete a default address of a company

Delete a specific default address of a company.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Company ID
companyId True string

ID of the company you want to access.

Default Address ID
defaultAddressId True string

ID of the default address you want to access.

Delete a distributor account

Delete a specific account from the address book of a distributor. An account can only be removed if it is not used in any projects and has no contacts.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Distributor ID
distributorId True string

ID of the distributor you want to access.

Account ID
accountId True string

ID of the account you want to access.

Delete a distributor contact

Delete a specific contact from the address book of a distributor.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Distributor ID
distributorId True string

ID of the distributor you want to access.

Contact ID
contactId True string

ID of the contact you want to access.

Delete a feature

Delete a feature from a specific feature group in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

Feature ID
featureId True string

ID of the feature you want to access.

Delete a feature group

Delete a specific feature group from master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

Delete a price catalog

Delete a specific price catalog.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Price Catalog ID
priceCatalogId True string

ID of the catalog you want to access.

Delete a project segment item

Delete a specific project segment item from a project.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment Item ID
projectSegmentItemId True string

ID of the project segment item you want to access.

Delete a property

Delete a specific property from master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Property ID
propertyId True string

ID of the property you want to access.

Delete a unit

Delete a specific unit from master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Unit ID
unitId True string

ID of the unit you want to access.

Delete a webhook

Delete a specific webhook of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

Delete a webhook trigger

Delete a specific trigger of a webhook.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

Webhook Trigger ID
webhookTriggerId True string

ID of the webhook trigger you want to access.

Delete a specific integrated system link.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Integrated System Link ID
integratedSystemLinkId True string

ID of the integrated system link you want to access.

Delete components in bulk

Delete multiple components in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

idsNotIn
idsNotIn array of string

A list of component IDs which should not be deleted. It cannot be used together with idsIn.

idsIn
idsIn array of string

A list of component IDs which should be deleted. It cannot be used together with idsNotIn.

Delete the header of a webhook

Delete the header of a specific webhook.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

Webhook Header ID
headerId True string

ID of the webhook header you want to access.

Generate a document for a project

Generate a PDF document for a specific project. The template ID is optional only if the document type is QUOTE and a default template has been configured.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project ID
projectId True string

ID of the project you want to access.

type
type string

Type of the output document template.

outputDocumentTemplateId
outputDocumentTemplateId string

ID of an output document template.

language
language True string

The ISO 639-1 language code the document should be generated in.

Get a company

Get a specific company linked to a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Company ID
companyId True string

ID of the company you want to access.

Returns

Get a complaint

Get a specific complaint of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

Returns

Get a complaint attachment

Get an attachment of a specific complaint.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

Attachment ID
attachmentId True string

ID of the attachment you want to access.

Get a component

Get a specific component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Returns

Get a component tooltip

Get a specific component tooltip in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Returns

Get a component tooltip image

Get a specific component tooltip image from master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Get a configuration

Get a specific configuration of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Configuration ID
configurationId True string

ID of the configuration you want to access.

Unique Label
uniqueLabel array

Filter on the unique label of the configuration nodes.

Include Optional Nodes
includeOptionalNodes boolean

Filter or include optional configuration nodes.

Returns

Get a custom object

Get a custom object of a specific type.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Custom Object Type
customObjectType True string

Name of the custom object type you want to access.

Custom Object ID
customObjectKey True string

ID of the custom object you want to access.

Returns

Get a default address of a company

Get a specific default address of a company.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Company ID
companyId True string

ID of the company you want to access.

Default Address ID
defaultAddressId True string

ID of the default address you want to access.

Returns

Get a feature from a feature group

Get a feature in a specific feature group in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

Feature ID
featureId True string

ID of the feature you want to access.

Returns

Get a feature group

Get a specific feature group in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

Returns

Get a manufacturer contact

Get a specific contact of a manufacturer or its companies.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Contact ID
contactId True string

ID of the contact you want to access.

Returns

Get a price catalog

Get a specific price catalog of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Price Catalog ID
priceCatalogId True string

ID of the catalog you want to access.

Returns

Get a project

Get a specific project of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project ID
projectId True string

ID of the project you want to access.

Returns

Get a project segment

Get a specific project segment of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

Returns

Get a unit

Get a specific unit from master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Unit ID
unitId True string

ID of the unit you want to access.

Returns

Get a user account

Get a specific user account connected to the given manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

User Account ID
userAccountId True string

ID of the user account you want to access.

Returns

Get a webhook

Get a specific webhook of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

Returns

Get a webhook trigger

Get a specific trigger of a webhook.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

Webhook Trigger ID
webhookTriggerId True string

ID of the webhook trigger you want to access.

Returns

Get file from a configuration

Get the file attached to a file node in the configuration.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Configuration ID
configurationId True string

ID of the configuration you want to access.

File Node Unique Label
uniqueLabel True string

The unique label of the file node.

Get manufacturers

Get all manufacturers to which you are connected.

Returns

Get plugin token information

Get information about the user who is currently using a plugin from within HiveCPQ.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Plugin Token ID
pluginTokenId True string

The plugin token generated by a Hive Plugin from which you want to retrieve user data.

Returns

Get project segment item

Get a specific project segment item of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment Item ID
projectSegmentItemId True string

ID of the project segment item you want to access.

Returns

Links one feature to a component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Feature ID
featureId True string

ID of the feature you want to access.

Links one or more features to a component in master data. Existing links will be overwritten or deleted.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

featureCodes
featureCodes True array of string

A collection of feature codes.

Move a project segment to step 1

Move a specific project segment to step 1. This starts the order process.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

customerPoRef
customerPoRef True string

Purchase order reference.

orderRemark
orderRemark True string

Remark on the order.

shippingDateRequested
shippingDateRequested True date-time

The requested date in ISO-8601 format.

vatCondition
vatCondition string

The VAT condition code. Available codes are defined inside your HiveCPQ environment.

deliveryCondition
deliveryCondition string

The delivery condition code. Available codes are defined inside your HiveCPQ environment.

paymentCondition
paymentCondition string

The payment condition code. Available codes are defined inside your HiveCPQ environment.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

Returns

response
string

Move a project segment to step 2

Move a specific project segment to step 2. This creates an order for the project segment.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

customerPoRef
customerPoRef True string

Purchase order reference.

orderRemark
orderRemark True string

Remark on the order.

shippingDateRequested
shippingDateRequested True date-time

The requested date in ISO-8601 format.

vatCondition
vatCondition string

The VAT condition code. Available codes are defined inside your HiveCPQ environment.

deliveryCondition
deliveryCondition string

The delivery condition code. Available codes are defined inside your HiveCPQ environment.

paymentCondition
paymentCondition string

The payment condition code. Available codes are defined inside your HiveCPQ environment.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

Returns

response
string

Move a project segment to step 3

Move a specific project segment to step 3.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

orderRemarkSupplier
orderRemarkSupplier True string

Remark of the manufacturer on the order.

supplierSoRef
supplierSoRef True string

Sales order reference.

shippingDateConfirmed
shippingDateConfirmed date-time

The confirmed date in ISO-8601 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

Returns

response
string

Move a project segment to step 4

Move a specific project segment to step 4.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

orderRemarkSupplier
orderRemarkSupplier True string

Remark of the manufacturer on the order.

supplierSoRef
supplierSoRef True string

Sales order reference.

shippingDateConfirmed
shippingDateConfirmed True date-time

The confirmed date in ISO-8601 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

Returns

response
string

Recalculate a project

Start an asynchronous recalculation of the project.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project ID
projectId True string

ID of the project you want to access.

Refresh the prices in running projects

Refresh prices of all projects which have not yet reached step 2 in the order process with master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

updateProductStorePrices
updateProductStorePrices boolean

Refresh prices of items in the product store.

projectRecalculationRequired
projectRecalculationRequired boolean

Require projects to be recalculated after the update.

updateConfiguratorPrices
updateConfiguratorPrices boolean

Update the prices of configurations.

Removes the attachment from a complaint

Removes the attachment from a complaint

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

Attachment ID
attachmentId True string

ID of the attachment you want to access.

Render a configuration screenshot

Render a screenshot of a configuration.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Configuration ID
configurationId True string

ID of the configuration you want to access.

Reorder features in a feature group

Reorder the features in a specific feature group to change how they are displayed in the product store. All existing features in the group must be part of the request.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

featureIds
featureIds True array of string

A collection of all feature IDs in the specified feature group in the desired sequence.

Reorder the feature groups

Reorder the feature groups to change how they are displayed in the product store. All existing groups must be part of the request.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

featureGroupIds
featureGroupIds True array of string

A collection of all feature group IDs in the desired sequence.

Replace complaint comments

Replace all comments of a specific complaint.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

comment
comment True string

The comment of a user.

createdByContactId
createdByContactId string

ID of the contact who created the comment.

createdAt
createdAt string

Timestamp of object creation.

updatedByContactId
updatedByContactId string

ID of the contact who updated the comment.

updatedAt
updatedAt string

Timestamp of the latest update.

Reset custom objects cache

Configurators may use caching when handling custom objects. Calling this endpoint will reset those caches.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Search companies

Search companies linked to a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Company Name
name string

Filter on the name of the companies.

Archival Status
includeArchived boolean

Filter on the archival status of the companies.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search complaint attachments

Search attachments of a specific complaint.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

Returns

Search complaint comments

Search comments of a specific complaint.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

Returns

Search complaints

Search complaints of a manufacturer

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Complaint Status
status string

Filter on the status of the complaints.

Complaint Type
type string

Filter on the type of the complaints.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search component attachments

Search attachments of a component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Is An Image
isImage boolean

Filter on whether the file is an image.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search component prices

Search prices of a component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Returns

Search component property values

Search property values of a component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search components

Search components in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Price Catalog ID
priceCatalogId string

Filter on the price catalog used in the price(s) of the components.

Feature IDs
featureIds array

Filter on the features linked to the components.

Article Code
articleCode string

Filter on the article code of the components.

EAN Code
eanCode string

Filter on the EAN code of the components.

GTIN Code
gtinCode string

Filter on the GTIN code of the components.

Language
language string

Specify the ISO 639-1 language code in which translated fields should be returned. If not provided, the language of the user is used.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search container versions

Search container versions of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

By IDs
idsIn array

Filter on the IDs of the items.

Container Version Status
status string

Filter on the status of the container versions.

Container Version Type
type string

Filter on the type of the container versions.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search custom object types

Search custom object types of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search custom objects

Search custom objects of a specific type.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Custom Object Type
customObjectType True string

Name of the custom object type you want to access.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search default addresses of a company

Search the default invoice and delivery addresses of a company.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Company ID
companyId True string

ID of the company you want to access.

Returns

Search delivery conditions

Search delivery conditions of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Language
language string

Specify the ISO 639-1 language code in which translated fields should be returned. If not provided, the language of the user is used.

Returns

Search distributor accounts

Search accounts in the address book of a distributor.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Distributor ID
distributorId True string

ID of the distributor you want to access.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search distributor contacts

Search contacts in the address book of a distributor.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Distributor ID
distributorId True string

ID of the distributor you want to access.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Account ID
accountId string

Filter on the account to which the contacts are connected.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search event subscriptions

Search event subscriptions to which you are subscribed.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

Returns

Search events

Search platform events of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Event Type
eventType string

Filter on the type of the events.

Event Type Group
eventGroup string

Filter on the group of the event types.

Events That Happened After
dateOccurredAfter date-time

Filter events which happened after the specified date and time.

Event Type
targetIntegrationName string

Filter events related to the external system integrating with Hive.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search feature groups

Search feature groups in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Language
language string

Specify the ISO 639-1 language code in which translated fields should be returned. If not provided, the language of the user is used.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search features

Search features in a specific feature group in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Language
language string

Specify the ISO 639-1 language code in which translated fields should be returned. If not provided, the language of the user is used.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search integrated system links of a manufacturer. An Integrated System link stores a link between a Hive entity and an external system entity.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Integrated System IDs
integratedSystemIdsIn True array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Integrated System Name
integratedSystemName True string

Filter on the integrated system name of the items.

Resource Type
resourceType True string

Filter on the resource type of the integrated system links.

Returns

Search invites

Search invites of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Contact Integrated System ID
integratedContactSystemId string

Filter on the integrated system ID of the contact to which the invite is sent. This must be used together with the integrated system name filter.

Contact ID
contactId string

Filter on the contact to which the invite is sent.

Contact Status
status string

Filter on the status of the invites.

Returns

Search manufacturer contacts

Search contacts linked to a manufacturer or its companies.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Company ID
companyId string

Filter on the company of the items.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search output document templates

Search output document templates of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search payment conditions

Search payment conditions of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Language
language string

Specify the ISO 639-1 language code in which translated fields should be returned. If not provided, the language of the user is used.

Returns

Search permissions

Search permissions of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Permission Code
code string

Filter on the code of the permissions.

Role ID
roleId string

Filter on the role to which the permissions are connected.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search price catalogs

Search price catalogs of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Price Catalog Name
name string

Filter on the name of the price catalogs.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search project segment items

Search project segment items of a specific manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Last Updated Since
updatedSince date-time

Retrieve all results which were last updated no sooner than the specified time.

Project Segment ID
projectSegmentId string

Filter on the project segment of the items.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search project segments

Search project segments of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Company ID
companyBId string

Filter on the distributor company the project segments are created for.

Step
step string

Filter on the step in the order flow of the project segments.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search projects

Search projects of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Last Updated Since
updatedSince date-time

Retrieve all results which were last updated no sooner than the specified time.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search properties

Search properties in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search roles

Search roles the manufacturer has defined for its own contacts and those of its distributors.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Only Default Manufacturer Roles
defaultRoleForManufacturerCompany boolean

Filter the roles to those used as default for users of your manufacturer company.

Only Default Distributor Roles
defaultRoleForDistributorCompanies boolean

Filter the roles to those used as default for users of your distributor companies.

Role Name
name string

Filter on the name of the roles.

Company ID
companyId string

Filter on the company of the items.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search tax conditions

Search tax conditions of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Language
language string

Specify the ISO 639-1 language code in which translated fields should be returned. If not provided, the language of the user is used.

Returns

Search units

Search units in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

By IDs
idsIn array

Filter on the IDs of the items.

Integrated System Name
integratedSystemName string

Filter on the integrated system name of the items.

Integrated System IDs
integratedSystemIdsIn array

Filter on the integrated system ID of the items. This must be used together with the integrated system name filter.

Unit Code
code string

Filter on the code of the units.

Language
language string

Specify the ISO 639-1 language code in which translated fields should be returned. If not provided, the language of the user is used.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search webhook headers

Search headers of a specific webhook.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

Returns

Search webhook triggers

Search triggers of a specific webhook.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

Language
language string

Specify the ISO 639-1 language code in which translated fields should be returned. If not provided, the language of the user is used.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Search webhooks

Search webhooks configured for a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Language
language string

Specify the ISO 639-1 language code in which translated fields should be returned. If not provided, the language of the user is used.

Page Number
page integer

View a page of the collection.

Page Size
pageSize integer

Control the size of the returned page.

Returns

Send invitation email

Send an invitation email using the HiveCPQ email system.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Invite ID
inviteId True string

ID of the invite you want to access.

invitationText
invitationText True string

Text which will be shown in the invitation e-mail.

toEmail
toEmail True email

The e-mail address to which the invite should be sent.

Returns

response
string

Set component property value

Set a single property value on a component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

code
code True string

The property code for which the new value should be set.

value
value string

The new value of the property if it is not of an array type.

arrayValues
arrayValues array of string

The new collection of values of the property if it is an array type.

Set component property values

Set multiple property values on a component in master data. Existing values are overwritten or deleted.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

code
code True string

The property code for which the new value should be set.

value
value string

The new value of the property if it is not of an array type.

arrayValues
arrayValues array of string

The new collection of values of the property if it is an array type.

Subscribe to events

Subscribe to events of a manufacturer. Existing subscriptions will be overwritten or deleted.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

body
body string

The events to which a webhook can subscribe.

Unarchive a company

Unarchive a company without unarchiving its contacts.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Company ID
companyId True string

ID of the company you want to access.

Unarchive a project segment

Unarchive a specifc project segment of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

Unlinks a feature from a specific component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

Feature ID
featureId True string

ID of the feature you want to access.

Update a company

Update a specific company of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Company ID
companyId True string

ID of the company you want to access.

name
name True string

Name of the company.

description
description string

Additional info about the company.

vatNumber
vatNumber string

VAT number of the company.

email
email email

E-mail address of the company.

telephone
telephone string

Phone number of the company.

websiteUrl
websiteUrl string

URL to the website of the company.

preferredLanguage
preferredLanguage string

The default language for the company in ISO 639-1 format.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

externalSystemId1
externalSystemId1 string

An ID used to identify the company in an external system. It is usually recommended to use a system link instead.

externalSystemId2
externalSystemId2 string

An ID used to identify the company in an external system. It is usually recommended to use a system link instead.

salesRepresentativeContactId
salesRepresentativeContactId string

ID of a contact who functions as sales representative.

techSupportManagerContactId
techSupportManagerContactId string

ID of a contact who functions as technical support manager.

orderProcessingManagerContactId
orderProcessingManagerContactId string

ID of a contact who functions as order processing manager.

shippingManagerContactId
shippingManagerContactId string

ID of a contact who functions as shipping support manager.

vatConditionCode
vatConditionCode string

The default VAT condition code to use in projects of this company. Available codes are defined inside your HiveCPQ environment.

deliveryConditionCode
deliveryConditionCode string

The default delivery condition code to use in projects of this company. Available codes are defined inside your HiveCPQ environment.

paymentConditionCode
paymentConditionCode string

The default payment condition code to use in projects of this company. Available codes are defined inside your HiveCPQ environment.

baseDiscount
baseDiscount float

The default discount to use for configurations in projects of this company.

orderCurrency
orderCurrency string

Default order currency of the company.

fee
fee float

The fee applied if a project for this company does not reach the fee threshold.

threshold
threshold float

The minimum price below which a fee will be applied.

enabled
enabled boolean

Allow this company to access the product store

storeDiscountPercentage
storeDiscountPercentage float

The discount percentage applied to product store items in a project of this company.

defaultVatConditionCode
defaultVatConditionCode string

The default VAT condition code to use in projects for this company. Available codes are defined inside your HiveCPQ environment.

defaultPaymentConditionCode
defaultPaymentConditionCode string

The default payment condition code to use in projects for this company. Available codes are defined inside your HiveCPQ environment.

salesPricingStrategy
salesPricingStrategy string

The default pricing strategy to use in projects for this company.

orderEmails
orderEmails array of email

E-mail address which will be used to send out order e-mails to sub-distributors.

Update a complaint

Update a specific complaint of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Complaint ID
complaintId True string

ID of the complaint you want to access.

title
title True string

The title of the complaint.

description
description True string

The description of the complaint.

companyId
companyId True string

The ID of the company that opened the complaint.

status
status True string

The status of a complaint.

type
type True string

The type of a complaint.

articleNumber
articleNumber string

The identifier of an article.

quantity
quantity integer

The quantity of the article.

orderReference
orderReference True string

Reference to an order.

claimNumber
claimNumber string

Number or identifier of this claim.

createdByContactId
createdByContactId string

ID of the contact who created the complaint.

createdAt
createdAt string

Timestamp of object creation.

updatedByContactId
updatedByContactId string

ID of the contact who updated the complaint.

updatedAt
updatedAt string

Timestamp of the latest update.

Update a component

Update a specific component in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

articleCode
articleCode True string

The unique article code.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

eanCode
eanCode string

The European Article Number.

gtinCode
gtinCode string

The Global Trade Item Number.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

productGroup
productGroup string

The group to which your component belongs.

features
features array of string

A collection of feature codes.

code
code True string

The property code for which the new value should be set.

value
value string

The new value of the property if it is not of an array type.

arrayValues
arrayValues array of string

The new collection of values of the property if it is an array type.

Update a component tooltip

Update a specific component tooltip in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

enabled
enabled boolean

Enable or disable displaying the tooltip.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

Returns

Update a component tooltip image

Update a specific component tooltip image in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Component ID
componentId True string

ID of the component you want to access.

File
file True file

The file to upload.

Update a custom object

Update a specific custom object of a specific type.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Custom Object Type
customObjectType True string

Name of the custom object type you want to access.

Custom Object ID
customObjectKey True string

ID of the custom object you want to access.

key
key True string

A unique key which will be used to identify a value inside of a single custom object.

value
value

A textual representation of the value to be saved for the key.

dataType
dataType string

The data types which can be used for custom object values.

Update a default address of a company

Update a specific default address of a company.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Company ID
companyId True string

ID of the company you want to access.

Default Address ID
defaultAddressId True string

ID of the default address you want to access.

companyName
companyName True string

Name of the default delivery or invoice company.

type
type True string

The default address type.

addressLine1
addressLine1 True string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city True string

The city.

postalCode
postalCode True string

The postal code.

countryIso
countryIso True string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

contactPerson
contactPerson True string

Name of a contact at the default delivery or invoice company.

contactPhone
contactPhone True string

Phone number of a contact at the default delivery or invoice company.

email
email True email

Contact e-mail of the default delivery or invoice company.

vatNumber
vatNumber string

VAT number to be used for the default invoice company.

canChangeAddress
canChangeAddress boolean

Allow the distributor to modify their default delivery and invoice addresses.

canChangeAddressOnPlaceOrder
canChangeAddressOnPlaceOrder boolean

Allow the distributor to modify their default delivery and invoice addresses during the order process.

Update a distributor contact

Update a specific contact in the address book of a distributor.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Distributor ID
distributorId True string

ID of the distributor you want to access.

Contact ID
contactId True string

ID of the contact you want to access.

firstName
firstName True string

First name of the contact.

lastName
lastName True string

Last name of the contact.

email
email True string

E-mail address of the contact.

salutation
salutation string

Salutation of the contact.

function
function string

Job title of the contact.

phone
phone string

Phone number of the contact.

mobile
mobile string

Mobile phone number of the contact

preferredLanguageIso
preferredLanguageIso string

Default language of the contact in ISO 639-1 format.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

vatNumber
vatNumber string

VAT number for the contact.

vatCondition
vatCondition string

The default VAT condition code for this contact. Available codes are defined inside your HiveCPQ environment.

deliveryCondition
deliveryCondition string

The default delivery condition code for this contact. Available codes are defined inside your HiveCPQ environment.

paymentCondition
paymentCondition string

The default payment condition code for for this contact. Available codes are defined inside your HiveCPQ environment.

Update a feature

Update a feature in a specific feature group in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

Feature ID
featureId True string

ID of the feature you want to access.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

serialSearchFunction
serialSearchFunction string

A JavaScript function which determines the visibility in the product store.

Update a feature group

Update a specific feature group in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Feature Group ID
featureGroupId True string

ID of the feature group you want to access.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

Returns

response
string

Update a specific integrated system link of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Integrated System Link ID
integratedSystemLinkId True string

ID of the integrated system link you want to access.

integratedSystemName
integratedSystemName True string

Name of the external system.

integratedSystemId
integratedSystemId True string

ID of the integrated resource.

Returns

response
string

Update a manufacturer contact

Update a specific contact of a manufacturer or its companies.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Contact ID
contactId True string

ID of the contact you want to access.

roleIds
roleIds True array of string

IDs of all roles which should be given to the contact.

firstName
firstName string
lastName
lastName string
email
email email
phone
phone string
mobile
mobile string
preferredLanguage
preferredLanguage string

The default language of the contact in ISO 639-1 format.

functionTitle
functionTitle string
addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

salutation
salutation string
externalSystemId
externalSystemId string

An ID used to identify the contact in an external system. It is usually recommended to use a system link instead.

avatarUrl
avatarUrl string

A publicly accessible URL to an image which will be used as the avatar.

Update a price catalog

Update a specific price catalog of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Price Catalog ID
priceCatalogId True string

ID of the catalog you want to access.

name
name True string

Unique name for the price catalog.

defaultPriceCatalog
defaultPriceCatalog boolean

Set the price catalog as default.

Update a project

Update a specific project of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project ID
projectId True string

ID of the project you want to access.

name
name string

Name of the project.

sellToCustomerReference
sellToCustomerReference string

A reference for the end customer.

accountId
accountId string

ID of an account in the address book.

contactId
contactId string

ID of a contact in the given account.

accountId
accountId string

ID of an account in the address book.

contactId
contactId string

ID of a contact in the given account.

accountId
accountId string

ID of an account in the address book.

contactId
contactId string

ID of a contact in the given account.

accountId
accountId string

ID of an account in the address book.

contactId
contactId string

ID of a contact in the given account.

taxCondition
taxCondition string

The VAT condition code of the project. Available codes are defined inside your HiveCPQ environment.

deliveryCondition
deliveryCondition string

The delivery condition code of the project. Available codes are defined inside your HiveCPQ environment.

paymentCondition
paymentCondition string

The payment condition code of the project. Available codes are defined inside your HiveCPQ environment.

Update a project segment

Update a specific project segment of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment ID
projectSegmentId True string

ID of the project segment you want to access.

orderRemark
orderRemark string

Remark on the order.

orderRemarkFromManufacturer
orderRemarkFromManufacturer string

Remark of the manufacturer on the order.

shippingDateRequested
shippingDateRequested date-time

The requested date in ISO-8601 format.

shippingDateConfirmed
shippingDateConfirmed date-time

The confirmed date in ISO-8601 format.

customerPoRef
customerPoRef string

Purchase order reference.

manufacturerSoRef
manufacturerSoRef string

Sales order reference.

manufacturerReference
manufacturerReference string

Reference for the manufacturer.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

vatCondition
vatCondition string

The VAT condition code. Available codes are defined inside your HiveCPQ environment.

deliveryCondition
deliveryCondition string

The delivery condition code. Available codes are defined inside your HiveCPQ environment.

paymentCondition
paymentCondition string

The payment condition code. Available codes are defined inside your HiveCPQ environment.

orderSenderContactId
orderSenderContactId string

Contact ID of the sender.

orderReceiverContactId
orderReceiverContactId string

Contact ID of the receiver.

companyASalesManagerId
companyASalesManagerId string

Contact ID of the manufacturer sales manager.

companyBSalesManagerId
companyBSalesManagerId string

Contact ID of the distributor sales manager.

status
status string

Status of the segment. It will default to RUNNING if the project is still in step 0 of the order process.

nextFollowUpDate
nextFollowUpDate date-time

The next follow up date.

estimatedSalesDate
estimatedSalesDate date-time

The estimated sales date.

freeTextNote
freeTextNote string

A free note on the segment.

saleProbability
saleProbability integer

The sales probability

status
status string

An external status of the order.

statusUrl
statusUrl string

A URL users may use to check on the external order status or view shipment info about their order.

statusText
statusText string

Custom text to be displayed for the shipment info.

orderGroup
orderGroup string

The order group.

Returns

response
string

Update a project segment item

Update a specific project segment item of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Project Segment Item ID
projectSegmentItemId True string

ID of the project segment item you want to access.

name
name string

A name for the configuration.

quantity
quantity True integer

The quantity of the item.

externalSerialNumbers
externalSerialNumbers array of string

Optional identifiers which can be used to identify the configuration in external systems.

Update a property

Update a specific property in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Property ID
propertyId True string

ID of the property you want to access.

info
info string

General info about the property.

Update a unit

Update a specific unit in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

Unit ID
unitId True string

ID of the unit you want to access.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

Returns

response
string

Update a webhook

Update a webhook of a manufacturer.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

url
url True string

The callback URL of the webhook.

description
description string

Additional info about the webhook.

Update a webhook trigger

Update a specific trigger of a webhook.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Webhook ID
webhookId True string

ID of the webhook you want to access.

Webhook Trigger ID
webhookTriggerId True string

ID of the webhook trigger you want to access.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

languageCode
languageCode True string

The language code in ISO 639-1 format.

translation
translation True string

The translated text.

confirmationRequired
confirmationRequired boolean

Enable or disable the confirmation modal when a user activates a webhook trigger.

openInSameTab
openInSameTab boolean

Enable opening the URL in the same browser tab when using the OPEN_URL type.

location
location True string

The location of the webhook trigger in the UI of HiveCPQ.

type
type True string

The type of the webhook trigger.

permissionIds
permissionIds array of string

A collection of permission IDs which have access to the trigger.

Update configuration

Update the values of the nodes in a configuration.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Configuration ID
configurationId True string

ID of the configuration you want to access.

uniqueLabel
uniqueLabel string

The unique identifier of the node.

value
value string

The textual representation of the node value.

quantity
quantity integer

The quantity of items represented by this node used to calculate the total node price.

optional
optional boolean

Mark the node as optional.

Update distributor account

Update a specific account in the address book of a distributor.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Distributor ID
distributorId True string

ID of the distributor you want to access.

Account ID
accountId True string

ID of the account you want to access.

name
name string

The company name.

description
description string

Additional info about the company.

vatNumber
vatNumber string

VAT number of the company.

phone
phone string

Phone number of the company.

email
email string

E-mail address of the company.

websiteUrl
websiteUrl string

URL to the website of the company.

addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

Upsert component prices in bulk

Create or update multiple component prices in master data.

Parameters

Name Key Required Type Description
Manufacturer ID
manufacturerId True string

ID of the manufacturer company to which you are connecting.

Container Name
name True string

Name of the container you want to access.

Container Version
version True string

Number of the version (e.g. 1.0.0) you want to access. Providing 'top' accesses the highest available version.

itemId
itemId string

A custom identifier of this item. It is not the component price ID.

componentCode
componentCode string

Code of the component to add the price(s) to.

unitCode
unitCode string

Code of the unit to use with the price.

priceCatalogName
priceCatalogName string

Name of the price catalog to which the price belongs.

costPrice
costPrice float

Cost price of the component.

listPrice
listPrice float

List price of the component.

purchasePrice
purchasePrice float

Purchase price of the component.

subDistributorPurchasePrice
subDistributorPurchasePrice float

Sub-distributor purchase price of the component.

currency
currency string

The currency in ISO 4217 format.

Returns

Definitions

createdAt

Timestamp of object creation.

Timestamp of object creation.

updatedAt

Timestamp of the latest update.

Timestamp of the latest update.

linkId

ID of the linked resource.

ID of the linked resource.

linkName

Translated name of the linked resource.

Translated name of the linked resource.

linkHref

A URL to the resource.

A URL to the resource.

An external link allowing integrators to link a resource in an external system to a resource in HiveCPQ.

Name Path Type Description
id
id linkId

ID of the linked resource.

integratedSystemName
integratedSystemName string

Name of the external system.

integratedSystemId
integratedSystemId string

ID of the resource as represented in the external system.

createdAt
createdAt createdAt

Timestamp of object creation.

updatedAt
updatedAt updatedAt

Timestamp of the latest update.

All integrated system links attached to this resource.

Name Path Type Description
Items
externalLink

An external link allowing integrators to link a resource in an external system to a resource in HiveCPQ.

All roles linked to this resource.

Name Path Type Description
id
id linkId

ID of the linked resource.

name
name linkName

Translated name of the linked resource.

href
href linkHref

A URL to the resource.

A link to a unit.

Name Path Type Description
id
id linkId

ID of the linked resource.

code
code string

Unique code of the unit.

href
href linkHref

A URL to the resource.

A link to a price catalog.

Name Path Type Description
id
id linkId

ID of the linked resource.

href
href linkHref

A URL to the resource.

name
name string

The unique name of the catalog.

A link to a category.

Name Path Type Description
id
id linkId

ID of the linked resource.

name
name linkName

Translated name of the linked resource.

href
href linkHref

A URL to the resource.

A link to a component.

Name Path Type Description
id
id linkId

ID of the linked resource.

code
code string

The article code of the component.

href
href linkHref

A URL to the resource.

Name Path Type Description
id
id linkId

ID of the linked resource.

name
name linkName

Translated name of the linked resource.

href
href linkHref

A URL to the resource.

A link to a contact.

Name Path Type Description
id
id linkId

ID of the linked resource.

href
href linkHref

A URL to the resource.

fullName
fullName string

Name of the contact.

A link to a user account.

Name Path Type Description
id
id linkId

ID of the linked resource.

href
href linkHref

A URL to the resource.

fullName
fullName string

Name of the contact.

A link to a company.

Name Path Type Description
id
id linkId

ID of the linked resource.

name
name linkName

Translated name of the linked resource.

href
href linkHref

A URL to the resource.

A link to a project.

Name Path Type Description
id
id linkId

ID of the linked resource.

name
name linkName

Translated name of the linked resource.

href
href linkHref

A URL to the resource.

A link to a project segment.

Name Path Type Description
id
id linkId

ID of the linked resource.

href
href linkHref

A URL to the resource.

orderStatus
orderStatus string

The step in the order flow.

Links to multiple project segments.

Name Path Type Description
Items
projectSegmentLink

A link to a project segment.

Name Path Type Description
id
id linkId

ID of the linked resource.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

name
name string

Name of the project segment item.

articleCode
articleCode string

Code of the product store article.

ConfiguratorCode
ConfiguratorCode string

Code of the configurable item configurator.

type
type enumProjectSegmentItemType

Type of the project segment item.

A link to a shipping schedule.

Name Path Type Description
id
id linkId

ID of the linked resource.

type
type string
week
week number
year
year number
href
href linkHref

A URL to the resource.

A link to a configurator.

Name Path Type Description
id
id linkId

ID of the linked resource.

name
name linkName

Translated name of the linked resource.

href
href linkHref

A URL to the resource.

A link to a configuration.

Name Path Type Description
id
id linkId

ID of the linked resource.

href
href linkHref

A URL to the resource.

address

The standard address format.

Name Path Type Description
addressLine1
addressLine1 string

Address line 1.

addressLine2
addressLine2 string

Address line 2.

city
city string

The city.

postalCode
postalCode string

The postal code.

countryIso
countryIso string

The country code in ISO 3166-2 format.

stateIso
stateIso string

The area code in ISO 3166-2 format.

companyContact

Name Path Type Description
email
email string

Contact e-mail address.

companyName
companyName string

Name of the company.

contactPhone
contactPhone string

Contact phone number.

contactName
contactName string

Name of the contact person.

companyVatNumber
companyVatNumber string

VAT number of the company.

address
address address

The standard address format.

customObjectKeyValuePair

This represents a key value pair used to store or pass data with custom objects.

Name Path Type Description
key
key string

A unique key which will be used to identify a value inside of a single custom object.

value
value

A textual representation of the value to be saved for the key.

dataType
dataType enumCustomObjectValueDataType

The data types which can be used for custom object values.

enumBulkResponseStatus

Status of the bulk item.

Status of the bulk item.

enumCompanyType

Type of a company.

Type of a company.

enumConfigurationNodeStatus

Status of a node.

Status of a node.

enumConfigurationNodeDatatype

Data type of the node value.

Data type of the node value.

enumProjectSegmentOrderStatus

Status of the order in the order flow.

Status of the order in the order flow.

enumProjectSegmentStatus

Status of the segment. It will default to RUNNING if the project is still in step 0 of the order process.

Status of the segment. It will default to RUNNING if the project is still in step 0 of the order process.

enumProjectSegmentItemType

Type of the project segment item.

Type of the project segment item.

enumComponentPropertyType

Type of the property

Type of the property

enumComponentPropertyArrayType

Type of the array property.

Type of the array property.

enumConfigurationStatus

Status of the configuration.

Status of the configuration.

enumCustomObjectValueDataType

The data types which can be used for custom object values.

The data types which can be used for custom object values.

enumOutputDocumentTemplateType

Type of the output document template.

Type of the output document template.

enumSystemLinkResourceType

The types of resources for which integrated system links can be created.

The types of resources for which integrated system links can be created.

enumWebhookEventSubscription

The events to which a webhook can subscribe.

The events to which a webhook can subscribe.

enumEventGroup

The event group of an event.

The event group of an event.

enumWebhookTriggerLocation

The location of the webhook trigger in the UI of HiveCPQ.

The location of the webhook trigger in the UI of HiveCPQ.

enumWebhookTriggerType

The type of the webhook trigger.

The type of the webhook trigger.

enumComplaintStatus

The status of a complaint.

The status of a complaint.

enumComplaintType

The type of a complaint.

The type of a complaint.

enumContainerVersionStatus

Status of the version

Status of the version

enumContainerVersionType

Type of the version.

Type of the version.

enumDefaultAddressType

The default address type.

The default address type.

enumInviteStatus

The status of an invite.

The status of an invite.

distributorAccountInfo

General info about the distributor account.

Name Path Type Description
name
name string

The company name.

description
description string

Additional info about the company.

vatNumber
vatNumber string

VAT number of the company.

phone
phone string

Phone number of the company.

email
email string

E-mail address of the company.

websiteUrl
websiteUrl string

URL to the website of the company.

distributorContactInfo

General info about the contact.

Name Path Type Description
firstName
firstName string

First name of the contact.

lastName
lastName string

Last name of the contact.

email
email string

E-mail address of the contact.

salutation
salutation string

Salutation of the contact.

function
function string

Job title of the contact.

phone
phone string

Phone number of the contact.

mobile
mobile string

Mobile phone number of the contact

preferredLanguageIso
preferredLanguageIso string

Default language of the contact in ISO 639-1 format.

distributorContactSalesConditions

Sales conditions of the contact.

Name Path Type Description
vatNumber
vatNumber string

VAT number for the contact.

vatCondition
vatCondition string

The default VAT condition code for this contact. Available codes are defined inside your HiveCPQ environment.

deliveryCondition
deliveryCondition string

The default delivery condition code for this contact. Available codes are defined inside your HiveCPQ environment.

paymentCondition
paymentCondition string

The default payment condition code for for this contact. Available codes are defined inside your HiveCPQ environment.

responseTranslations

A list of translations.

Name Path Type Description
languageCode
languageCode string

The language code in ISO 639-1 format.

translation
translation string

The translated text.

responsePrice

The pricing information.

Name Path Type Description
listPrice
listPrice string

The list price.

discount
discount string

The discount.

purchasePrice
purchasePrice string

The purchase price.

salesPrice
salesPrice string

The sales price.

currency
currency string

The currency in ISO 4217 format.

responseGetVersions

Name Path Type Description
items
items array of object

A list of container versions.

id
items.id string

ID of the container version.

version
items.version string

The version number.

status
items.status enumContainerVersionStatus

Status of the version

type
items.type enumContainerVersionType

Type of the version.

notes
items.notes string

Additional info about the version.

audit
items.audit responseAudit

The audit information.

total
total responseTotalCount

The total number of results.

responseGetDefaultAddress

Name Path Type Description
id
id string

ID of the default address.

companyName
companyName string

Company name of the default address.

type
type enumDefaultAddressType

The default address type.

address
address address

The standard address format.

email
email string

E-mail of the default address.

contactPerson
contactPerson string

Contact person of the default address.

contactPhone
contactPhone string

Phone number of the default address.

vatNumber
vatNumber string

VAT number of the default address.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

canChangeAddress
canChangeAddress boolean

Is the distributor able to modify their default delivery and invoice addresses.

canChangeAddressOnPlaceOrder
canChangeAddressOnPlaceOrder boolean

Is the distributor able to set their own delivery and invoice addresses during the order process.

responseGetDefaultAddresses

Name Path Type Description
items
items array of responseGetDefaultAddress

A list of default addresses.

total
total responseTotalCount

The total number of results.

responseGetCompany

Name Path Type Description
id
id string

ID of the company.

type
type enumCompanyType

Type of a company.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

name
info.name string

Name of the company.

description
info.description string

Additional info about the company.

vatNumber
info.vatNumber string

VAT number of the company.

email
info.email string

E-mail address of the company.

telephone
info.telephone string

Phone number of the company.

websiteUrl
info.websiteUrl string

URL to the website of the company.

preferredLanguage
info.preferredLanguage string

The language of the company in ISO 639-1 format.

address
info.address address

The standard address format.

externalSystemId1
info.externalSystemId1 string

An ID used to identify the company in an external system.

externalSystemId2
info.externalSystemId2 string

An ID used to identify the company in an external system.

distributor
subDistributorSettings.distributor companyLink

A link to a company.

orderEmails
subDistributorSettings.orderEmails array of string

All sub-distributor e-mails which receive order e-mails.

archived
archived boolean

archived

responseGetCompanies

Name Path Type Description
items
items array of responseGetCompany

A list of companies.

total
total responseTotalCount

The total number of results.

responseGetInvites

Name Path Type Description
items
items array of object

A list of invites.

id
items.id string

ID of an invite.

status
items.status enumInviteStatus

The status of an invite.

toEmail
items.toEmail string

The e-mail address to which the invite was sent.

createdAt
items.createdAt createdAt

Timestamp of object creation.

claimedAt
items.claimedAt string

The date when the invite was claimed in ISO-8601 format.

inviteUrl
items.inviteUrl string

The URL where the invite can be claimed.

fromContact
items.fromContact contactLink

A link to a contact.

toContact
items.toContact contactLink

A link to a contact.

total
total responseTotalCount

The total number of results.

responseGetContact

Name Path Type Description
id
id string

The contact ID.

firstName
firstName string

First name of contact.

lastName
lastName string

Last name of the contact.

email
email string

E-mail address of the contact.

phone
phone string

Phone number of the contact.

mobile
mobile string

Mobile phone number of the contact.

preferredLanguage
preferredLanguage string

Language of the user in ISO 639-1 format.

functionTitle
functionTitle string

The job title of the contact.

address
address address

The standard address format.

salutation
salutation string

Salutation of the contact.

externalSystemId
externalSystemId string

ID used to identify the contact in an external system

avatarUrl
avatarUrl string

A URL to the avatar of the contact.

company
company companyLink

A link to a company.

archived
archived boolean

Archival status of the contact.

roles
roles roleLinks

All roles linked to this resource.

userAccount
userAccount userAccountLink

A link to a user account.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

responseGetContacts

Name Path Type Description
items
items array of responseGetContact

A list of contacts.

total
total responseTotalCount

The total number of results.

responseGetComponentProperties

Name Path Type Description
items
items array of object

A list of property values.

code
items.code string

The property code.

value
items.value string

Value of a property.

arrayValues
items.arrayValues array of string

Values of an array property.

audit
items.audit responseAudit

The audit information.

total
total responseTotalCount

The total number of results.

responseGetComponentAttachments

Name Path Type Description
items
items array of object

A list of component attachments.

id
items.id string

ID of an attachment.

fileUrl
items.fileUrl string

Publicly accessible URL of an attachment.

fileName
items.fileName string

File name of the attachment.

total
total responseTotalCount

The total number of results.

responseGetComponentPrices

Name Path Type Description
items
items array of object

A list of component prices.

id
items.id string

ID of a component price.

priceCatalog
items.priceCatalog priceCatalogLink

A link to a price catalog.

unit
items.unit unitLink

A link to a unit.

costPrice
items.costPrice float

The cost price.

listPrice
items.listPrice float

The list price.

purchasePrice
items.purchasePrice float

The purchase price.

subDistributorPurchasePrice
items.subDistributorPurchasePrice float

The sub-distributor purchase price.

currency
items.currency string

The currency in ISO 4217 format.

total
total responseTotalCount

The total number of results.

responsePostBulkUpsertComponentPrices

Name Path Type Description
results
results array of object

A list of result items.

itemId
results.itemId string

The custom identifier of this item.

status
results.status enumBulkResponseStatus

Status of the bulk item.

message
results.message string

Message with additional information if the item failed to be handled.

successCount
successCount integer

The amount of successfully handled items.

responseGetComponentTooltip

Name Path Type Description
id
id string

ID of a component tooltip.

enabled
enabled boolean

Enable or disable displaying the tooltip.

titles
titles responseTranslations

A list of translations.

details
details responseTranslations

A list of translations.

responsePutComponentTooltip

Name Path Type Description
id
id string

ID of the tooltip.

responseGetComponent

Name Path Type Description
id
id string

ID of the component.

articleCode
articleCode string

Unique article code of the component.

eanCode
eanCode string

The European Article Number of the component.

gtinCode
gtinCode string

The Global Trade Item Number of the component.

scriptPrice
scriptPrice string

An optional pricing script.

unitCode
unitCode unitLink

A link to a unit.

productGroup
productGroup string

Group of the component.

showOnlyForSerialNumber
showOnlyForSerialNumber boolean

Indicates if the component can only be accessed in the product store through serial number searches.

minimumQuantity
minimumQuantity integer

The minimum quantity which needs to be used when adding this component to a project.

name
name responseTranslations

A list of translations.

description
description responseTranslations

A list of translations.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

audit
audit responseAudit

The audit information.

priceCatalogs
priceCatalogs array of object

The prices linked to the component.

currency
priceCatalogs.currency string

The currency in ISO 4217 format.

unitCode
priceCatalogs.unitCode string

The unique code of a unit.

costPrice
priceCatalogs.costPrice float

The cost price.

listPrice
priceCatalogs.listPrice float

The list price.

purchasePrice
priceCatalogs.purchasePrice float

The purchase price.

subDistributorPurchasePrice
priceCatalogs.subDistributorPurchasePrice float

The sub-distributor purchase price.

price (deprecated)
priceCatalogs.price float

The list price. (Deprecated, use listPrice instead)

id
priceCatalogs.id string

ID of the price catalog.

href
priceCatalogs.href linkHref

A URL to the resource.

name
priceCatalogs.name string

Unique name of the price catalog.

categories
categories array of categoryLink

A list of categories linked to the component.

explodedViews
explodedViews array of object

A list of exploded views linked to the component.

category
explodedViews.category categoryLink

A link to a category.

explodedViewArea
explodedViews.explodedViewArea string

The exploded view area.

configurator
configurable.configurator configuratorLink

A link to a configurator.

parameters
configurable.parameters array of object

Information about the component if it has been configured as a configurable product.

key
configurable.parameters.key string

The identifier of a configurator input value.

value
configurable.parameters.value string

The configurator input value.

features
features array of featureLink

A list of features linked to the component.

responseGetComponents

Name Path Type Description
items
items array of object

A list of components.

id
items.id string

ID of the component.

name
items.name string

Translated name of the component.

description
items.description string

Translated description of the component.

articleCode
items.articleCode string

Unique article code of the component.

eanCode
items.eanCode string

The European Article Number of the component.

gtinCode
items.gtinCode string

The Global Trade Item Number of the component.

unitCode
items.unitCode unitLink

A link to a unit.

productGroup
items.productGroup string

Group of the component.

showOnlyForSerialNumber
items.showOnlyForSerialNumber boolean

Indicates if the component can only be accessed in the product store through serial number searches.

minimumQuantity
items.minimumQuantity integer

The minimum quantity which needs to be used when adding this component to a project.

externalLinks
items.externalLinks externalLinks

All integrated system links attached to this resource.

audit
items.audit responseAudit

The audit information.

configurable
items.configurable boolean

Indicates if a configurator is linked.

total
total responseTotalCount

The total number of results.

responseGetProperties

Name Path Type Description
items
items array of object

A list of properties.

id
items.id string

ID of the property.

externalLinks
items.externalLinks externalLinks

All integrated system links attached to this resource.

code
items.code string

Unique code of the property.

type
items.type enumComponentPropertyType

Type of the property

arrayType
items.arrayType enumComponentPropertyArrayType

Type of the array property.

info
items.info string

Additional info about the property.

audit
items.audit responseAudit

The audit information.

total
total responseTotalCount

The total number of results.

responseGetFeature

Name Path Type Description
id
id string

ID of the feature.

code
code string

Unique code of the feature.

descriptions
descriptions responseTranslations

A list of translations.

audit
audit responseAudit

The audit information.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

serialSearchFunction
serialSearchFunction string

The JavaScript function which determines component visibility in the product store.

responseGetFeatures

Name Path Type Description
items
items array of object

A list of features.

id
items.id string

ID of the feature.

code
items.code string

Unique code of the feature.

description
items.description string

Translated description of the feature.

externalLinks
items.externalLinks externalLinks

All integrated system links attached to this resource.

serialSearchFunction
items.serialSearchFunction string

The JavaScript function which determines component visibility in the product store.

audit
items.audit responseAudit

The audit information.

total
total responseTotalCount

The total number of results.

responseGetFeatureGroup

Name Path Type Description
id
id string

ID of the feature group.

code
code string

Unique code of the feature group.

descriptions
descriptions responseTranslations

A list of translations.

audit
audit responseAudit

The audit information.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

responseGetFeatureGroups

Name Path Type Description
items
items array of object

A list of feature groups.

id
items.id string

ID of the feature group.

code
items.code string

Unique code of the feature group.

description
items.description string

Translated description of the feature group.

audit
items.audit responseAudit

The audit information.

externalLinks
items.externalLinks externalLinks

All integrated system links attached to this resource.

total
total responseTotalCount

The total number of results.

responseGetUnit

Name Path Type Description
id
id string

ID of the unit.

code
code string

Unique code of the unit.

names
names responseTranslations

A list of translations.

audit
audit responseAudit

The audit information.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

responseGetUnits

Name Path Type Description
items
items array of object

A list of units.

id
items.id string

ID of the unit.

code
items.code string

Unique code of the unit.

name
items.name string

Translated name of the unit.

audit
items.audit responseAudit

The audit information.

externalLinks
items.externalLinks externalLinks

All integrated system links attached to this resource.

total
total responseTotalCount

The total number of results.

responseGetCustomObjectTypes

Name Path Type Description
items
items array of object

A list of custom object types.

type
items.type string

Name of the custom object type.

href
items.href string

A URL to this type.

total
total responseTotalCount

The total number of results.

responseGetCustomObject

Name Path Type Description
key
key string

The ID of a customer object.

href
href string

A URL to retrieve the custom object.

keyValues
keyValues array of customObjectKeyValuePair

A list of keys and values of the custom object.

responseGetCustomObjects

Name Path Type Description
items
items array of responseGetCustomObject

A list of custom objects.

total
total responseTotalCount

The total number of results.

responseGetProject

Name Path Type Description
id
id string

ID of the project.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

projectSegments
projectSegments projectSegmentLinks

Links to multiple project segments.

name
name string

Name of the project.

sellToCustomerReference
sellToCustomerReference string

The customer reference.

company
sellTo.company companyLink

A link to a company.

contact
sellTo.contact contactLink

A link to a contact.

company
invoice.company companyLink

A link to a company.

contact
invoice.contact contactLink

A link to a contact.

company
delivery.company companyLink

A link to a company.

contact
delivery.contact contactLink

A link to a contact.

company
installation.company companyLink

A link to a company.

contact
installation.contact contactLink

A link to a contact.

vatCondition
salesConditions.vatCondition string

The VAT condition code of the project.

vatPercentage
salesConditions.vatPercentage string

The VAT percentage of the project.

deliveryCondition
salesConditions.deliveryCondition string

The delivery condition code of the project.

paymentCondition
salesConditions.paymentCondition string

The payment condition code of the project.

audit
audit responseAudit

The audit information.

responseGetProjects

Name Path Type Description
items
items array of responseGetProject

A list of projects.

total
total responseTotalCount

The total number of results.

responseGetProjectSegment

Name Path Type Description
id
id string

ID of the project segment.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

projectSegmentItems
projectSegmentItems array of projectSegmentItemLink

projectSegmentItems

project
project projectLink

A link to a project.

orderStatus
order.orderStatus enumProjectSegmentOrderStatus

Status of the order in the order flow.

moveToStep1At
order.moveToStep1At string

Timestamp when the project was last moved to step 1.

moveToStep2At
order.moveToStep2At string

Timestamp when the project was last moved to step 2.

moveToStep3At
order.moveToStep3At string

Timestamp when the project was last moved to step 3.

moveToStep4At
order.moveToStep4At string

Timestamp when the project was last moved to step 4.

orderRemark
order.orderRemark string

Remark on the order.

orderRemarkFromManufacturer
order.orderRemarkFromManufacturer string

Remark of the manufacturer on the order.

shippingDateRequested
order.shippingDateRequested string

The requested date in ISO-8601 format.

shippingDateConfirmed
order.shippingDateConfirmed string

The confirmed date in ISO-8601 format.

customerPoRef
order.customerPoRef string

The purchase order reference of the customer.

manufacturerSoRef
order.manufacturerSoRef string

The sales order reference of the manufacturer.

manufacturerReference
order.manufacturerReference string

Reference for the manufacturer.

delivery
order.delivery companyContact
invoice
order.invoice companyContact
sellTo
order.sellTo companyContact
installation
order.installation companyContact
vatCondition
order.salesCondition.vatCondition string

The VAT condition code of the order.

vatPercentage
order.salesCondition.vatPercentage string

The VAT percentage of the order.

deliveryCondition
order.salesCondition.deliveryCondition string

The delivery condition code of the order.

paymentCondition
order.salesCondition.paymentCondition string

The payment condition code of the order.

orderSenderContact
order.orderSenderContact contactLink

A link to a contact.

orderReceiverContact
order.orderReceiverContact contactLink

A link to a contact.

price
price responsePrice

The pricing information.

companyAId
companyRelation.companyAId string

The manufacturer ID.

companyBId
companyRelation.companyBId string

The distributor ID.

companyASalesManager
companyASalesManager contactLink

A link to a contact.

companyBSalesManager
companyBSalesManager contactLink

A link to a contact.

status
status enumProjectSegmentStatus

Status of the segment. It will default to RUNNING if the project is still in step 0 of the order process.

nextFollowUpDate
nextFollowUpDate string

The next follow up date in ISO-8601 format.

estimatedSalesDate
estimatedSalesDate string

The estimated sales date in ISO-8601 format.

freeTextNote
freeTextNote string

A note on the segment.

saleProbability
saleProbability integer

The sale probability.

status
externalOrderStatus.status string

An external status of the order.

statusUrl
externalOrderStatus.statusUrl string

A URL users may use to check on the external order status or view shipment info about their order.

statusText
externalOrderStatus.statusText string

Custom text displayed for the shipment info.

orderGroup
orderGroup string

The order group.

configurationStatus
configurationStatus enumConfigurationStatus

Status of the configuration.

configuration
configuration configurationLink

A link to a configuration.

subDistributor
subDistributor companyLink

A link to a company.

responseGetProjectSegments

Name Path Type Description
items
items array of responseGetProjectSegment

A list of segments.

total
total responseTotalCount

The total number of results.

responseGetProjectSegmentItem

Name Path Type Description
id
id string

ID of the project segment item.

name
name string

Name of the project segment item.

type
type enumProjectSegmentItemType

Type of the project segment item.

configurationStatus
configurationStatus enumConfigurationStatus

Status of the configuration.

quantity
quantity integer

The quantity of this item used to calculate the total price.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

price
price responsePrice

The pricing information.

externalSerialNumbers
externalSerialNumbers array of string

Identifiers of the item in an external system.

component
component componentLink

A link to a component.

productGroup
productGroup string

Group of the item.

project
project projectLink

A link to a project.

orderSerialNumberMatched
orderSerialNumberMatched boolean

Is the order serial number matched?

projectSegment
projectSegment projectSegmentLink

A link to a project segment.

audit
audit responseAudit

The audit information.

shippingSchedule
shippingSchedule shippingScheduleLink

A link to a shipping schedule.

configuration
configuration configurationLink

A link to a configuration.

responseGetProjectSegmentItems

Name Path Type Description
items
items array of responseGetProjectSegmentItem

A list of project segment items.

total
total responseTotalCount

The total number of results.

Name Path Type Description
items
items array of object

A list of integrated system links.

id
items.id string

ID of the integrated system link.

integratedSystemName
items.integratedSystemName string

Name of the external system.

integratedSystemId
items.integratedSystemId string

ID of the resource in the external system.

hiveId
items.hiveId string

ID of the HiveCPQ resource.

createdAt
items.createdAt createdAt

Timestamp of object creation.

updatedAt
items.updatedAt updatedAt

Timestamp of the latest update.

total
total responseTotalCount

The total number of results.

responseGetDistributorAccounts

Name Path Type Description
items
items array of object

A list of distributor accounts.

id
items.id string

ID of the distributor account.

info
items.info distributorAccountInfo

General info about the distributor account.

address
items.address address

The standard address format.

externalLinks
items.externalLinks externalLinks

All integrated system links attached to this resource.

audit
items.audit responseAudit

The audit information.

total
total responseTotalCount

The total number of results.

responseGetDistributorContacts

Name Path Type Description
items
items array of object

A list of distributor contacts.

id
items.id string

ID of the distributor contact.

info
items.info distributorContactInfo

General info about the contact.

address
items.address address

The standard address format.

salesConditions
items.salesConditions distributorContactSalesConditions

Sales conditions of the contact.

externalLinks
items.externalLinks externalLinks

All integrated system links attached to this resource.

audit
items.audit responseAudit

The audit information.

total
total responseTotalCount

The total number of results.

responseGetWebhookHeaders

Name Path Type Description
items
items array of object

A list of webhooks headers.

id
items.id string

ID of the webhook header.

key
items.key string

Key used in an HTTP header during a webhook callback.

value
items.value string

Value used for the key in an HTTP header during a webhook callback.

total
total responseTotalCount

The total number of results.

responseGetWebhookEventSubscriptions

Name Path Type Description
eventSubscriptions
eventSubscriptions array of enumWebhookEventSubscription

A list of platform events to which the webhook is subscribed.

responseGetWebhookTrigger

Name Path Type Description
id
id string

ID of the trigger.

code
code string

Unique code of the trigger.

names
names responseTranslations

A list of translations.

confirmations
confirmations responseTranslations

A list of translations.

confirmationRequired
confirmationRequired boolean

Indicates if a confirmation modal will be shown when a webhook trigger is activated.

openInSameTab
openInSameTab boolean

Indicates if webhook triggers of the OPEN_URL type open the URL in the same or a different browser tab.

location
location enumWebhookTriggerLocation

The location of the webhook trigger in the UI of HiveCPQ.

type
type enumWebhookTriggerType

The type of the webhook trigger.

permissions
permissions array of object

A list of permission with access to the trigger.

id
permissions.id string

The permission ID.

code
permissions.code string

The unique code of the permission.

audit
audit responseAudit

The audit information.

responseGetWebhookTriggers

Name Path Type Description
items
items array of object

A list of webhook triggers.

id
items.id string

ID of the trigger.

code
items.code string

Unique code of the trigger.

name
items.name string

The translated name of the trigger.

confirmation
items.confirmation string

The translated confirmation text of the trigger.

confirmationRequired
items.confirmationRequired boolean

Indicates if a confirmation modal will be shown when a webhook trigger is activated.

location
items.location enumWebhookTriggerLocation

The location of the webhook trigger in the UI of HiveCPQ.

type
items.type enumWebhookTriggerType

The type of the webhook trigger.

openInSameTab
items.openInSameTab boolean

Indicates if webhook triggers of the OPEN_URL type open the URL in the same or a different browser tab.

permissions
items.permissions array of object

A list of permissions with access to the trigger.

id
items.permissions.id string

The permission ID.

code
items.permissions.code string

Unique code of the permission.

audit
items.audit responseAudit

The audit information.

total
total responseTotalCount

The total number of results.

responseGetWebhook

Name Path Type Description
id
id string

ID of the webhook.

code
code string

Unique code of the webhook.

url
url string

Callback URL of the webhook.

description
description string

Additional info about the webhook.

audit
audit responseAudit

The audit information.

responseGetWebhooks

Name Path Type Description
items
items array of responseGetWebhook

A list of webhooks.

total
total responseTotalCount

The total number of results.

responseGetPriceCatalog

Name Path Type Description
id
id string

ID of the price catalog.

name
name string

Unique name of the price catalog.

defaultPriceCatalog
defaultPriceCatalog boolean

Indicates if this is the default price catalog.

audit
audit responseAudit

The audit information.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

responseGetPriceCatalogs

Name Path Type Description
items
items array of responseGetPriceCatalog

A list of price catalogs.

total
total responseTotalCount

The total number of results.

responseGetComplaintComments

Name Path Type Description
items
items array of object

A list of complaint comments.

id
items.id string

ID of the complaint comment.

comment
items.comment string

Content of the complaint comment.

audit
items.audit responseAudit

The audit information.

total
total responseTotalCount

The total number of results.

responseGetComplaintAttachments

Name Path Type Description
items
items array of object

A list of complaint attachments.

id
items.id string

ID of the complaint attachment.

fileName
items.fileName string

File name of the complaint attachment.

contentType
items.contentType string

Content-Type of the complaint attachment.

total
total responseTotalCount

The total number of results.

responseGetComplaint

Name Path Type Description
id
id string

ID of the complaint.

title
title string

Title of the complaint.

description
description string

Additional info about the complaint.

status
status enumComplaintStatus

The status of a complaint.

type
type enumComplaintType

The type of a complaint.

company
company companyLink

A link to a company.

orderReference
orderReference string

Order reference of the complaint

claimNumber
claimNumber string

Claim number of the complaint.

articles
articles array of object

The articles of the complaint.

articleNumber
articles.articleNumber string

The identifier of an article.

quantity
articles.quantity integer

The quantity of the article.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

audit
audit responseAudit

The audit information.

responseGetComplaints

Name Path Type Description
items
items array of responseGetComplaint

A list of complaints.

total
total responseTotalCount

The total number of results.

responseGetUserAccount

Name Path Type Description
id
id string

ID of the user account.

contacts
contacts array of contactLink

A list of contacts connected to the user account.

lastActiveAt
lastActiveAt string

Last login timestamp of the user account in ISO-8601 format.

responseGetRoles

Name Path Type Description
items
items array of object

A list of roles.

id
items.id string

ID of the role.

name
items.name string

Unique name of the role.

description
items.description string

Additional information about the role.

roleType
items.roleType string

Type of the role

visibility
items.visibility string

Visibility of the role.

defaultRoleForManufacturerCompany
items.defaultRoleForManufacturerCompany boolean

Is the role configured as default for new manufacturer users?

defaultRoleForDistributorCompanies
items.defaultRoleForDistributorCompanies boolean

Is the role configured as default for new distributor users?

companyId
items.companyId string

ID of the company which owns the role.

total
total responseTotalCount

The total number of results.

responseGetPermissions

Name Path Type Description
items
items array of object

A list of permissions.

id
items.id string

ID of the permission.

code
items.code string

Unique code of the permission.

total
total responseTotalCount

The total number of results.

responseGetSalesConditions

Name Path Type Description
items
items array of object

A list of sales conditions.

code
items.code string

Unique condition code.

name
items.name string

Translated name of the condition.

total
total responseTotalCount

The total number of results.

responseGetOutputDocumentTemplates

Name Path Type Description
items
items array of object

A list of output document templates.

id
items.id string

ID of the template.

name
items.name string

Name of the template.

languageCodes
items.languageCodes array of string

The available language codes for this template in ISO 639-1 format.

audit
items.audit responseAudit

The audit information.

type
items.type enumOutputDocumentTemplateType

Type of the output document template.

total
total responseTotalCount

The total number of results.

responseGetEvents

Name Path Type Description
items
items array of object

List of platform events.

eventId
items.eventId string

ID of the event.

eventType
items.eventType enumWebhookEventSubscription

The events to which a webhook can subscribe.

eventGroup
items.eventGroup enumEventGroup

The event group of an event.

translationLabel
items.translationLabel string

The translation label of the event.

data
items.data object

Data of the event

userAccountId
items.userAccountId string

ID of the user account that initiated the event.

translationParams
items.translationParams string

Parameters used to translate the event label.

occurrenceTimestamp
items.occurrenceTimestamp string

The timestamp when the event happened.

removalTimestamp
items.removalTimestamp string

The timestamp when the event will be removed.

distributorIds
items.distributorIds array of string

IDs of distributors.

total
total responseTotalCount

The total number of results.

responseGetPluginToken

Name Path Type Description
contacts
contacts array of object

A list of contacts.

contactId
contacts.contactId string

ID of the contact.

email
contacts.email string

E-mail of the contact.

companyId
contacts.companyId string

ID of the company the contact is a part of.

companyName
contacts.companyName string

Name of the company the contact is a part of.

externalLinks
contacts.externalLinks externalLinks

All integrated system links attached to this resource.

userAccount
contacts.userAccount userAccountLink

A link to a user account.

responseGetManufacturers

Name Path Type Description
items
items array of object

A list of manufacturers.

id
items.id string

ID of the manufacturer.

name
items.name string

Name of the manufacturer.

total
total responseTotalCount

The total number of results.

responseGetConfiguration

Name Path Type Description
id
id string

ID of the configuration

configurator
configurator configuratorLink

A link to a configurator.

nodes
nodes array of object

A collection of configuration nodes.

uniqueLabel
nodes.uniqueLabel string

Unique identifier of a node.

componentCode
nodes.componentCode string

The article code of the component linked to the node.

datatype
nodes.datatype enumConfigurationNodeDatatype

Data type of the node value.

type
nodes.type string

The node type.

status
nodes.status enumConfigurationNodeStatus

Status of a node.

value
nodes.value string

The textual representation of the node value.

unit
nodes.unit string

The unit code of the node.

quantity
nodes.quantity number

The quantity of items represented by this node used to calculate the total node price.

listPrice
nodes.price.listPrice float

List price of the node.

purchasePrice
nodes.price.purchasePrice float

Purchase price of the node.

optional
nodes.optional boolean

Is the node optional in the configuration?

purchasePrice
price.purchasePrice float

Purchase price of the configuration.

listPrice
price.listPrice float

List price of the configuration.

currency
price.currency string

Currency of the configuration in ISO 4217 format.

numberOfDecimals
price.numberOfDecimals integer

The decimal precision of the prices.

externalLinks
externalLinks externalLinks

All integrated system links attached to this resource.

responseAudit

The audit information.

Name Path Type Description
createdBy
createdBy contactLink

A link to a contact.

createdAt
createdAt createdAt

Timestamp of object creation.

updatedBy
updatedBy contactLink

A link to a contact.

updatedAt
updatedAt updatedAt

Timestamp of the latest update.

responseTotalCount

The total number of results.

The total number of results.

string

This is the basic data type 'string'.