Freigeben über


Hive CPQ Produktkonfigurator

Hive CPQ ist eine umfassende Configure Price Quote (CPQ)-Lösung, mit der Vertriebsteams genaue Angebote für komplexe Produkte generieren können. Optimieren Sie Ihren Vertriebsprozess, indem Sie Hive CPQ nahtlos integrieren, um Workflows zu automatisieren, Daten zu synchronisieren und Ihre Vorgänge mithilfe unseres Connectors zu optimieren. Maximieren Sie die Effizienz und liefern Sie außergewöhnliche Vertriebserfahrungen mit dem leistungsstarken Connector von Hive CPQ.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name HiveCPQ-Unterstützung
URL https://hivecpq.com/en/integrations
Email support@hivecpq.com
Connectormetadaten
Herausgeber NimbleOps NV
Webseite https://hivecpq.com/
Datenschutzrichtlinie https://hivecpq.com/en/privacy-policy
Kategorien Produktivität; Vertrieb und CRM

Hive CPQ Produktkonfigurator

Hive CPQ ist eine umfassende Configure Price Quote (CPQ)-Lösung, mit der Vertriebsteams genaue Angebote für komplexe Produkte generieren können. Optimieren Sie Ihren Vertriebsprozess, indem Sie Hive CPQ nahtlos integrieren, um Workflows zu automatisieren, Daten zu synchronisieren und Ihre Vorgänge mithilfe unseres Connectors zu optimieren. Maximieren Sie die Effizienz und liefern Sie außergewöhnliche Vertriebserfahrungen mit dem leistungsstarken Connector von Hive CPQ.

Herausgeber: Name des Herausgebers

NimbleOps NV

Voraussetzungen

Sie müssen

  • aktiver Kunde von Hive CPQ
  • Zugriff auf eine Hive CPQ-Umgebung haben

Unterstützte Vorgänge

  • Abrufen von Herstellern: Erhalten Sie alle Hersteller, mit denen Sie verbunden sind.
  • Suchunternehmen: Suchunternehmen, die mit einem Hersteller verknüpft sind.
  • Hinzufügen eines neuen Unternehmens: Hinzufügen eines neuen Unternehmens zu einem Hersteller.
  • Erhalten Sie ein Unternehmen: Erhalten Sie ein bestimmtes Unternehmen, das mit einem Hersteller verknüpft ist.
  • Aktualisieren eines Unternehmens: Aktualisieren sie ein bestimmtes Unternehmen eines Herstellers.
  • Archivieren sie ein Unternehmen: Archivieren Sie ein Unternehmen zusammen mit allen ihren Kontakten.
  • Aufheben der Archivierung eines Unternehmens: Heben Sie die Archivierung eines Unternehmens auf, ohne die Archivierung ihrer Kontakte aufzuheben.
  • Suchen Sie standardadressen eines Unternehmens: Durchsuchen Sie die Standardrechnung und Lieferadressen eines Unternehmens.
  • Fügen Sie eine neue Standardadresse hinzu: Fügen Sie einem Unternehmen eine neue Standardadresse hinzu.
  • Abrufen einer Standardadresse eines Unternehmens: Abrufen einer bestimmten Standardadresse eines Unternehmens.
  • Löschen einer Standardadresse eines Unternehmens: Löschen einer bestimmten Standardadresse eines Unternehmens
  • Aktualisieren einer Standardadresse eines Unternehmens: Aktualisieren einer bestimmten Standardadresse eines Unternehmens.
  • Suchen Von Herstellerkontakten: Suchen Sie Kontakte, die mit einem Hersteller oder ihren Unternehmen verknüpft sind.
  • Hinzufügen eines Herstellerkontakts: Hinzufügen eines neuen Kontakts zu einem Unternehmen eines Herstellers oder seiner Unternehmen.
  • Erhalten Sie einen Herstellerkontakt: Erhalten Sie einen bestimmten Kontakt eines Herstellers oder seiner Unternehmen.
  • Aktualisieren Eines Herstellerkontakts: Aktualisieren Sie einen bestimmten Kontakt eines Herstellers oder seiner Unternehmen.
  • Archiv a contact: Archiv a specific contact and remove its invites.
  • Verteilerkonten durchsuchen: Suchen Sie Konten im Adressbuch eines Händlers.
  • Hinzufügen eines Verteilerkontos: Hinzufügen eines Kontos zum Adressbuch eines Händlers.
  • Löschen eines Verteilerkontos: Löschen Eines bestimmten Kontos aus dem Adressbuch eines Händlers. Ein Konto kann nur entfernt werden, wenn es nicht in Projekten verwendet wird und keine Kontakte hat.
  • Verteilerkonto aktualisieren: Aktualisieren Sie ein bestimmtes Konto im Adressbuch eines Händlers.
  • Suchen Von Verteilerkontakten: Suchen Sie Kontakte im Adressbuch eines Distributors.
  • Hinzufügen eines Verteilerkontakts: Hinzufügen eines neuen Kontakts zum Adressbuch eines Händlers.
  • Löschen eines Verteilerkontakts: Löschen Eines bestimmten Kontakts aus dem Adressbuch eines Händlers.
  • Aktualisieren eines Verteilerkontakts: Aktualisieren Eines bestimmten Kontakts im Adressbuch eines Händlers.
  • Such-Einladungen: Such-Einladungen eines Herstellers.
  • Fügen Sie eine Einladung hinzu: Fügen Sie eine Einladung für einen Kontakt hinzu, um einem Unternehmen beizutreten.
  • Einladungs-E-Mail senden: Senden Sie eine Einladungs-E-Mail mithilfe des Hive CPQ-E-Mail-Systems.
  • Suchcontainerversionen: Containerversionen eines Herstellers durchsuchen.
  • Suchkomponenten: Suchkomponenten in Stammdaten.
  • Hinzufügen einer Komponente: Hinzufügen einer Komponente zu Stammdaten.
  • Abrufen einer Komponente: Abrufen einer bestimmten Komponente in Masterdaten.
  • Löschen einer Komponente: Löschen einer Komponente aus Stammdaten
  • Aktualisieren einer Komponente: Aktualisieren einer bestimmten Komponente in Masterdaten
  • Massenlöschen von Komponenten: Löschen mehrerer Komponenten in Masterdaten
  • Upsert-Komponentenpreise in Massen: Erstellen oder Aktualisieren mehrerer Komponentenpreise in Stammdaten.
  • Abrufen einer Komponenten-QuickInfo: Abrufen einer bestimmten Komponenten-QuickInfo in Masterdaten.
  • Aktualisieren einer Komponenten-QuickInfo: Aktualisieren einer bestimmten Komponenten-QuickInfo in Masterdaten.
  • Löschen einer Komponenten-QuickInfo: Löschen einer Komponenten-QuickInfo aus Masterdaten.
  • Abrufen eines Komponenten-QuickInfo-Bilds: Abrufen eines bestimmten Komponenten-QuickInfo-Bilds aus Masterdaten.
  • Aktualisieren eines Komponenten-QuickInfo-Bilds: Aktualisieren eines bestimmten Komponenten-QuickInfo-Bilds in Masterdaten.
  • Löschen eines Komponenten-QuickInfo-Bilds: Löschen eines Komponenten-QuickInfo-Bilds aus Masterdaten.
  • Rendern eines Konfigurationsfotos: Rendern eines Screenshots einer Konfiguration.
  • Suchkomponentenpreise: Suchpreise einer Komponente in Stammdaten.
  • Add a component price: Add a new price to a component in master data.
  • Löschen eines Komponentenpreises: Löschen eines Preises aus einer Komponente in Stammdaten.
  • Anlagen der Suchkomponente: Durchsuchen von Anlagen einer Komponente in Stammdaten.
  • Hinzufügen einer Komponentenanlage: Hinzufügen einer neuen Anlage zu einer Komponente in Stammdaten.
  • Löschen einer Komponentenanlage: Löschen einer Anlage aus einer Komponente in Stammdaten.
  • Eigenschaftenwerte der Suchkomponente: Sucheigenschaftenwerte einer Komponente in Masterdaten.
  • Festlegen des Eigenschaftswerts der Komponente: Festlegen eines einzelnen Eigenschaftswerts für eine Komponente in Masterdaten.
  • Festlegen von Komponenteneigenschaftswerten: Festlegen mehrerer Eigenschaftswerte für eine Komponente in Masterdaten. Vorhandene Werte werden überschrieben oder gelöscht.
  • Verknüpfen von Features mit einer Komponente: Verknüpft ein oder mehrere Features mit einer Komponente in Masterdaten. Vorhandene Links werden überschrieben oder gelöscht.
  • Aufheben der Verknüpfung eines Features aus einer Komponente: Hebt die Verknüpfung eines Features aus einer bestimmten Komponente in Masterdaten auf.
  • Verknüpfen eines Features mit einer Komponente: Verknüpft ein Feature mit einer Komponente in Masterdaten.
  • Sucheigenschaften: Sucheigenschaften in Masterdaten.
  • Hinzufügen einer neuen Eigenschaft: Hinzufügen einer neuen Eigenschaft zu Masterdaten.
  • Löschen einer Eigenschaft: Löschen einer bestimmten Eigenschaft aus Masterdaten
  • Aktualisieren einer Eigenschaft: Aktualisieren einer bestimmten Eigenschaft in Masterdaten.
  • Suchfeaturegruppen: Suchfeaturegruppen in Stammdaten.
  • Neue Featuregruppe hinzufügen: Hinzufügen einer neuen Featuregruppe zu Masterdaten.
  • Ordnen Sie die Featuregruppen neu an: Ordnen Sie die Featuregruppen neu an, um zu ändern, wie sie im Produktspeicher angezeigt werden. Alle vorhandenen Gruppen müssen Teil der Anforderung sein.
  • Abrufen einer Featuregruppe: Abrufen einer bestimmten Featuregruppe in Stammdaten.
  • Löschen einer Featuregruppe: Löschen einer bestimmten Featuregruppe aus Stammdaten.
  • Aktualisieren einer Featuregruppe: Aktualisieren einer bestimmten Featuregruppe in Stammdaten.
  • Suchfunktionen: Suchfeatures in einer bestimmten Featuregruppe in Masterdaten.
  • Hinzufügen eines Features zu einer Featuregruppe: Hinzufügen eines neuen Features zu einer bestimmten Featuregruppe in Masterdaten.
  • Neuanordnen von Features in einer Featuregruppe: Ordnen Sie die Features in einer bestimmten Featuregruppe neu an, um zu ändern, wie sie im Produktspeicher angezeigt werden. Alle vorhandenen Features in der Gruppe müssen Teil der Anforderung sein.
  • Abrufen eines Features aus einer Featuregruppe: Abrufen eines Features in einer bestimmten Featuregruppe in Stammdaten.
  • Löschen eines Features: Löschen eines Features aus einer bestimmten Featuregruppe in Masterdaten
  • Aktualisieren eines Features: Aktualisieren eines Features in einer bestimmten Featuregruppe in Masterdaten.
  • Ändern Sie die Featuregruppe eines Features: Ändern sie die Featuregruppe eines bestimmten Features in Masterdaten.
  • Sucheinheiten: Sucheinheiten in Stammdaten.
  • Hinzufügen einer Einheit: Hinzufügen einer neuen Einheit zu Stammdaten.
  • Abrufen einer Einheit: Abrufen einer bestimmten Einheit aus Stammdaten.
  • Löschen einer Einheit: Löschen einer bestimmten Einheit aus Stammdaten.
  • Aktualisieren einer Einheit: Aktualisieren einer bestimmten Einheit in Stammdaten.
  • Durchsuchen benutzerdefinierter Objekttypen: Durchsuchen benutzerdefinierter Objekttypen eines Herstellers.
  • Durchsuchen benutzerdefinierter Objekte: Durchsuchen benutzerdefinierter Objekte eines bestimmten Typs.
  • Hinzufügen eines benutzerdefinierten Objekts: Hinzufügen eines neuen benutzerdefinierten Objekts eines bestimmten Typs. Dieser Typ wird erstellt, wenn er nicht vorhanden ist.
  • Abrufen eines benutzerdefinierten Objekts: Abrufen eines benutzerdefinierten Objekts eines bestimmten Typs.
  • Löschen eines benutzerdefinierten Objekts: Löschen eines benutzerdefinierten Objekts eines bestimmten Typs.
  • Aktualisieren eines benutzerdefinierten Objekts:Aktualisieren eines bestimmten benutzerdefinierten Objekts eines bestimmten Typs.
  • Cache für benutzerdefinierte Objekte zurücksetzen: Konfiguratoren können beim Behandeln benutzerdefinierter Objekte Zwischenspeicherung verwenden. Durch Aufrufen dieses Endpunkts werden diese Caches zurückgesetzt.
  • Suchprojekte: Suchen Sie Projekte eines Herstellers.
  • Hinzufügen eines Projekts: Hinzufügen eines neuen Projekts für ein Unternehmen.
  • Abrufen eines Projekts: Abrufen eines bestimmten Projekts eines Herstellers.
  • Aktualisieren eines Projekts: Aktualisieren eines bestimmten Projekts eines Herstellers.
  • Hinzufügen von Produkten zu einem Projekt: Hinzufügen eines oder mehrerer Produkte zu einem Projekt eines Herstellers.
  • Kopieren eines Projekts: Kopiert alle Daten eines Projekts in ein neues Projekt.
  • Neuberechnung eines Projekts: Starten einer asynchronen Neuberechnung des Projekts.
  • Generieren Eines Dokuments für ein Projekt: Generieren eines PDF-Dokuments für ein bestimmtes Projekt. Die Vorlagen-ID ist nur optional, wenn der Dokumenttyp QUOTE ist und eine Standardvorlage konfiguriert wurde.
  • Hinzufügen einer Konfiguration zu einem Projekt: Hinzufügen einer neuen V2-Konfiguration zu einem Projekt.
  • Aktualisieren Sie die Preise in laufenden Projekten: Aktualisieren Sie die Preise aller Projekte, die noch nicht schritt 2 im Auftragsvorgang mit Stammdaten erreicht haben.
  • Projektsegmente durchsuchen: Projektsegmente eines Herstellers durchsuchen.
  • Abrufen eines Projektsegments: Abrufen eines bestimmten Projektsegments eines Herstellers.
  • Aktualisieren eines Projektsegments: Aktualisieren eines bestimmten Projektsegments eines Herstellers.
  • Archiv a project segment: Archiv a specific project segment of a manufacturer.
  • Aufheben der Archivierung eines Projektsegments: Heben Sie die Archivierung eines bestimmten Projektsegments eines Herstellers auf.
  • Verschieben eines Projektsegments in Schritt 1: Verschieben eines bestimmten Projektsegments in Schritt 1. Dadurch wird der Bestellvorgang gestartet.
  • Verschieben eines Projektsegments in Schritt 2: Verschieben eines bestimmten Projektsegments in Schritt 2 Dadurch wird eine Bestellung für das Projektsegment erstellt.
  • Verschieben eines Projektsegments in Schritt 3: Verschieben eines bestimmten Projektsegments in Schritt 3
  • Verschieben eines Projektsegments in Schritt 4: Verschieben eines bestimmten Projektsegments in Schritt 4.
  • Bestellungsprozess eines Projektsegments abbrechen: Abbrechen des Auftragsvorgangs und Verschieben eines Projektsegments zurück zu Schritt 2.
  • Ändern Sie die Einstellungen eines Projektsegments: Ändern Sie die Einstellungen eines Projektsegments. Einstellungen sind nur verfügbar, wenn ein Segmentkonfigurator konfiguriert ist.
  • Hinzufügen einer Konfiguration zu einem Segment: Hinzufügen einer V1-Konfiguration zu einem bestimmten Projektsegment.
  • Durchsuchen von Projektsegmentelementen: Durchsuchen von Projektsegmentelementen eines bestimmten Herstellers.
  • Projektsegmentelement abrufen: Abrufen eines bestimmten Projektsegmentelements eines Herstellers.
  • Löschen eines Projektsegmentelements: Löschen eines bestimmten Projektsegmentelements aus einem Projekt.
  • Aktualisieren eines Projektsegmentelements: Aktualisieren eines bestimmten Projektsegmentelements eines Herstellers.
  • Kopieren Sie das Projektsegmentelement in ein anderes Projekt: Kopiert ein Projektsegmentelement in ein anderes Projekt. Wenn das Element über eine angefügte Konfiguration verfügt, wird es automatisch auf die neueste Version aktualisiert.
  • Hinzufügen einer eigenständigen Konfiguration: Erstellen einer eigenständigen Konfiguration durch Starten einer Konfigurationsüberprüfung für einen V2-Konfigurator
  • Abrufen einer Konfiguration: Abrufen einer bestimmten Konfiguration eines Herstellers.
  • Updatekonfiguration: Aktualisieren Sie die Werte der Knoten in einer Konfiguration.
  • Abrufen einer Datei aus einer Konfiguration: Abrufen der Datei, die an einen Dateiknoten in der Konfiguration angefügt ist.
  • Integrierte Systemlinks durchsuchen: Suchen Sie integrierte Systemlinks eines Herstellers. Eine integrierte Systemverbindung speichert eine Verknüpfung zwischen einer Strukturentität und einer externen Systementität.
  • Fügen Sie eine integrierte Systemverknüpfung hinzu: Fügen Sie eine neue integrierte Systemverknüpfung für eine Ressource hinzu.
  • Löschen einer integrierten Systemverbindung: Löschen einer bestimmten integrierten Systemverbindung.
  • Aktualisieren Sie eine integrierte Systemverbindung: Aktualisieren Sie eine bestimmte integrierte Systemverbindung eines Herstellers.
  • Suchwebhooks: Suchwebhooks, die für einen Hersteller konfiguriert sind.
  • Hinzufügen eines Webhooks: Hinzufügen eines neuen Webhooks für einen Hersteller.
  • Abrufen eines Webhooks: Abrufen eines bestimmten Webhooks eines Herstellers.
  • Löschen eines Webhooks: Löschen eines bestimmten Webhooks eines Herstellers.
  • Aktualisieren eines Webhooks: Aktualisieren eines Webhooks eines Herstellers.
  • Suchen von Webhook-Headern: Suchheader eines bestimmten Webhooks.
  • Hinzufügen des Webhook-Headers: Hinzufügen eines neuen Headers zu einem bestimmten Webhook.
  • Löschen Sie den Header eines Webhooks: Löschen Sie den Header eines bestimmten Webhooks.
  • Suchereignisabonnements: Suchereignisabonnements, für die Sie abonniert sind.
  • Abonnieren Sie Ereignisse: Abonnieren Sie Ereignisse eines Herstellers. Vorhandene Abonnements werden überschrieben oder gelöscht.
  • Suchwebhook-Trigger: Suchtrigger eines bestimmten Webhooks.
  • Hinzufügen eines Webhook-Triggers: Hinzufügen eines neuen Triggers zu einem bestimmten Webhook.
  • Abrufen eines Webhook-Triggers: Abrufen eines bestimmten Triggers eines Webhooks.
  • Löschen eines Webhook-Triggers: Löschen eines bestimmten Triggers eines Webhooks.
  • Aktualisieren eines Webhook-Triggers: Aktualisieren eines bestimmten Triggers eines Webhooks.
  • Suchpreiskataloge: Suchen Sie Preiskataloge eines Herstellers.
  • Hinzufügen eines Preiskatalogs: Hinzufügen eines Preiskatalogs für einen Hersteller.
  • Abrufen eines Preiskatalogs: Erhalten Sie einen bestimmten Preiskatalog eines Herstellers.
  • Aktualisieren eines Preiskatalogs: Aktualisieren Sie einen bestimmten Preiskatalog eines Herstellers.
  • Löschen eines Preiskatalogs: Löschen Eines bestimmten Preiskatalogs.
  • Suchbeschwerden: Suchbeschwerden eines Herstellers
  • Hinzufügen einer Beschwerde: Hinzufügen einer neuen Beanstandung für einen Hersteller.
  • Erhalten Sie eine Beschwerde: Erhalten Sie eine bestimmte Beschwerde eines Herstellers.
  • Beanstandung löschen: Eine bestimmte Beschwerde eines Herstellers löschen.
  • Aktualisieren einer Beschwerde: Aktualisieren einer bestimmten Beschwerde eines Herstellers.
  • Suchbeschwerdekommentare: Durchsuchen von Kommentaren einer bestimmten Beschwerde.
  • Fügen Sie einen Beschwerdekommentar hinzu: Fügen Sie einer bestimmten Beschwerde einen neuen Kommentar hinzu.
  • Beanstandungskommentare ersetzen: Ersetzen Sie alle Kommentare einer bestimmten Beschwerde.
  • Anlagen für Suchbeschwerde: Anlagen einer bestimmten Beschwerde durchsuchen.
  • Hinzufügen einer Beschwerdeanlage: Hinzufügen einer neuen Anlage zu einer bestimmten Beanstandung.
  • Erhalten Sie eine Beschwerdeanfügung: Erhalten Sie eine Anlage einer bestimmten Beschwerde.
  • Entfernt den Anhang aus einer Beschwerde: Entfernt den Anhang aus einer Beschwerde.
  • Abrufen eines Benutzerkontos: Rufen Sie ein bestimmtes Benutzerkonto ab, das mit dem angegebenen Hersteller verbunden ist.
  • Suchausgabedokumentvorlagen: Suchen Von Ausgabedokumentvorlagen eines Herstellers.
  • Suchrollen: Suchrollen, die der Hersteller für seine eigenen Kontakte und die seiner Händler definiert hat.
  • Suchberechtigungen: Suchberechtigungen eines Herstellers.
  • Suchereignisse: Suchplattformereignisse eines Herstellers.
  • Abrufen von Plug-In-Tokeninformationen: Abrufen von Informationen über den Benutzer, der derzeit ein Plug-In aus Hive CPQ verwendet.
  • Suchzustellbedingungen: Such-Lieferbedingungen eines Herstellers.
  • Suchzahlungsbedingungen: Suchzahlungsbedingungen eines Herstellers.
  • Suchsteuerbedingungen: Suchsteuerbedingungen eines Herstellers.

Abrufen von Anmeldeinformationen

Eine Anforderung muss gestellt werden, um API-Anmeldeinformationen in Form eines Benutzernamens und Kennworts anzufordern support@Hive CPQ.com. Bei einer benutzerdefinierten Installation müssen Sie auch Ihre eigene Client-ID und ihren geheimen Schlüssel anfordern.

Bekannte Probleme und Einschränkungen

Abfrageparameter, mit denen eine Liste von Werten übergeben werden kann, weisen nur den ersten Wert auf, der vom zugrunde liegenden Dienst berücksichtigt wird. Dies liegt an einem Konflikt zwischen den unterstützten Formaten, die powerautomate verwenden kann, um Mehrwertparameter zu senden und das Format, das der zugrunde liegende Dienst akzeptiert.

