Angebotsmanagement-API
Die Angebotsmanagement Die API stellt Endpunkte zum Erstellen, Aktualisieren und Abrufen von Kundenangebotsdaten bereit.
Die Angebotsmanagement Offen API ist ein ServiceNow Implementierung der REST-Spezifikation der TM Forum Quote Management API. Diese Implementierung basiert auf https://www.tmforum.org/resources/standard/tmf648-quote-management-api-rest-specification-r19-0-0/ .
Diese API kann erweitert werden, um Anpassungen an erforderlichen Parametern, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen.
Die Angebotsmanagement Die API erfordert das Plugin „Angebotsmanagement“ (com.sn_Quote_mgmt) und die Rolle „Quote_Integrator“. Diese API gehört zum Namespace sn_tmf_api. Weitere Informationen finden Sie unter Quote Management.
- Angebot [sn_Quote_mgmt_Core_Quote]
- Vertriebsvereinbarung [sn_Sales_agmt_Core_Sales_Agreement]
- Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item]
- Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal]
- Anpassung der Angebotspreise [sn_Quote_mgmt_Core_pricing_adjustment]
Angebotsmanagement-API – LÖSCHEN SIE /sn_tmf_api/Quote_Management_api/Quote/{ID}
Löscht das angegebene Angebot.
URL-Format
Versionierte URL: /api/sn_tmf_api/{api_Version}/Quote_Management_api/Quote/{ID}
Standard-URL: /api/sn_tmf_api/Quote_Management_api/Quote/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID des zu löschenden Angebots. Datentyp: Zeichenfolge Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 204 | Erfolgreich. Anforderung erfolgreich abgeschlossen, und das angegebene Angebot wurde gelöscht. Kein Inhalt. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
Parameter des Antwort-Haupttexts (JSON)
| Header | Beschreibung |
|---|---|
| Keine |
cURL-Anforderung
Dieses Beispiel zeigt, wie ein Angebot gelöscht wird.
curl "http://instance.servicenow.com/api/sn_tmf_api/quote_management_api/quote/cb15734fd5692a10f8774663edf0ac19" \
--request DELETE\
--header "Accept:application/json" \
--user 'username':'password'
Angebotsmanagement-API – GET /sn_tmf_api/Quote_Management_api/Quote
Ruft alle Angebote ab.
- Angebot [sn_Quote_mgmt_Core_Quote]
- Vertriebsvereinbarung [sn_Sales_agmt_Core_Sales_Agreement]
- Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item]
- Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal]
- Anpassung der Angebotspreise [sn_Quote_mgmt_Core_pricing_adjustment]
URL-Format
Versionierte URL: /api/sn_tmf_api/{api_Version}/Quote_Management_api/Quote
Standard-URL: /api/sn_tmf_api/Quote_Management_api/Quote
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder:
Datentyp: Zeichenfolge Standard: Alle Felder zurückgegeben. |
| id | Ergebnisse nach sys_ID des Angebots filtern Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] Datentyp: Zeichenfolge Standard: Leer |
| limit | Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 20 Maximum: 100 |
| Offset | Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Datentyp: Zahl Standard: 0 |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltsbereich | Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn |
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
|
| X-Gesamtzahl | Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung). |
| 206 | Teilressource als Antwort zurückgegeben (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| ContactMedium | Liste der Kontaktmedien. Kontaktinformationen im Zusammenhang mit der anfordernden Person des Angebots. |
| KontaktMittel.Stadt | Stadt, in der die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Land | Land, in dem die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| ContactMedium.LocationID | SYS_ID des Standorts, der in der Tabelle „Standort“ [cmn_location] oder in der anwenderdefinierten Adresse aufgeführt ist. Datentyp: Zeichenfolge |
| KontaktMedium.MediumType | Typ des Kontaktmediums, z. B. E-Mail-Adresse, Telefonnummer oder Postanschrift. Datentyp: Zeichenfolge |
| KontaktMedium.Postleitzahl | Postleitzahl der anfordernden Person des Angebots. Datentyp: Zeichenfolge |
| KontaktMedium.stateOrProvinz | Bundesland oder Kanton, in dem die anfordernde Person des Angebots wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Straße | Straße und Hausnummer der Angebotsanfordernden Person. Datentyp: Zeichenfolge |
| ContactMedium.@type | Typ des Mediums gemäß dem TMF Open API-Standard. Beispiel: GeographicalAddressContactMedium . Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Angebots. Datentyp: Zeichenfolge |
| ExpectedQuoteCompletionDate | Das erwartete Datum des Angebotslieferanten, um eine Antwort für dieses Angebot zurücksenden zu können. Datentyp: Zeichenfolge |
| externalId | Eindeutige vom Verbraucher bereitgestellte ID für das Angebot. Datentyp: Zeichenfolge |
| href | Relativer Link für den Zugriff auf das Angebot. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| id | SYS_ID des angeforderten Angebots. Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] Datentyp: Zeichenfolge |
| note | Liste der Notizen, die dem Angebot zugeordnet sind. Datentyp: Array |
| note.author | Anwendername der Person, die die zugehörige Notiz erstellt hat. Datentyp: Zeichenfolge |
| Hinweis.Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Hinweis.Text | Inhalt der Notiz. Datentyp: Zeichenfolge |
| Hinweis.@type | Dieser Wert ist immer Hinweis . Datentyp: Zeichenfolge |
| Angebotsdatum | Datum und Uhrzeit der Erstellung des Angebots. Datentyp: Zeichenfolge |
| QuoteItem | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| QuoteItem.action | Aktion, die für dieses Angebotselement ausgeführt werden soll (Hinzufügen, Ändern, Entfernen usw.). Datentyp: Zeichenfolge |
| quoteItem.id | SYS_ID des Angebotselements. Tabelle: Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item] Datentyp: Zeichenfolge |
| quoteItem.product | Liste der im Angebot enthaltenen Produkte.Datentyp: Objekt |
| quoteItem.product. Merkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten Weitere Informationen finden Sie unter Create product characteristics and characteristic options. |
| quoteItem.product. Merkmal.ID | SYS_ID des Produktmerkmals. Tabelle: Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal] Datentyp: Zeichenfolge |
| quoteItem.product. characteristic.name | Name des Produktmerkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.@Typ | Dieser Wert ist immer Zeichenfolgenmerkmal . Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Spezifikation | Detaillierte Beschreibung eines materiellen oder immateriellen Objekts, das extern in Form eines Produktangebots für Kunden oder andere Parteien verfügbar gemacht wird, die eine Parteirolle spielen. Datentyp: Zeichenfolge |
| quoteItem.product.@type | Dieser Wert ist immer Produkt . Datentyp: Zeichenfolge |
| quoteItem.productOffering | Eine Produktangebotsreferenz (ProductOfferingRef). Ein Produktangebot stellt Entitäten dar, die beim Anbieter des Katalogs bestellt werden können.Datentyp: Objekt |
| QuoteItem. Produktangebot.href | Referenz der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. Produktangebot.ID | SYS_ID des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| QuoteItem. productOffering.name | Name der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. ProductOffering.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| Angebotselement.Menge | Für diesen Angebotselement angeforderte Menge. Datentyp: Zahl |
| QuoteItem.State | Ein Angebotsstatustyp (QuoteStateType). Status des Angebots. Datentyp: Zeichenfolge |
| QuoteItem.@type | Dieser Wert ist immer Angebotselement . Datentyp: Zeichenfolge |
| Angebotsnummer | Datensatznummer der Angebotsposition, die dem Angebot zugewiesen ist. Tabelle: Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item] Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID der Angebotstabelle zum Abrufen des Accounts, Kontakts oder Kunden. Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge |
| ZugehörigPartei.Rolle | Die Rolle der Partei im Kontext des Angebots (z. B. Account, Kontakt oder Kunde). Datentyp: Zeichenfolge |
| RelatedParty.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| AnfordertQuoteCompletionDate | Ein Datum/Uhrzeit (Datum/Uhrzeit). Dieser Wert stellt das von der Angebotsanfordernden Person angegebene Datum dar, bis zu dem eine vollständige Antwort auf dieses Angebot erhalten soll. Datentyp: Zeichenfolge |
| Status | Status des Angebotselements. Datentyp: Zeichenfolge |
| @TYPE | Typ der Ressource. Dieser Wert ist immer Angebot . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel werden alle Angebote abgerufen.
curl "https://instance.service-now.com/api/sn_tmf_api/quote_management_api/quote" \
--request GET \
--header "Accept:application/json" \
--user 'userName':'password'
Antworttext.
{
"id": "47e562bad565a610f8774663edf0ac10",
"quoteNumber": "QT0001001",
"href": "api/sn_tmf_api/quote_management_api/quote/47e562bad565a610f8774663edf0ac10",
"@type": "Quote",
"description": "Testing Quote",
"expectedQuoteCompletionDate": "2025-05-23 11:12:08",
"externalId": "Test_1234",
"quoteDate": "2025-05-20 11:11:13",
"requestedQuoteCompletionDate": "2025-05-23 11:12:08",
"version": "3",
"agreement": [],
"contactMedium": [
{
"@type": "GeographicalAddressContactMedium",
"mediumType": "ShippingAddressRef",
"locationId": "6774fee611383110f877366201dea64f",
"city": "Santa Clara",
"country": "USA",
"postCode": "94560",
"stateOrProvince": "CA",
"street": "222 Star St"
}
],
"note": [],
"quoteItem": [
{
"id": "8be562bad565a610f8774663edf0ac16",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"id": "0fe562bad565a610f8774663edf0ac17",
"name": "Voice Pack",
"value": "1500 Minutes/Month"
},
{
"id": "4be562bad565a610f8774663edf0ac17",
"name": "SMS Pack",
"value": "700 /Month"
},
{
"id": "83e562bad565a610f8774663edf0ac18",
"name": "Data Pack",
"value": "20 GB/Month"
},
{
"id": "87e562bad565a610f8774663edf0ac17",
"name": "Mobile Number",
"value": ""
},
{
"id": "cfe562bad565a610f8774663edf0ac17",
"name": "Shipping Address",
"value": ""
}
],
"productSpecification": {
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"href": "api/sn_tmf_api/catalogmanagement/productSpecification/3ee1fdb1c3331010d216b5183c40dd81",
"name": "Mobile Plan",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "2cb5588fc30020105252716b7d40dddd",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/2cb5588fc30020105252716b7d40dddd",
"name": "All in one mobile plan starting from $49/month",
"@type": "ProductOfferingRef"
},
"quoteItemPrice": [
{
"description": "Standard Price List",
"name": "Standard Price List",
"priceType": "Recurring",
"recurringChargePeriod": "",
"unitOfMeasure": "",
"unitMarginPercentage": "",
"price": {
"totalOneTimePrice": {
"unit": "USD",
"value": 0
},
"monthlyRecurringPrice": {
"unit": "USD",
"value": 0
},
"annualRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeAnnualRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeNetPrice": {
"unit": "USD",
"value": 0
},
"unitMarginAmount": {
"unit": "USD",
"value": 0
},
"unitMarginBasePrice": {
"unit": "USD",
"value": 0
},
"listPrice": {
"unit": "USD",
"value": 0
},
"unitCost": {
"unit": "USD",
"value": 0
},
"unitPrice": {
"unit": "USD",
"value": 0
},
"dutyFreeAmount": {
"unit": "USD",
"value": 0
},
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
},
"priceAlteration": []
}
]
}
],
"relatedParty": [
{
"role": "Customer",
"id": "9e2fd2ee11b43110f877366201dea674",
"name": "Startech svcs",
"@type": "RelatedPartyRef",
"@referredType": "Organization"
},
{
"role": "CustomerContact",
"id": "dca96eaa11f43110f877366201dea6c1",
"name": "Alex Star",
"@type": "RelatedPartyRef",
"@referredType": "Individual"
}
],
"state": "Draft"
}
Angebotsmanagement-API – GET /sn_tmf_api/Quote_Management_api/Quote/{ID}
Ruft ein angegebenes Angebot ab.
- Angebot [sn_Quote_mgmt_Core_Quote]
- Vertriebsvereinbarung [sn_Sales_agmt_Core_Sales_Agreement]
- Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item]
- Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal]
- Anpassung der Angebotspreise [sn_Quote_mgmt_Core_pricing_adjustment]
URL-Format
Versionierte URL: /api/sn_tmf_api/{api_Version}/Quote_Management_api/Quote/{ID}
Standard-URL: /api/sn_tmf_api/Quote_Management_api/Quote/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID des abzurufenden Angebots. Datentyp: Zeichenfolge Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung). |
| 206 | Teilressource als Antwort zurückgegeben (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| ContactMedium | Liste der Kontaktmedien. Kontaktinformationen im Zusammenhang mit der anfordernden Person des Angebots. |
| KontaktMittel.Stadt | Stadt, in der die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Land | Land, in dem die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| ContactMedium.LocationID | SYS_ID des Standorts, der in der Tabelle „Standort“ [cmn_location] oder in der anwenderdefinierten Adresse aufgeführt ist. Datentyp: Zeichenfolge |
| KontaktMedium.MediumType | Typ des Kontaktmediums, z. B. E-Mail-Adresse, Telefonnummer oder Postanschrift. Datentyp: Zeichenfolge |
| KontaktMedium.Postleitzahl | Postleitzahl der anfordernden Person des Angebots. Datentyp: Zeichenfolge |
| KontaktMedium.stateOrProvinz | Bundesland oder Kanton, in dem die anfordernde Person des Angebots wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Straße | Straße und Hausnummer der Angebotsanfordernden Person. Datentyp: Zeichenfolge |
| ContactMedium.@type | Typ des Mediums gemäß dem TMF Open API-Standard. Beispiel: GeographicalAddressContactMedium . Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Angebots. Datentyp: Zeichenfolge |
| ExpectedQuoteCompletionDate | Das erwartete Datum des Angebotslieferanten, um eine Antwort für dieses Angebot zurücksenden zu können. Datentyp: Zeichenfolge |
| externalId | Eindeutige vom Verbraucher bereitgestellte ID für das Angebot. Datentyp: Zeichenfolge |
| href | Relativer Link für den Zugriff auf das Angebot. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| id | SYS_ID des angeforderten Angebots. Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] Datentyp: Zeichenfolge |
| note | Liste der Notizen, die dem Angebot zugeordnet sind. Datentyp: Array |
| note.author | Anwendername der Person, die die zugehörige Notiz erstellt hat. Datentyp: Zeichenfolge |
| Hinweis.Datum | Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge |
| Hinweis.Text | Inhalt der Notiz. Datentyp: Zeichenfolge |
| Hinweis.@type | Dieser Wert ist immer Hinweis . Datentyp: Zeichenfolge |
| Angebotsdatum | Datum und Uhrzeit der Erstellung des Angebots. Datentyp: Zeichenfolge |
| QuoteItem | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| QuoteItem.action | Aktion, die für dieses Angebotselement ausgeführt werden soll (Hinzufügen, Ändern, Entfernen usw.). Datentyp: Zeichenfolge |
| quoteItem.id | SYS_ID des Angebotselements. Tabelle: Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item] Datentyp: Zeichenfolge |
| quoteItem.product | Liste der im Angebot enthaltenen Produkte.Datentyp: Objekt |
| quoteItem.product. Merkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten Weitere Informationen finden Sie unter Create product characteristics and characteristic options. |
| quoteItem.product. Merkmal.ID | SYS_ID des Produktmerkmals. Tabelle: Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal] Datentyp: Zeichenfolge |
| quoteItem.product. characteristic.name | Name des Produktmerkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.@Typ | Dieser Wert ist immer Zeichenfolgenmerkmal . Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Spezifikation | Detaillierte Beschreibung eines materiellen oder immateriellen Objekts, das extern in Form eines Produktangebots für Kunden oder andere Parteien verfügbar gemacht wird, die eine Parteirolle spielen. Datentyp: Zeichenfolge |
| quoteItem.product.@type | Dieser Wert ist immer Produkt . Datentyp: Zeichenfolge |
| quoteItem.productOffering | Eine Produktangebotsreferenz (ProductOfferingRef). Ein Produktangebot stellt Entitäten dar, die beim Anbieter des Katalogs bestellt werden können.Datentyp: Objekt |
| QuoteItem. Produktangebot.href | Referenz der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. Produktangebot.ID | SYS_ID des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| QuoteItem. productOffering.name | Name der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. ProductOffering.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| Angebotselement.Menge | Für diesen Angebotselement angeforderte Menge. Datentyp: Zahl |
| QuoteItem.State | Ein Angebotsstatustyp (QuoteStateType). Status des Angebots. Datentyp: Zeichenfolge |
| QuoteItem.@type | Dieser Wert ist immer Angebotselement . Datentyp: Zeichenfolge |
| Angebotsnummer | Datensatznummer der Angebotsposition, die dem Angebot zugewiesen ist. Tabelle: Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item] Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID der Angebotstabelle zum Abrufen des Accounts, Kontakts oder Kunden. Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge |
| ZugehörigPartei.Rolle | Die Rolle der Partei im Kontext des Angebots (z. B. Account, Kontakt oder Kunde). Datentyp: Zeichenfolge |
| RelatedParty.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| AnfordertQuoteCompletionDate | Ein Datum/Uhrzeit (Datum/Uhrzeit). Dieser Wert stellt das von der Angebotsanfordernden Person angegebene Datum dar, bis zu dem eine vollständige Antwort auf dieses Angebot erhalten soll. Datentyp: Zeichenfolge |
| Status | Status des Angebotselements. Datentyp: Zeichenfolge |
| @TYPE | Typ der Ressource. Dieser Wert ist immer Angebot . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
Im folgenden Beispiel wird ein angegebenes Angebot abgerufen.
curl "https://instance.service-now.com/api/sn_tmf_api/quote_management_api/quote/04ba9004f11f3110f8777d7194f166f6" \
--request GET \
--header "Accept:application/json" \
--user 'userName':'password'
Antworttext.
{
"id": "47e562bad565a610f8774663edf0ac10",
"quoteNumber": "QT0001001",
"href": "api/sn_tmf_api/quote_management_api/quote/47e562bad565a610f8774663edf0ac10",
"@type": "Quote",
"description": "Testing Quote",
"expectedQuoteCompletionDate": "2025-05-23 11:12:08",
"externalId": "Test_1234",
"quoteDate": "2025-05-20 11:11:13",
"requestedQuoteCompletionDate": "2025-05-23 11:12:08",
"version": "3",
"agreement": [],
"contactMedium": [
{
"@type": "GeographicalAddressContactMedium",
"mediumType": "ShippingAddressRef",
"locationId": "6774fee611383110f877366201dea64f",
"city": "Santa Clara",
"country": "USA",
"postCode": "94560",
"stateOrProvince": "CA",
"street": "222 Star St"
}
],
"note": [],
"quoteItem": [
{
"id": "8be562bad565a610f8774663edf0ac16",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"id": "0fe562bad565a610f8774663edf0ac17",
"name": "Voice Pack",
"value": "1500 Minutes/Month"
},
{
"id": "4be562bad565a610f8774663edf0ac17",
"name": "SMS Pack",
"value": "700 /Month"
},
{
"id": "83e562bad565a610f8774663edf0ac18",
"name": "Data Pack",
"value": "20 GB/Month"
},
{
"id": "87e562bad565a610f8774663edf0ac17",
"name": "Mobile Number",
"value": ""
},
{
"id": "cfe562bad565a610f8774663edf0ac17",
"name": "Shipping Address",
"value": ""
}
],
"productSpecification": {
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"href": "api/sn_tmf_api/catalogmanagement/productSpecification/3ee1fdb1c3331010d216b5183c40dd81",
"name": "Mobile Plan",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "2cb5588fc30020105252716b7d40dddd",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/2cb5588fc30020105252716b7d40dddd",
"name": "All in one mobile plan starting from $49/month",
"@type": "ProductOfferingRef"
},
"quoteItemPrice": [
{
"description": "Standard Price List",
"name": "Standard Price List",
"priceType": "Recurring",
"recurringChargePeriod": "",
"unitOfMeasure": "",
"unitMarginPercentage": "",
"price": {
"totalOneTimePrice": {
"unit": "USD",
"value": 0
},
"monthlyRecurringPrice": {
"unit": "USD",
"value": 0
},
"annualRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeAnnualRecurringPrice": {
"unit": "USD",
"value": 0
},
"cumulativeNetPrice": {
"unit": "USD",
"value": 0
},
"unitMarginAmount": {
"unit": "USD",
"value": 0
},
"unitMarginBasePrice": {
"unit": "USD",
"value": 0
},
"listPrice": {
"unit": "USD",
"value": 0
},
"unitCost": {
"unit": "USD",
"value": 0
},
"unitPrice": {
"unit": "USD",
"value": 0
},
"dutyFreeAmount": {
"unit": "USD",
"value": 0
},
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
},
"priceAlteration": []
}
]
}
],
"relatedParty": [
{
"role": "Customer",
"id": "9e2fd2ee11b43110f877366201dea674",
"name": "Startech svcs",
"@type": "RelatedPartyRef",
"@referredType": "Organization"
},
{
"role": "CustomerContact",
"id": "dca96eaa11f43110f877366201dea6c1",
"name": "Alex Star",
"@type": "RelatedPartyRef",
"@referredType": "Individual"
}
],
"state": "Draft"
}
Angebotsmanagement-API – PATCH /sn_tmf_api/Quote_Management_api/Quote/{ID}
Aktualisiert das angegebene Angebot.
URL-Format
Versionierte URL: /api/sn_tmf_api/{api_Version}/Quote_Management_api/Quote/{ID}
Standard-URL: /api/sn_tmf_api/Quote_Management_api/Quote/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID des zu aktualisierenden Angebots. Datentyp: Zeichenfolge Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| ContactMedium | Liste der Kontaktmedien. Kontaktinformationen im Zusammenhang mit der anfordernden Person des Angebots. |
| KontaktMittel.Stadt | Stadt, in der die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Land | Land, in dem die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| ContactMedium.LocationID | SYS_ID des Standorts, der in der Tabelle „Standort“ [cmn_location] oder in der anwenderdefinierten Adresse aufgeführt ist. Datentyp: Zeichenfolge |
| KontaktMedium.MediumType | Typ des Kontaktmediums, z. B. E-Mail-Adresse, Telefonnummer oder Postanschrift. Datentyp: Zeichenfolge |
| KontaktMedium.Postleitzahl | Postleitzahl der anfordernden Person des Angebots. Datentyp: Zeichenfolge |
| KontaktMedium.stateOrProvinz | Bundesland oder Kanton, in dem die anfordernde Person des Angebots wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Straße | Straße und Hausnummer der Angebotsanfordernden Person. Datentyp: Zeichenfolge |
| ContactMedium.@type | Typ des Mediums gemäß dem TMF Open API-Standard. Beispiel: GeographicalAddressContactMedium . Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Angebots. Datentyp: Zeichenfolge |
| note | Liste der Notizen, die dem Angebot zugeordnet sind. Datentyp: Array |
| Hinweis.Text | Inhalt der Notiz. Datentyp: Zeichenfolge |
| Hinweis.@type | Dieser Wert ist immer Hinweis . Datentyp: Zeichenfolge |
| Angebotsdatum | Datum und Uhrzeit der Erstellung des Angebots. Datentyp: Zeichenfolge |
| QuoteItem | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| QuoteItem.action | Aktion, die für dieses Angebotselement ausgeführt werden soll (Hinzufügen, Ändern, Entfernen usw.). Datentyp: Zeichenfolge |
| quoteItem.id | SYS_ID des Angebotselements. Tabelle: Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item] Datentyp: Zeichenfolge |
| quoteItem.product | Liste der im Angebot enthaltenen Produkte.Datentyp: Objekt |
| quoteItem.product. Merkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten Weitere Informationen finden Sie unter Create product characteristics and characteristic options. |
| quoteItem.product. Merkmal.ID | SYS_ID des Produktmerkmals. Tabelle: Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal] Datentyp: Zeichenfolge |
| quoteItem.product. characteristic.name | Name des Produktmerkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.@Typ | Dieser Wert ist immer Zeichenfolgenmerkmal . Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Spezifikation | Detaillierte Beschreibung eines materiellen oder immateriellen Objekts, das extern in Form eines Produktangebots für Kunden oder andere Parteien verfügbar gemacht wird, die eine Parteirolle spielen. Datentyp: Zeichenfolge |
| quoteItem.product.@type | Dieser Wert ist immer Produkt . Datentyp: Zeichenfolge |
| quoteItem.productOffering | Eine Produktangebotsreferenz (ProductOfferingRef). Ein Produktangebot stellt Entitäten dar, die beim Anbieter des Katalogs bestellt werden können.Datentyp: Objekt |
| QuoteItem. Produktangebot.href | Referenz der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. Produktangebot.ID | SYS_ID des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| QuoteItem. productOffering.name | Name der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. ProductOffering.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| quoteItem.productRelationship | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| quoteItem.productRelationship. Produkt | Eine Produktreferenz oder ein Wert (ProductRefOrValue). Ein Erzeugnis, das durch einen Wert definiert werden soll, oder ein vorhandenes, durch eine Referenz definiert wird. Das Produkt erfüllt eines der folgenden Kriterien:
Datentyp: Zeichenfolge |
| quoteItem.productRelationship. Beziehungstyp | Typ der Produktbeziehung, z. B. Gebündelt Wenn das Produkt ein Paket ist und Sie die gebündelten Produkte in beschreiben möchten. Datentyp: Zeichenfolge |
| Angebotselement.Menge | Für diesen Angebotselement angeforderte Menge. Datentyp: Zahl |
| QuoteItem.State | Ein Angebotsstatustyp (QuoteStateType). Status des Angebots. Datentyp: Zeichenfolge |
| QuoteItem.@type | Dieser Wert ist immer Angebotselement . Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID der Angebotstabelle zum Abrufen des Accounts, Kontakts oder Kunden. Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge |
| ZugehörigPartei.Rolle | Die Rolle der Partei im Kontext des Angebots (z. B. Account, Kontakt oder Kunde). Datentyp: Zeichenfolge |
| RelatedParty.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| Status | Status des Angebotselements. Datentyp: Zeichenfolge |
| @TYPE | Typ der Ressource. Dieser Wert ist immer Angebot . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| ContactMedium | Liste der Kontaktmedien. Kontaktinformationen im Zusammenhang mit der anfordernden Person des Angebots. |
| KontaktMittel.Stadt | Stadt, in der die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Land | Land, in dem die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| ContactMedium.LocationID | SYS_ID des Standorts, der in der Tabelle „Standort“ [cmn_location] oder in der anwenderdefinierten Adresse aufgeführt ist. Datentyp: Zeichenfolge |
| KontaktMedium.MediumType | Typ des Kontaktmediums, z. B. E-Mail-Adresse, Telefonnummer oder Postanschrift. Datentyp: Zeichenfolge |
| KontaktMedium.Postleitzahl | Postleitzahl der anfordernden Person des Angebots. Datentyp: Zeichenfolge |
| KontaktMedium.stateOrProvinz | Bundesland oder Kanton, in dem die anfordernde Person des Angebots wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Straße | Straße und Hausnummer der Angebotsanfordernden Person. Datentyp: Zeichenfolge |
| ContactMedium.@type | Typ des Mediums gemäß dem TMF Open API-Standard. Beispiel: GeographicalAddressContactMedium . Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Angebots. Datentyp: Zeichenfolge |
| note | Liste der Notizen, die dem Angebot zugeordnet sind. Datentyp: Array |
| Hinweis.Text | Inhalt der Notiz. Datentyp: Zeichenfolge |
| Hinweis.@type | Dieser Wert ist immer Hinweis . Datentyp: Zeichenfolge |
| Angebotsdatum | Datum und Uhrzeit der Erstellung des Angebots. Datentyp: Zeichenfolge |
| QuoteItem | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| QuoteItem.action | Aktion, die für dieses Angebotselement ausgeführt werden soll (Hinzufügen, Ändern, Entfernen usw.). Datentyp: Zeichenfolge |
| QuoteItem.ID | SYS_ID des Angebotselements. Tabelle: Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item] Datentyp: Zeichenfolge |
| quoteItem.product | Liste der im Angebot enthaltenen Produkte.Datentyp: Objekt |
| quoteItem.product. Merkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten Weitere Informationen finden Sie unter Create product characteristics and characteristic options. |
| quoteItem.product. Merkmal.ID | SYS_ID des Produktmerkmals. Tabelle: Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal] Datentyp: Zeichenfolge |
| quoteItem.product. characteristic.name | Name des Produktmerkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.@Typ | Dieser Wert ist immer Zeichenfolgenmerkmal . Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Spezifikation | Detaillierte Beschreibung eines materiellen oder immateriellen Objekts, das extern in Form eines Produktangebots für Kunden oder andere Parteien verfügbar gemacht wird, die eine Parteirolle spielen. Datentyp: Zeichenfolge |
| quoteItem.product.@type | Dieser Wert ist immer Produkt . Datentyp: Zeichenfolge |
| quoteItem.productOffering | Eine Produktangebotsreferenz (ProductOfferingRef). Ein Produktangebot stellt Entitäten dar, die beim Anbieter des Katalogs bestellt werden können.Datentyp: Objekt |
| QuoteItem. Produktangebot.href | Referenz der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. Produktangebot.ID | SYS_ID des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| QuoteItem. productOffering.name | Name der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. ProductOffering.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| quoteItem.productRelationship | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| quoteItem.productRelationship. Produkt | Eine Produktreferenz oder ein Wert (ProductRefOrValue). Ein Erzeugnis, das durch einen Wert definiert werden soll, oder ein vorhandenes, durch eine Referenz definiert wird. Das Produkt erfüllt eines der folgenden Kriterien:
Datentyp: Zeichenfolge |
| quoteItem.productRelationship. Beziehungstyp | Typ der Produktbeziehung, z. B. Gebündelt Wenn das Produkt ein Paket ist und Sie die gebündelten Produkte in beschreiben möchten. Datentyp: Zeichenfolge |
| Angebotselement.Menge | Für diesen Angebotselement angeforderte Menge. Datentyp: Zahl |
| QuoteItem.State | Ein Angebotsstatustyp (QuoteStateType). Status des Angebots. Datentyp: Zeichenfolge |
| QuoteItem.@type | Dieser Wert ist immer Angebotselement . Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten |
| ZugehörigPartei.ID | SYS_ID der Angebotstabelle zum Abrufen des Accounts, Kontakts oder Kunden. Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge |
| ZugehörigPartei.Rolle | Die Rolle der Partei im Kontext des Angebots (z. B. Account, Kontakt oder Kunde). Datentyp: Zeichenfolge |
| RelatedParty.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| Status | Status des Angebotselements. Datentyp: Zeichenfolge |
| @TYPE | Typ der Ressource. Dieser Wert ist immer Angebot . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel zeigt, wie ein Angebot aktualisiert wird.
curl "https://k8s0747687-node1.thunder.devsnc.com/api/sn_tmf_api/quote_management_api/quote/cb15734fd5692a10f8774663edf0ac19" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"@type\": \"Quote\",
\"description\": \"Quote for Internet and OTT Bundle\",
\"contactMedium\": [
{
\"@type\": \"GeographicalAddressContactMedium\",
\"mediumType\": \"ShippingAddressRef\",
\"locationId\": \"25ab96060a0a0bb300a6d66ce72095f2\",
\"city\": \"Santa Clara\",
\"country\": \"USA\",
\"postCode\": \"95050\",
\"stateOrProvince\": \"CA\",
\"street\": \"2866 Stevens Creek Blvd\"
}
],
\"note\": [
{
\"@type\": \"Note\",
\"text\": \"This is a quote request following today call\"
}
],
\"quoteItem\": [
{
\"id\": \"086be79bd5e1aa10f8774663edf0acba\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"ffeb447211bc3110f877366201dea6df\",
\"name\": \"Internet and OTT Bundle\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"597bab9bd5e1aa10f8774663edf0ac1b\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"d57bab9bd5e1aa10f8774663edf0ac1a\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"d57bab9bd5e1aa10f8774663edf0ac1c\",
\"relationshipType\": \"HasChild\"
}
]
},
{
\"id\": \"d57bab9bd5e1aa10f8774663edf0ac1a\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"0761dd9fd0a63110f8770dbf976be173\",
\"name\": \"Solana Modem N Series\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"086be79bd5e1aa10f8774663edf0acba\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"597bab9bd5e1aa10f8774663edf0ac1b\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"8b61dd9fd0a63110f8770dbf976be140\",
\"name\": \"Basic internet - 100 Mbps Plan\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"086be79bd5e1aa10f8774663edf0acba\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"d57bab9bd5e1aa10f8774663edf0ac1c\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"62619d9fd0a63110f8770dbf976be180\",
\"name\": \"Solana Movie streaming channel\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"086be79bd5e1aa10f8774663edf0acba\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\",
\"productCharacteristic\": [
{
\"name\": \"Internet breakout\",
\"value\": \"No\"
},
{
\"name\": \"Quality of Service\",
\"value\": \"Basic\"
},
{
\"name\": \"Speed\",
\"value\": \"High\"
}
],
\"productSpecification\": {
\"id\": \"cd81594e74ae4a10f877468e695efa81\",
\"name\": \"VPN Site PS\",
\"@type\": \"ProductSpecificationRef\"
}
},
\"productOffering\": {
\"id\": \"6c3d1e86a5e20210f8774c9b4be6ce42\",
\"name\": \"VPN Site\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"7f8c6b1fd5e1aa10f8774663edf0ac71\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"bb8c6b1fd5e1aa10f8774663edf0ac73\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"bf8c6b1fd5e1aa10f8774663edf0ac70\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"fb8c6b1fd5e1aa10f8774663edf0ac72\",
\"relationshipType\": \"HasChild\"
}
]
},
{
\"id\": \"bf8c6b1fd5e1aa10f8774663edf0ac70\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"2c265d4274ee4a10f877468e695efa45\",
\"name\": \"Maintenance Fee\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"7f8c6b1fd5e1aa10f8774663edf0ac71\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"4466d50674ee4a10f877468e695efa0d\",
\"name\": \"Security Fee\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"fb8c6b1fd5e1aa10f8774663edf0ac72\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\",
\"productCharacteristic\": [
{
\"name\": \"Speed\",
\"value\": \"High\"
},
{
\"name\": \"Internet breakout\",
\"value\": \"No\"
}
],
\"productSpecification\": {
\"id\": \"ee4f8d8a74ae4a10f877468e695efa3f\",
\"name\": \"VPN Endpoint PS\",
\"@type\": \"ProductSpecificationRef\"
}
},
\"productOffering\": {
\"id\": \"7acc9e46a5e20210f8774c9b4be6ce9e\",
\"name\": \"VPN Endpoint\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"bb8c6b1fd5e1aa10f8774663edf0ac73\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\",
\"productCharacteristic\": [
{
\"name\": \"Quality of Service\",
\"value\": \"Basic\"
}
],
\"productSpecification\": {
\"id\": \"3ba0914e74ae4a10f877468e695efa6e\",
\"name\": \"VPN Firewall PS\",
\"@type\": \"ProductSpecificationRef\"
}
},
\"productOffering\": {
\"id\": \"4407d90674ee4a10f877468e695efaab\",
\"name\": \"VPN Firewall\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"797ca71fd5e1aa10f8774663edf0ac2b\",
\"relationshipType\": \"HasParent\"
}
]
}
],
\"relatedParty\": [
{
\"role\": \"Customer\",
\"id\": \"9e2fd2ee11b43110f877366201dea674\",
\"name\": \"Startech svcs\",
\"@type\": \"RelatedPartyRef\",
\"@referredType\": \"Organization\"
}
],
\"state\": \"Draft\"
}" \
--user 'userName':'password'
Antworttext.
{
"@type": "Quote",
"description": "Quote for Internet and OTT Bundle",
"contactMedium": [
{
"@type": "GeographicalAddressContactMedium",
"mediumType": "ShippingAddressRef",
"locationId": "25ab96060a0a0bb300a6d66ce72095f2",
"city": "Santa Clara",
"country": "USA",
"postCode": "95050",
"stateOrProvince": "CA",
"street": "2866 Stevens Creek Blvd"
}
],
"note": [
{
"@type": "Note",
"text": "This is a quote request following today call"
}
],
"quoteItem": [
{
"id": "086be79bd5e1aa10f8774663edf0acba",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "ffeb447211bc3110f877366201dea6df",
"name": "Internet and OTT Bundle",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "597bab9bd5e1aa10f8774663edf0ac1b",
"relationshipType": "HasChild"
},
{
"product": "d57bab9bd5e1aa10f8774663edf0ac1a",
"relationshipType": "HasChild"
},
{
"product": "d57bab9bd5e1aa10f8774663edf0ac1c",
"relationshipType": "HasChild"
}
]
},
{
"id": "d57bab9bd5e1aa10f8774663edf0ac1a",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "0761dd9fd0a63110f8770dbf976be173",
"name": "Solana Modem N Series",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "086be79bd5e1aa10f8774663edf0acba",
"relationshipType": "HasParent"
}
]
},
{
"id": "597bab9bd5e1aa10f8774663edf0ac1b",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "8b61dd9fd0a63110f8770dbf976be140",
"name": "Basic internet - 100 Mbps Plan",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "086be79bd5e1aa10f8774663edf0acba",
"relationshipType": "HasParent"
}
]
},
{
"id": "d57bab9bd5e1aa10f8774663edf0ac1c",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "086be79bd5e1aa10f8774663edf0acba",
"relationshipType": "HasParent"
}
]
},
{
"id": "797ca71fd5e1aa10f8774663edf0ac2b",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Internet breakout",
"value": "No"
},
{
"name": "Quality of Service",
"value": "Basic"
},
{
"name": "Speed",
"value": "High"
}
],
"productSpecification": {
"id": "cd81594e74ae4a10f877468e695efa81",
"name": "VPN Site PS",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "6c3d1e86a5e20210f8774c9b4be6ce42",
"name": "VPN Site",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "7f8c6b1fd5e1aa10f8774663edf0ac71",
"relationshipType": "HasChild"
},
{
"product": "bb8c6b1fd5e1aa10f8774663edf0ac73",
"relationshipType": "HasChild"
},
{
"product": "bf8c6b1fd5e1aa10f8774663edf0ac70",
"relationshipType": "HasChild"
},
{
"product": "fb8c6b1fd5e1aa10f8774663edf0ac72",
"relationshipType": "HasChild"
}
]
},
{
"id": "bf8c6b1fd5e1aa10f8774663edf0ac70",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "2c265d4274ee4a10f877468e695efa45",
"name": "Maintenance Fee",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "797ca71fd5e1aa10f8774663edf0ac2b",
"relationshipType": "HasParent"
}
]
},
{
"id": "7f8c6b1fd5e1aa10f8774663edf0ac71",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "4466d50674ee4a10f877468e695efa0d",
"name": "Security Fee",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "797ca71fd5e1aa10f8774663edf0ac2b",
"relationshipType": "HasParent"
}
]
},
{
"id": "fb8c6b1fd5e1aa10f8774663edf0ac72",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Speed",
"value": "High"
},
{
"name": "Internet breakout",
"value": "No"
}
],
"productSpecification": {
"id": "ee4f8d8a74ae4a10f877468e695efa3f",
"name": "VPN Endpoint PS",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "7acc9e46a5e20210f8774c9b4be6ce9e",
"name": "VPN Endpoint",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "797ca71fd5e1aa10f8774663edf0ac2b",
"relationshipType": "HasParent"
}
]
},
{
"id": "bb8c6b1fd5e1aa10f8774663edf0ac73",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Quality of Service",
"value": "Basic"
}
],
"productSpecification": {
"id": "3ba0914e74ae4a10f877468e695efa6e",
"name": "VPN Firewall PS",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "4407d90674ee4a10f877468e695efaab",
"name": "VPN Firewall",
"@type": "ProductOfferingRef"
},
"productRelationship": [
{
"product": "797ca71fd5e1aa10f8774663edf0ac2b",
"relationshipType": "HasParent"
}
]
}
],
"relatedParty": [
{
"role": "Customer",
"id": "9e2fd2ee11b43110f877366201dea674",
"name": "Startech svcs",
"@type": "RelatedPartyRef",
"@referredType": "Organization"
}
],
"state": "Draft",
"id": "cb15734fd5692a10f8774663edf0ac19",
"version": "2",
"quoteDate": "2025-05-21 04:56:50",
"href": "api/sn_tmf_api/quote_management_api/quote/cb15734fd5692a10f8774663edf0ac19"
}
Angebotsmanagement-API: POST /sn_tmf_api/Quote_Management_api/Quote
Erstellt ein Angebot.
- Angebot [sn_Quote_mgmt_Core_Quote]
- Vertriebsvereinbarung [sn_Sales_agmt_Core_Sales_Agreement]
- Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item]
- Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal]
- Anpassung der Angebotspreise [sn_Quote_mgmt_Core_pricing_adjustment]
URL-Format
Versionierte URL: /api/sn_tmf_api/{api_Version}/Quote_Management_api/Quote
Standard-URL: /api/sn_tmf_api/Quote_Management_api/Quote
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| ContactMedium | Liste der Kontaktmedien. Kontaktinformationen im Zusammenhang mit der anfordernden Person des Angebots. |
| KontaktMittel.Stadt | Stadt, in der die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Land | Land, in dem die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| ContactMedium.LocationID | SYS_ID des Standorts, der in der Tabelle „Standort“ [cmn_location] oder in der anwenderdefinierten Adresse aufgeführt ist. Datentyp: Zeichenfolge |
| KontaktMedium.MediumType | Typ des Kontaktmediums, z. B. E-Mail-Adresse, Telefonnummer oder Postanschrift. Datentyp: Zeichenfolge |
| KontaktMedium.Postleitzahl | Postleitzahl der anfordernden Person des Angebots. Datentyp: Zeichenfolge |
| KontaktMedium.stateOrProvinz | Bundesland oder Kanton, in dem die anfordernde Person des Angebots wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Straße | Straße und Hausnummer der Angebotsanfordernden Person. Datentyp: Zeichenfolge |
| ContactMedium.@type | Typ des Mediums gemäß dem TMF Open API-Standard. Beispiel: GeographicalAddressContactMedium . Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Angebots. Datentyp: Zeichenfolge |
| externalId | Eindeutige vom Verbraucher bereitgestellte ID für das Angebot. Datentyp: Zeichenfolge |
| href | Relativer Link für den Zugriff auf das Angebot. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Hinweis | Liste der Notizen, die dem Angebot zugeordnet sind. Datentyp: Array |
| Hinweis.Text | Inhalt der Notiz. Datentyp: Zeichenfolge |
| Hinweis.@type | Dieser Wert ist immer Hinweis . Datentyp: Zeichenfolge |
| Angebotsdatum | Datum und Uhrzeit der Erstellung des Angebots. Datentyp: Zeichenfolge |
| QuoteItem | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| QuoteItem.action | Aktion, die für dieses Angebotselement ausgeführt werden soll (Hinzufügen, Ändern, Entfernen usw.). Datentyp: Zeichenfolge |
| quoteItem.id | SYS_ID des Angebotselements. Tabelle: Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item] Datentyp: Zeichenfolge |
| quoteItem.product | Liste der im Angebot enthaltenen Produkte.Datentyp: Objekt |
| quoteItem.product. Merkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten Weitere Informationen finden Sie unter Create product characteristics and characteristic options. |
| quoteItem.product. Merkmal.ID | SYS_ID des Produktmerkmals. Tabelle: Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal] Datentyp: Zeichenfolge |
| quoteItem.product. characteristic.name | Name des Produktmerkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.@Typ | Dieser Wert ist immer Zeichenfolgenmerkmal . Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Spezifikation | Detaillierte Beschreibung eines materiellen oder immateriellen Objekts, das extern in Form eines Produktangebots für Kunden oder andere Parteien verfügbar gemacht wird, die eine Parteirolle spielen. Datentyp: Zeichenfolge |
| quoteItem.product.@type | Dieser Wert ist immer Produkt . Datentyp: Zeichenfolge |
| quoteItem.productOffering | Eine Produktangebotsreferenz (ProductOfferingRef). Ein Produktangebot stellt Entitäten dar, die beim Anbieter des Katalogs bestellt werden können.Datentyp: Objekt |
| QuoteItem. Produktangebot.href | Referenz der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. Produktangebot.ID | SYS_ID des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| QuoteItem. productOffering.name | Name der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. ProductOffering.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| quoteItem.productRelationship | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| quoteItem.productRelationship. Produkt | Eine Produktreferenz oder ein Wert (ProductRefOrValue). Ein Erzeugnis, das durch einen Wert definiert werden soll, oder ein vorhandenes, durch eine Referenz definiert wird. Das Produkt erfüllt eines der folgenden Kriterien:
Datentyp: Zeichenfolge |
| quoteItem.productRelationship. Beziehungstyp | Typ der Produktbeziehung, z. B. Gebündelt Wenn das Produkt ein Paket ist und Sie die gebündelten Produkte in beschreiben möchten. Datentyp: Zeichenfolge |
| Angebotselement.Menge | Für diesen Angebotselement angeforderte Menge. Datentyp: Zahl |
| QuoteItem.State | Ein Angebotsstatustyp (QuoteStateType). Status des Angebots. Datentyp: Zeichenfolge |
| QuoteItem.@type | Dieser Wert ist immer Angebotselement . Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID der Angebotstabelle zum Abrufen des Accounts, Kontakts oder Kunden. Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge |
| ZugehörigPartei.Rolle | Die Rolle der Partei im Kontext des Angebots (z. B. Account, Kontakt oder Kunde). Datentyp: Zeichenfolge |
| RelatedParty.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| Status | Status des Angebotselements. Datentyp: Zeichenfolge |
| @TYPE | Typ der Ressource. Dieser Wert ist immer Angebot . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Mögliche Gründe:
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| ContactMedium | Liste der Kontaktmedien. Kontaktinformationen im Zusammenhang mit der anfordernden Person des Angebots. |
| KontaktMittel.Stadt | Stadt, in der die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Land | Land, in dem die Angebotsanfordernde Person wohnt. Datentyp: Zeichenfolge |
| ContactMedium.LocationID | SYS_ID des Standorts, der in der Tabelle „Standort“ [cmn_location] oder in der anwenderdefinierten Adresse aufgeführt ist. Datentyp: Zeichenfolge |
| KontaktMedium.MediumType | Typ des Kontaktmediums, z. B. E-Mail-Adresse, Telefonnummer oder Postanschrift. Datentyp: Zeichenfolge |
| KontaktMedium.Postleitzahl | Postleitzahl der anfordernden Person des Angebots. Datentyp: Zeichenfolge |
| KontaktMedium.stateOrProvinz | Bundesland oder Kanton, in dem die anfordernde Person des Angebots wohnt. Datentyp: Zeichenfolge |
| KontaktMittel.Straße | Straße und Hausnummer der Angebotsanfordernden Person. Datentyp: Zeichenfolge |
| ContactMedium.@type | Typ des Mediums gemäß dem TMF Open API-Standard. Beispiel: GeographicalAddressContactMedium . Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Angebots. Datentyp: Zeichenfolge |
| externalId | Eindeutige vom Verbraucher bereitgestellte ID für das Angebot. Datentyp: Zeichenfolge |
| href | Relativer Link für den Zugriff auf das Angebot. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Hinweis | Liste der Notizen, die dem Angebot zugeordnet sind. Datentyp: Array |
| Hinweis.Text | Inhalt der Notiz. Datentyp: Zeichenfolge |
| Hinweis.@type | Dieser Wert ist immer Hinweis . Datentyp: Zeichenfolge |
| Angebotsdatum | Datum und Uhrzeit der Erstellung des Angebots. Datentyp: Zeichenfolge |
| QuoteItem | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| QuoteItem.action | Aktion, die für dieses Angebotselement ausgeführt werden soll (Hinzufügen, Ändern, Entfernen usw.). Datentyp: Zeichenfolge |
| QuoteItem.ID | SYS_ID des Angebotselements. Tabelle: Angebotsposition [sn_Quote_mgmt_Core_Quote_line_item] Datentyp: Zeichenfolge |
| quoteItem.product | Liste der im Angebot enthaltenen Produkte.Datentyp: Objekt |
| quoteItem.product. Merkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten Weitere Informationen finden Sie unter Create product characteristics and characteristic options. |
| quoteItem.product. Merkmal.ID | SYS_ID des Produktmerkmals. Tabelle: Merkmal der Angebotsposition [sn_Quote_mgmt_Core_Quote_line_Merkmal] Datentyp: Zeichenfolge |
| quoteItem.product. characteristic.name | Name des Produktmerkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.@Typ | Dieser Wert ist immer Zeichenfolgenmerkmal . Datentyp: Zeichenfolge |
| quoteItem.product. Merkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| quoteItem.product. Spezifikation | Detaillierte Beschreibung eines materiellen oder immateriellen Objekts, das extern in Form eines Produktangebots für Kunden oder andere Parteien verfügbar gemacht wird, die eine Parteirolle spielen. Datentyp: Zeichenfolge |
| quoteItem.product.@type | Dieser Wert ist immer Produkt . Datentyp: Zeichenfolge |
| quoteItem.productOffering | Eine Produktangebotsreferenz (ProductOfferingRef). Ein Produktangebot stellt Entitäten dar, die beim Anbieter des Katalogs bestellt werden können.Datentyp: Objekt |
| QuoteItem. Produktangebot.href | Referenz der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. Produktangebot.ID | SYS_ID des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| QuoteItem. productOffering.name | Name der zugehörigen Entität. Datentyp: Zeichenfolge |
| QuoteItem. ProductOffering.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| quoteItem.productRelationship | Eine Liste von Angebotselementen. Jedes Angebotselement beschreibt eine Aktion für ein Produkt, das angeboten werden soll.Datentyp: Array von Objekten |
| quoteItem.productRelationship. Produkt | Eine Produktreferenz oder ein Wert (ProductRefOrValue). Ein Erzeugnis, das durch einen Wert definiert werden soll, oder ein vorhandenes, durch eine Referenz definiert wird. Das Produkt erfüllt eines der folgenden Kriterien:
Datentyp: Zeichenfolge |
| quoteItem.productRelationship. Beziehungstyp | Typ der Produktbeziehung, z. B. Gebündelt Wenn das Produkt ein Paket ist und Sie die gebündelten Produkte in beschreiben möchten. Datentyp: Zeichenfolge |
| Angebotselement.Menge | Für diesen Angebotselement angeforderte Menge. Datentyp: Zahl |
| QuoteItem.State | Ein Angebotsstatustyp (QuoteStateType). Status des Angebots. Datentyp: Zeichenfolge |
| QuoteItem.@type | Dieser Wert ist immer Angebotselement . Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Datentyp: Array von Objekten |
| ZugehörigPartei.ID | SYS_ID der Angebotstabelle zum Abrufen des Accounts, Kontakts oder Kunden. Tabelle: Angebot [sn_Quote_mgmt_Core_Quote] Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge |
| ZugehörigPartei.Rolle | Die Rolle der Partei im Kontext des Angebots (z. B. Account, Kontakt oder Kunde). Datentyp: Zeichenfolge |
| RelatedParty.@type | Dieser Wert ist immer ProduktangebotsRef . Datentyp: Zeichenfolge |
| Status | Status des Angebotselements. Datentyp: Zeichenfolge |
| @TYPE | Typ der Ressource. Dieser Wert ist immer Angebot . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
Das folgende Beispiel zeigt, wie ein Angebot erstellt wird.
curl "http://localhost:8080/api/sn_tmf_api/quote_management_api/quote" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"@type\": \"Quote\",
\"description\": \"Quote for Internet and OTT Bundle\",
\"state\": \"Draft\",
\"externalId\": \"12233\",
\"contactMedium\": [
{
\"@type\": \"GeographicalAddressContactMedium\",
\"mediumType\": \"ShippingAddressRef\",
\"locationId\": \"6774fee611383110f877366201dea64f\",
\"city\": \"Santa Clara\",
\"country\": \"USA\",
\"postCode\": \"95050\",
\"stateOrProvince\": \"CA\",
\"street\": \"2866 Stevens Creek Blvd\"
}
],
\"note\": [
{
\"@type\": \"Note\",
\"text\": \"This is a quote request for the Internet and OTT Bundle\"
}
],
\"quoteItem\": [
{
\"id\": \"ea88d77c4165ae10f8776348db5f9196\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"ffeb447211bc3110f877366201dea6df\",
\"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/ffeb447211bc3110f877366201dea6df\",
\"name\": \"Internet and OTT Bundle\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"3688d77c4165ae10f8776348db5f91cf\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"3a881b7c4165ae10f8776348db5f911b\",
\"relationshipType\": \"HasChild\"
},
{
\"product\": \"7e88d77c4165ae10f8776348db5f91fb\",
\"relationshipType\": \"HasChild\"
}
]
},
{
\"id\": \"3688d77c4165ae10f8776348db5f91cf\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"0761dd9fd0a63110f8770dbf976be173\",
\"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/0761dd9fd0a63110f8770dbf976be173\",
\"name\": \"Solana Modem N Series\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"ea88d77c4165ae10f8776348db5f9196\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"7e88d77c4165ae10f8776348db5f91fb\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"8b61dd9fd0a63110f8770dbf976be140\",
\"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/8b61dd9fd0a63110f8770dbf976be140\",
\"name\": \"Basic internet - 100 Mbps Plan\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"ea88d77c4165ae10f8776348db5f9196\",
\"relationshipType\": \"HasParent\"
}
]
},
{
\"id\": \"3a881b7c4165ae10f8776348db5f911b\",
\"@type\": \"QuoteItem\",
\"action\": \"add\",
\"quantity\": \"1\",
\"state\": \"Draft\",
\"product\": {
\"@type\": \"Product\"
},
\"productOffering\": {
\"id\": \"62619d9fd0a63110f8770dbf976be180\",
\"href\": \"api/sn_tmf_api/catalogmanagement/productOffering/62619d9fd0a63110f8770dbf976be180\",
\"name\": \"Solana Movie streaming channel\",
\"@type\": \"ProductOfferingRef\"
},
\"productRelationship\": [
{
\"product\": \"ea88d77c4165ae10f8776348db5f9196\",
\"relationshipType\": \"HasParent\"
}
]
}
],
\"relatedParty\": [
{
\"role\": \"Customer\",
\"id\": \"ab9a0e8b2fc9a610b79db3bf42faf3a6\",
\"name\": \"Funco Intl\",
\"@type\": \"RelatedPartyRef\",
\"@referredType\": \"Organization\"
}
]
}" \
--user 'userName':'password'
Antworttext.
{
"@type": "Quote",
"description": "Quote for Internet and OTT Bundle",
"state": "Draft",
"externalId": "12233",
"contactMedium": [
{
"@type": "GeographicalAddressContactMedium",
"mediumType": "ShippingAddressRef",
"locationId": "6774fee611383110f877366201dea64f",
"city": "Santa Clara",
"country": "USA",
"postCode": "95050",
"stateOrProvince": "CA",
"street": "2866 Stevens Creek Blvd"
}
],
"note": [
{
"@type": "Note",
"text": "This is a quote request for the Internet and OTT Bundle"
}
],
"quoteItem": [
{
"id": "ea88d77c4165ae10f8776348db5f9196",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "ffeb447211bc3110f877366201dea6df",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/ffeb447211bc3110f877366201dea6df",
"name": "Internet and OTT Bundle",
"@type": "ProductOfferingRef",
"internalVersion": "1",
"version": "",
"internalId": "ffeb447211bc3110f877366201dea6df"
},
"productRelationship": [
{
"product": "3688d77c4165ae10f8776348db5f91cf",
"relationshipType": "HasChild"
},
{
"product": "3a881b7c4165ae10f8776348db5f911b",
"relationshipType": "HasChild"
},
{
"product": "7e88d77c4165ae10f8776348db5f91fb",
"relationshipType": "HasChild"
}
]
},
{
"id": "3688d77c4165ae10f8776348db5f91cf",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "0761dd9fd0a63110f8770dbf976be173",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/0761dd9fd0a63110f8770dbf976be173",
"name": "Solana Modem N Series",
"@type": "ProductOfferingRef",
"internalVersion": "1",
"version": "",
"internalId": "0761dd9fd0a63110f8770dbf976be173"
},
"productRelationship": [
{
"product": "ea88d77c4165ae10f8776348db5f9196",
"relationshipType": "HasParent"
}
]
},
{
"id": "7e88d77c4165ae10f8776348db5f91fb",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "8b61dd9fd0a63110f8770dbf976be140",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/8b61dd9fd0a63110f8770dbf976be140",
"name": "Basic internet - 100 Mbps Plan",
"@type": "ProductOfferingRef",
"internalVersion": "1",
"version": "",
"internalId": "8b61dd9fd0a63110f8770dbf976be140"
},
"productRelationship": [
{
"product": "ea88d77c4165ae10f8776348db5f9196",
"relationshipType": "HasParent"
}
]
},
{
"id": "3a881b7c4165ae10f8776348db5f911b",
"@type": "QuoteItem",
"action": "add",
"quantity": "1",
"state": "Draft",
"product": {
"@type": "Product"
},
"productOffering": {
"id": "62619d9fd0a63110f8770dbf976be180",
"href": "api/sn_tmf_api/catalogmanagement/productOffering/62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"@type": "ProductOfferingRef",
"internalVersion": "1",
"version": "",
"internalId": "62619d9fd0a63110f8770dbf976be180"
},
"productRelationship": [
{
"product": "ea88d77c4165ae10f8776348db5f9196",
"relationshipType": "HasParent"
}
]
}
],
"relatedParty": [
{
"role": "Customer",
"id": "ab9a0e8b2fc9a610b79db3bf42faf3a6",
"name": "Funco Intl",
"@type": "RelatedPartyRef",
"@referredType": "Organization"
}
],
"id": "acc805bcfff5a610b79dffffffffffe6",
"href": "api/sn_tmf_api/quote_management_api/quote/acc805bcfff5a610b79dffffffffffe6"
}