Häufige Fehler und Abhilfemaßnahmen

  • 400 Ungültige Anforderung:
    • Gibt ein Problem in der Nutzlast an, die vom Dienst empfangen wurde: Es wird empfohlen, die eingaben, die im Connector verwendet werden, auf ungültige Werte erneut zu überprüfen.
  • 401 Nicht autorisiert:
    • Gibt ein Problem mit der Authentifizierung an den Dienst an: Es wird empfohlen, die Verbindung des Connectors zu verlängern.
  • 403 Verboten:
    • Gibt an, dass die Zugriffsebene nicht hoch genug ist, um auf eine bestimmte Ressource zuzugreifen oder eine bestimmte Aktion auszuführen: Es wird empfohlen, erhöhte Berechtigungen für das Connectorbenutzerkonto anzufordern. support@hivecpq.com
  • 404 nicht gefunden:
    • Gibt an, dass die angeforderte Ressource nicht vorhanden ist: Es wird empfohlen, das Innere des zugrunde liegenden Diensts zu überprüfen, wenn die Ressource vorhanden ist.
  • 500 Serverfehler:
    • Gibt an, dass beim zugrunde liegenden Dienst ein Fehler aufgetreten ist, der nicht wiederhergestellt werden kann: Es wird empfohlen, sich an den Support zu wenden, um das Problem zu untersuchen.

Häufig gestellte Fragen

Wie lange ist die Verbindung mit HiveCPQ gültig, nachdem die angegebenen Anmeldeinformationen eingegeben wurden?

Die Anmeldeinformationen bleiben unbegrenzt gültig. Es ist möglich, Kennwortverlängerungen anzufordern. Die Verbindung selbst funktioniert basierend auf dem Ablauf der Inaktivität. Wenn die Verbindung in keinem Workflow mehr als 2 Monate ausgeführt wird, läuft sie ab, und die Anmeldeinformationen müssen erneut eingegeben werden.

Bereitstellungsanweisungen

Verwenden Sie diese Anweisungen , um diesen Connector als benutzerdefinierter Connector in Microsoft Power Automate und Power Apps bereitzustellen.

Geben Sie für benutzerdefinierte Connectorinstallationen die richtige client_id ein, die Sie von der Hive CPQ-Unterstützung anfordern müssen, in der Eigenschaftendatei des Connectors.

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abbrechen des Bestellvorgangs in Schritt 1

Bricht den Bestellvorgang ab und verschebt ein Segment zurück zu Schritt 1. Das Projektsegment muss sich in Schritt 2 befinden, um in Schritt 1 verschoben werden zu können.

Abonnieren von Ereignissen

Abonnieren Sie Ereignisse eines Herstellers. Vorhandene Abonnements werden überschrieben oder gelöscht.

Abrufen einer Beschwerde

Erhalten Sie eine bestimmte Beschwerde eines Herstellers.

Abrufen einer Datei aus einer Konfiguration

Rufen Sie die Datei ab, die an einen Dateiknoten in der Konfiguration angefügt ist.

Abrufen einer Einheit

Rufen Sie eine bestimmte Einheit aus Stammdaten ab.

Abrufen einer Featuregruppe

Rufen Sie eine bestimmte Featuregruppe in Stammdaten ab.

Abrufen einer Komponente

Rufen Sie eine bestimmte Komponente in Stammdaten ab.

Abrufen einer Komponenten-QuickInfo

Abrufen einer bestimmten Komponenten-QuickInfo in Masterdaten.

Abrufen einer Konfiguration

Rufen Sie eine bestimmte Konfiguration eines Herstellers ab.

Abrufen einer Standardadresse eines Unternehmens

Rufen Sie eine bestimmte Standardadresse eines Unternehmens ab.

Abrufen eines benutzerdefinierten Objekts

Ruft ein benutzerdefiniertes Objekt eines bestimmten Typs ab.

Abrufen eines Benutzerkontos

Rufen Sie ein bestimmtes Benutzerkonto ab, das mit dem angegebenen Hersteller verbunden ist.

Abrufen eines Features aus einer Featuregruppe

Rufen Sie ein Feature in einer bestimmten Featuregruppe in Masterdaten ab.

Abrufen eines Komponenten-QuickInfo-Bilds

Rufen Sie ein bestimmtes Komponenten-QuickInfo-Image aus Masterdaten ab.

Abrufen eines Preiskatalogs

Rufen Sie einen bestimmten Preiskatalog eines Herstellers ab.

Abrufen eines Projekts

Rufen Sie ein bestimmtes Projekt eines Herstellers ab.

Abrufen eines Projektsegments

Rufen Sie ein bestimmtes Projektsegment eines Herstellers ab.

Abrufen eines Webhook-Triggers

Rufen Sie einen bestimmten Trigger eines Webhooks ab.

Abrufen eines Webhooks

Rufen Sie einen bestimmten Webhook eines Herstellers ab.

Abrufen von Herstellern

Rufen Sie alle Hersteller ab, mit denen Sie verbunden sind.

Abrufen von Plug-In-Tokeninformationen

Abrufen von Informationen über den Benutzer, der derzeit ein Plug-In aus HiveCPQ verwendet.

Aktualisieren der Preise in laufenden Projekten

Aktualisieren Sie die Preise aller Projekte, die schritt 2 noch nicht im Bestellprozess mit Stammdaten erreicht haben.

Aktualisieren einer Beschwerde

Aktualisieren Sie eine spezifische Beanstandung eines Herstellers.

Aktualisieren einer Eigenschaft

Aktualisieren einer bestimmten Eigenschaft in Stammdaten.

Aktualisieren einer Einheit

Aktualisieren einer bestimmten Einheit in Stammdaten.

Aktualisieren einer Featuregruppe

Aktualisieren sie eine bestimmte Featuregruppe in Stammdaten.

Aktualisieren einer integrierten Systemverbindung

Aktualisieren Sie eine bestimmte integrierte Systemverbindung eines Herstellers.

Aktualisieren einer Komponente

Aktualisieren einer bestimmten Komponente in Stammdaten

Aktualisieren einer Komponenten-QuickInfo

Aktualisieren Sie eine bestimmte Komponenten-QuickInfo in Masterdaten.

Aktualisieren einer Standardadresse eines Unternehmens

Aktualisieren Einer bestimmten Standardadresse eines Unternehmens.

Aktualisieren eines benutzerdefinierten Objekts

Aktualisieren eines bestimmten benutzerdefinierten Objekts eines bestimmten Typs.

Aktualisieren eines Features

Aktualisieren sie ein Feature in einer bestimmten Featuregruppe in Stammdaten.

Aktualisieren eines Herstellerkontakts

Aktualisieren Sie einen bestimmten Kontakt eines Herstellers oder seiner Unternehmen.

Aktualisieren eines Komponenten-QuickInfo-Bilds

Aktualisieren eines bestimmten Komponenten-QuickInfo-Images in Masterdaten.

Aktualisieren eines Preiskatalogs

Aktualisieren Sie einen bestimmten Preiskatalog eines Herstellers.

Aktualisieren eines Projektsegmentelements

Aktualisieren Sie ein bestimmtes Projektsegmentelement eines Herstellers.

Aktualisieren eines Projektsegments

Aktualisieren Sie ein bestimmtes Projektsegment eines Herstellers.

Aktualisieren eines Unternehmens

Aktualisieren Sie ein bestimmtes Unternehmen eines Herstellers.

Aktualisieren eines Vertriebskontakts

Aktualisieren Sie einen bestimmten Kontakt im Adressbuch eines Händlers.

Aktualisieren eines Webhook-Triggers

Aktualisieren eines bestimmten Triggers eines Webhooks.

Aktualisieren eines Webhooks

Aktualisieren sie einen Webhook eines Herstellers.

Anfordern eines Herstellerkontakts

Erhalten Sie einen bestimmten Kontakt eines Herstellers oder seiner Unternehmen.

Anlagen der Suchkomponente

Durchsuchen von Anlagen einer Komponente in Stammdaten.

Anlagen für Die Suche nach Beschwerden

Durchsuchen von Anlagen einer bestimmten Beschwerde.

Archiv eines Kontakts

Archiviert einen bestimmten Kontakt und entfernt seine Einladungen.

Archiv eines Projektsegments

Archiv a specific project segment of a manufacturer.

Archiv eines Unternehmens

Archivieren Sie ein Unternehmen zusammen mit allen ihren Kontakten.

Aufheben der Archivierung eines Kontakts

Heben Sie die Archivierung eines bestimmten Kontakts auf.

Aufheben der Archivierung eines Projektsegments

Heben Sie die Archivierung eines bestimmten Projektsegments eines Herstellers auf.

Aufheben der Archivierung eines Unternehmens

Heben Sie die Archivierung eines Unternehmens auf, ohne die Archivierung der Kontakte aufzuheben.

Aufheben der Verknüpfung eines Features aus einer Komponente

Hebt die Verknüpfung eines Features aus einer bestimmten Komponente in Masterdaten auf.

Beanstandungsanlage abrufen

Erhalten Sie eine Anlage einer bestimmten Beschwerde.

Benutzerdefinierte Objekte durchsuchen

Durchsuchen benutzerdefinierter Objekte eines bestimmten Typs.

Benutzerdefinierte Objekttypen durchsuchen

Suchen Sie benutzerdefinierte Objekttypen eines Herstellers.

Bestellungsprozess eines Projektsegments abbrechen

Abbrechen des Auftragsvorgangs und Verschieben eines Projektsegments zurück in Schritt 2.

Cache für benutzerdefinierte Objekte zurücksetzen

Konfiguratoren können beim Behandeln von benutzerdefinierten Objekten Zwischenspeicherung verwenden. Durch Aufrufen dieses Endpunkts werden diese Caches zurückgesetzt.

Containerversionen durchsuchen

Suchen Sie Containerversionen eines Herstellers.

Durchsuchen von Anlagen eines Projektsegments

Durchsuchen von Anlagen eines bestimmten Projektsegments

Durchsuchen von Standardadressen eines Unternehmens

Durchsuchen Sie die Standardrechnungs- und Lieferadressen eines Unternehmens.

Eigenschaftenwerte der Suchkomponente

Sucheigenschaftenwerte einer Komponente in Stammdaten.

Einladungs-E-Mail senden

Senden Sie eine Einladungs-E-Mail mithilfe des HiveCPQ-E-Mail-Systems.

Entfernt den Anhang aus einer Beschwerde.

Entfernt den Anhang aus einer Beschwerde.

Ersetzen von Beschwerdekommentaren

Ersetzen Sie alle Kommentare einer bestimmten Beschwerde.

Festlegen des Eigenschaftswerts der Komponente

Legen Sie einen einzelnen Eigenschaftswert für eine Komponente in Masterdaten fest.

Festlegen von Komponenteneigenschaftswerten

Legen Sie mehrere Eigenschaftswerte für eine Komponente in Masterdaten fest. Vorhandene Werte werden überschrieben oder gelöscht.

Festlegen von Komponentenmengen

Legen Sie Mengen für eine Komponente in Stammdaten fest. Bestehende Mengen werden überschrieben oder gelöscht.

Generieren eines PDF-Dokuments für ein Projekt

Generieren Sie ein PDF-Dokument für ein bestimmtes Projekt. Die Vorlagen-ID ist nur optional, wenn der Dokumenttyp QUOTE ist und eine Standardvorlage konfiguriert wurde.

Generieren eines Wortdokuments für ein Projekt

Generieren Sie ein Microsoft Word-Dokument für ein bestimmtes Projekt. Die Vorlagen-ID ist nur optional, wenn der Dokumenttyp QUOTE ist und eine Standardvorlage konfiguriert wurde.

Herstellerkontakt hinzufügen

Fügen Sie einem Unternehmen eines Herstellers oder seiner Unternehmen einen neuen Kontakt hinzu.

Hinzufügen einer Anlage zu einem Projektsegment

Fügen Sie einem bestimmten Projektsegment eine Anlage hinzu.

Hinzufügen einer Beschwerde

Fügen Sie eine neue Beschwerde für einen Hersteller hinzu.

Hinzufügen einer Beschwerdeanlage

Fügen Sie einer bestimmten Beschwerde eine neue Anlage hinzu.

Hinzufügen einer eigenständigen Konfiguration

Erstellen einer eigenständigen Konfiguration durch Starten einer Konfigurationsüberprüfung für einen V2-Konfigurator

Hinzufügen einer Einheit

Fügen Sie eine neue Einheit zu Stammdaten hinzu.

Hinzufügen einer Einladung

Fügen Sie eine Einladung für einen Kontakt hinzu, um einem Unternehmen beizutreten.

Hinzufügen einer Komponente

Fügen Sie eine Komponente zu Stammdaten hinzu.

Hinzufügen einer Komponentenanlage

Fügen Sie einer Komponente in Stammdaten eine neue Anlage hinzu.

Hinzufügen einer Konfiguration zu einem Projekt

Fügen Sie einem Projekt eine neue V2-Konfiguration hinzu.

Hinzufügen einer Konfiguration zu einem Projektsegment

Hinzufügen einer V1-Konfiguration zu einem bestimmten Projektsegment.

Hinzufügen einer neuen Eigenschaft

Hinzufügen einer neuen Eigenschaft zu Masterdaten.

Hinzufügen einer neuen Standardadresse

Fügen Sie einer Firma eine neue Standardadresse hinzu.

Hinzufügen eines benutzerdefinierten Objekts

Fügen Sie ein neues benutzerdefiniertes Objekt eines bestimmten Typs hinzu. Dieser Typ wird erstellt, wenn er nicht vorhanden ist.

Hinzufügen eines Beschwerdekommentars

Fügen Sie einen neuen Kommentar zu einer bestimmten Beschwerde hinzu.

Hinzufügen eines Features zu einer Featuregruppe

Fügen Sie einer bestimmten Featuregruppe in Masterdaten ein neues Feature hinzu.

Hinzufügen eines integrierten Systemlinks

Fügen Sie eine neue integrierte Systemverknüpfung für eine Ressource hinzu.

Hinzufügen eines Komponentenpreises

Fügen Sie einer Komponente in Stammdaten einen neuen Preis hinzu.

Hinzufügen eines neuen Unternehmens

Fügen Sie einem Hersteller ein neues Unternehmen hinzu.

Hinzufügen eines Preiskatalogs

Fügen Sie einen Preiskatalog für einen Hersteller hinzu.

Hinzufügen eines Projekts

Fügen Sie ein neues Projekt für ein Unternehmen hinzu.

Hinzufügen eines Verteilerkontos

Fügen Sie dem Adressbuch eines Händlers ein Konto hinzu.

Hinzufügen eines Vertriebskontakts

Fügen Sie dem Adressbuch eines Händlers einen neuen Kontakt hinzu.

Hinzufügen eines Webhook-Triggers

Fügen Sie einen neuen Trigger zu einem bestimmten Webhook hinzu.

Hinzufügen eines Webhooks

Fügen Sie einen neuen Webhook für einen Hersteller hinzu.

Hinzufügen von Produkten zu einem Projekt

Fügen Sie einem Projekt eines Herstellers mindestens ein Produkt hinzu.

Hinzufügen von Webhook-Headern

Fügen Sie einem bestimmten Webhook einen neuen Header hinzu.

Integrierte Systemlinks durchsuchen

Suchen Sie integrierte Systemlinks eines Herstellers. Eine integrierte Systemverbindung speichert eine Verknüpfung zwischen einer Strukturentität und einer externen Systementität.

Kopieren einer Eigenschaft in eine andere Version

Kopieren Sie eine Eigenschaft in eine andere Version.

Kopieren einer Einheit in eine andere Version

Kopieren Sie eine Einheit in eine andere Version.

Kopieren einer Featuregruppe in eine andere Version

Kopieren Sie eine Featuregruppe in eine andere Version. Zugrunde liegende Features werden nicht kopiert.

Kopieren einer Komponente in eine andere Version

Kopieren Sie eine Komponente in eine andere Version.

Kopieren eines Features in eine andere Version

Kopieren Sie ein Feature in eine andere Version.

Kopieren eines Projektsegmentelements in ein anderes Projekt

Kopiert ein Projektsegmentelement in ein anderes Projekt. Wenn das Element über eine angefügte Konfiguration verfügt, wird es automatisch auf die neueste Version aktualisiert.

Löschen der Kopfzeile eines Webhooks

Löschen Sie den Header eines bestimmten Webhooks.

Löschen einer Anlage eines Projektsegments

Löschen sie eine Anlage eines bestimmten Projektsegments.

Löschen einer Beschwerde

Löschen einer spezifischen Beschwerde eines Herstellers.

Löschen einer Eigenschaft

Löschen einer bestimmten Eigenschaft aus Stammdaten

Löschen einer Einheit

Löschen einer bestimmten Einheit aus Stammdaten.

Löschen einer Featuregruppe

Löschen sie eine bestimmte Featuregruppe aus Stammdaten.

Löschen einer integrierten Systemverbindung

Löschen Sie eine bestimmte integrierte Systemverbindung.

Löschen einer Komponente

Löschen einer Komponente aus Stammdaten

Löschen einer Komponenten-QuickInfo

Löschen einer Komponenten-QuickInfo aus Masterdaten.

Löschen einer Komponentenanlage

Löschen einer Anlage aus einer Komponente in Stammdaten.

Löschen einer Standardadresse eines Unternehmens

Löschen einer bestimmten Standardadresse eines Unternehmens

Löschen eines benutzerdefinierten Objekts

Löschen eines benutzerdefinierten Objekts eines bestimmten Typs.

Löschen eines Features

Löschen eines Features aus einer bestimmten Featuregruppe in Masterdaten

Löschen eines Komponenten-QuickInfo-Bilds

Löschen eines Komponenten-QuickInfo-Bilds aus Masterdaten.

Löschen eines Komponentenpreises

Löschen eines Preises aus einer Komponente in Stammdaten.

Löschen eines Konfigurators

Löschen Eines bestimmten Konfigurators aus einer Version.

Löschen eines Preiskatalogs

Löschen Sie einen bestimmten Preiskatalog.

Löschen eines Projekts

Löschen Sie ein bestimmtes Projekt eines Herstellers.

Löschen eines Projektsegmentelements

Löschen eines bestimmten Projektsegmentelements aus einem Projekt.

Löschen eines Unternehmens

Löschen Sie ein bestimmtes Unternehmen eines Herstellers.

Löschen eines Vertriebskontakts

Löschen eines bestimmten Kontakts eines Distributors

Löschen eines Vertriebskontakts

Löschen Sie einen bestimmten Kontakt aus dem Adressbuch eines Händlers.

Löschen eines Vertriebskontos

Löschen Sie ein bestimmtes Konto aus dem Adressbuch eines Händlers. Ein Konto kann nur entfernt werden, wenn es nicht in Projekten verwendet wird und keine Kontakte hat.

Löschen eines Webhook-Triggers

Löschen eines bestimmten Triggers eines Webhooks.

Löschen eines Webhooks

Löschen Sie einen bestimmten Webhook eines Herstellers.

Massenlöschen von Komponenten

Löschen mehrerer Komponenten in Stammdaten.

Neuanordnen der Featuregruppen

Ordnen Sie die Featuregruppen neu an, um zu ändern, wie sie im Produktspeicher angezeigt werden. Alle vorhandenen Gruppen müssen Teil der Anforderung sein.

Neuanordnen von Features in einer Featuregruppe

Ordnen Sie die Features in einer bestimmten Featuregruppe neu an, um zu ändern, wie sie im Produktspeicher angezeigt werden. Alle vorhandenen Features in der Gruppe müssen Teil der Anforderung sein.

Neuberechnung eines Projekts

Starten Sie eine asynchrone Neuberechnung des Projekts.

Neuberechnung eines Projektsegments fortsetzen

Setzt die Neuberechnung eines Projektsegments fort, wenn es durch eine externe Neuberechnung angehalten wurde.

Neue Featuregruppe hinzufügen

Hinzufügen einer neuen Featuregruppe zu Stammdaten.

Projekt aktualisieren

Aktualisieren Sie ein bestimmtes Projekt eines Herstellers.

Projekt kopieren

Kopiert alle Daten eines Projekts in ein neues Projekt.

Projekte durchsuchen

Suchprojekte eines Herstellers.

Projektsegmente durchsuchen

Suchen Sie Projektsegmente eines Herstellers.

Projektsegmentelement abrufen

Rufen Sie ein bestimmtes Projektsegmentelement eines Herstellers ab.

Projektsegmentelemente durchsuchen

Durchsuchen von Projektsegmentelementen eines bestimmten Herstellers.

Rendern eines Konfigurationsfotos

Rendern eines Screenshots einer Konfiguration.

Steuerbedingungen durchsuchen

Suchen Sie steuerrechtlichen Bedingungen eines Herstellers.

Stornieren des Bestellvorgangs zum Anführungszeichen

Bricht den Bestellvorgang ab und verschenkt ein Segment wieder in anführungszeichen. Das Projektsegment muss sich in Schritt 1 oder Schritt 2 befinden, um in anführungszeichen verschoben werden zu können.

Such-Einladungen

Suchen Sie Einladungen eines Herstellers.

Suchausgabedokumentvorlagen

Suchausgabedokumentvorlagen eines Herstellers.

Suchberechtigungen

Suchberechtigungen eines Herstellers.

Suchbeschwerdekommentare

Durchsuchen Sie Kommentare einer bestimmten Beschwerde.

Suchbeschwerden

Suchbeschwerden eines Herstellers

Sucheigenschaften

Sucheigenschaften in Masterdaten.

Sucheinheiten

Sucheinheiten in Stammdaten.

Suchen nach Verteilerkontakten

Suchen Sie Kontakte im Adressbuch eines Händlers.

Suchen von Kontakten des Herstellers

Suchen Sie Kontakte, die mit einem Hersteller oder ihren Unternehmen verknüpft sind.

Suchen von Unternehmen

Suchunternehmen, die mit einem Hersteller verknüpft sind.

Suchen von Webhook-Headern

Suchheader eines bestimmten Webhooks.

Suchen von Webhooks

Suchwebhooks, die für einen Hersteller konfiguriert sind.

Suchereignisabonnements

Suchereignisabonnements, für die Sie abonniert sind.

Suchereignisse

Suchplattformereignisse eines Herstellers.

Suchfeaturegruppen

Suchfeaturegruppen in Stammdaten.

Suchfeatures

Suchfeatures in einer bestimmten Featuregruppe in Stammdaten.

Suchkategorien

Suchkategorien in Stammdaten.

Suchkomponenten

Suchkomponenten in Stammdaten.

Suchkomponentenmengen

Suchmengen einer Komponente in Stammdaten.

Suchkomponentenpreise

Suchpreise einer Komponente in Stammdaten.

Suchkonfiguratoren

Suchkonfiguratoren in version.

Suchpreiskataloge

Suchen Sie Preiskataloge eines Herstellers.

Suchrollen

Suchrollen, die der Hersteller für seine eigenen Kontakte und diejenigen seiner Händler definiert hat.

Suchwebhook-Trigger

Suchtrigger eines bestimmten Webhooks.

Suchzustellbedingungen

Suchzustellbedingungen eines Herstellers.

Unternehmen abrufen

Rufen Sie ein bestimmtes Unternehmen ab, das mit einem Hersteller verknüpft ist.

Unterstützte Sprachen durchsuchen

Durchsuchen Sie die unterstützten Sprachen.

Updatekonfiguration

Aktualisieren Sie die Werte der Knoten in einer Konfiguration.

Upsert-Eigenschaften in Massen

Erstellen oder Aktualisieren von 50 Eigenschaften in Masterdaten.

Upsert-Einheiten in Massen

Erstellen oder Aktualisieren von 50 Einheiten in Stammdaten.

Upsert-Features in Massen

Erstellen oder Aktualisieren von 50 Features in Masterdaten.

Upsert-Kategorien in Massen

Erstellen oder Aktualisieren von 50 Kategorien in Masterdaten.

Upsert-Komponenten in Massen

Erstellen oder Aktualisieren von 50 Komponenten in Stammdaten.

Upsert-Komponentenpreise in Massen

Erstellen oder Aktualisieren von 50 Komponentenpreisen in Stammdaten.

Verknüpfen eines Features mit einer Komponente

Verknüpft ein Feature mit einer Komponente in Masterdaten.

Verknüpfen von Features mit einer Komponente

Verknüpft ein oder mehrere Features mit einer Komponente in Masterdaten. Vorhandene Links werden überschrieben oder gelöscht.

Verschieben eines Projektsegments in Schritt 1

Verschieben sie ein bestimmtes Projektsegment in Schritt 1. Dadurch wird der Bestellvorgang gestartet.

Verschieben eines Projektsegments in Schritt 2

Verschieben sie ein bestimmtes Projektsegment in Schritt 2. Dadurch wird eine Bestellung für das Projektsegment erstellt.

Verschieben eines Projektsegments in Schritt 3

Verschieben sie ein bestimmtes Projektsegment in Schritt 3.

Verschieben eines Projektsegments in Schritt 4

Verschieben sie ein bestimmtes Projektsegment in Schritt 4.

Verteilerkonten durchsuchen

Suchen Sie Konten im Adressbuch eines Händlers.

Verteilerkonto aktualisieren

Aktualisieren Sie ein bestimmtes Konto im Adressbuch eines Distributors.

Zahlungsbedingungen suchen

Suchen Sie die Zahlungsbedingungen eines Herstellers.

Ändern der Einstellungen eines Projektsegments

Ändern Sie die Einstellungen eines Projektsegments. Einstellungen sind nur verfügbar, wenn ein Segmentkonfigurator konfiguriert ist.

Ändern der Featuregruppe eines Features

Ändern Sie die Featuregruppe eines bestimmten Features in Stammdaten.

Abbrechen des Bestellvorgangs in Schritt 1

Bricht den Bestellvorgang ab und verschebt ein Segment zurück zu Schritt 1. Das Projektsegment muss sich in Schritt 2 befinden, um in Schritt 1 verschoben werden zu können.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Abonnieren von Ereignissen

Abonnieren Sie Ereignisse eines Herstellers. Vorhandene Abonnements werden überschrieben oder gelöscht.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

body
body string

Die Ereignisse, für die ein Webhook abonniert werden kann.

Abrufen einer Beschwerde

Erhalten Sie eine bestimmte Beschwerde eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

Gibt zurück

Abrufen einer Datei aus einer Konfiguration

Rufen Sie die Datei ab, die an einen Dateiknoten in der Konfiguration angefügt ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Konfigurations-ID
configurationId True string

ID der Konfiguration, auf die Sie zugreifen möchten.

Eindeutige Bezeichnung für Dateiknoten
uniqueLabel True string

Die eindeutige Bezeichnung des Dateiknotens.

Abrufen einer Einheit

Rufen Sie eine bestimmte Einheit aus Stammdaten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Einheiten-ID
unitId True string

ID der Einheit, auf die Sie zugreifen möchten.

Gibt zurück

Abrufen einer Featuregruppe

Rufen Sie eine bestimmte Featuregruppe in Stammdaten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

Gibt zurück

Abrufen einer Komponente

Rufen Sie eine bestimmte Komponente in Stammdaten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Gibt zurück

Abrufen einer Komponenten-QuickInfo

Abrufen einer bestimmten Komponenten-QuickInfo in Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Gibt zurück

Abrufen einer Konfiguration

Rufen Sie eine bestimmte Konfiguration eines Herstellers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Konfigurations-ID
configurationId True string

ID der Konfiguration, auf die Sie zugreifen möchten.

Eindeutiges Etikett
uniqueLabel array

Filtern Sie nach der eindeutigen Bezeichnung der Konfigurationsknoten.

Eigenschaftencode
propertyCode array

Eigenschaftscode(n), für die ein Komponenteneigenschaftswert für jeden Knoten zurückgegeben werden soll.

Optionale Knoten einschließen
includeOptionalNodes boolean

Filtern oder Einschließen optionaler Konfigurationsknoten.

Komponentendaten einschließen
includeComponentData boolean

Enthält zusätzliche Komponentendaten für jeden Knoten.

Ausgabemodus
outputMode string

Steuern Sie die Ausgabestruktur der Konfiguration.

Language
language array

Filtern Sie die BOM- und Konfigurationsbeschreibungen nach Sprache.

Gibt zurück

Abrufen einer Standardadresse eines Unternehmens

Rufen Sie eine bestimmte Standardadresse eines Unternehmens ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

Standardadress-ID
defaultAddressId True string

ID der Standardadresse, auf die Sie zugreifen möchten.

Gibt zurück

Abrufen eines benutzerdefinierten Objekts

Ruft ein benutzerdefiniertes Objekt eines bestimmten Typs ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Benutzerdefinierter Objekttyp
customObjectType True string

Name des benutzerdefinierten Objekttyps, auf den Sie zugreifen möchten.

Benutzerdefinierte Objekt-ID
customObjectKey True string

ID des benutzerdefinierten Objekts, auf das Sie zugreifen möchten.

Gibt zurück

Abrufen eines Benutzerkontos

Rufen Sie ein bestimmtes Benutzerkonto ab, das mit dem angegebenen Hersteller verbunden ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Benutzerkonto-ID
userAccountId True string

ID des Benutzerkontos, auf das Sie zugreifen möchten.

Gibt zurück

Abrufen eines Features aus einer Featuregruppe

Rufen Sie ein Feature in einer bestimmten Featuregruppe in Masterdaten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

Feature-ID
featureId True string

ID des Features, auf das Sie zugreifen möchten.

Gibt zurück

Abrufen eines Komponenten-QuickInfo-Bilds

Rufen Sie ein bestimmtes Komponenten-QuickInfo-Image aus Masterdaten ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Abrufen eines Preiskatalogs

Rufen Sie einen bestimmten Preiskatalog eines Herstellers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Preiskatalog-ID
priceCatalogId True string

ID des Katalogs, auf den Sie zugreifen möchten.

Gibt zurück

Abrufen eines Projekts

Rufen Sie ein bestimmtes Projekt eines Herstellers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektkennung
projectId True string

ID des Projekts, auf das Sie zugreifen möchten.

Gibt zurück

Abrufen eines Projektsegments

Rufen Sie ein bestimmtes Projektsegment eines Herstellers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Gibt zurück

Abrufen eines Webhook-Triggers

Rufen Sie einen bestimmten Trigger eines Webhooks ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Webhook-Trigger-ID
webhookTriggerId True string

ID des Webhook-Triggers, auf den Sie zugreifen möchten.

Gibt zurück

Abrufen eines Webhooks

Rufen Sie einen bestimmten Webhook eines Herstellers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Gibt zurück

Abrufen von Herstellern

Rufen Sie alle Hersteller ab, mit denen Sie verbunden sind.

Gibt zurück

Abrufen von Plug-In-Tokeninformationen

Abrufen von Informationen über den Benutzer, der derzeit ein Plug-In aus HiveCPQ verwendet.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Plug-In-Token-ID
pluginTokenId True string

Das Plug-In-Token, das von einem Hive-Plug-In generiert wird, aus dem Sie Benutzerdaten abrufen möchten.

Gibt zurück

Aktualisieren der Preise in laufenden Projekten

Aktualisieren Sie die Preise aller Projekte, die schritt 2 noch nicht im Bestellprozess mit Stammdaten erreicht haben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

updateProductStorePrices
updateProductStorePrices boolean

Aktualisieren Sie die Preise der Artikel im Produktspeicher.

projectRecalculationRequired
projectRecalculationRequired boolean

Erfordert, dass Projekte nach dem Update neu berechnet werden.

updateConfiguratorPrices
updateConfiguratorPrices boolean

Aktualisieren Sie die Preise der Konfigurationen.

Aktualisieren einer Beschwerde

Aktualisieren Sie eine spezifische Beanstandung eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

title
title True string

Der Titel der Beschwerde.

Beschreibung
description True string

Die Beschreibung der Beschwerde.

companyId
companyId True string

Die ID des Unternehmens, das die Beschwerde geöffnet hat.

status
status True string

Der Status einer Beschwerde.

type
type True string

Die Art einer Beschwerde.

articleNumber
articleNumber string

Der Bezeichner eines Artikels.

Menge
quantity integer

Die Menge des Artikels.

orderReference
orderReference True string

Verweisen auf eine Bestellung.

claimNumber
claimNumber string

Die Nummer oder der Bezeichner dieses Anspruchs.

createdByContactId
createdByContactId string

ID des Kontakts, der die Beschwerde erstellt hat.

ErstelltAm
createdAt string

Zeitstempel der Objekterstellung.

updatedByContactId
updatedByContactId string

ID des Kontakts, der die Beschwerde aktualisiert hat.

updatedAt
updatedAt string

Zeitstempel des neuesten Updates.

Aktualisieren einer Eigenschaft

Aktualisieren einer bestimmten Eigenschaft in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Eigenschaften-ID
propertyId True string

ID der Eigenschaft, auf die Sie zugreifen möchten.

info
info string

Allgemeine Informationen zur Eigenschaft.

Aktualisieren einer Einheit

Aktualisieren einer bestimmten Einheit in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Einheiten-ID
unitId True string

ID der Einheit, auf die Sie zugreifen möchten.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

Gibt zurück

response
string

Aktualisieren einer Featuregruppe

Aktualisieren sie eine bestimmte Featuregruppe in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

Gibt zurück

response
string

Aktualisieren einer integrierten Systemverbindung

Aktualisieren Sie eine bestimmte integrierte Systemverbindung eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Integrierte Systemverbindungs-ID
integratedSystemLinkId True string

ID des integrierten Systemlinks, auf den Sie zugreifen möchten.

integratedSystemName
integratedSystemName True string

Name des externen Systems.

integratedSystemId
integratedSystemId True string

ID der integrierten Ressource.

Gibt zurück

response
string

Aktualisieren einer Komponente

Aktualisieren einer bestimmten Komponente in Stammdaten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

articleCode
articleCode True string

Der eindeutige Artikelcode.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

eanCode
eanCode string

Die Nummer des europäischen Artikels.

gtinCode
gtinCode string

Die Nummer des globalen Handelsartikels.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

productGroup
productGroup string

Die Gruppe, zu der Ihre Komponente gehört.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zielfeatures, die mit einem integrierten System verknüpft sind.

featureCodes
featureCodes True array of string

Eine Reihe von Featurecodes. Zum Löschen vorhandener Links geben Sie eine leere Liste an.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zielunterkategorien, die mit einem integrierten System verknüpft sind.

mainCategoryCode
mainCategoryCode True string

Code der Hauptkategorie, aus der Unterkategorien mit der Komponente verknüpft werden.

subCategoryCodes
subCategoryCodes True array of string

Eine Sammlung von Unterkategoriecodes, die mit der Komponente verknüpft werden sollen.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zieleigenschaften, die mit einem integrierten System verknüpft sind.

Code
code True string

Der Eigenschaftencode, für den der neue Wert festgelegt werden soll.

value
value string

Der neue Wert der Eigenschaft, wenn sie kein Arraytyp ist.

arrayValues
arrayValues array of string

Die neue Auflistung von Werten der Eigenschaft, wenn es sich um einen Arraytyp handelt.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zieleinheiten, die mit einem integrierten System verknüpft sind.

unitCode
unitCode True string

Code der Einheit, die für diese Komponentenmenge verwendet werden soll.

minimum
minimum True number

Die Mindestmenge, die für diese Komponentenmenge verwendet werden soll.

Maximalwert
maximum number

Die optionale maximale Menge, die für diese Komponentenmenge verwendet werden soll.

Schritt
step True number

Der Schrittwert, der für jeden inkrementellen Schritt für diese Komponentenmenge verwendet werden soll.

enabled
enabled boolean

Aktivieren oder deaktivieren Sie die Anzeige der QuickInfo.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

Features (veraltet)
features array of string

(Veraltet) Eine Sammlung von Featurecodes.

Aktualisieren einer Komponenten-QuickInfo

Aktualisieren Sie eine bestimmte Komponenten-QuickInfo in Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

enabled
enabled boolean

Aktivieren oder deaktivieren Sie die Anzeige der QuickInfo.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

Gibt zurück

Aktualisieren einer Standardadresse eines Unternehmens

Aktualisieren Einer bestimmten Standardadresse eines Unternehmens.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

Standardadress-ID
defaultAddressId True string

ID der Standardadresse, auf die Sie zugreifen möchten.

companyName
companyName True string

Name des Standardzustellungs- oder Rechnungsunternehmens.

type
type True string

Der Standardadressentyp.

AdresseZeile1
addressLine1 True string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city True string

Die Stadt.

postalCode
postalCode True string

Die Postleitzahl.

countryIso
countryIso True string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

Ansprechpartner
contactPerson True string

Name eines Kontakts bei der Standardzustellung oder Rechnungsfirma.

KontaktTelefon
contactPhone True string

Telefonnummer eines Kontakts beim Standardzustell- oder Rechnungsunternehmen.

E-Mail
email True email

Wenden Sie sich an die E-Mail-Adresse des Standardzustell- oder Rechnungsunternehmens.

vatNumber
vatNumber string

Umsatzsteuernummer, die für das Standardrechnungsunternehmen verwendet werden soll.

canChangeAddress
canChangeAddress boolean

Zulassen, dass der Händler seine Standardzustellungs- und Rechnungsadressen ändern kann.

canChangeAddressOnPlaceOrder
canChangeAddressOnPlaceOrder boolean

Zulassen, dass der Händler seine Standardzustellungs- und Rechnungsadressen während des Bestellvorgangs ändern kann.

Aktualisieren eines benutzerdefinierten Objekts

Aktualisieren eines bestimmten benutzerdefinierten Objekts eines bestimmten Typs.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Benutzerdefinierter Objekttyp
customObjectType True string

Name des benutzerdefinierten Objekttyps, auf den Sie zugreifen möchten.

Benutzerdefinierte Objekt-ID
customObjectKey True string

ID des benutzerdefinierten Objekts, auf das Sie zugreifen möchten.

key
key True string

Ein eindeutiger Schlüssel, der verwendet wird, um einen Wert innerhalb eines einzelnen benutzerdefinierten Objekts zu identifizieren.

value
value

Eine textbezogene Darstellung des Werts, der für den Schlüssel gespeichert werden soll.

Datentyp
dataType string

Die Datentypen, die für benutzerdefinierte Objektwerte verwendet werden können.

Aktualisieren eines Features

Aktualisieren sie ein Feature in einer bestimmten Featuregruppe in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

Feature-ID
featureId True string

ID des Features, auf das Sie zugreifen möchten.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

serialSearchFunction
serialSearchFunction string

Eine JavaScript-Funktion, die die Sichtbarkeit im Produktspeicher bestimmt.

Aktualisieren eines Herstellerkontakts

Aktualisieren Sie einen bestimmten Kontakt eines Herstellers oder seiner Unternehmen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Kontakt-ID
contactId True string

ID des Kontakts, auf den Sie zugreifen möchten.

roleIds
roleIds True array of string

IDs aller Rollen, die dem Kontakt zugewiesen werden sollen.

Vorname
firstName string
lastName
lastName string
E-Mail
email email
phone
phone string
mobile
mobile string
preferredLanguage
preferredLanguage string

Die Standardsprache des Kontakts im ISO 639-1-Format.

functionTitle
functionTitle string
AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

Anrede
salutation string
externalSystemId
externalSystemId string

Eine ID, die verwendet wird, um den Kontakt in einem externen System zu identifizieren. Es wird in der Regel empfohlen, stattdessen eine Systemverbindung zu verwenden.

avatarUrl
avatarUrl string

Eine öffentlich zugängliche URL zu einem Bild, das als Avatar verwendet wird.

Aktualisieren eines Komponenten-QuickInfo-Bilds

Aktualisieren eines bestimmten Komponenten-QuickInfo-Images in Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Datei
file True file

Die hochzuladende Datei.

Aktualisieren eines Preiskatalogs

Aktualisieren Sie einen bestimmten Preiskatalog eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Preiskatalog-ID
priceCatalogId True string

ID des Katalogs, auf den Sie zugreifen möchten.

name
name True string

Eindeutiger Name für den Preiskatalog.

defaultPriceCatalog
defaultPriceCatalog boolean

Legen Sie den Preiskatalog als Standard fest.

Aktualisieren eines Projektsegmentelements

Aktualisieren Sie ein bestimmtes Projektsegmentelement eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegmentelement-ID
projectSegmentItemId True string

ID des Projektsegmentelements, auf das Sie zugreifen möchten.

name
name string

Ein Name für die Konfiguration.

Menge
quantity True integer

Die Menge des Artikels.

externalSerialNumbers
externalSerialNumbers array of string

Optionale Bezeichner, mit denen die Konfiguration in externen Systemen identifiziert werden kann.

Aktualisieren eines Projektsegments

Aktualisieren Sie ein bestimmtes Projektsegment eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

orderRemark
orderRemark string

Hinweis auf die Bestellung.

orderRemarkFromManufacturer
orderRemarkFromManufacturer string

Bemerkung des Herstellers auf der Bestellung.

shippingDateRequested
shippingDateRequested date-time

Das angeforderte Datum im ISO-8601-Format.

shippingDateConfirmed
shippingDateConfirmed date-time

Das bestätigte Datum im ISO-8601-Format.

customerPoRef
customerPoRef string

Bestellreferenz.

manufacturerSoRef
manufacturerSoRef string

Verkaufsauftragsreferenz.

manufacturerReference
manufacturerReference string

Referenz für den Hersteller.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

vatCondition
vatCondition string

Der MwSt-Bedingungscode. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryCondition
deliveryCondition string

Der Code für die Übermittlungsbedingung. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentCondition
paymentCondition string

Der Zahlungsbedingungscode. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

orderSenderContactId
orderSenderContactId string

Kontakt-ID des Absenders.

orderReceiverContactId
orderReceiverContactId string

Kontakt-ID des Empfängers.

companyASalesManagerId
companyASalesManagerId string

Kontakt-ID des Vertriebsleiters des Herstellers.

companyBSalesManagerId
companyBSalesManagerId string

Kontakt-ID des Vertriebsleiters des Vertriebshändlers.

status
status string

Status des Segments. Standardmäßig wird ausgeführt, wenn sich das Projekt noch in Schritt 0 des Auftragsvorgangs befindet.

nextFollowUpDate
nextFollowUpDate date-time

Das nächste Nachverfolgungsdatum.

estimatedSalesDate
estimatedSalesDate date-time

Das geschätzte Verkaufsdatum.

freeTextNote
freeTextNote string

Eine kostenlose Notiz im Segment.

saleProbability
saleProbability integer

Die Verkaufswahrscheinlichkeit

status
status string

Ein externer Status der Bestellung.

statusUrl
statusUrl string

Benutzer einer URL können verwenden, um den Status der externen Bestellung zu überprüfen oder Versandinformationen zu ihrer Bestellung anzuzeigen.

statusText
statusText string

Benutzerdefinierter Text, der für die Versandinformationen angezeigt werden soll.

orderGroup
orderGroup string

Die Bestellgruppe.

Gibt zurück

response
string

Aktualisieren eines Unternehmens

Aktualisieren Sie ein bestimmtes Unternehmen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

name
name True string

Name des Unternehmens.

Beschreibung
description string

Weitere Informationen zum Unternehmen.

vatNumber
vatNumber string

Umsatzsteuernummer des Unternehmens.

E-Mail
email email

E-Mail-Adresse des Unternehmens.

Telefon
telephone string

Telefonnummer des Unternehmens.

Webseiten-URL
websiteUrl string

URL zur Website des Unternehmens.

preferredLanguage
preferredLanguage string

Die Standardsprache für das Unternehmen im ISO 639-1-Format.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

externalSystemId1
externalSystemId1 string

Eine ID, die verwendet wird, um das Unternehmen in einem externen System zu identifizieren. Es wird in der Regel empfohlen, stattdessen eine Systemverbindung zu verwenden.

externalSystemId2
externalSystemId2 string

Eine ID, die verwendet wird, um das Unternehmen in einem externen System zu identifizieren. Es wird in der Regel empfohlen, stattdessen eine Systemverbindung zu verwenden.

salesRepresentativeContactId
salesRepresentativeContactId string

ID eines Kontakts, der als Vertriebsmitarbeiter fungiert.

techSupportManagerContactId
techSupportManagerContactId string

ID eines Kontakts, der als technischer Supportmanager fungiert.

orderProcessingManagerContactId
orderProcessingManagerContactId string

ID eines Kontakts, der als Auftragsverarbeitungsmanager fungiert.

shippingManagerContactId
shippingManagerContactId string

ID eines Kontakts, der als Versandsupportmanager fungiert.

companyGroups
companyGroups array of string

Liste der Unternehmensgruppen.

vatConditionCode
vatConditionCode string

Der Standard-MwSt-Bedingungscode für Projekte dieses Unternehmens. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryConditionCode
deliveryConditionCode string

Der Standardzustellbedingungscode für Projekte dieses Unternehmens. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentConditionCode
paymentConditionCode string

Der Standardzahlungsbedingungscode für Projekte dieses Unternehmens. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

baseDiscount
baseDiscount float

Der Standardrabatt für Konfigurationen in Projekten dieses Unternehmens.

orderCurrency
orderCurrency string

Standardauftragswährung des Unternehmens.

Honorar
fee float

Die Gebühr wird angewendet, wenn ein Projekt für dieses Unternehmen die Gebührenschwelle nicht erreicht.

threshold
threshold float

Der Mindestpreis, unter dem eine Gebühr erhoben wird.

enabled
enabled boolean

Zulassen, dass dieses Unternehmen auf den Produktspeicher zugreifen kann

priceCatalogId
priceCatalogId string

ID des für dieses Unternehmen verwendeten Preiskatalogs.

storeDiscountPercentage
storeDiscountPercentage float

Der Rabattprozentsatz, der auf Artikel im Produktspeicher in einem Projekt dieses Unternehmens angewendet wird.

defaultVatConditionCode
defaultVatConditionCode string

Der Standard-MwSt-Bedingungscode für Projekte für dieses Unternehmen. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

defaultPaymentConditionCode
defaultPaymentConditionCode string

Der Standardzahlungsbedingungscode für Projekte für dieses Unternehmen. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

salesPricingStrategy
salesPricingStrategy string

Die Standardpreisstrategie für Projekte für dieses Unternehmen.

orderEmails
orderEmails array of email

E-Mail-Adresse, die zum Versenden von Bestell-E-Mails an Unterhändler verwendet wird.

Aktualisieren eines Vertriebskontakts

Aktualisieren Sie einen bestimmten Kontakt im Adressbuch eines Händlers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Verteiler-ID
distributorId True string

ID des Distributors, auf den Sie zugreifen möchten.

Kontakt-ID
contactId True string

ID des Kontakts, auf den Sie zugreifen möchten.

Vorname
firstName True string

Vorname des Kontakts.

lastName
lastName True string

Nachname des Kontakts.

E-Mail
email True string

E-Mail-Adresse des Kontakts.

Anrede
salutation string

Anrede des Kontakts.

Funktion
function string

Position des Kontakts.

phone
phone string

Telefonnummer des Kontakts.

mobile
mobile string

Mobiltelefonnummer des Kontakts

preferredLanguageIso
preferredLanguageIso string

Standardsprache des Kontakts im ISO 639-1-Format.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

vatNumber
vatNumber string

Umsatzsteuernummer für den Kontakt.

vatCondition
vatCondition string

Der Standard-MwSt-Bedingungscode für diesen Kontakt. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryCondition
deliveryCondition string

Der Standardmäßige Lieferbedingungscode für diesen Kontakt. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentCondition
paymentCondition string

Der Standardcode für die Zahlungsbedingung für diesen Kontakt. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

Aktualisieren eines Webhook-Triggers

Aktualisieren eines bestimmten Triggers eines Webhooks.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Webhook-Trigger-ID
webhookTriggerId True string

ID des Webhook-Triggers, auf den Sie zugreifen möchten.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

confirmationRequired
confirmationRequired boolean

Aktivieren oder deaktivieren Sie den Bestätigungs modal, wenn ein Benutzer einen Webhook-Trigger aktiviert.

openInSameTab
openInSameTab boolean

Aktivieren Sie das Öffnen der URL auf derselben Browserregisterkarte, wenn Sie den typ "OPEN_URL" verwenden.

location
location True string

Der Speicherort des Webhook-Triggers in der Benutzeroberfläche von HiveCPQ.

type
type True string

Der Typ des Webhook-Triggers.

permissionIds
permissionIds array of string

Eine Sammlung von Berechtigungs-IDs, die Zugriff auf den Trigger haben.

Aktualisieren eines Webhooks

Aktualisieren sie einen Webhook eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

URL
url True string

Die Rückruf-URL des Webhooks.

Beschreibung
description string

Weitere Informationen zum Webhook.

Anfordern eines Herstellerkontakts

Erhalten Sie einen bestimmten Kontakt eines Herstellers oder seiner Unternehmen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Kontakt-ID
contactId True string

ID des Kontakts, auf den Sie zugreifen möchten.

Gibt zurück

Anlagen der Suchkomponente

Durchsuchen von Anlagen einer Komponente in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Ist ein Bild
isImage boolean

Filtern Sie nach, ob es sich bei der Datei um ein Bild handelt.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Anlagen für Die Suche nach Beschwerden

Durchsuchen von Anlagen einer bestimmten Beschwerde.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

Gibt zurück

Archiv eines Kontakts

Archiviert einen bestimmten Kontakt und entfernt seine Einladungen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Kontakt-ID
contactId True string

ID des Kontakts, auf den Sie zugreifen möchten.

Archiv eines Projektsegments

Archiv a specific project segment of a manufacturer.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Archiv eines Unternehmens

Archivieren Sie ein Unternehmen zusammen mit allen ihren Kontakten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

Aufheben der Archivierung eines Kontakts

Heben Sie die Archivierung eines bestimmten Kontakts auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Kontakt-ID
contactId True string

ID des Kontakts, auf den Sie zugreifen möchten.

Aufheben der Archivierung eines Projektsegments

Heben Sie die Archivierung eines bestimmten Projektsegments eines Herstellers auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Aufheben der Archivierung eines Unternehmens

Heben Sie die Archivierung eines Unternehmens auf, ohne die Archivierung der Kontakte aufzuheben.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

Aufheben der Verknüpfung eines Features aus einer Komponente

Hebt die Verknüpfung eines Features aus einer bestimmten Komponente in Masterdaten auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Feature-ID
featureId True string

ID des Features, auf das Sie zugreifen möchten.

Beanstandungsanlage abrufen

Erhalten Sie eine Anlage einer bestimmten Beschwerde.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

Anlagen-ID
attachmentId True string

ID der Anlage, auf die Sie zugreifen möchten.

Benutzerdefinierte Objekte durchsuchen

Durchsuchen benutzerdefinierter Objekte eines bestimmten Typs.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Benutzerdefinierter Objekttyp
customObjectType True string

Name des benutzerdefinierten Objekttyps, auf den Sie zugreifen möchten.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Benutzerdefinierte Objekttypen durchsuchen

Suchen Sie benutzerdefinierte Objekttypen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Bestellungsprozess eines Projektsegments abbrechen

Abbrechen des Auftragsvorgangs und Verschieben eines Projektsegments zurück in Schritt 2.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Cache für benutzerdefinierte Objekte zurücksetzen

Konfiguratoren können beim Behandeln von benutzerdefinierten Objekten Zwischenspeicherung verwenden. Durch Aufrufen dieses Endpunkts werden diese Caches zurückgesetzt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containerversionen durchsuchen

Suchen Sie Containerversionen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Containerversionsstatus
status string

Filtern Sie nach dem Status der Containerversionen.

Containerversionstyp
type string

Filtern Sie nach dem Typ der Containerversionen.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Durchsuchen von Anlagen eines Projektsegments

Durchsuchen von Anlagen eines bestimmten Projektsegments

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Ist eine Verteilerdatei
isDistributorFile boolean

Filtern Sie nach, ob die Datei im Besitz des Herstellers oder Händlers ist.

Gibt zurück

Durchsuchen von Standardadressen eines Unternehmens

Durchsuchen Sie die Standardrechnungs- und Lieferadressen eines Unternehmens.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

Gibt zurück

Eigenschaftenwerte der Suchkomponente

Sucheigenschaftenwerte einer Komponente in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Einladungs-E-Mail senden

Senden Sie eine Einladungs-E-Mail mithilfe des HiveCPQ-E-Mail-Systems.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Einladungs-ID
inviteId True string

ID der Einladung, auf die Sie zugreifen möchten.

invitationText
invitationText True string

Text, der in der Einladungs-E-Mail angezeigt wird.

toEmail
toEmail True email

Die E-Mail-Adresse, an die die Einladung gesendet werden soll.

Gibt zurück

response
string

Entfernt den Anhang aus einer Beschwerde.

Entfernt den Anhang aus einer Beschwerde.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

Anlagen-ID
attachmentId True string

ID der Anlage, auf die Sie zugreifen möchten.

Ersetzen von Beschwerdekommentaren

Ersetzen Sie alle Kommentare einer bestimmten Beschwerde.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

Kommentar
comment True string

Der Kommentar eines Benutzers.

createdByContactId
createdByContactId string

ID des Kontakts, der den Kommentar erstellt hat.

ErstelltAm
createdAt string

Zeitstempel der Objekterstellung.

updatedByContactId
updatedByContactId string

ID des Kontakts, der den Kommentar aktualisiert hat.

updatedAt
updatedAt string

Zeitstempel des neuesten Updates.

Festlegen des Eigenschaftswerts der Komponente

Legen Sie einen einzelnen Eigenschaftswert für eine Komponente in Masterdaten fest.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Code
code True string

Der Eigenschaftencode, für den der neue Wert festgelegt werden soll.

value
value string

Der neue Wert der Eigenschaft, wenn sie kein Arraytyp ist.

arrayValues
arrayValues array of string

Die neue Auflistung von Werten der Eigenschaft, wenn es sich um einen Arraytyp handelt.

Festlegen von Komponenteneigenschaftswerten

Legen Sie mehrere Eigenschaftswerte für eine Komponente in Masterdaten fest. Vorhandene Werte werden überschrieben oder gelöscht.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zieleigenschaften, die mit einem integrierten System verknüpft sind.

Code
code True string

Der Eigenschaftencode, für den der neue Wert festgelegt werden soll.

value
value string

Der neue Wert der Eigenschaft, wenn sie kein Arraytyp ist.

arrayValues
arrayValues array of string

Die neue Auflistung von Werten der Eigenschaft, wenn es sich um einen Arraytyp handelt.

Festlegen von Komponentenmengen

Legen Sie Mengen für eine Komponente in Stammdaten fest. Bestehende Mengen werden überschrieben oder gelöscht.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zieleinheiten, die mit einem integrierten System verknüpft sind.

unitCode
unitCode True string

Code der Einheit, die für diese Komponentenmenge verwendet werden soll.

minimum
minimum True number

Die Mindestmenge, die für diese Komponentenmenge verwendet werden soll.

Maximalwert
maximum number

Die optionale maximale Menge, die für diese Komponentenmenge verwendet werden soll.

Schritt
step True number

Der Schrittwert, der für jeden inkrementellen Schritt für diese Komponentenmenge verwendet werden soll.

Generieren eines PDF-Dokuments für ein Projekt

Generieren Sie ein PDF-Dokument für ein bestimmtes Projekt. Die Vorlagen-ID ist nur optional, wenn der Dokumenttyp QUOTE ist und eine Standardvorlage konfiguriert wurde.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektkennung
projectId True string

ID des Projekts, auf das Sie zugreifen möchten.

type
type string

Typ der Ausgabedokumentvorlage.

outputDocumentTemplateId
outputDocumentTemplateId string

ID einer Ausgabedokumentvorlage.

language
language True string

Der ISO 639-1-Sprachcode, in dem das Dokument generiert werden soll.

Generieren eines Wortdokuments für ein Projekt

Generieren Sie ein Microsoft Word-Dokument für ein bestimmtes Projekt. Die Vorlagen-ID ist nur optional, wenn der Dokumenttyp QUOTE ist und eine Standardvorlage konfiguriert wurde.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektkennung
projectId True string

ID des Projekts, auf das Sie zugreifen möchten.

type
type string

Typ der Ausgabedokumentvorlage.

outputDocumentTemplateId
outputDocumentTemplateId string

ID einer Ausgabedokumentvorlage.

language
language True string

Der ISO 639-1-Sprachcode, in dem das Dokument generiert werden soll.

Herstellerkontakt hinzufügen

Fügen Sie einem Unternehmen eines Herstellers oder seiner Unternehmen einen neuen Kontakt hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

companyId
companyId True string

ID des Unternehmens, in dem der Kontakt erstellt werden soll.

roleIds
roleIds True array of string

IDs aller Rollen, die dem Kontakt zugewiesen werden sollen.

Vorname
firstName string
lastName
lastName string
E-Mail
email email
phone
phone string
mobile
mobile string
preferredLanguage
preferredLanguage string

Die Standardsprache des Kontakts im ISO 639-1-Format.

functionTitle
functionTitle string
AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

Anrede
salutation string
externalSystemId
externalSystemId string

Eine ID, die den Kontakt in einem externen System identifizieren kann. Es wird in der Regel empfohlen, stattdessen eine Systemverbindung zu verwenden.

avatarUrl
avatarUrl string

Eine öffentlich zugängliche URL zu einem Bild, das als Avatar verwendet wird.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen einer Anlage zu einem Projektsegment

Fügen Sie einem bestimmten Projektsegment eine Anlage hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Datei
file True file

Die hochzuladende Datei.

Ist eine Verteilerdatei
isDistributorFile boolean

Geben Sie an, ob die hochgeladene Datei im Besitz des Händlers oder Herstellers ist.

Hinzufügen einer Beschwerde

Fügen Sie eine neue Beschwerde für einen Hersteller hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

title
title True string

Der Titel der Beschwerde.

Beschreibung
description True string

Die Beschreibung der Beschwerde.

companyId
companyId True string

Die ID des Unternehmens, das die Beschwerde geöffnet hat.

articleNumber
articleNumber string

Der Bezeichner eines Artikels.

Menge
quantity integer

Die Menge des Artikels.

type
type True string

Die Art einer Beschwerde.

status
status string

Der Status einer Beschwerde.

orderReference
orderReference True string

Verweisen auf eine Bestellung.

claimNumber
claimNumber True string

Die Nummer oder der Bezeichner dieses Anspruchs.

createdByContactId
createdByContactId string

ID des Kontakts, der die Beschwerde erstellt hat.

ErstelltAm
createdAt string

Zeitstempel der Objekterstellung.

updatedByContactId
updatedByContactId string

ID des Kontakts, der die Beschwerde aktualisiert hat.

updatedAt
updatedAt string

Zeitstempel des neuesten Updates.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen einer Beschwerdeanlage

Fügen Sie einer bestimmten Beschwerde eine neue Anlage hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

Datei
file True file

Die hochzuladende Datei.

Hinzufügen einer eigenständigen Konfiguration

Erstellen einer eigenständigen Konfiguration durch Starten einer Konfigurationsüberprüfung für einen V2-Konfigurator

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

konfiguratorId
configuratorId True string

ID eines V2-Konfigurators

versionId
versionId string

ID der Containerversion, zu der die Stammdaten in der Konfiguration gehören.

uniqueLabel
uniqueLabel string

Der eindeutige Bezeichner des Knotens.

value
value string

Die Textdarstellung des Knotenwerts.

Menge
quantity number

Die Anzahl der elemente, die durch diesen Knoten dargestellt werden, um den Gesamtknotenpreis zu berechnen.

optional
optional boolean

Markieren Sie den Knoten als optional.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen einer Einheit

Fügen Sie eine neue Einheit zu Stammdaten hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Code
code True string

Der eindeutige Code der Einheit.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen einer Einladung

Fügen Sie eine Einladung für einen Kontakt hinzu, um einem Unternehmen beizutreten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

contactId
contactId string

ID des Kontakts.

integratedSystemName
integratedSystemName string

Name eines externen Systems, in dem der Kontakt bekannt ist. Dies muss zusammen mit integratedSystemId verwendet werden.

integratedSystemId
integratedSystemId string

ID des Kontakts im externen System. Dies muss zusammen mit integratedSystemName verwendet werden.

contactId
contactId string

ID des Kontakts.

integratedSystemName
integratedSystemName string

Name eines externen Systems, in dem der Kontakt bekannt ist. Dies muss zusammen mit integratedSystemId verwendet werden.

integratedSystemId
integratedSystemId string

ID des Kontakts im externen System. Dies muss zusammen mit integratedSystemName verwendet werden.

Aktivieren von SSO
enableSSO boolean

Aktivieren Sie single-Sign-On für diesen Kontakt.

Hinzufügen einer Komponente

Fügen Sie eine Komponente zu Stammdaten hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

articleCode
articleCode True string

Der eindeutige Artikelcode.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

eanCode
eanCode string

Die Nummer des europäischen Artikels.

gtinCode
gtinCode string

Die Nummer des globalen Handelsartikels.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

productGroup
productGroup string

Die Gruppe, zu der Ihre Komponente gehört.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zielfeatures, die mit einem integrierten System verknüpft sind.

featureCodes
featureCodes True array of string

Eine Reihe von Featurecodes. Zum Löschen vorhandener Links geben Sie eine leere Liste an.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zielunterkategorien, die mit einem integrierten System verknüpft sind.

mainCategoryCode
mainCategoryCode True string

Code der Hauptkategorie, aus der Unterkategorien mit der Komponente verknüpft werden.

subCategoryCodes
subCategoryCodes True array of string

Eine Sammlung von Unterkategoriecodes, die mit der Komponente verknüpft werden sollen.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zieleigenschaften, die mit einem integrierten System verknüpft sind.

Code
code True string

Der Eigenschaftencode, für den der neue Wert festgelegt werden soll.

value
value string

Der neue Wert der Eigenschaft, wenn sie kein Arraytyp ist.

arrayValues
arrayValues array of string

Die neue Auflistung von Werten der Eigenschaft, wenn es sich um einen Arraytyp handelt.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zieleinheiten, die mit einem integrierten System verknüpft sind.

unitCode
unitCode True string

Code der Einheit, die für diese Komponentenmenge verwendet werden soll.

minimum
minimum True number

Die Mindestmenge, die für diese Komponentenmenge verwendet werden soll.

Maximalwert
maximum number

Die optionale maximale Menge, die für diese Komponentenmenge verwendet werden soll.

Schritt
step True number

Der Schrittwert, der für jeden inkrementellen Schritt für diese Komponentenmenge verwendet werden soll.

enabled
enabled boolean

Aktivieren oder deaktivieren Sie die Anzeige der QuickInfo.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

Features (veraltet)
features array of string

(Veraltet) Eine Sammlung von Featurecodes.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen einer Komponentenanlage

Fügen Sie einer Komponente in Stammdaten eine neue Anlage hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Datei
file True file

Die hochzuladende Datei.

Ist ein Bild
isImage boolean

Geben Sie an, ob es sich bei der hochgeladenen Datei um ein Bild oder eine Informationsdatei handelt.

Hinzufügen einer Konfiguration zu einem Projekt

Fügen Sie einem Projekt eine neue V2-Konfiguration hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektkennung
projectId True string

ID des Projekts, auf das Sie zugreifen möchten.

Menge
quantity integer

Die Menge dieser Konfiguration, die hinzugefügt werden soll.

konfiguratorId
configuratorId True string

ID eines V2-Konfigurators.

name
name string

Name der Konfiguration.

configurationCode
configurationCode string

Eindeutiger Code aus einer anderen Konfiguration, aus der eine neue Konfiguration erstellt wird.

uniqueLabel
uniqueLabel string

Der eindeutige Bezeichner des Knotens.

value
value string

Die Textdarstellung des Knotenwerts.

Menge
quantity number

Die Anzahl der elemente, die durch diesen Knoten dargestellt werden, um den Gesamtknotenpreis zu berechnen.

optional
optional boolean

Markieren Sie den Knoten als optional.

containerName
containerName string

Wählen Sie optional einen Container aus, aus dem der Konfigurator verwendet werden soll.

Ausgabe
version string

Wählen Sie optional eine Version aus, aus der der Konfigurator verwendet werden soll. Dies ist die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen einer Konfiguration zu einem Projektsegment

Hinzufügen einer V1-Konfiguration zu einem bestimmten Projektsegment.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

konfiguratorId
configuratorId True string

ID eines V1-Konfigurators.

initialValues
initialValues object

Die Eingabewerte, die zum Initialisieren der Konfiguration verwendet werden.

Menge
quantity integer

Die Menge des Artikels.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen einer neuen Eigenschaft

Hinzufügen einer neuen Eigenschaft zu Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Code
code True string

Eindeutiger Code für die Eigenschaft.

type
type True string

Typ der Eigenschaft.

arrayType
arrayType string

Typ der Arrayeigenschaft.

info
info string

Allgemeine Informationen zur Eigenschaft.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen einer neuen Standardadresse

Fügen Sie einer Firma eine neue Standardadresse hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

companyName
companyName True string

Name des Standardzustellungs- oder Rechnungsunternehmens.

type
type True string

Der Standardadressentyp.

AdresseZeile1
addressLine1 True string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city True string

Die Stadt.

postalCode
postalCode True string

Die Postleitzahl.

countryIso
countryIso True string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

Ansprechpartner
contactPerson True string

Name eines Kontakts bei der Standardzustellung oder Rechnungsfirma.

KontaktTelefon
contactPhone True string

Telefonnummer eines Kontakts beim Standardzustell- oder Rechnungsunternehmen.

E-Mail
email True email

Wenden Sie sich an die E-Mail-Adresse des Standardzustell- oder Rechnungsunternehmens.

vatNumber
vatNumber string

Umsatzsteuernummer, die für das Standardrechnungsunternehmen verwendet werden soll.

canChangeAddress
canChangeAddress boolean

Zulassen, dass der Händler seine Standardzustellungs- und Rechnungsadressen ändern kann.

canChangeAddressOnPlaceOrder
canChangeAddressOnPlaceOrder boolean

Zulassen, dass der Händler seine Standardzustellungs- und Rechnungsadressen während des Bestellvorgangs ändern kann.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen eines benutzerdefinierten Objekts

Fügen Sie ein neues benutzerdefiniertes Objekt eines bestimmten Typs hinzu. Dieser Typ wird erstellt, wenn er nicht vorhanden ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Benutzerdefinierter Objekttyp
customObjectType True string

Name des benutzerdefinierten Objekttyps, auf den Sie zugreifen möchten.

key
key True string

Ein eindeutiger Schlüssel, der verwendet wird, um einen Wert innerhalb eines einzelnen benutzerdefinierten Objekts zu identifizieren.

value
value

Eine textbezogene Darstellung des Werts, der für den Schlüssel gespeichert werden soll.

Datentyp
dataType string

Die Datentypen, die für benutzerdefinierte Objektwerte verwendet werden können.

Hinzufügen eines Beschwerdekommentars

Fügen Sie einen neuen Kommentar zu einer bestimmten Beschwerde hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

Kommentar
comment True string

Der Kommentar eines Benutzers.

createdByContactId
createdByContactId string

ID des Kontakts, der den Kommentar erstellt hat.

ErstelltAm
createdAt string

Zeitstempel der Objekterstellung.

updatedByContactId
updatedByContactId string

ID des Kontakts, der den Kommentar aktualisiert hat.

updatedAt
updatedAt string

Zeitstempel des neuesten Updates.

Hinzufügen eines Features zu einer Featuregruppe

Fügen Sie einer bestimmten Featuregruppe in Masterdaten ein neues Feature hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

Code
code True string

Eindeutiger Code für das Feature.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

serialSearchFunction
serialSearchFunction string

Eine JavaScript-Funktion, die die Sichtbarkeit im Produktspeicher bestimmt.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Fügen Sie eine neue integrierte Systemverknüpfung für eine Ressource hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

integratedSystemName
integratedSystemName True string

Name des externen Systems.

integratedSystemId
integratedSystemId True string

ID der integrierten Ressource.

resourceType
resourceType True string

Die Arten von Ressourcen, für die integrierte Systemverbindungen erstellt werden können.

hiveId
hiveId True string

ID der HiveCPQ-Ressource.

Gibt zurück

Name Pfad Typ Beschreibung
integratedSystemName
integratedSystemName string

integratedSystemName

integratedSystemId
integratedSystemId string

integratedSystemId

resourceType
resourceType enumSystemLinkResourceType

Die Arten von Ressourcen, für die integrierte Systemverbindungen erstellt werden können.

hiveId
hiveId string

hiveId

Hinzufügen eines Komponentenpreises

Fügen Sie einer Komponente in Stammdaten einen neuen Preis hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

costPrice
costPrice float

Kostenpreis der Komponente.

listPrice
listPrice True float

Listenpreis der Komponente.

PurchasePrice
purchasePrice float

Kaufpreis der Komponente.

subDistributorPurchasePrice
subDistributorPurchasePrice float

Unterverteiler-Kaufpreis der Komponente.

priceCatalogId
priceCatalogId True string

Preiskatalog-ID, zu der dieser Preis gehört.

Währung
currency True string

Die Währung im ISO 4217-Format.

unitId
unitId True string

ID der Einheit, die mit dem Preis verwendet werden soll.

Hinzufügen eines neuen Unternehmens

Fügen Sie einem Hersteller ein neues Unternehmen hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

name
name True string

Name des Unternehmens.

Beschreibung
description string

Weitere Informationen zum Unternehmen.

vatNumber
vatNumber string

Umsatzsteuernummer des Unternehmens.

E-Mail
email email

E-Mail-Adresse des Unternehmens.

Telefon
telephone string

Telefonnummer des Unternehmens.

Webseiten-URL
websiteUrl string

URL zur Website des Unternehmens.

preferredLanguage
preferredLanguage string

Die Standardsprache für das Unternehmen im ISO 639-1-Format.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

externalSystemId1
externalSystemId1 string

Eine ID, die verwendet wird, um das Unternehmen in einem externen System zu identifizieren. Es wird in der Regel empfohlen, stattdessen eine Systemverbindung zu verwenden.

externalSystemId2
externalSystemId2 string

Eine ID, die verwendet wird, um das Unternehmen in einem externen System zu identifizieren. Es wird in der Regel empfohlen, stattdessen eine Systemverbindung zu verwenden.

salesRepresentativeContactId
salesRepresentativeContactId string

ID eines Kontakts, der als Vertriebsmitarbeiter fungiert.

techSupportManagerContactId
techSupportManagerContactId string

ID eines Kontakts, der als technischer Supportmanager fungiert.

orderProcessingManagerContactId
orderProcessingManagerContactId string

ID eines Kontakts, der als Auftragsverarbeitungsmanager fungiert.

shippingManagerContactId
shippingManagerContactId string

ID eines Kontakts, der als Versandsupportmanager fungiert.

companyGroups
companyGroups array of string

Liste der Unternehmensgruppen.

vatConditionCode
vatConditionCode string

Der Standard-MwSt-Bedingungscode für Projekte dieses Unternehmens. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryConditionCode
deliveryConditionCode string

Der Standardzustellbedingungscode für Projekte dieses Unternehmens. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentConditionCode
paymentConditionCode string

Der Standardzahlungsbedingungscode für Projekte dieses Unternehmens. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

baseDiscount
baseDiscount float

Der Standardrabatt für Konfigurationen in Projekten dieses Unternehmens.

orderCurrency
orderCurrency string

Standardauftragswährung des Unternehmens.

Honorar
fee float

Die Gebühr wird angewendet, wenn ein Projekt für dieses Unternehmen die Gebührenschwelle nicht erreicht.

threshold
threshold float

Der Mindestpreis, unter dem eine Gebühr erhoben wird.

enabled
enabled boolean

Zulassen, dass dieses Unternehmen auf den Produktspeicher zugreifen kann

priceCatalogId
priceCatalogId string

ID des für dieses Unternehmen verwendeten Preiskatalogs.

storeDiscountPercentage
storeDiscountPercentage float

Der Rabattprozentsatz, der auf Artikel im Produktspeicher in einem Projekt dieses Unternehmens angewendet wird.

defaultVatConditionCode
defaultVatConditionCode string

Der Standard-MwSt-Bedingungscode für Projekte für dieses Unternehmen. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

defaultPaymentConditionCode
defaultPaymentConditionCode string

Der Standardzahlungsbedingungscode für Projekte für dieses Unternehmen. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

salesPricingStrategy
salesPricingStrategy string

Die Standardpreisstrategie für Projekte für dieses Unternehmen.

distributorId
distributorId True string

ID des Vertriebsunternehmens, mit dem dieser Unterhändler verknüpft wird.

orderEmails
orderEmails array of email

Alle Unterverteiler-E-Mails, die Bestell-E-Mails erhalten.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen eines Preiskatalogs

Fügen Sie einen Preiskatalog für einen Hersteller hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

name
name True string

Eindeutiger Name für den Preiskatalog.

defaultPriceCatalog
defaultPriceCatalog boolean

Legen Sie den Preiskatalog als Standard fest.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen eines Projekts

Fügen Sie ein neues Projekt für ein Unternehmen hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

companyId
companyId True string

ID des Distributors, zu dem das Projekt gehört.

name
name string

Name des Projekts.

sellToCustomerReference
sellToCustomerReference string

Ein Verweis für den Endkunden.

accountId
accountId string

ID eines Kontos im Adressbuch.

contactId
contactId string

ID eines Kontakts im angegebenen Konto.

accountId
accountId string

ID eines Kontos im Adressbuch.

contactId
contactId string

ID eines Kontakts im angegebenen Konto.

accountId
accountId string

ID eines Kontos im Adressbuch.

contactId
contactId string

ID eines Kontakts im angegebenen Konto.

accountId
accountId string

ID eines Kontos im Adressbuch.

contactId
contactId string

ID eines Kontakts im angegebenen Konto.

taxCondition
taxCondition string

Der MwSt-Bedingungscode des Projekts. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryCondition
deliveryCondition string

Der Lieferbedingungscode des Projekts. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentCondition
paymentCondition string

Der Zahlungsbedingungscode des Projekts. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen eines Verteilerkontos

Fügen Sie dem Adressbuch eines Händlers ein Konto hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Verteiler-ID
distributorId True string

ID des Distributors, auf den Sie zugreifen möchten.

name
name string

Der Firmenname.

Beschreibung
description string

Weitere Informationen zum Unternehmen.

vatNumber
vatNumber string

Umsatzsteuernummer des Unternehmens.

phone
phone string

Telefonnummer des Unternehmens.

E-Mail
email string

E-Mail-Adresse des Unternehmens.

Webseiten-URL
websiteUrl string

URL zur Website des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen eines Vertriebskontakts

Fügen Sie dem Adressbuch eines Händlers einen neuen Kontakt hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Verteiler-ID
distributorId True string

ID des Distributors, auf den Sie zugreifen möchten.

Vorname
firstName True string

Vorname des Kontakts.

lastName
lastName True string

Nachname des Kontakts.

E-Mail
email True string

E-Mail-Adresse des Kontakts.

Anrede
salutation string

Anrede des Kontakts.

Funktion
function string

Position des Kontakts.

phone
phone string

Telefonnummer des Kontakts.

mobile
mobile string

Mobiltelefonnummer des Kontakts

preferredLanguageIso
preferredLanguageIso string

Standardsprache des Kontakts im ISO 639-1-Format.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

vatNumber
vatNumber string

Umsatzsteuernummer für den Kontakt.

vatCondition
vatCondition string

Der Standard-MwSt-Bedingungscode für diesen Kontakt. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryCondition
deliveryCondition string

Der Standardmäßige Lieferbedingungscode für diesen Kontakt. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentCondition
paymentCondition string

Der Standardcode für die Zahlungsbedingung für diesen Kontakt. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

accountId
accountId string

ID des Vertriebskontos, dem der Kontakt hinzugefügt werden soll.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Hinzufügen eines Webhook-Triggers

Fügen Sie einen neuen Trigger zu einem bestimmten Webhook hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Code
code True string

Ein eindeutiger Code für den Trigger.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

confirmationRequired
confirmationRequired boolean

Aktivieren oder deaktivieren Sie den Bestätigungs modal, wenn ein Benutzer einen Webhook-Trigger aktiviert.

openInSameTab
openInSameTab boolean

Aktivieren Sie das Öffnen der URL auf derselben Browserregisterkarte, wenn Sie den typ "OPEN_URL" verwenden.

location
location True string

Der Speicherort des Webhook-Triggers in der Benutzeroberfläche von HiveCPQ.

type
type True string

Der Typ des Webhook-Triggers.

permissionIds
permissionIds array of string

Eine Sammlung von Berechtigungs-IDs, die Zugriff auf den Trigger haben.

Hinzufügen eines Webhooks

Fügen Sie einen neuen Webhook für einen Hersteller hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Code
code True string

Ein eindeutiger Code für den Webhook.

URL
url True string

Die Rückruf-URL des Webhooks.

Beschreibung
description string

Weitere Informationen zum Webhook.

eventSubscriptions
eventSubscriptions string

Die Ereignisse, für die ein Webhook abonniert werden kann.

Hinzufügen von Produkten zu einem Projekt

Fügen Sie einem Projekt eines Herstellers mindestens ein Produkt hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektkennung
projectId True string

ID des Projekts, auf das Sie zugreifen möchten.

articleCode
articleCode True string

Der Artikelcode des Produkts, das hinzugefügt werden soll.

Menge
quantity True integer

Die Menge dieses Produkts, die hinzugefügt werden soll.

serialNumber
serialNumber string

Eine Seriennummer, um das Produkt in externen Systemen zu identifizieren.

serialMatched
serialMatched boolean

Stimmen Sie bei Verwendung von Produkthistorien die Seriennummer mit dem Produkt überein.

mainCategoryName
mainCategoryName string

Code der Hauptkategorie, in der das Produkt gesucht werden soll.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Gibt zurück

Name Pfad Typ Beschreibung
array of string

Liste der IDs aller erstellten Projektsegmentelemente.

Hinzufügen von Webhook-Headern

Fügen Sie einem bestimmten Webhook einen neuen Header hinzu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

key
key True string

Ein HTTP-Headerschlüssel, den der Webhook während eines Rückrufs hinzufügt.

value
value True string

Ein HTTP-Headerwert für den Schlüssel, den der Webhook während eines Rückrufs hinzufügt.

Suchen Sie integrierte Systemlinks eines Herstellers. Eine integrierte Systemverbindung speichert eine Verknüpfung zwischen einer Strukturentität und einer externen Systementität.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Integrierte System-IDs
integratedSystemIdsIn True array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Name des integrierten Systems
integratedSystemName True string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Ressourcentyp
resourceType True string

Filtern Sie nach dem Ressourcentyp der integrierten Systemverknüpfungen.

Gibt zurück

Kopieren einer Eigenschaft in eine andere Version

Kopieren Sie eine Eigenschaft in eine andere Version.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Eigenschaften-ID
propertyId True string

ID der Eigenschaft, auf die Sie zugreifen möchten.

targetVersion
targetVersion True string

Versionsnummer (z. B. 1.0.0), in die Sie Daten kopieren möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Kopieren einer Einheit in eine andere Version

Kopieren Sie eine Einheit in eine andere Version.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Einheiten-ID
unitId True string

ID der Einheit, auf die Sie zugreifen möchten.

targetVersion
targetVersion True string

Versionsnummer (z. B. 1.0.0), in die Sie Daten kopieren möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Kopieren einer Featuregruppe in eine andere Version

Kopieren Sie eine Featuregruppe in eine andere Version. Zugrunde liegende Features werden nicht kopiert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

targetVersion
targetVersion True string

Versionsnummer (z. B. 1.0.0), in die Sie Daten kopieren möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Kopieren einer Komponente in eine andere Version

Kopieren Sie eine Komponente in eine andere Version.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

targetVersion
targetVersion True string

Versionsnummer (z. B. 1.0.0), in die Sie Daten kopieren möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Kopieren eines Features in eine andere Version

Kopieren Sie ein Feature in eine andere Version.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

Feature-ID
featureId True string

ID des Features, auf das Sie zugreifen möchten.

targetVersion
targetVersion True string

Versionsnummer (z. B. 1.0.0), in die Sie Daten kopieren möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Kopieren eines Projektsegmentelements in ein anderes Projekt

Kopiert ein Projektsegmentelement in ein anderes Projekt. Wenn das Element über eine angefügte Konfiguration verfügt, wird es automatisch auf die neueste Version aktualisiert.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegmentelement-ID
projectSegmentItemId True string

ID des Projektsegmentelements, auf das Sie zugreifen möchten.

projectId
projectId True string

ID des Zielprojekts.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Löschen der Kopfzeile eines Webhooks

Löschen Sie den Header eines bestimmten Webhooks.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Webhook-Header-ID
headerId True string

ID des Webhook-Headers, auf den Sie zugreifen möchten.

Löschen einer Anlage eines Projektsegments

Löschen sie eine Anlage eines bestimmten Projektsegments.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Projektsegment-Anlagen-ID
attachmentId True string

ID der Projektsegmentanlage, auf die Sie zugreifen möchten.

Löschen einer Beschwerde

Löschen einer spezifischen Beschwerde eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

Löschen einer Eigenschaft

Löschen einer bestimmten Eigenschaft aus Stammdaten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Eigenschaften-ID
propertyId True string

ID der Eigenschaft, auf die Sie zugreifen möchten.

Löschen einer Einheit

Löschen einer bestimmten Einheit aus Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Einheiten-ID
unitId True string

ID der Einheit, auf die Sie zugreifen möchten.

Löschen einer Featuregruppe

Löschen sie eine bestimmte Featuregruppe aus Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

Löschen einer integrierten Systemverbindung

Löschen Sie eine bestimmte integrierte Systemverbindung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Integrierte Systemverbindungs-ID
integratedSystemLinkId True string

ID des integrierten Systemlinks, auf den Sie zugreifen möchten.

Löschen einer Komponente

Löschen einer Komponente aus Stammdaten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Löschen einer Komponenten-QuickInfo

Löschen einer Komponenten-QuickInfo aus Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Löschen einer Komponentenanlage

Löschen einer Anlage aus einer Komponente in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Anlagen-ID
attachmentId True string

ID der Anlage, auf die Sie zugreifen möchten.

Löschen einer Standardadresse eines Unternehmens

Löschen einer bestimmten Standardadresse eines Unternehmens

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

Standardadress-ID
defaultAddressId True string

ID der Standardadresse, auf die Sie zugreifen möchten.

Löschen eines benutzerdefinierten Objekts

Löschen eines benutzerdefinierten Objekts eines bestimmten Typs.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Benutzerdefinierter Objekttyp
customObjectType True string

Name des benutzerdefinierten Objekttyps, auf den Sie zugreifen möchten.

Benutzerdefinierte Objekt-ID
customObjectKey True string

ID des benutzerdefinierten Objekts, auf das Sie zugreifen möchten.

Löschen eines Features

Löschen eines Features aus einer bestimmten Featuregruppe in Masterdaten

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

Feature-ID
featureId True string

ID des Features, auf das Sie zugreifen möchten.

Löschen eines Komponenten-QuickInfo-Bilds

Löschen eines Komponenten-QuickInfo-Bilds aus Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Löschen eines Komponentenpreises

Löschen eines Preises aus einer Komponente in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Komponentenpreis-ID
componentPriceId True string

Der Komponentenpreis, auf den Sie zugreifen möchten.

Löschen eines Konfigurators

Löschen Eines bestimmten Konfigurators aus einer Version.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Konfigurator-ID
configuratorId True string

ID des Konfigurators, auf den Sie zugreifen möchten.

Löschen eines Preiskatalogs

Löschen Sie einen bestimmten Preiskatalog.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Preiskatalog-ID
priceCatalogId True string

ID des Katalogs, auf den Sie zugreifen möchten.

Löschen eines Projekts

Löschen Sie ein bestimmtes Projekt eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektkennung
projectId True string

ID des Projekts, auf das Sie zugreifen möchten.

Löschen eines Projektsegmentelements

Löschen eines bestimmten Projektsegmentelements aus einem Projekt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegmentelement-ID
projectSegmentItemId True string

ID des Projektsegmentelements, auf das Sie zugreifen möchten.

Löschen eines Unternehmens

Löschen Sie ein bestimmtes Unternehmen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

Löschen eines Vertriebskontakts

Löschen eines bestimmten Kontakts eines Distributors

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Kontakt-ID
contactId True string

ID des Kontakts, auf den Sie zugreifen möchten.

Löschen eines Vertriebskontakts

Löschen Sie einen bestimmten Kontakt aus dem Adressbuch eines Händlers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Verteiler-ID
distributorId True string

ID des Distributors, auf den Sie zugreifen möchten.

Kontakt-ID
contactId True string

ID des Kontakts, auf den Sie zugreifen möchten.

Löschen eines Vertriebskontos

Löschen Sie ein bestimmtes Konto aus dem Adressbuch eines Händlers. Ein Konto kann nur entfernt werden, wenn es nicht in Projekten verwendet wird und keine Kontakte hat.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Verteiler-ID
distributorId True string

ID des Distributors, auf den Sie zugreifen möchten.

Konto-ID
accountId True string

ID des Kontos, auf das Sie zugreifen möchten.

Löschen eines Webhook-Triggers

Löschen eines bestimmten Triggers eines Webhooks.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Webhook-Trigger-ID
webhookTriggerId True string

ID des Webhook-Triggers, auf den Sie zugreifen möchten.

Löschen eines Webhooks

Löschen Sie einen bestimmten Webhook eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Massenlöschen von Komponenten

Löschen mehrerer Komponenten in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

idsNotIn
idsNotIn array of string

Eine Liste der Komponenten-IDs, die nicht gelöscht werden sollen. Sie kann nicht zusammen mit idsIn verwendet werden.

idsIn
idsIn array of string

Eine Liste der Komponenten-IDs, die gelöscht werden sollen. Sie kann nicht zusammen mit idsNotIn verwendet werden.

Neuanordnen der Featuregruppen

Ordnen Sie die Featuregruppen neu an, um zu ändern, wie sie im Produktspeicher angezeigt werden. Alle vorhandenen Gruppen müssen Teil der Anforderung sein.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

featureGroupIds
featureGroupIds True array of string

Eine Auflistung aller Featuregruppen-IDs in der gewünschten Sequenz.

Neuanordnen von Features in einer Featuregruppe

Ordnen Sie die Features in einer bestimmten Featuregruppe neu an, um zu ändern, wie sie im Produktspeicher angezeigt werden. Alle vorhandenen Features in der Gruppe müssen Teil der Anforderung sein.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

featureIds
featureIds True array of string

Eine Auflistung aller Feature-IDs in der angegebenen Featuregruppe in der gewünschten Sequenz.

Neuberechnung eines Projekts

Starten Sie eine asynchrone Neuberechnung des Projekts.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektkennung
projectId True string

ID des Projekts, auf das Sie zugreifen möchten.

Neuberechnung eines Projektsegments fortsetzen

Setzt die Neuberechnung eines Projektsegments fort, wenn es durch eine externe Neuberechnung angehalten wurde.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Neue Featuregruppe hinzufügen

Hinzufügen einer neuen Featuregruppe zu Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Code
code True string

Eindeutiger Code für die Featuregruppe.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Projekt aktualisieren

Aktualisieren Sie ein bestimmtes Projekt eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektkennung
projectId True string

ID des Projekts, auf das Sie zugreifen möchten.

name
name string

Name des Projekts.

sellToCustomerReference
sellToCustomerReference string

Ein Verweis für den Endkunden.

accountId
accountId string

ID eines Kontos im Adressbuch.

contactId
contactId string

ID eines Kontakts im angegebenen Konto.

accountId
accountId string

ID eines Kontos im Adressbuch.

contactId
contactId string

ID eines Kontakts im angegebenen Konto.

accountId
accountId string

ID eines Kontos im Adressbuch.

contactId
contactId string

ID eines Kontakts im angegebenen Konto.

accountId
accountId string

ID eines Kontos im Adressbuch.

contactId
contactId string

ID eines Kontakts im angegebenen Konto.

taxCondition
taxCondition string

Der MwSt-Bedingungscode des Projekts. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryCondition
deliveryCondition string

Der Lieferbedingungscode des Projekts. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentCondition
paymentCondition string

Der Zahlungsbedingungscode des Projekts. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

Projekt kopieren

Kopiert alle Daten eines Projekts in ein neues Projekt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektkennung
projectId True string

ID des Projekts, auf das Sie zugreifen möchten.

projectName
projectName True string

Name des neuen Projekts.

distributorId
distributorId string

Verteiler für das neue Projekt. Der Verteiler des ursprünglichen Projekts wird verwendet, wenn nicht angegeben.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der integrierten Ressource.

Projekte durchsuchen

Suchprojekte eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Aktualisiert vor
updatedBefore date-time

Rufen Sie alle Ergebnisse ab, die vor der angegebenen Uhrzeit aktualisiert wurden.

Letzte Aktualisierung seit
updatedSince date-time

Rufen Sie alle Ergebnisse ab, die zuletzt aktualisiert wurden, nicht früher als die angegebene Uhrzeit.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Projektsegmente durchsuchen

Suchen Sie Projektsegmente eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Unternehmens-ID
companyBId array

Filtern Sie nach dem Vertriebsunternehmen, für das die Projektsegmente erstellt werden.

Schritt
step string

Filtern Sie nach dem Schritt im Auftragsfluss der Projektsegmente.

Letzte Aktualisierung seit
updatedSince date-time

Rufen Sie alle Ergebnisse ab, die zuletzt aktualisiert wurden, nicht früher als die angegebene Uhrzeit.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Projektsegmentelement abrufen

Rufen Sie ein bestimmtes Projektsegmentelement eines Herstellers ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegmentelement-ID
projectSegmentItemId True string

ID des Projektsegmentelements, auf das Sie zugreifen möchten.

Gibt zurück

Projektsegmentelemente durchsuchen

Durchsuchen von Projektsegmentelementen eines bestimmten Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Letzte Aktualisierung seit
updatedSince date-time

Rufen Sie alle Ergebnisse ab, die zuletzt aktualisiert wurden, nicht früher als die angegebene Uhrzeit.

Projektsegment-ID
projectSegmentId string

Filtern Sie nach dem Projektsegment der Elemente.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Sortieren
sort string

Sortieren Sie die Projektsegmentelemente. Präfix mit "-", um mit einer absteigenden Reihenfolge zu sortieren.

Gibt zurück

Rendern eines Konfigurationsfotos

Rendern eines Screenshots einer Konfiguration.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Konfigurations-ID
configurationId True string

ID der Konfiguration, auf die Sie zugreifen möchten.

Steuerbedingungen durchsuchen

Suchen Sie steuerrechtlichen Bedingungen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Gibt zurück

Stornieren des Bestellvorgangs zum Anführungszeichen

Bricht den Bestellvorgang ab und verschenkt ein Segment wieder in anführungszeichen. Das Projektsegment muss sich in Schritt 1 oder Schritt 2 befinden, um in anführungszeichen verschoben werden zu können.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Such-Einladungen

Suchen Sie Einladungen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-ID des Kontakts
integratedContactSystemId string

Filtern Sie nach der integrierten System-ID des Kontakts, an den die Einladung gesendet wird. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Kontakt-ID
contactId string

Filtern Sie nach dem Kontakt, an den die Einladung gesendet wird.

Kontaktstatus
status string

Filtern Sie nach dem Status der Einladungen.

Gibt zurück

Suchausgabedokumentvorlagen

Suchausgabedokumentvorlagen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchberechtigungen

Suchberechtigungen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Berechtigungscode
code string

Filtern Sie nach dem Code der Berechtigungen.

Rollen-ID
roleId string

Filtern Sie nach der Rolle, mit der die Berechtigungen verbunden sind.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchbeschwerdekommentare

Durchsuchen Sie Kommentare einer bestimmten Beschwerde.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Beschwerde-ID
complaintId True string

ID der Beschwerde, auf die Sie zugreifen möchten.

Gibt zurück

Suchbeschwerden

Suchbeschwerden eines Herstellers

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Beschwerdestatus
status string

Filtern Sie nach dem Status der Beschwerden.

Beschwerdetyp
type string

Filtern Sie nach der Art der Beschwerden.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Sucheigenschaften

Sucheigenschaften in Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Sucheinheiten

Sucheinheiten in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Einheitencode
code string

Filtern Sie nach dem Code der Einheiten.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchen nach Verteilerkontakten

Suchen Sie Kontakte im Adressbuch eines Händlers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Verteiler-ID
distributorId True string

ID des Distributors, auf den Sie zugreifen möchten.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Konto-ID
accountId string

Filtern Sie nach dem Konto, mit dem die Kontakte verbunden sind.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchen von Kontakten des Herstellers

Suchen Sie Kontakte, die mit einem Hersteller oder ihren Unternehmen verknüpft sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Unternehmens-ID
companyId string

Filtern Sie nach dem Unternehmen der Elemente.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchen von Unternehmen

Suchunternehmen, die mit einem Hersteller verknüpft sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Name des Unternehmens
name string

Filtern Sie nach dem Namen der Unternehmen.

Archivierungsstatus
includeArchived boolean

Filtern Sie nach dem Archivstatus der Unternehmen.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchen von Webhook-Headern

Suchheader eines bestimmten Webhooks.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Gibt zurück

Suchen von Webhooks

Suchwebhooks, die für einen Hersteller konfiguriert sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchereignisabonnements

Suchereignisabonnements, für die Sie abonniert sind.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Gibt zurück

Suchereignisse

Suchplattformereignisse eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Ereignistyp
eventType string

Filtern Sie nach dem Typ der Ereignisse.

Ereignistypgruppe
eventGroup string

Filtern Sie nach der Gruppe der Ereignistypen.

Ereignisse, die nachher passiert sind
dateOccurredAfter date-time

Filterereignisse, die nach dem angegebenen Datum und der angegebenen Uhrzeit aufgetreten sind.

Ereignistyp
targetIntegrationName string

Filterereignisse im Zusammenhang mit dem externen System, das in Hive integriert ist.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchfeaturegruppen

Suchfeaturegruppen in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchfeatures

Suchfeatures in einer bestimmten Featuregruppe in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchkategorien

Suchkategorien in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Code
code array

Filtert Kategorien nach Code.

Hauptkategoriecode
mainCategoryCode array

Filtern sie Unterkategorien nach ihrem übergeordneten Code.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchkomponenten

Suchkomponenten in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Preiskatalog-ID
priceCatalogId string

Filtern Sie nach dem Preiskatalog, der in den Preisen der Komponenten verwendet wird.

Feature-IDs
featureIds array

Filtern Sie nach den Features, die mit den Komponenten verknüpft sind.

Sachnummer
articleCode array

Filtern Sie nach dem Artikelcode der Komponenten.

EAN-Code
eanCode string

Filtern Sie nach dem EAN-Code der Komponenten.

GTIN-Code
gtinCode string

Filtern Sie nach dem GTIN-Code der Komponenten.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchkomponentenmengen

Suchmengen einer Komponente in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Gibt zurück

Suchkomponentenpreise

Suchpreise einer Komponente in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Gibt zurück

Suchkonfiguratoren

Suchkonfiguratoren in version.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Konfiguratorcode
code string

Filtern Sie nach dem Code der Konfiguratoren.

Gibt zurück

Suchpreiskataloge

Suchen Sie Preiskataloge eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Name des Preiskatalogs
name string

Filtern Sie nach dem Namen der Preiskataloge.

Ist Der Standardpreiskatalog
default boolean

Suchen Sie den Standardpreiskatalog.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchrollen

Suchrollen, die der Hersteller für seine eigenen Kontakte und diejenigen seiner Händler definiert hat.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Nur Standardherstellerrollen
defaultRoleForManufacturerCompany boolean

Filtern Sie die Rollen auf die Rollen, die für Benutzer Ihres Herstellerunternehmens als Standard verwendet werden.

Nur Standardverteilerrollen
defaultRoleForDistributorCompanies boolean

Filtern Sie die Rollen auf die Rollen, die für Benutzer Ihrer Vertriebsunternehmen als Standard verwendet werden.

Rollenname
name string

Filtern Sie nach dem Namen der Rollen.

Unternehmens-ID
companyId string

Filtern Sie nach dem Unternehmen der Elemente.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchwebhook-Trigger

Suchtrigger eines bestimmten Webhooks.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Webhook-ID
webhookId True string

ID des Webhooks, auf den Sie zugreifen möchten.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Suchzustellbedingungen

Suchzustellbedingungen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Gibt zurück

Unternehmen abrufen

Rufen Sie ein bestimmtes Unternehmen ab, das mit einem Hersteller verknüpft ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Unternehmens-ID
companyId True string

ID des Unternehmens, auf das Sie zugreifen möchten.

Gibt zurück

Unterstützte Sprachen durchsuchen

Durchsuchen Sie die unterstützten Sprachen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Updatekonfiguration

Aktualisieren Sie die Werte der Knoten in einer Konfiguration.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Konfigurations-ID
configurationId True string

ID der Konfiguration, auf die Sie zugreifen möchten.

uniqueLabel
uniqueLabel string

Der eindeutige Bezeichner des Knotens.

value
value string

Die Textdarstellung des Knotenwerts.

Menge
quantity number

Die Anzahl der elemente, die durch diesen Knoten dargestellt werden, um den Gesamtknotenpreis zu berechnen.

optional
optional boolean

Markieren Sie den Knoten als optional.

Upsert-Eigenschaften in Massen

Erstellen oder Aktualisieren von 50 Eigenschaften in Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

integratedSystemName
integratedSystemName string

Optionaler integrierter Systemname, der zum Erstellen integrierter Systemlinks für Ihre Eigenschaften verwendet wird.

Artikel-ID
itemId True string

Ein benutzerdefinierter Bezeichner dieses Elements, der innerhalb der gesamten Anforderung eindeutig sein muss. Dies ist nicht die Eigenschafts-ID.

Code
code True string

Eindeutiger Code für die Eigenschaft.

type
type True string

Typ der Eigenschaft.

arrayType
arrayType string

Typ der Arrayeigenschaft.

info
info string

Allgemeine Informationen zur Eigenschaft.

integratedSystemId
integratedSystemId string

Optionale integrierte System-ID zum Erstellen einer integrierten Systemverbindung für diese Eigenschaft.

Gibt zurück

Upsert-Einheiten in Massen

Erstellen oder Aktualisieren von 50 Einheiten in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

integratedSystemName
integratedSystemName string

Optionaler integrierter Systemname, der zum Erstellen integrierter Systemverbindungen für Ihre Einheiten verwendet wird.

Artikel-ID
itemId True string

Ein benutzerdefinierter Bezeichner dieses Elements, der innerhalb der gesamten Anforderung eindeutig sein muss. Dies ist nicht die Einheiten-ID.

Code
code True string

Der eindeutige Einheitencode.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

integratedSystemId
integratedSystemId string

Optionale integrierte System-ID zum Erstellen einer integrierten Systemverbindung für diese Einheit.

Gibt zurück

Upsert-Features in Massen

Erstellen oder Aktualisieren von 50 Features in Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

integratedSystemName
integratedSystemName string

Optionaler integrierter Systemname, der verwendet wird, um integrierte Systemlinks für Ihre Features zu erstellen.

Artikel-ID
itemId True string

Ein benutzerdefinierter Bezeichner dieses Elements, der innerhalb der gesamten Anforderung eindeutig sein muss. Dies ist nicht die Feature-ID.

Code
code True string

Eindeutiger Code für das Feature.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

serialSearchFunction
serialSearchFunction string

Eine JavaScript-Funktion, die die Sichtbarkeit im Produktspeicher bestimmt.

integratedSystemId
integratedSystemId string

Optionale integrierte System-ID zum Erstellen einer integrierten Systemverbindung für dieses Feature.

Gibt zurück

Upsert-Kategorien in Massen

Erstellen oder Aktualisieren von 50 Kategorien in Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

integratedSystemName
integratedSystemName string

Optionaler integrierter Systemname, der verwendet wird, um integrierte Systemlinks für Ihre Kategorien zu erstellen.

Artikel-ID
itemId True string

Ein benutzerdefinierter Bezeichner dieses Elements. Es handelt sich nicht um die Kategorie-ID.

Code
code True string

Code der Kategorie.

mainCategoryCode
mainCategoryCode string

Code der übergeordneten Kategorie. Dadurch wird Die neue Kategorie in eine Unterkategorie umgewandelt.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

integratedSystemId
integratedSystemId string

Optionale integrierte System-ID zum Erstellen einer integrierten Systemverbindung für diese Kategorie.

Gibt zurück

Upsert-Komponenten in Massen

Erstellen oder Aktualisieren von 50 Komponenten in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

integratedSystemName
integratedSystemName string

Optionaler integrierter Systemname zum Erstellen integrierter Systemverbindungen für Ihre Komponenten.

Artikel-ID
itemId True string

Ein benutzerdefinierter Bezeichner dieses Elements, der innerhalb der gesamten Anforderung eindeutig sein muss. Dies ist nicht die Komponenten-ID.

articleCode
articleCode True string

Der eindeutige Artikelcode.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

eanCode
eanCode string

Die Nummer des europäischen Artikels.

gtinCode
gtinCode string

Die Nummer des globalen Handelsartikels.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

productGroup
productGroup string

Die Gruppe, zu der Ihre Komponente gehört.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zielfeatures, die mit einem integrierten System verknüpft sind.

featureCodes
featureCodes True array of string

Eine Reihe von Featurecodes. Zum Löschen vorhandener Links geben Sie eine leere Liste an.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zielunterkategorien, die mit einem integrierten System verknüpft sind.

mainCategoryCode
mainCategoryCode True string

Code der Hauptkategorie, aus der Unterkategorien mit der Komponente verknüpft werden.

subCategoryCodes
subCategoryCodes True array of string

Eine Sammlung von Unterkategoriecodes, die mit der Komponente verknüpft werden sollen.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zieleigenschaften, die mit einem integrierten System verknüpft sind.

Code
code True string

Der Eigenschaftencode, für den der neue Wert festgelegt werden soll.

value
value string

Der neue Wert der Eigenschaft, wenn sie kein Arraytyp ist.

arrayValues
arrayValues array of string

Die neue Auflistung von Werten der Eigenschaft, wenn es sich um einen Arraytyp handelt.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zieleinheiten, die mit einem integrierten System verknüpft sind.

unitCode
unitCode True string

Code der Einheit, die für diese Komponentenmenge verwendet werden soll.

minimum
minimum True number

Die Mindestmenge, die für diese Komponentenmenge verwendet werden soll.

Maximalwert
maximum number

Die optionale maximale Menge, die für diese Komponentenmenge verwendet werden soll.

Schritt
step True number

Der Schrittwert, der für jeden inkrementellen Schritt für diese Komponentenmenge verwendet werden soll.

enabled
enabled boolean

Aktivieren oder deaktivieren Sie die Anzeige der QuickInfo.

languageCode
languageCode True string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation True string

Der übersetzte Text.

Features (veraltet)
features array of string

(Veraltet) Eine Sammlung von Featurecodes.

integratedSystemId
integratedSystemId string

Optionale integrierte System-ID zum Erstellen einer integrierten Systemverbindung für diese Komponente.

Gibt zurück

Upsert-Komponentenpreise in Massen

Erstellen oder Aktualisieren von 50 Komponentenpreisen in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Artikel-ID
itemId string

Ein benutzerdefinierter Bezeichner dieses Elements. Es handelt sich nicht um die Komponentenpreis-ID.

componentCode
componentCode string

Code der Komponente, der den Preis(n) hinzugefügt werden soll.

unitCode
unitCode string

Code der Einheit, die mit dem Preis verwendet werden soll.

priceCatalogName
priceCatalogName string

Name des Preiskatalogs, zu dem der Preis gehört.

costPrice
costPrice float

Kostenpreis der Komponente.

listPrice
listPrice float

Listenpreis der Komponente.

PurchasePrice
purchasePrice float

Kaufpreis der Komponente.

subDistributorPurchasePrice
subDistributorPurchasePrice float

Unterverteiler-Kaufpreis der Komponente.

Währung
currency string

Die Währung im ISO 4217-Format.

Gibt zurück

Verknüpfen eines Features mit einer Komponente

Verknüpft ein Feature mit einer Komponente in Masterdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

Feature-ID
featureId True string

ID des Features, auf das Sie zugreifen möchten.

Verknüpfen von Features mit einer Komponente

Verknüpft ein oder mehrere Features mit einer Komponente in Masterdaten. Vorhandene Links werden überschrieben oder gelöscht.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Komponenten-ID
componentId True string

ID der Komponente, auf die Sie zugreifen möchten.

integratedSystemName
integratedSystemName string

Wahlfrei. Nur Zielfeatures, die mit einem integrierten System verknüpft sind.

featureCodes
featureCodes True array of string

Eine Reihe von Featurecodes. Zum Löschen vorhandener Links geben Sie eine leere Liste an.

Verschieben eines Projektsegments in Schritt 1

Verschieben sie ein bestimmtes Projektsegment in Schritt 1. Dadurch wird der Bestellvorgang gestartet.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

customerPoRef
customerPoRef True string

Bestellreferenz.

orderRemark
orderRemark True string

Hinweis auf die Bestellung.

shippingDateRequested
shippingDateRequested True date-time

Das angeforderte Datum im ISO-8601-Format.

vatCondition
vatCondition string

Der MwSt-Bedingungscode. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryCondition
deliveryCondition string

Der Code für die Übermittlungsbedingung. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentCondition
paymentCondition string

Der Zahlungsbedingungscode. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

Gibt zurück

response
string

Verschieben eines Projektsegments in Schritt 2

Verschieben sie ein bestimmtes Projektsegment in Schritt 2. Dadurch wird eine Bestellung für das Projektsegment erstellt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

customerPoRef
customerPoRef True string

Bestellreferenz.

orderRemark
orderRemark True string

Hinweis auf die Bestellung.

shippingDateRequested
shippingDateRequested True date-time

Das angeforderte Datum im ISO-8601-Format.

vatCondition
vatCondition string

Der MwSt-Bedingungscode. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryCondition
deliveryCondition string

Der Code für die Übermittlungsbedingung. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentCondition
paymentCondition string

Der Zahlungsbedingungscode. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

Gibt zurück

response
string

Verschieben eines Projektsegments in Schritt 3

Verschieben sie ein bestimmtes Projektsegment in Schritt 3.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

orderRemarkSupplier
orderRemarkSupplier True string

Bemerkung des Herstellers auf der Bestellung.

supplierSoRef
supplierSoRef True string

Verkaufsauftragsreferenz.

shippingDateConfirmed
shippingDateConfirmed date-time

Das bestätigte Datum im ISO-8601-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

Gibt zurück

response
string

Verschieben eines Projektsegments in Schritt 4

Verschieben sie ein bestimmtes Projektsegment in Schritt 4.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

orderRemarkSupplier
orderRemarkSupplier True string

Bemerkung des Herstellers auf der Bestellung.

supplierSoRef
supplierSoRef True string

Verkaufsauftragsreferenz.

shippingDateConfirmed
shippingDateConfirmed True date-time

Das bestätigte Datum im ISO-8601-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

Gibt zurück

response
string

Verteilerkonten durchsuchen

Suchen Sie Konten im Adressbuch eines Händlers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Verteiler-ID
distributorId True string

ID des Distributors, auf den Sie zugreifen möchten.

Nach IDs
idsIn array

Filtern Sie nach den IDs der Elemente.

Name des integrierten Systems
integratedSystemName string

Filtern Sie nach dem integrierten Systemnamen der Elemente.

Integrierte System-IDs
integratedSystemIdsIn array

Filtern Sie nach der integrierten System-ID der Elemente. Dies muss zusammen mit dem integrierten Systemnamenfilter verwendet werden.

Seitennummer
page integer

Zeigen Sie eine Seite der Auflistung an.

Seitenformat
pageSize integer

Steuern der Größe der zurückgegebenen Seite.

Gibt zurück

Verteilerkonto aktualisieren

Aktualisieren Sie ein bestimmtes Konto im Adressbuch eines Distributors.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Verteiler-ID
distributorId True string

ID des Distributors, auf den Sie zugreifen möchten.

Konto-ID
accountId True string

ID des Kontos, auf das Sie zugreifen möchten.

name
name string

Der Firmenname.

Beschreibung
description string

Weitere Informationen zum Unternehmen.

vatNumber
vatNumber string

Umsatzsteuernummer des Unternehmens.

phone
phone string

Telefonnummer des Unternehmens.

E-Mail
email string

E-Mail-Adresse des Unternehmens.

Webseiten-URL
websiteUrl string

URL zur Website des Unternehmens.

AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

Zahlungsbedingungen suchen

Suchen Sie die Zahlungsbedingungen eines Herstellers.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Language
language string

Geben Sie den ISO 639-1-Sprachcode an, in dem übersetzte Felder zurückgegeben werden sollen. Falls nicht angegeben, wird die Sprache des Benutzers verwendet.

Gibt zurück

Ändern der Einstellungen eines Projektsegments

Ändern Sie die Einstellungen eines Projektsegments. Einstellungen sind nur verfügbar, wenn ein Segmentkonfigurator konfiguriert ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Projektsegment-ID
projectSegmentId True string

ID des Projektsegments, auf das Sie zugreifen möchten.

Eingaben
inputs object

Eine Zuordnung von Schlüsseln und Werten, die als Eingabe für einen Segmentkonfigurator verwendet werden.

Ändern der Featuregruppe eines Features

Ändern Sie die Featuregruppe eines bestimmten Features in Stammdaten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Hersteller-ID
manufacturerId True string

ID des Herstellerunternehmens, mit dem Sie eine Verbindung herstellen.

Containername
name True string

Name des Containers, auf den Sie zugreifen möchten.

Containerversion
version True string

Die Nummer der Version (z. B. 1.0.0), auf die Sie zugreifen möchten. Die Bereitstellung von "top" zugriff auf die höchste verfügbare Version.

Featuregruppen-ID
featureGroupId True string

ID der Featuregruppe, auf die Sie zugreifen möchten.

Feature-ID
featureId True string

ID des Features, auf das Sie zugreifen möchten.

newFeatureGroupId
newFeatureGroupId True string

ID der neuen Featuregruppe.

Definitionen

ErstelltAm

Zeitstempel der Objekterstellung.

Zeitstempel der Objekterstellung.

updatedAt

Zeitstempel des neuesten Updates.

Zeitstempel des neuesten Updates.

linkId

ID der verknüpften Ressource.

ID der verknüpften Ressource.

linkName

Übersetzter Name der verknüpften Ressource.

Übersetzter Name der verknüpften Ressource.

linkHref

Eine URL zur Ressource.

Eine URL zur Ressource.

Eine externe Verknüpfung, über die Integratoren eine Ressource in einem externen System mit einer Ressource in HiveCPQ verknüpfen können.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

integratedSystemName
integratedSystemName string

Name des externen Systems.

integratedSystemId
integratedSystemId string

ID der Ressource, wie im externen System dargestellt.

ErstelltAm
createdAt createdAt

Zeitstempel der Objekterstellung.

updatedAt
updatedAt updatedAt

Zeitstempel des neuesten Updates.

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

Name Pfad Typ Beschreibung
Gegenstände
externalLink

Eine externe Verknüpfung, über die Integratoren eine Ressource in einem externen System mit einer Ressource in HiveCPQ verknüpfen können.

Alle Rollen, die mit dieser Ressource verknüpft sind.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

name
name linkName

Übersetzter Name der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

Eine Verknüpfung zu einer Einheit.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

Code
code string

Eindeutiger Code der Einheit.

href
href linkHref

Eine URL zur Ressource.

Ein Link zu einem Preiskatalog.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

name
name string

Der eindeutige Name des Katalogs.

Ein Link zu einer Kategorie.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

name
name linkName

Übersetzter Name der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

Eine Verknüpfung mit einer Komponente.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

Code
code string

Der Artikelcode der Komponente.

href
href linkHref

Eine URL zur Ressource.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

name
name linkName

Übersetzter Name der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

Ein Link zu einem Kontakt.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

fullName
fullName string

Name des Kontakts.

Ein Link zu einem Benutzerkonto.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

fullName
fullName string

Name des Kontakts.

Ein Link zu einem Unternehmen.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

name
name linkName

Übersetzter Name der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

Ein Link zu einem Projekt.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

name
name linkName

Übersetzter Name der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

Eine Verknüpfung zu einem Projektsegment.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

orderStatus
orderStatus string

Der Schritt im Auftragsfluss.

Verknüpfungen zu mehreren Projektsegmenten.

Name Pfad Typ Beschreibung
Gegenstände
projectSegmentLink

Eine Verknüpfung zu einem Projektsegment.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

name
name string

Name des Projektsegmentelements.

articleCode
articleCode string

Code des Artikel zum Produktspeicher.

KonfiguratorCode
ConfiguratorCode string

Code des konfigurierbaren Elementkonfigurators.

type
type enumProjectSegmentItemType

Typ des Projektsegmentelements.

Ein Link zu einem Versandzeitplan.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

type
type string
Woche
week number
Jahr
year number
href
href linkHref

Eine URL zur Ressource.

Eine Verknüpfung mit einem Konfigurator.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

name
name linkName

Übersetzter Name der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

Eine Verknüpfung mit einer Konfiguration.

Name Pfad Typ Beschreibung
id
id linkId

ID der verknüpften Ressource.

href
href linkHref

Eine URL zur Ressource.

address

Das Standardadressformat.

Name Pfad Typ Beschreibung
AdresseZeile1
addressLine1 string

Adresszeile 1.

AdresseZeile2
addressLine2 string

Adresszeile 2.

city
city string

Die Stadt.

postalCode
postalCode string

Die Postleitzahl.

countryIso
countryIso string

Der Ländercode im ISO 3166-2-Format.

stateIso
stateIso string

Die Vorwahl im ISO 3166-2-Format.

companyContact

Name Pfad Typ Beschreibung
E-Mail
email string

E-Mail-Adresse des Kontakts.

companyName
companyName string

Name des Unternehmens.

KontaktTelefon
contactPhone string

Telefonnummer des Kontakts.

Name des Kontakts
contactName string

Name der Kontaktperson.

companyVatNumber
companyVatNumber string

Umsatzsteuernummer des Unternehmens.

address
address address

Das Standardadressformat.

Firmeninfo

Die allgemeinen Informationen zu einem Unternehmen.

Name Pfad Typ Beschreibung
name
name string

Name des Unternehmens.

Beschreibung
description string

Weitere Informationen zum Unternehmen.

vatNumber
vatNumber string

Umsatzsteuernummer des Unternehmens.

E-Mail
email email

E-Mail-Adresse des Unternehmens.

Telefon
telephone string

Telefonnummer des Unternehmens.

Webseiten-URL
websiteUrl string

URL zur Website des Unternehmens.

preferredLanguage
preferredLanguage string

Die Standardsprache für das Unternehmen im ISO 639-1-Format.

address
address address

Das Standardadressformat.

externalSystemId1
externalSystemId1 string

Eine ID, die verwendet wird, um das Unternehmen in einem externen System zu identifizieren. Es wird in der Regel empfohlen, stattdessen eine Systemverbindung zu verwenden.

externalSystemId2
externalSystemId2 string

Eine ID, die verwendet wird, um das Unternehmen in einem externen System zu identifizieren. Es wird in der Regel empfohlen, stattdessen eine Systemverbindung zu verwenden.

companyAdvanced

Die erweiterten Informationen zu einem Unternehmen.

Name Pfad Typ Beschreibung
salesRepresentativeContactId
salesRepresentativeContactId string

ID eines Kontakts, der als Vertriebsmitarbeiter fungiert.

techSupportManagerContactId
techSupportManagerContactId string

ID eines Kontakts, der als technischer Supportmanager fungiert.

orderProcessingManagerContactId
orderProcessingManagerContactId string

ID eines Kontakts, der als Auftragsverarbeitungsmanager fungiert.

shippingManagerContactId
shippingManagerContactId string

ID eines Kontakts, der als Versandsupportmanager fungiert.

companyGroups
companyGroups array of string

Liste der Unternehmensgruppen.

companySalesConditions

Die Bedingungen und Standardwerte, die auf Projekte dieses Unternehmens angewendet werden.

Name Pfad Typ Beschreibung
vatConditionCode
vatConditionCode string

Der Standard-MwSt-Bedingungscode für Projekte dieses Unternehmens. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryConditionCode
deliveryConditionCode string

Der Standardzustellbedingungscode für Projekte dieses Unternehmens. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentConditionCode
paymentConditionCode string

Der Standardzahlungsbedingungscode für Projekte dieses Unternehmens. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

baseDiscount
baseDiscount float

Der Standardrabatt für Konfigurationen in Projekten dieses Unternehmens.

orderCurrency
orderCurrency string

Standardauftragswährung des Unternehmens.

Honorar
administrationFee.fee float

Die Gebühr wird angewendet, wenn ein Projekt für dieses Unternehmen die Gebührenschwelle nicht erreicht.

threshold
administrationFee.threshold float

Der Mindestpreis, unter dem eine Gebühr erhoben wird.

companyProductStore

Produktspeichereinstellungen dieses Unternehmens.

Name Pfad Typ Beschreibung
enabled
enabled boolean

Zulassen, dass dieses Unternehmen auf den Produktspeicher zugreifen kann

priceCatalogId
priceCatalogId string

ID des für dieses Unternehmen verwendeten Preiskatalogs.

storeDiscountPercentage
storeDiscountPercentage float

Der Rabattprozentsatz, der auf Artikel im Produktspeicher in einem Projekt dieses Unternehmens angewendet wird.

companyDefaultProjectSettings

Die Standardprojekteinstellungen des Unternehmens.

Name Pfad Typ Beschreibung
defaultVatConditionCode
defaultVatConditionCode string

Der Standard-MwSt-Bedingungscode für Projekte für dieses Unternehmen. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

defaultPaymentConditionCode
defaultPaymentConditionCode string

Der Standardzahlungsbedingungscode für Projekte für dieses Unternehmen. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

salesPricingStrategy
salesPricingStrategy string

Die Standardpreisstrategie für Projekte für dieses Unternehmen.

customObjectKeyValuePair

Dies stellt ein Schlüsselwertpaar dar, das zum Speichern oder Übergeben von Daten mit benutzerdefinierten Objekten verwendet wird.

Name Pfad Typ Beschreibung
key
key string

Ein eindeutiger Schlüssel, der verwendet wird, um einen Wert innerhalb eines einzelnen benutzerdefinierten Objekts zu identifizieren.

value
value

Eine textbezogene Darstellung des Werts, der für den Schlüssel gespeichert werden soll.

Datentyp
dataType enumCustomObjectValueDataType

Die Datentypen, die für benutzerdefinierte Objektwerte verwendet werden können.

enumBulkResponseStatus

Status des Massenelements.

Status des Massenelements.

enumCompanyType

Typ eines Unternehmens.

Typ eines Unternehmens.

enumConfigurationNodeStatus

Status eines Knotens.

Status eines Knotens.

enumConfigurationNodeDatatype

Datentyp des Knotenwerts.

Datentyp des Knotenwerts.

enumProjectSegmentOrderStatus

Status der Reihenfolge im Auftragsfluss.

Status der Reihenfolge im Auftragsfluss.

enumProjectSegmentStatus

Status des Segments. Standardmäßig wird ausgeführt, wenn sich das Projekt noch in Schritt 0 des Auftragsvorgangs befindet.

Status des Segments. Standardmäßig wird ausgeführt, wenn sich das Projekt noch in Schritt 0 des Auftragsvorgangs befindet.

enumProjectSegmentItemType

Typ des Projektsegmentelements.

Typ des Projektsegmentelements.

enumComponentPropertyType

Typ der Eigenschaft.

Typ der Eigenschaft.

enumComponentPropertyArrayType

Typ der Arrayeigenschaft.

Typ der Arrayeigenschaft.

enumConfigurationStatus

Status der Konfiguration.

Status der Konfiguration.

enumCustomObjectValueDataType

Die Datentypen, die für benutzerdefinierte Objektwerte verwendet werden können.

Die Datentypen, die für benutzerdefinierte Objektwerte verwendet werden können.

enumOutputDocumentTemplateType

Typ der Ausgabedokumentvorlage.

Typ der Ausgabedokumentvorlage.

enumSystemLinkResourceType

Die Arten von Ressourcen, für die integrierte Systemverbindungen erstellt werden können.

Die Arten von Ressourcen, für die integrierte Systemverbindungen erstellt werden können.

enumWebhookEventSubscription

Die Ereignisse, für die ein Webhook abonniert werden kann.

Die Ereignisse, für die ein Webhook abonniert werden kann.

enumEventGroup

Die Ereignisgruppe eines Ereignisses.

Die Ereignisgruppe eines Ereignisses.

enumWebhookTriggerLocation

Der Speicherort des Webhook-Triggers in der Benutzeroberfläche von HiveCPQ.

Der Speicherort des Webhook-Triggers in der Benutzeroberfläche von HiveCPQ.

enumWebhookTriggerType

Der Typ des Webhook-Triggers.

Der Typ des Webhook-Triggers.

enumComplaintStatus

Der Status einer Beschwerde.

Der Status einer Beschwerde.

enumComplaintType

Die Art einer Beschwerde.

Die Art einer Beschwerde.

enumContainerVersionStatus

Status der Version

Status der Version

enumContainerVersionType

Typ der Version.

Typ der Version.

enumDefaultAddressType

Der Standardadressentyp.

Der Standardadressentyp.

enumInviteStatus

Der Status einer Einladung.

Der Status einer Einladung.

distributorAccountInfo

Allgemeine Informationen zum Händlerkonto.

Name Pfad Typ Beschreibung
name
name string

Der Firmenname.

Beschreibung
description string

Weitere Informationen zum Unternehmen.

vatNumber
vatNumber string

Umsatzsteuernummer des Unternehmens.

phone
phone string

Telefonnummer des Unternehmens.

E-Mail
email string

E-Mail-Adresse des Unternehmens.

Webseiten-URL
websiteUrl string

URL zur Website des Unternehmens.

distributorContactInfo

Allgemeine Informationen zum Kontakt.

Name Pfad Typ Beschreibung
Vorname
firstName string

Vorname des Kontakts.

lastName
lastName string

Nachname des Kontakts.

E-Mail
email string

E-Mail-Adresse des Kontakts.

Anrede
salutation string

Anrede des Kontakts.

Funktion
function string

Position des Kontakts.

phone
phone string

Telefonnummer des Kontakts.

mobile
mobile string

Mobiltelefonnummer des Kontakts

preferredLanguageIso
preferredLanguageIso string

Standardsprache des Kontakts im ISO 639-1-Format.

distributorContactSalesConditions

Verkaufsbedingungen des Kontakts.

Name Pfad Typ Beschreibung
vatNumber
vatNumber string

Umsatzsteuernummer für den Kontakt.

vatCondition
vatCondition string

Der Standard-MwSt-Bedingungscode für diesen Kontakt. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

deliveryCondition
deliveryCondition string

Der Standardmäßige Lieferbedingungscode für diesen Kontakt. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

paymentCondition
paymentCondition string

Der Standardcode für die Zahlungsbedingung für diesen Kontakt. Verfügbare Codes werden in Ihrer HiveCPQ-Umgebung definiert.

responseTranslations

Eine Liste der Übersetzungen.

Name Pfad Typ Beschreibung
languageCode
languageCode string

Der Sprachcode im ISO 639-1-Format.

Übersetzung
translation string

Der übersetzte Text.

responseKeyValueTranslations

Name Pfad Typ Beschreibung
languageCode
languageCode string

Sprachcode im ISO 639-1-Format.

Übersetzungen
translations array of object

Eine Sammlung übersetzter Schlüssel und Werte.

key
translations.key string

Der übersetzte Schlüssel.

value
translations.value string

Der übersetzte Wert.

responsePrice

Die Preisinformationen.

Name Pfad Typ Beschreibung
listPrice
listPrice string

Der Listenpreis.

Rabatt
discount string

Der Rabatt.

PurchasePrice
purchasePrice string

Der Kaufpreis.

salesPrice
salesPrice string

Der Verkaufspreis.

Währung
currency string

Die Währung im ISO 4217-Format.

unitCode
unitCode string

Die Einheit.

Markup
markup string

Das Preismarkup.

responseComponentProperty

Name Pfad Typ Beschreibung
Code
code string

Der Eigenschaftencode.

value
value string

Wert einer Eigenschaft.

arrayValues
arrayValues array of string

Werte einer Arrayeigenschaft.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

responseComponentPropertyWithoutAudit

Name Pfad Typ Beschreibung
Code
code string

Der Eigenschaftencode.

value
value string

Wert einer Eigenschaft.

arrayValues
arrayValues array of string

Werte einer Arrayeigenschaft.

responseConfigurationNode

Name Pfad Typ Beschreibung
uniqueLabel
uniqueLabel string

Eindeutiger Bezeichner eines Knotens.

componentCode
componentCode string

Der Artikelcode der Komponente, die mit dem Knoten verknüpft ist.

Datatype
datatype enumConfigurationNodeDatatype

Datentyp des Knotenwerts.

type
type string

Der Knotentyp.

status
status enumConfigurationNodeStatus

Status eines Knotens.

value
value string

Die Textdarstellung des Knotenwerts.

Einheit
unit string

Der Einheitencode des Knotens.

Menge
quantity number

Die Anzahl der elemente, die durch diesen Knoten dargestellt werden, um den Gesamtknotenpreis zu berechnen.

listPrice
price.listPrice float

Listenpreis des Knotens.

PurchasePrice
price.purchasePrice float

Kaufpreis des Knotens.

salesPrice
price.salesPrice float

Verkaufspreis des Knotens.

optional
optional boolean

Ist der Knoten in der Konfiguration optional?

Bestandteil
component responseConfigurationNodeComponentData

Zusätzliche Daten aus der Komponente, die für den Konfigurationsknoten oder die Komponentendaten verwendet werden, die dem ausgewählten Wert eines Knotens zugeordnet sind.

selectedComponent
selectedComponent responseConfigurationNodeComponentData

Zusätzliche Daten aus der Komponente, die für den Konfigurationsknoten oder die Komponentendaten verwendet werden, die dem ausgewählten Wert eines Knotens zugeordnet sind.

Beschreibungen
descriptions responseKeyValueTranslations
nodes
nodes array of object

Untergeordnete Knoten des übergeordneten Knotens, die Knotenstrukturen sind identisch. Geschachtelte Knoten sind für den DEFAULT-Ausgabemodus nicht verfügbar.

items
nodes object

responseConfigurationNodeComponentData

Zusätzliche Daten aus der Komponente, die für den Konfigurationsknoten oder die Komponentendaten verwendet werden, die dem ausgewählten Wert eines Knotens zugeordnet sind.

Name Pfad Typ Beschreibung
eanCode
eanCode string

Die Europäische Artikelnummer der Komponente.

gtinCode
gtinCode string

Die Global Trade Item Number der Komponente.

unitCode
unitCode string

Die Einheit der Komponente.

names
names responseTranslations

Eine Liste der Übersetzungen.

Beschreibungen
descriptions responseTranslations

Eine Liste der Übersetzungen.

propertyValues
propertyValues array of responseComponentPropertyWithoutAudit

Eine Liste der Komponenteneigenschaftenwerte.

responseGetVersions

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Containerversionen.

id
items.id string

ID der Containerversion.

Ausgabe
items.version string

Die Versionsnummer.

status
items.status enumContainerVersionStatus

Status der Version

type
items.type enumContainerVersionType

Typ der Version.

Notizen
items.notes string

Zusätzliche Informationen zur Version.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetDefaultAddress

Name Pfad Typ Beschreibung
id
id string

ID der Standardadresse.

companyName
companyName string

Firmenname der Standardadresse.

type
type enumDefaultAddressType

Der Standardadressentyp.

address
address address

Das Standardadressformat.

E-Mail
email string

E-Mail der Standardadresse.

Ansprechpartner
contactPerson string

Kontaktperson der Standardadresse.

KontaktTelefon
contactPhone string

Telefonnummer der Standardadresse.

vatNumber
vatNumber string

Umsatzsteuernummer der Standardadresse.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

canChangeAddress
canChangeAddress boolean

Kann der Händler seine Standardzustellungs- und Rechnungsadressen ändern.

canChangeAddressOnPlaceOrder
canChangeAddressOnPlaceOrder boolean

Ist der Händler in der Lage, während des Bestellvorgangs eigene Liefer- und Rechnungsadressen festzulegen.

responseGetDefaultAddresses

Name Pfad Typ Beschreibung
items
items array of responseGetDefaultAddress

Eine Liste der Standardadressen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetCompany

Name Pfad Typ Beschreibung
id
id string

ID des Unternehmens.

type
type enumCompanyType

Typ eines Unternehmens.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

info
info companyInfo

Die allgemeinen Informationen zu einem Unternehmen.

advanced
advanced companyAdvanced

Die erweiterten Informationen zu einem Unternehmen.

Verteiler
subDistributorSettings.distributor companyLink

Ein Link zu einem Unternehmen.

orderEmails
subDistributorSettings.orderEmails array of string

Alle Unterverteiler-E-Mails, die Bestell-E-Mails erhalten.

archiviert
archived boolean

Gibt an, ob das Unternehmen archiviert wird.

salesConditions
salesConditions companySalesConditions

Die Bedingungen und Standardwerte, die auf Projekte dieses Unternehmens angewendet werden.

productStore
productStore companyProductStore

Produktspeichereinstellungen dieses Unternehmens.

defaultProjectSettings
defaultProjectSettings companyDefaultProjectSettings

Die Standardprojekteinstellungen des Unternehmens.

responseGetCompanies

Name Pfad Typ Beschreibung
items
items array of responseGetCompany

Eine Liste der Unternehmen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetInvites

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Einladungen.

id
items.id string

ID einer Einladung.

status
items.status enumInviteStatus

Der Status einer Einladung.

toEmail
items.toEmail string

Die E-Mail-Adresse, an die die Einladung gesendet wurde.

ErstelltAm
items.createdAt createdAt

Zeitstempel der Objekterstellung.

anspruchsgefordertAt
items.claimedAt string

Das Datum, an dem die Einladung im ISO-8601-Format beansprucht wurde.

inviteUrl
items.inviteUrl string

Die URL, unter der die Einladung beansprucht werden kann.

fromContact
items.fromContact contactLink

Ein Link zu einem Kontakt.

toContact
items.toContact contactLink

Ein Link zu einem Kontakt.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetContact

Name Pfad Typ Beschreibung
id
id string

Die Kontakt-ID.

Vorname
firstName string

Vorname des Kontakts.

lastName
lastName string

Nachname des Kontakts.

E-Mail
email string

E-Mail-Adresse des Kontakts.

phone
phone string

Telefonnummer des Kontakts.

mobile
mobile string

Mobiltelefonnummer des Kontakts.

preferredLanguage
preferredLanguage string

Sprache des Benutzers im ISO 639-1-Format.

functionTitle
functionTitle string

Die Position des Kontakts.

address
address address

Das Standardadressformat.

Anrede
salutation string

Anrede des Kontakts.

externalSystemId
externalSystemId string

ID, die zum Identifizieren des Kontakts in einem externen System verwendet wird

avatarUrl
avatarUrl string

Eine URL zum Avatar des Kontakts.

Firma
company companyLink

Ein Link zu einem Unternehmen.

archiviert
archived boolean

Archivstatus des Kontakts.

roles
roles roleLinks

Alle Rollen, die mit dieser Ressource verknüpft sind.

userAccount
userAccount userAccountLink

Ein Link zu einem Benutzerkonto.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

responseGetContacts

Name Pfad Typ Beschreibung
items
items array of responseGetContact

Eine Liste von Kontakten.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetComponentProperties

Name Pfad Typ Beschreibung
items
items array of responseComponentProperty

Eine Liste der Eigenschaftswerte.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetComponentQuantities

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Komponentenmengen.

id
items.id string

ID der Komponentenmenge.

Einheit
items.unit unitLink

Eine Verknüpfung zu einer Einheit.

minimum
items.minimum number

Das Minimum dieser Komponentenmenge.

Maximalwert
items.maximum number

Das optionale Maximum dieser Komponentenmenge.

Schritt
items.step number

Der Schritt für diese Komponentenmenge.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetComponentAttachments

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Komponentenanlagen.

id
items.id string

ID einer Anlage.

fileUrl
items.fileUrl string

Öffentlich zugängliche URL einer Anlage.

fileName
items.fileName string

Dateiname der Anlage.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetComponentPrices

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Komponentenpreise.

id
items.id string

ID eines Komponentenpreises.

priceCatalog
items.priceCatalog priceCatalogLink

Ein Link zu einem Preiskatalog.

Einheit
items.unit unitLink

Eine Verknüpfung zu einer Einheit.

costPrice
items.costPrice float

Der Kostenpreis.

listPrice
items.listPrice float

Der Listenpreis.

PurchasePrice
items.purchasePrice float

Der Kaufpreis.

subDistributorPurchasePrice
items.subDistributorPurchasePrice float

Der Kaufpreis des Subverteilers.

Währung
items.currency string

Die Währung im ISO 4217-Format.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseBulkResults

Name Pfad Typ Beschreibung
results
results array of object

Eine Liste der Ergebniselemente.

Artikel-ID
results.itemId string

Benutzerdefinierter Bezeichner des Elements.

resourceId
results.resourceId string

Technische ID des erstellten oder aktualisierten Elements.

status
results.status enumBulkResponseStatus

Status des Massenelements.

message
results.message string

Nachricht mit zusätzlichen Informationen, wenn das Element nicht verarbeitet werden konnte.

successCount
successCount integer

Die Menge der erfolgreich verarbeiteten Elemente.

responseGetComponentTooltip

Name Pfad Typ Beschreibung
id
id string

ID einer Komponenten-QuickInfo.

enabled
enabled boolean

Aktivieren oder deaktivieren Sie die Anzeige der QuickInfo.

Titel
titles responseTranslations

Eine Liste der Übersetzungen.

details
details responseTranslations

Eine Liste der Übersetzungen.

responsePutComponentTooltip

Name Pfad Typ Beschreibung
id
id string

ID der QuickInfo.

responseGetComponent

Name Pfad Typ Beschreibung
id
id string

ID der Komponente.

articleCode
articleCode string

Eindeutiger Artikelcode der Komponente.

eanCode
eanCode string

Die Europäische Artikelnummer der Komponente.

gtinCode
gtinCode string

Die Global Trade Item Number der Komponente.

scriptPrice
scriptPrice string

Ein optionales Preisskript.

unitCode
unitCode unitLink

Eine Verknüpfung zu einer Einheit.

productGroup
productGroup string

Gruppe der Komponente.

showOnlyForSerialNumber
showOnlyForSerialNumber boolean

Gibt an, ob auf die Komponente nur im Produktspeicher über Seriennummernsuchen zugegriffen werden kann.

Mindestmenge
minimumQuantity integer

Die Mindestmenge, die beim Hinzufügen dieser Komponente zu einem Projekt verwendet werden muss.

name
name responseTranslations

Eine Liste der Übersetzungen.

Beschreibung
description responseTranslations

Eine Liste der Übersetzungen.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

priceCatalogs
priceCatalogs array of object

Die preise, die mit der Komponente verknüpft sind.

Währung
priceCatalogs.currency string

Die Währung im ISO 4217-Format.

unitCode
priceCatalogs.unitCode string

Der eindeutige Code einer Einheit.

costPrice
priceCatalogs.costPrice float

Der Kostenpreis.

listPrice
priceCatalogs.listPrice float

Der Listenpreis.

PurchasePrice
priceCatalogs.purchasePrice float

Der Kaufpreis.

subDistributorPurchasePrice
priceCatalogs.subDistributorPurchasePrice float

Der Kaufpreis des Subverteilers.

Preis (veraltet)
priceCatalogs.price float

Der Listenpreis. (Veraltet, stattdessen listPrice verwenden)

id
priceCatalogs.id string

ID des Preiskatalogs.

href
priceCatalogs.href linkHref

Eine URL zur Ressource.

name
priceCatalogs.name string

Eindeutiger Name des Preiskatalogs.

categories
categories array of categoryLink

Eine Liste der Kategorien, die mit der Komponente verknüpft sind.

explodedViews
explodedViews array of object

Eine Liste der explodierten Ansichten, die mit der Komponente verknüpft sind.

Kategorie
explodedViews.category categoryLink

Ein Link zu einer Kategorie.

explodedViewArea
explodedViews.explodedViewArea string

Der explodierte Ansichtsbereich.

Konfigurator
configurable.configurator configuratorLink

Eine Verknüpfung mit einem Konfigurator.

parameters
configurable.parameters array of object

Informationen zu der Komponente, wenn sie als konfigurierbares Produkt konfiguriert wurde.

key
configurable.parameters.key string

Der Bezeichner eines Konfiguratoreingabewerts.

value
configurable.parameters.value string

Der Eingabewert des Konfigurators.

features
features array of featureLink

Eine Liste der Features, die mit der Komponente verknüpft sind.

responseGetComponents

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Komponenten.

id
items.id string

ID der Komponente.

name
items.name string

Übersetzter Name der Komponente.

Beschreibung
items.description string

Übersetzte Beschreibung der Komponente.

articleCode
items.articleCode string

Eindeutiger Artikelcode der Komponente.

eanCode
items.eanCode string

Die Europäische Artikelnummer der Komponente.

gtinCode
items.gtinCode string

Die Global Trade Item Number der Komponente.

unitCode
items.unitCode unitLink

Eine Verknüpfung zu einer Einheit.

productGroup
items.productGroup string

Gruppe der Komponente.

showOnlyForSerialNumber
items.showOnlyForSerialNumber boolean

Gibt an, ob auf die Komponente nur im Produktspeicher über Seriennummernsuchen zugegriffen werden kann.

Mindestmenge
items.minimumQuantity integer

Die Mindestmenge, die beim Hinzufügen dieser Komponente zu einem Projekt verwendet werden muss.

externalLinks
items.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

konfigurierbar
items.configurable boolean

Gibt an, ob ein Konfigurator verknüpft ist.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetProperties

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Eigenschaften.

id
items.id string

ID der Eigenschaft.

externalLinks
items.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

Code
items.code string

Eindeutiger Code der Eigenschaft.

type
items.type enumComponentPropertyType

Typ der Eigenschaft.

arrayType
items.arrayType enumComponentPropertyArrayType

Typ der Arrayeigenschaft.

info
items.info string

Zusätzliche Informationen zur Eigenschaft.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetFeature

Name Pfad Typ Beschreibung
id
id string

ID des Features.

Code
code string

Eindeutiger Code des Features.

Beschreibungen
descriptions responseTranslations

Eine Liste der Übersetzungen.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

serialSearchFunction
serialSearchFunction string

Die JavaScript-Funktion, die die Sichtbarkeit der Komponenten im Produktspeicher bestimmt.

responseGetFeatures

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Features.

id
items.id string

ID des Features.

Code
items.code string

Eindeutiger Code des Features.

Beschreibung
items.description string

Übersetzte Beschreibung des Features.

externalLinks
items.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

serialSearchFunction
items.serialSearchFunction string

Die JavaScript-Funktion, die die Sichtbarkeit der Komponenten im Produktspeicher bestimmt.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetFeatureGroup

Name Pfad Typ Beschreibung
id
id string

ID der Featuregruppe.

Code
code string

Eindeutiger Code der Featuregruppe.

Beschreibungen
descriptions responseTranslations

Eine Liste der Übersetzungen.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

responseGetCategories

Name Pfad Typ Beschreibung
items
items array of object
id
items.id string

ID der Kategorie.

Code
items.code string

Code der Kategorie.

name
items.name string

Übersetzter Name der Kategorie.

type
items.type string

Typ der Kategorie.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

externalLinks
items.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetFeatureGroups

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste von Featuregruppen.

id
items.id string

ID der Featuregruppe.

Code
items.code string

Eindeutiger Code der Featuregruppe.

Beschreibung
items.description string

Übersetzte Beschreibung der Featuregruppe.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

externalLinks
items.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetUnit

Name Pfad Typ Beschreibung
id
id string

ID der Einheit.

Code
code string

Eindeutiger Code der Einheit.

names
names responseTranslations

Eine Liste der Übersetzungen.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

responseGetUnits

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Einheiten.

id
items.id string

ID der Einheit.

Code
items.code string

Eindeutiger Code der Einheit.

name
items.name string

Übersetzter Name der Einheit.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

externalLinks
items.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetConfigurators

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Konfiguratoren.

id
items.id string

ID des Konfigurators.

Code
items.code string

Eindeutiger Code des Konfigurators.

name
items.name responseTranslations

Eine Liste der Übersetzungen.

externalLinks
items.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetCustomObjectTypes

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der benutzerdefinierten Objekttypen.

type
items.type string

Name des benutzerdefinierten Objekttyps.

href
items.href string

Eine URL zu diesem Typ.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetCustomObject

Name Pfad Typ Beschreibung
key
key string

Die ID eines Kundenobjekts.

href
href string

Eine URL zum Abrufen des benutzerdefinierten Objekts.

keyValues
keyValues array of customObjectKeyValuePair

Eine Liste der Schlüssel und Werte des benutzerdefinierten Objekts.

responseGetCustomObjects

Name Pfad Typ Beschreibung
items
items array of responseGetCustomObject

Eine Liste von benutzerdefinierten Objekten.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetProject

Name Pfad Typ Beschreibung
id
id string

ID des Projekts.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

projectSegments
projectSegments projectSegmentLinks

Verknüpfungen zu mehreren Projektsegmenten.

name
name string

Name des Projekts.

sellToCustomerReference
sellToCustomerReference string

Der Kundenverweis.

Firma
sellTo.company companyLink

Ein Link zu einem Unternehmen.

Kontakt
sellTo.contact contactLink

Ein Link zu einem Kontakt.

Firma
invoice.company companyLink

Ein Link zu einem Unternehmen.

Kontakt
invoice.contact contactLink

Ein Link zu einem Kontakt.

Firma
delivery.company companyLink

Ein Link zu einem Unternehmen.

Kontakt
delivery.contact contactLink

Ein Link zu einem Kontakt.

Firma
installation.company companyLink

Ein Link zu einem Unternehmen.

Kontakt
installation.contact contactLink

Ein Link zu einem Kontakt.

vatCondition
salesConditions.vatCondition string

Der MwSt-Bedingungscode des Projekts.

vatPercentage
salesConditions.vatPercentage string

Der Mehrwertsteuerprozentsatz des Projekts.

deliveryCondition
salesConditions.deliveryCondition string

Der Lieferbedingungscode des Projekts.

paymentCondition
salesConditions.paymentCondition string

Der Zahlungsbedingungscode des Projekts.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

responseGetProjects

Name Pfad Typ Beschreibung
items
items array of responseGetProject

Eine Liste der Projekte.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetProjectSegment

Name Pfad Typ Beschreibung
id
id string

ID des Projektsegments.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

projectSegmentItems
projectSegmentItems array of projectSegmentItemLink

projectSegmentItems

Projekt
project projectLink

Ein Link zu einem Projekt.

orderStatus
order.orderStatus enumProjectSegmentOrderStatus

Status der Reihenfolge im Auftragsfluss.

moveToStep1At
order.moveToStep1At string

Zeitstempel, zu dem das Projekt zuletzt in Schritt 1 verschoben wurde.

moveToStep2At
order.moveToStep2At string

Zeitstempel, zu dem das Projekt zuletzt in Schritt 2 verschoben wurde.

moveToStep3At
order.moveToStep3At string

Zeitstempel, zu dem das Projekt zuletzt in Schritt 3 verschoben wurde.

moveToStep4At
order.moveToStep4At string

Zeitstempel, zu dem das Projekt zuletzt in Schritt 4 verschoben wurde.

orderRemark
order.orderRemark string

Hinweis auf die Bestellung.

orderRemarkFromManufacturer
order.orderRemarkFromManufacturer string

Bemerkung des Herstellers auf der Bestellung.

shippingDateRequested
order.shippingDateRequested string

Das angeforderte Datum im ISO-8601-Format.

shippingDateConfirmed
order.shippingDateConfirmed string

Das bestätigte Datum im ISO-8601-Format.

customerPoRef
order.customerPoRef string

Die Bestellreferenz des Kunden.

manufacturerSoRef
order.manufacturerSoRef string

Die Verkaufsauftragsreferenz des Herstellers.

manufacturerReference
order.manufacturerReference string

Referenz für den Hersteller.

bereitstellung
order.delivery companyContact
Rechnung
order.invoice companyContact
sellTo
order.sellTo companyContact
Installation
order.installation companyContact
vatCondition
order.salesCondition.vatCondition string

Der MwSt-Bedingungscode der Bestellung.

vatPercentage
order.salesCondition.vatPercentage string

Der Mehrwertsteuerprozentsatz der Bestellung.

deliveryCondition
order.salesCondition.deliveryCondition string

Der Lieferbedingungscode der Bestellung.

paymentCondition
order.salesCondition.paymentCondition string

Der Zahlungsbedingungscode der Bestellung.

orderSenderContact
order.orderSenderContact contactLink

Ein Link zu einem Kontakt.

orderReceiverContact
order.orderReceiverContact contactLink

Ein Link zu einem Kontakt.

Preis
price responsePrice

Die Preisinformationen.

companyAId
companyRelation.companyAId string

Die Hersteller-ID.

companyBId
companyRelation.companyBId string

Die Verteiler-ID.

companyASalesManager
companyASalesManager contactLink

Ein Link zu einem Kontakt.

companyBSalesManager
companyBSalesManager contactLink

Ein Link zu einem Kontakt.

status
status enumProjectSegmentStatus

Status des Segments. Standardmäßig wird ausgeführt, wenn sich das Projekt noch in Schritt 0 des Auftragsvorgangs befindet.

nextFollowUpDate
nextFollowUpDate string

Das nächste Nachverfolgungsdatum im ISO-8601-Format.

estimatedSalesDate
estimatedSalesDate string

Das geschätzte Verkaufsdatum im ISO-8601-Format.

freeTextNote
freeTextNote string

Eine Notiz im Segment.

saleProbability
saleProbability integer

Die Verkaufswahrscheinlichkeit.

status
externalOrderStatus.status string

Ein externer Status der Bestellung.

statusUrl
externalOrderStatus.statusUrl string

Benutzer einer URL können verwenden, um den Status der externen Bestellung zu überprüfen oder Versandinformationen zu ihrer Bestellung anzuzeigen.

statusText
externalOrderStatus.statusText string

Benutzerdefinierter Text, der für die Versandinformationen angezeigt wird.

orderGroup
orderGroup string

Die Bestellgruppe.

configurationStatus
configurationStatus enumConfigurationStatus

Status der Konfiguration.

configuration
configuration configurationLink

Eine Verknüpfung mit einer Konfiguration.

subDistributor
subDistributor companyLink

Ein Link zu einem Unternehmen.

responseGetProjectSegments

Name Pfad Typ Beschreibung
items
items array of responseGetProjectSegment

Eine Liste der Segmente.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetProjectSegmentAttachments

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Projektsegmentanlagen.

id
items.id string

ID der Projektsegmentanlage.

fileName
items.fileName string

Dateiname der Projektsegmentanlage.

fileUrl
items.fileUrl string

Öffentlich zugängliche URL der Projektsegmentanlage.

distributorFile
items.distributorFile boolean

Ist die Projektsegmentanlage im Besitz des Distributors.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetProjectSegmentItem

Name Pfad Typ Beschreibung
id
id string

ID des Projektsegmentelements.

name
name string

Name des Projektsegmentelements.

type
type enumProjectSegmentItemType

Typ des Projektsegmentelements.

configurationStatus
configurationStatus enumConfigurationStatus

Status der Konfiguration.

sortingSequence
sortingSequence integer

Position des Projektsegmentelements in seinem Segment.

Menge
quantity integer

Die Menge dieses Artikels, die zum Berechnen des Gesamtpreises verwendet wird.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

Preis
price responsePrice

Die Preisinformationen.

externalSerialNumbers
externalSerialNumbers array of string

Bezeichner des Elements in einem externen System.

Bestandteil
component componentLink

Eine Verknüpfung mit einer Komponente.

productGroup
productGroup string

Gruppe des Elements.

Projekt
project projectLink

Ein Link zu einem Projekt.

orderSerialNumberMatched
orderSerialNumberMatched boolean

Stimmt die Seriennummer der Bestellung überein?

projectSegment
projectSegment projectSegmentLink

Eine Verknüpfung zu einem Projektsegment.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

shippingSchedule
shippingSchedule shippingScheduleLink

Ein Link zu einem Versandzeitplan.

configuration
configuration configurationLink

Eine Verknüpfung mit einer Konfiguration.

responseGetProjectSegmentItems

Name Pfad Typ Beschreibung
items
items array of responseGetProjectSegmentItem

Eine Liste der Projektsegmentelemente.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der integrierten Systemlinks.

id
items.id string

ID der integrierten Systemverbindung.

integratedSystemName
items.integratedSystemName string

Name des externen Systems.

integratedSystemId
items.integratedSystemId string

ID der Ressource im externen System.

hiveId
items.hiveId string

ID der HiveCPQ-Ressource.

ErstelltAm
items.createdAt createdAt

Zeitstempel der Objekterstellung.

updatedAt
items.updatedAt updatedAt

Zeitstempel des neuesten Updates.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetDistributorAccounts

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Verteilerkonten.

id
items.id string

ID des Verteilerkontos.

info
items.info distributorAccountInfo

Allgemeine Informationen zum Händlerkonto.

address
items.address address

Das Standardadressformat.

externalLinks
items.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetDistributorContacts

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Verteilerkontakte.

id
items.id string

ID des Vertriebskontakts.

info
items.info distributorContactInfo

Allgemeine Informationen zum Kontakt.

address
items.address address

Das Standardadressformat.

salesConditions
items.salesConditions distributorContactSalesConditions

Verkaufsbedingungen des Kontakts.

externalLinks
items.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

Konto
items.account

Verteilerkonto, zu dem der Kontakt gehört.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetWebhookHeaders

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Webhooks-Header.

id
items.id string

ID des Webhook-Headers.

key
items.key string

Schlüssel, der in einem HTTP-Header während eines Webhook-Rückrufs verwendet wird.

value
items.value string

Wert, der für den Schlüssel in einem HTTP-Header während eines Webhook-Rückrufs verwendet wird.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetWebhookEventSubscriptions

Name Pfad Typ Beschreibung
eventSubscriptions
eventSubscriptions array of enumWebhookEventSubscription

Eine Liste der Plattformereignisse, für die der Webhook abonniert wird.

responseGetWebhookTrigger

Name Pfad Typ Beschreibung
id
id string

ID des Triggers.

Code
code string

Eindeutiger Code des Triggers.

names
names responseTranslations

Eine Liste der Übersetzungen.

Zusicherungen
confirmations responseTranslations

Eine Liste der Übersetzungen.

confirmationRequired
confirmationRequired boolean

Gibt an, ob beim Aktivieren eines Webhook-Triggers ein Bestätigungs modal angezeigt wird.

openInSameTab
openInSameTab boolean

Gibt an, ob Webhook-Trigger des OPEN_URL Typs die URL auf derselben oder einer anderen Browserregisterkarte öffnen.

location
location enumWebhookTriggerLocation

Der Speicherort des Webhook-Triggers in der Benutzeroberfläche von HiveCPQ.

type
type enumWebhookTriggerType

Der Typ des Webhook-Triggers.

Erlaubnisse
permissions array of object

Eine Liste der Berechtigungen mit Zugriff auf den Trigger.

id
permissions.id string

Die Berechtigungs-ID.

Code
permissions.code string

Der eindeutige Code der Berechtigung.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

responseGetWebhookTriggers

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Webhook-Trigger.

id
items.id string

ID des Triggers.

Code
items.code string

Eindeutiger Code des Triggers.

name
items.name string

Der übersetzte Name des Triggers.

Bestätigung
items.confirmation string

Der übersetzte Bestätigungstext des Triggers.

confirmationRequired
items.confirmationRequired boolean

Gibt an, ob beim Aktivieren eines Webhook-Triggers ein Bestätigungs modal angezeigt wird.

location
items.location enumWebhookTriggerLocation

Der Speicherort des Webhook-Triggers in der Benutzeroberfläche von HiveCPQ.

type
items.type enumWebhookTriggerType

Der Typ des Webhook-Triggers.

openInSameTab
items.openInSameTab boolean

Gibt an, ob Webhook-Trigger des OPEN_URL Typs die URL auf derselben oder einer anderen Browserregisterkarte öffnen.

Erlaubnisse
items.permissions array of object

Eine Liste der Berechtigungen mit Zugriff auf den Trigger.

id
items.permissions.id string

Die Berechtigungs-ID.

Code
items.permissions.code string

Eindeutiger Code der Berechtigung.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetWebhook

Name Pfad Typ Beschreibung
id
id string

ID des Webhooks.

Code
code string

Eindeutiger Code des Webhooks.

URL
url string

Rückruf-URL des Webhooks.

Beschreibung
description string

Weitere Informationen zum Webhook.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

responseGetWebhooks

Name Pfad Typ Beschreibung
items
items array of responseGetWebhook

Eine Liste von Webhooks.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetPriceCatalog

Name Pfad Typ Beschreibung
id
id string

ID des Preiskatalogs.

name
name string

Eindeutiger Name des Preiskatalogs.

defaultPriceCatalog
defaultPriceCatalog boolean

Gibt an, ob dies der Standardpreiskatalog ist.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

responseGetPriceCatalogs

Name Pfad Typ Beschreibung
items
items array of responseGetPriceCatalog

Eine Liste der Preiskataloge.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetComplaintComments

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Beschwerdekommentare.

id
items.id string

ID des Beschwerdekommentars.

Kommentar
items.comment string

Inhalt des Beschwerdekommentars.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetComplaintAttachments

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Beschwerdeanfügungen.

id
items.id string

ID des Beschwerdeanhangs.

fileName
items.fileName string

Dateiname des Beschwerdeanhangs.

Inhaltstyp
items.contentType string

Inhaltstyp des Beschwerdeanhangs.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetComplaint

Name Pfad Typ Beschreibung
id
id string

ID der Beschwerde.

title
title string

Titel der Beschwerde.

Beschreibung
description string

Weitere Informationen zur Beschwerde.

status
status enumComplaintStatus

Der Status einer Beschwerde.

type
type enumComplaintType

Die Art einer Beschwerde.

Firma
company companyLink

Ein Link zu einem Unternehmen.

orderReference
orderReference string

Auftragsverweis der Beschwerde

claimNumber
claimNumber string

Anspruchsnummer der Beschwerde.

Artikel
articles array of object

Die Artikel der Beschwerde.

articleNumber
articles.articleNumber string

Der Bezeichner eines Artikels.

Menge
articles.quantity integer

Die Menge des Artikels.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

Überwachung
audit responseAudit

Die Überwachungsinformationen.

responseGetComplaints

Name Pfad Typ Beschreibung
items
items array of responseGetComplaint

Eine Liste der Beschwerden.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetUserAccount

Name Pfad Typ Beschreibung
id
id string

ID des Benutzerkontos.

contacts
contacts array of contactLink

Eine Liste der Kontakte, die mit dem Benutzerkonto verbunden sind.

lastActiveAt
lastActiveAt string

Letzter Anmeldezeitstempel des Benutzerkontos im ISO-8601-Format.

responseGetRoles

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Rollen.

id
items.id string

ID der Rolle.

name
items.name string

Eindeutiger Name der Rolle.

Beschreibung
items.description string

Zusätzliche Informationen zur Rolle.

roleType
items.roleType string

Typ der Rolle

Sichtbarkeit
items.visibility string

Sichtbarkeit der Rolle.

defaultRoleForManufacturerCompany
items.defaultRoleForManufacturerCompany boolean

Ist die Rolle als Standard für neue Herstellerbenutzer konfiguriert?

defaultRoleForDistributorCompanies
items.defaultRoleForDistributorCompanies boolean

Ist die Rolle als Standard für neue Verteilerbenutzer konfiguriert?

companyId
items.companyId string

ID des Unternehmens, das die Rolle besitzt.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetPermissions

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Berechtigungen.

id
items.id string

ID der Berechtigung.

Code
items.code string

Eindeutiger Code der Berechtigung.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetSalesConditions

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Verkaufsbedingungen.

Code
items.code string

Eindeutiger Bedingungscode.

name
items.name string

Übersetzter Name der Bedingung.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetSupportedLanguages

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der unterstützten Sprachen.

isoCode
items.isoCode string

ISO-Code der Sprache.

nativeName
items.nativeName string

Nativer Name der Sprache.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetOutputDocumentTemplates

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Ausgabedokumentvorlagen.

id
items.id string

ID der Vorlage.

name
items.name string

Name der Vorlage.

languageCodes
items.languageCodes array of string

Die verfügbaren Sprachcodes für diese Vorlage im ISO 639-1-Format.

Überwachung
items.audit responseAudit

Die Überwachungsinformationen.

type
items.type enumOutputDocumentTemplateType

Typ der Ausgabedokumentvorlage.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetEvents

Name Pfad Typ Beschreibung
items
items array of object

Liste der Plattformereignisse.

eventId
items.eventId string

ID des Ereignisses.

eventType
items.eventType enumWebhookEventSubscription

Die Ereignisse, für die ein Webhook abonniert werden kann.

eventGroup
items.eventGroup enumEventGroup

Die Ereignisgruppe eines Ereignisses.

translationLabel
items.translationLabel string

Die Übersetzungsbezeichnung des Ereignisses.

Daten
items.data object

Daten des Ereignisses

userAccountId
items.userAccountId string

ID des Benutzerkontos, das das Ereignis initiiert hat.

translationParams
items.translationParams string

Parameter, die zum Übersetzen der Ereignisbezeichnung verwendet werden.

occurrenceTimestamp
items.occurrenceTimestamp string

Der Zeitstempel, zu dem das Ereignis aufgetreten ist.

removalTimestamp
items.removalTimestamp string

Der Zeitstempel, wenn das Ereignis entfernt wird.

distributorIds
items.distributorIds array of string

IDs von Distributoren.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetPluginToken

Name Pfad Typ Beschreibung
contacts
contacts array of object

Eine Liste von Kontakten.

contactId
contacts.contactId string

ID des Kontakts.

E-Mail
contacts.email string

E-Mail des Kontakts.

companyId
contacts.companyId string

Die ID des Unternehmens, zu dem der Kontakt gehört.

companyName
contacts.companyName string

Der Name des Unternehmens, zu dem der Kontakt gehört.

externalLinks
contacts.externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

userAccount
contacts.userAccount userAccountLink

Ein Link zu einem Benutzerkonto.

responseGetManufacturers

Name Pfad Typ Beschreibung
items
items array of object

Eine Liste der Hersteller.

id
items.id string

ID des Herstellers.

name
items.name string

Name des Herstellers.

gesamt
total responseTotalCount

Die Gesamtanzahl der Ergebnisse.

responseGetConfiguration

Name Pfad Typ Beschreibung
id
id string

ID der Konfiguration

configuredProduct
configuredProduct componentLink

Eine Verknüpfung mit einer Komponente.

configurationCode
configurationCode string

Ein eindeutiger Code, der diese Konfiguration identifiziert.

Beschreibungen
descriptions responseKeyValueTranslations
configurationStatus
configurationStatus enumConfigurationStatus

Status der Konfiguration.

Konfigurator
configurator configuratorLink

Eine Verknüpfung mit einem Konfigurator.

nodes
nodes array of responseConfigurationNode

Eine Sammlung von Konfigurationsknoten.

PurchasePrice
price.purchasePrice float

Kaufpreis der Konfiguration.

listPrice
price.listPrice float

Listenpreis der Konfiguration.

salesPrice
price.salesPrice float

Verkaufspreis der Konfiguration.

Währung
price.currency string

Währung der Konfiguration im ISO 4217-Format.

numberOfDecimals
price.numberOfDecimals integer

Die Dezimalgenauigkeit der Preise.

externalLinks
externalLinks externalLinks

Alle integrierten Systemverbindungen, die an diese Ressource angefügt sind.

responseAudit

Die Überwachungsinformationen.

Name Pfad Typ Beschreibung
createdBy
createdBy contactLink

Ein Link zu einem Kontakt.

ErstelltAm
createdAt createdAt

Zeitstempel der Objekterstellung.

aktualisiertvon
updatedBy contactLink

Ein Link zu einem Kontakt.

updatedAt
updatedAt updatedAt

Zeitstempel des neuesten Updates.

responseTotalCount

Die Gesamtanzahl der Ergebnisse.

Die Gesamtanzahl der Ergebnisse.

Schnur

Dies ist der grundlegende Datentyp "string".