Offene API für Produktbestellung
Die Produktauftrag Offen Die API stellt Endpunkte bereit, die einen standardisierten Mechanismus für die Platzierung von Produktbestellungen ermöglichen.
Eine Produktbestellung wird basierend auf einem Produktangebot erstellt, das in einem Produktkatalog definiert und veröffentlicht ist. Das Produktangebot identifiziert das Produkt oder den Satz von Produkten, die einem Kunden zur Verfügung stehen, und enthält die relevanten Produktmerkmale, die die eindeutigen Optionen eines Produkts erfassen, sowie andere relevante Attribute wie Preise, Vertragsbedingungen und Verfügbarkeit.
Um auf diese API zuzugreifen, muss das Plugin „Auftragsmanagement für Telekommunikation“ (sn_ind_tmt_orm) aktiviert sein.
Diese API wird in bereitgestellt sn_ind_tmt_orm Namespace.
Der aufrufende Anwender muss über die Rolle sn_ind_tmt_orm.order_integrator verfügen.
Diese API kann erweitert werden, um Anpassungen an erforderlichen Parametern, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unterDie Produktbestellung – API-Entwicklerleitfaden öffnen .
Die Produktauftrag Offen API ist ein ServiceNow® Implementierung der REST-Spezifikation der TM Forum TMF622 Product Order Management API und ist von TM Forum zertifiziert.
Produktbestellungs-API öffnen – GET /sn_ind_tmt_orm/order/productOrder
Ruft alle Produktbestellungen ab.
- Kundenauftrag [sn_ind_tmt_orm_order]
- Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
- Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
- Auftragspositionselementkontakt [sn_ind_tmt_orm_order_line_item_contact]
- Auftragspositionsbezogene Elemente [sn_ind_tmt_orm_order_line_related_items]
URL-Format
Standard-URL: /api/sn_ind_tmt_orm/order/productOrder
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. Datentyp: Zeichenfolge Standard: Alle Felder zurückgegeben. |
| 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 |
| Status | Reihenfolge nach Status filtern. Nur Aufträge mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge Standard: Nicht nach Status sortieren. |
| 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 |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen.
Datentyp: Array von Objekten |
| Kanal.ID | Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| committedDueDate | Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge |
| ExpectedCompletionDate | Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge |
| href | Relativer Link zum Produktbestellungsdatensatz. Datentyp: Zeichenfolge |
| id | SYS_ID der Produktbestellung. Datentyp: Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten |
| 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 | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung.
Datentyp: Zeichenfolge |
| Bestellwährung | Währungscode für den Auftrag und die Auftragspositionen. Datentyp: Zeichenfolge |
| Ponr | Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten |
| ProduktbestellungElement.Aktion | Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert.
Datentyp: Zeichenfolge |
| ProduktbestellungElement.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge |
| ProduktbestellungElement.extern Produktbestand | Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array von Objekten |
| ProduktbestellungElement.externalProduktbestand.externalProduktbestellungId | Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge |
| productOrderItem.id | Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist.
Datentyp: Array von Objekten |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludedAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Währungscode, in dem der Preis dargestellt wird.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Preis des Produkts, einschließlich Steuern.
Datentyp: Zahl |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat .
Datentyp: Zeichenfolge |
| ProduktbestellungElement.ponr | Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| productOrderItem.product | Beschreibung der Instanzdetails des vom Kunden gekauften Produkts. Datentyp: Objekt |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll.
Datentyp: Objekt |
| productOrderItem.product.place.id | SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location].
Datentyp: Zeichenfolge |
| productOrderItem.product.place.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Ort . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts. Nur Produktmerkmale, deren valueUnterscheiden sich von previousValueWerden zurückgegeben. Datentyp: Array von Objekten |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.valueType | Typ des Merkmalwerts. Mögliche Werte:
Datentyp: Zeichenfolge |
| productOrderItem.product.productRelationship | Liste der Produktbeziehungsdetails für eine Auftragsposition. Datentyp: Array von Objekten |
| productOrderItem.product.productRelationship.id | SYS_ID oder sn_prd_invt_external_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „sn_prd_invt_external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_Product_Inventory]. |
| productOrderItem.product.productRelationship.relationshipType | Typ der Beziehung zwischen der Auftragsposition und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.product.productSpecification.id | Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.internalId | Anfangsversion der Produktspezifikation. Die Anfangsversion ist die sys_ID der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.internalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.version | Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten. Datentyp: Array von Objekten |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.id | SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact].
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts.
Datentyp: Zeichenfolge Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden.
Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.productOffering.id | Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.internalId | Anfangsversion des Produktangebots. Die Anfangsversion ist die sys_ID der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.internalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| ProduktbestellungArtikel.Menge | Anzahl der gekauften Produktartikel. Datentyp: Zahl |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen.
Datentyp: Array von Objekten |
| productOrderItem.productOrderItemRelationship.id | Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren.
Mögliche Werte:
HasChild Und Übergeordnetes Element Werden für übergeordnete/untergeordnete Beziehungen verwendet. Erforderlich Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten).Datentyp: Zeichenfolge |
| ProduktbestellungElement.Status | Status der Bestellung des zugehörigen Produktartikels. Datentyp: Zeichenfolge |
| ProduktbestellungElement.Version | Auftragsversion. Datentyp: Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer].
Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden.
Mögliche Werte:
Datentyp: Zeichenfolge |
| RelatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum.
Datentyp: Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags.
Datentyp: Zeichenfolge |
| Status | Aktueller Status des Auftrags. Datentyp: Zeichenfolge |
| Version | Auftragsversion. Datentyp: Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel werden alle Produktbestellungen abgerufen.
curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder' \
--user 'username':'password'
Antworttext.
[
{
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"orderCurrency": "USD",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "v1",
"internalVersion": "1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "v1",
"internalVersion": "1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "v1",
"internalVersion": "1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI110",
"relationshipType": "Requires"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "v1",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
]
Produktbestellungs-API – GET /sn_ind_tmt_orm/order/productOrder/{ID}
Ruft die angegebene Produktbestellung ab.
- Kundenauftrag [sn_ind_tmt_orm_order]
- Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
- Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
- Auftragspositionselementkontakt [sn_ind_tmt_orm_order_line_item_contact]
- Auftragspositionsbezogene Elemente [sn_ind_tmt_orm_order_line_related_items]
URL-Format
Standard-URL: /api/sn_ind_tmt_orm/order/productOrder/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID oder external_ID des abzurufenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order] |
| 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).
Die Antwort gibt erfolgreich mit einer Fehlermeldung zurück, wenn für den ausgewählten Auftrag Verarbeitungsprobleme auftreten.
|
| 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 |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen.
Datentyp: Array von Objekten |
| Kanal.ID | Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| committedDueDate | Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge |
| ExpectedCompletionDate | Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge |
| href | Relativer Link zum Produktbestellungsdatensatz. Datentyp: Zeichenfolge |
| id | SYS_ID der Produktbestellung. Datentyp: Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten |
| 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 | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung.
Datentyp: Zeichenfolge |
| Bestellwährung | Währungscode für den Auftrag und die Auftragspositionen. Datentyp: Zeichenfolge |
| Ponr | Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten |
| ProduktbestellungElement.Aktion | Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert.
Datentyp: Zeichenfolge |
| ProduktbestellungElement.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge |
| ProduktbestellungElement.extern Produktbestand | Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array von Objekten |
| ProduktbestellungElement.externalProduktbestand.externalProduktbestellungId | Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge |
| productOrderItem.id | Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist.
Datentyp: Array von Objekten |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludedAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Währungscode, in dem der Preis dargestellt wird.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Preis des Produkts, einschließlich Steuern.
Datentyp: Zahl |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat .
Datentyp: Zeichenfolge |
| ProduktbestellungElement.ponr | Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| productOrderItem.product | Beschreibung der Instanzdetails des vom Kunden gekauften Produkts. Datentyp: Objekt |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll.
Datentyp: Objekt |
| productOrderItem.product.place.id | SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location].
Datentyp: Zeichenfolge |
| productOrderItem.product.place.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Ort . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts. Nur Produktmerkmale, deren valueUnterscheiden sich von previousValueWerden zurückgegeben. Datentyp: Array von Objekten |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.valueType | Typ des Merkmalwerts. Mögliche Werte:
Datentyp: Zeichenfolge |
| productOrderItem.product.productRelationship | Liste der Produktbeziehungsdetails für eine Auftragsposition. Datentyp: Array von Objekten |
| productOrderItem.product.productRelationship.id | SYS_ID oder sn_prd_invt_external_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „sn_prd_invt_external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_Product_Inventory]. |
| productOrderItem.product.productRelationship.relationshipType | Typ der Beziehung zwischen der Auftragsposition und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.product.productSpecification.id | Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.internalId | Anfangsversion der Produktspezifikation. Die Anfangsversion ist die sys_ID der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.internalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.version | Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten. Datentyp: Array von Objekten |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.id | SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact].
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts.
Datentyp: Zeichenfolge Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden.
Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.productOffering.id | Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.internalId | Anfangsversion des Produktangebots. Die Anfangsversion ist die sys_ID der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.internalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| ProduktbestellungArtikel.Menge | Anzahl der gekauften Produktartikel. Datentyp: Zahl |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen.
Datentyp: Array von Objekten |
| productOrderItem.productOrderItemRelationship.id | Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren.
Mögliche Werte:
HasChild Und Übergeordnetes Element Werden für übergeordnete/untergeordnete Beziehungen verwendet. Erforderlich Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten).Datentyp: Zeichenfolge |
| ProduktbestellungElement.Status | Status der Bestellung des zugehörigen Produktartikels. Datentyp: Zeichenfolge |
| ProduktbestellungElement.Version | Auftragsversion. Datentyp: Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer].
Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden.
Mögliche Werte:
Datentyp: Zeichenfolge |
| RelatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum.
Datentyp: Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags.
Datentyp: Zeichenfolge |
| Status | Aktueller Status des Auftrags. Datentyp: Zeichenfolge |
| Version | Auftragsversion. Datentyp: Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel wird eine angegebene Produktbestellung abgerufen.
curl -X GET "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"
Antworttext.
{
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"orderCurrency": "USD",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "v1",
"internalVersion": "1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "v1",
"internalVersion": "1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "v1",
"internalVersion": "1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI110",
"relationshipType": "Requires"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "v1",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
Produktbestellung – API öffnen – GET /sn_ind_tmt_orm/productorder
Ruft alle Produktbestellungen ab.
- Kundenauftrag [sn_ind_tmt_orm_order]
- Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
- Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
- Auftragspositionselementkontakt [sn_ind_tmt_orm_order_line_item_contact]
URL-Format
Standard-URL: /api/sn_ind_tmt_orm/productorder
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. Datentyp: Zeichenfolge Standard: Alle Felder zurückgegeben. |
| 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 |
| Status | Reihenfolge nach Status filtern. Nur Aufträge mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge Standard: Alle status zurückgegeben. |
| 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 |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen.
Datentyp: Array von Objekten |
| Kanal.ID | Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| ExpectedCompletionDate | Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten |
| 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 | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung.
Datentyp: Zeichenfolge |
| Ponr | Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten |
| ProduktbestellungElement.Aktion | Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert.
Datentyp: Zeichenfolge |
| ProduktbestellungElement.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.id | Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist.
Datentyp: Array von Objekten |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludedAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Währungscode, in dem der Preis dargestellt wird.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Preis des Produkts, einschließlich Steuern.
Datentyp: Zahl |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat .
Datentyp: Zeichenfolge |
| ProduktbestellungElement.ponr | Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| productOrderItem.product | Beschreibung der Instanzdetails des vom Kunden gekauften Produkts. Datentyp: Objekt |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll.
Datentyp: Objekt |
| productOrderItem.product.place.id | SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location].
Datentyp: Zeichenfolge |
| productOrderItem.product.place.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Ort . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts. Nur Produktmerkmale, deren valueUnterscheiden sich von previousValueWerden zurückgegeben. Datentyp: Array von Objekten |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.valueType | Typ des Merkmalwerts. Mögliche Werte:
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.product.productSpecification.id | Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten. Datentyp: Array von Objekten |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.id | SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact].
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts.
Datentyp: Zeichenfolge Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden.
Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist.
Datentyp: Objekt |
| productOrderItem.productOffering.id | Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der gekauften Produktartikel. Datentyp: Zahl |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen.
Datentyp: Array von Objekten |
| productOrderItem.productOrderItemRelationship.id | Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren.
Mögliche Werte:
HasChild Und Übergeordnetes Element Werden für übergeordnete/untergeordnete Beziehungen verwendet. Erforderlich Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten).Datentyp: Zeichenfolge |
| ProduktbestellungElement.Status | Status der Bestellung des zugehörigen Produktartikels. Datentyp: Zeichenfolge |
| ProduktbestellungElement.Version | Auftragsversion. Datentyp: Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer].
Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden.
Mögliche Werte:
Datentyp: Zeichenfolge |
| RelatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum.
Datentyp: Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags.
Datentyp: Zeichenfolge |
| Status | Aktueller Status des Auftrags. Datentyp: Zeichenfolge |
| Version | Auftragsversion. Datentyp: Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel werden alle Produktbestellungen abgerufen.
curl --location --request GET 'https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder' \
--user 'username':'password'
Antworttext.
[
{
"id": "8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
]
Produktbestellungs-API – GET /sn_ind_tmt_orm/productorder/{ID}
Ruft die angegebene Produktbestellung ab.
- Kundenauftrag [sn_ind_tmt_orm_order]
- Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
- Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
- Auftragspositionselementkontakt [sn_ind_tmt_orm_order_line_item_contact]
URL-Format
Standard-URL: /api/sn_ind_tmt_orm/productorder/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID oder external_ID des abzurufenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order] |
| 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 |
|---|---|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Kann aus einem der folgenden Gründe sein:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen.
Datentyp: Array von Objekten |
| Kanal.ID | Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| ExpectedCompletionDate | Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Objekt |
| 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 | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung.
Datentyp: Zeichenfolge |
| Ponr | Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten |
| ProduktbestellungElement.Aktion | Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert.
Datentyp: Zeichenfolge |
| ProduktbestellungElement.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.id | Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist.
Datentyp: Array von Objekten |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludedAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Währungscode, in dem der Preis dargestellt wird.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Preis des Produkts, einschließlich Steuern.
Datentyp: Zahl |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat .
Datentyp: Zeichenfolge |
| ProduktbestellungElement.ponr | Kennzeichnung, die angibt, ob der Punkt, an dem der Auftrag nicht zurückgegeben wurde, erreicht wurde. Mögliche Werte:
Datentyp: Boolesch |
| productOrderItem.product | Beschreibung der Instanzdetails des vom Kunden gekauften Produkts. Datentyp: Objekt |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll.
Datentyp: Objekt |
| productOrderItem.product.place.id | SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location].
Datentyp: Zeichenfolge |
| productOrderItem.product.place.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Ort . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts. Nur Produktmerkmale, deren valueUnterscheiden sich von previousValueWerden zurückgegeben. Datentyp: Array von Objekten |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.valueType | Typ des Merkmalwerts. Mögliche Werte:
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.product.productSpecification.id | Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten. Datentyp: Objekt |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.id | SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact].
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden.
Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist.
Datentyp: Objekt |
| productOrderItem.productOffering.id | Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der gekauften Produktartikel. Datentyp: Zahl |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen.
Datentyp: Array von Objekten |
| productOrderItem.productOrderItemRelationship.id | Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren.
Mögliche Werte:
HasChild Und Übergeordnetes Element Werden für übergeordnete/untergeordnete Beziehungen verwendet. Erforderlich Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten).Datentyp: Zeichenfolge |
| ProduktbestellungElement.Status | Status der Bestellung des zugehörigen Produktartikels. Datentyp: Zeichenfolge |
| ProduktbestellungElement.Version | Auftragsversion. Datentyp: Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer].
Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden.
Mögliche Werte:
Datentyp: Zeichenfolge |
| RelatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum.
Datentyp: Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags.
Datentyp: Zeichenfolge |
| Status | Aktueller Status des Auftrags. Datentyp: Zeichenfolge |
| Version | Auftragsversion. Datentyp: Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel fordert einen vorhandenen Kundenauftrag an.
curl -X GET "https://servicenow-instance/api/sn_ind_tmt_orm/productorder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"
Antworttext.
{
"id": "8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
Produktbestellungs-API – PATCH /sn_ind_tmt_orm/order/productOrder/{ID}
Aktualisiert den angegebenen Kundenauftrag.
URL-Format
Standard-URL: /api/sn_ind_tmt_orm/order/productOrder/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID des zu aktualisierenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order |
| Kanal.ID | Erforderlich, wenn channelParameter wird verwendet. Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge Tabelle: Im Feld external_ID der Tabelle „Verteilungskanal“ [sn_prd_pm_Distribution_Channel]. Gespeichert in: Das Kanalfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen werden auf der Registerkarte Auswahlliste im Kanalwörterbucheintrag der Tabelle „sn_ind_tmt_orm_order“ definiert. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| committedDueDate | Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Wenn die Aktion für Auftragspositionen lautet Anhalten Oder Fortsetzen , Dieser Parameter kann nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „sn_ind_tmt_orm_order“. |
| externalId | Eindeutiger Bezeichner für den Kundenauftrag. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order |
| Hinweis.Text | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Das Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| Bestellwährung | Währungscode für den Auftrag und die Auftragspositionen. Das Aktualisieren des Währungscodes eines vorhandenen Auftrags wird nicht unterstützt. Wenn Sie einen anderen Wert als den Währungscode angeben, der dem Auftrag bereits zugeordnet ist, wird die Aktualisierung abgelehnt. Datentyp: Zeichenfolge |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item |
| ProduktbestellungElement.Aktion | Erforderlich, wenn productOrderItemParameter wird verwendet. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert. Mögliche Werte:
Datentyp: Zeichenfolge Gespeichert in: Das Aktionsfeld der Tabelle „sn_ind_tmt_orm_order_line_item“. Standard: Hinzufügen |
| ProduktbestellungElement.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Wenn die Aktion für das Element lautet Anhalten Oder Fortsetzen , Dieser Parameter kann nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „sn_ind_tmt_orm_order_line_item“. |
| ProduktbestellungElement.extern Produktbestand | Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten Hinweis: Beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID wurde der Vorgang zuvor abgebrochen und ein Fehler zurückgegeben. Mit Xanadu Release: Dieser Parameter wird einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben wird und kein Fehler ausgelöst wird. |
| ProduktbestellungElement.externalProduktbestand.externalProduktbestellungId | Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_Inventory_ID“ der Tabelle „sn_ind_tmt_orm_order_line_item“ und das Feld „sn_prd_invt_external_ID“ der Tabelle „sn_prd_invt_Product_Inventory“. |
| Produktauftragselement.ID | Erforderlich, wenn productOrderItemParameter wird verwendet. Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Tabelle „sn_ind_tmt_orm_order_line_item“. Maximale Länge: 40 Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludedAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge Gespeichert in: Das mrc- oder nrc-Feld in der Tabelle „sn_ind_tmt_orm_order_line_item“. |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Gespeichert in: Das mrc- oder nrc-Feld in der Tabelle „sn_ind_tmt_orm_order_line_item“. |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend. Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat . Datentyp: Zeichenfolge |
| productOrderItem.product | Erforderlich, wenn productOrderItem.actionIst Change oder DELETE. Beschreibung der Instanzdetails des vom Kunden gekauften Produkts. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.id | Erforderlich, wenn productOrderItem.actionIst Change oder DELETE. Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld „sys_ID“ oder „sn_ind_tmt_orm_external_ID“ der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory]. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.place.id | Erforderlich, wenn productOrderItem.product.placeParameter wird verwendet. SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge Gespeichert in: Das Standortfeld der Tabelle „sn_ind_tmt_orm_order_line_item“. Standard: Leere Zeichenfolge |
| productOrderItem.product.place.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Ort . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal]. Datentyp: Zeichenfolge Gespeichert in: Das Merkmalsfeld der Tabelle „sn_ind_tmt_orm_order_characteristic_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: The previous_Characteristic_Option_value der Tabelle „sn_ind_tmt_orm_order_Characteristic_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Das Feld „Merkmal_Option_Wert“ der Tabelle „sn_ind_tmt_orm_order_Merkmal_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.valueType | Typ des Merkmalwerts. Datentyp: Zeichenfolge Mögliche Werte:
|
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Hinweis:
Änderungsreihenfolgen ( productOrderItem.actionIst Ändern ) Werden je nach Wert von unterschiedlich verarbeitet sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderSystemeigenschaft. Der Wert dieser Systemeigenschaft bestimmt, wie der Auftrag verarbeitet wird, wenn der Produktbestand eine andere Version als in der Bestellung angegeben ist.
Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.id | Erforderlich, wenn productOrderItem.product.productSpecificationParameter wird verwendet. Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.internalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.version | External_Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das E-Mail-Feld der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das Feld „first_Name“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.id | SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge Gespeichert in: Das Feld „sys_ID“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das Feld lastName der Tabelle sn_ind_tmt_orm_order_line_item_contact. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Feld „Business_Phone“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | |
| productOrderItem.product.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produkt . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | Erforderlich, wenn productOrderItem.productOfferingParameter wird verwendet. Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| productOrderItem.productOffering.internalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| productOrderItem.productOffering.version | External_Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOrderItem.quantity | Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl Gespeichert in: Das Mengenfeld von sn_ind_tmt_orm_order. Standard: Null |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | Erforderlich, wenn productOrderItem.productOrderItemRelationshipParameter wird verwendet. Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Gespeichert in: Das Feld parent_line_item der Tabelle „debsn_ind_tmt_orm_order_line_item“. Standard: Leere Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte:
HasChild Und Übergeordnetes Element Werden für übergeordnete/untergeordnete Beziehungen verwendet. Erforderlich Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten).Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der bestellten Artikel. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| ProduktOrderElement.revisionVorgang | Typ der Aktualisierung, die für die Position ausgeführt werden soll. Wenn dieser Wert leer ist, wird die vorhandene Position aktualisiert, oder eine neue Position wird hinzugefügt, wenn sie nicht bereits vorhanden ist. Wenn dieser Wert ist Abbrechen , Die Position wird abgebrochen. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | |
| ZugehörigPartei.ID | |
| relatedParty.name | |
| RelatedParty.@referredType | |
| RelatedParty.@type | |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Gespeichert in: Das Feld expected_end_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge Gespeichert in: Feld expected_Start_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
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. |
| 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 |
|---|---|
| 201 | Erfolgreich. Wenn Probleme mit den Informationen zur Option „Merkmale“ oder „Merkmale“ auftreten, speichert der Endpunkt die folgenden Kommentare in den Feldern „Arbeitsnotizen“ des zugehörigen Kundenauftrags-Positionselementdatensatzes:
|
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen.
Datentyp: Array von Objekten |
| Kanal.ID | Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| committedDueDate | Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge |
| externalId | Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge |
| href | Relativer Link zum Produktbestellungsdatensatz. Datentyp: Zeichenfolge |
| id | SYS_ID des Kundenauftrags, der für diese Anforderung aktualisiert wurde. Datentyp: Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat.
Datentyp: Array von Objekten |
| Hinweis.Text | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung.
Datentyp: Zeichenfolge |
| Bestellwährung | Währungscode für den Auftrag und die Auftragspositionen. Datentyp: Zeichenfolge |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten |
| ProduktbestellungElement.Aktion | Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert.
Datentyp: Zeichenfolge |
| ProduktbestellungElement.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge |
| ProduktbestellungElement.extern Produktbestand | Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten Hinweis: Beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID wurde der Vorgang zuvor abgebrochen und ein Fehler zurückgegeben. Mit Xanadu Release: Dieser Parameter wird einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben wird und kein Fehler ausgelöst wird. |
| ProduktbestellungElement.externalProduktbestand.externalProduktbestellungId | Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge |
| productOrderItem.id | Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist.
Datentyp: Array von Objekten |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludeAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludeAmount.unit | Währungscode, in dem der Preis dargestellt wird.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludeAmount.value | Preis des Produkts, einschließlich Steuern.
Datentyp: Zahl |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat .
Datentyp: Zeichenfolge |
| productOrderItem.product | Beschreibung der Instanzdetails des vom Kunden gekauften Produkts.
Datentyp: Objekt |
| productOrderItem.product.id | Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld „sys_ID“ oder „sn_ind_tmt_orm_external_ID“ der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory].
Datentyp: Zeichenfolge |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll.
Datentyp: Objekt |
| productOrderItem.product.place.id | SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.product.productSpecification.id | Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.internalId | Anfangsversion der Produktspezifikation. Die Anfangsversion ist die sys_ID der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.internalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.version | Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten.
Datentyp: Array von Objekten |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.id | SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact].
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden.
Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produkt . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.productOffering.id | Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.internalId | Anfangsversion des Produktangebots. Die Anfangsversion ist die sys_ID der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.internalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen.
Datentyp: Array von Objekten |
| productOrderItem.productOrderItemRelationship.id | Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren.
Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der zugeordneten Artikel, die bestellt werden sollen.
Datentyp: Zahl |
| ProduktbestellungElement.Status | Aktueller Status des Produktbestellelements. Datentyp: Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält.
Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer].
Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers.
Datentyp: Zeichenfolge |
| ZugehörigPartei.Typ | Typ des Kunden.
Mögliche Werte:
Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum.
Datentyp: Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags.
Datentyp: Zeichenfolge |
| Status | Aktueller Status des Auftrags. Datentyp: Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel wird der Kanal für eine Produktbestellung aktualisiert.
curl -X PATCH "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
]
}
Antworttext.
{
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"externalId": "PO-456",
"orderCurrency": "USD",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "v1",
"internalVersion": "1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "v1",
"internalVersion": "1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "v1",
"internalVersion": "1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "v1",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"@type": "ProductOrder"
}
Produktbestellungs-API – PATCH /sn_ind_tmt_orm/productorder/{ID}
Aktualisiert den angegebenen Kundenauftrag.
URL-Format
Standard-URL: /api/sn_ind_tmt_orm/productorder/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID des zu aktualisierenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order |
| Kanal.ID | Erforderlich, wenn channelParameter wird verwendet. Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge Tabelle: Im Feld external_ID der Tabelle „Verteilungskanal“ [sn_prd_pm_Distribution_Channel]. Gespeichert in: Das Kanalfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen werden auf der Registerkarte Auswahlliste im Kanalwörterbucheintrag der Tabelle „sn_ind_tmt_orm_order“ definiert. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| committedDueDate | Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Wenn die Aktion für Auftragspositionen lautet Anhalten Oder Fortsetzen , Dieser Parameter kann nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „sn_ind_tmt_orm_order“. |
| externalId | Eindeutiger Bezeichner für den Kundenauftrag. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order |
| Hinweis.Text | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Das Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| Bestellwährung | Währungscode für den Auftrag und die Auftragspositionen. Das Aktualisieren des Währungscodes eines vorhandenen Auftrags wird nicht unterstützt. Wenn Sie einen anderen Wert als den Währungscode angeben, der dem Auftrag bereits zugeordnet ist, wird die Aktualisierung abgelehnt. Datentyp: Zeichenfolge |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item |
| ProduktbestellungElement.Aktion | Erforderlich, wenn productOrderItemParameter wird verwendet. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert. Mögliche Werte:
Datentyp: Zeichenfolge Gespeichert in: Das Aktionsfeld der Tabelle „sn_ind_tmt_orm_order_line_item“. Standard: Hinzufügen |
| ProduktbestellungElement.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Wenn die Aktion für das Element lautet Anhalten Oder Fortsetzen , Dieser Parameter kann nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „sn_ind_tmt_orm_order_line_item“. |
| ProduktbestellungElement.extern Produktbestand | Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten Hinweis: Beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID wurde der Vorgang zuvor abgebrochen und ein Fehler zurückgegeben. Mit Xanadu Release: Dieser Parameter wird einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben wird und kein Fehler ausgelöst wird. |
| ProduktbestellungElement.externalProduktbestand.externalProduktbestellungId | Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_Inventory_ID“ der Tabelle „sn_ind_tmt_orm_order_line_item“ und das Feld „sn_prd_invt_external_ID“ der Tabelle „sn_prd_invt_Product_Inventory“. |
| Produktauftragselement.ID | Erforderlich, wenn productOrderItemParameter wird verwendet. Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Tabelle „sn_ind_tmt_orm_order_line_item“. Maximale Länge: 40 Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludedAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge Gespeichert in: Das mrc- oder nrc-Feld in der Tabelle „sn_ind_tmt_orm_order_line_item“. |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Gespeichert in: Das mrc- oder nrc-Feld in der Tabelle „sn_ind_tmt_orm_order_line_item“. |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend. Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat . Datentyp: Zeichenfolge |
| productOrderItem.product | Erforderlich, wenn productOrderItem.actionIst Change oder DELETE. Beschreibung der Instanzdetails des vom Kunden gekauften Produkts. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.id | Erforderlich, wenn productOrderItem.actionIst Change oder DELETE. Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld „sys_ID“ oder „sn_ind_tmt_orm_external_ID“ der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory]. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.place.id | Erforderlich, wenn productOrderItem.product.placeParameter wird verwendet. SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location]. Datentyp: Zeichenfolge Gespeichert in: Das Standortfeld der Tabelle „sn_ind_tmt_orm_order_line_item“. Standard: Leere Zeichenfolge |
| productOrderItem.product.place.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Ort . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal]. Datentyp: Zeichenfolge Gespeichert in: Das Merkmalsfeld der Tabelle „sn_ind_tmt_orm_order_characteristic_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: The previous_Characteristic_Option_value der Tabelle „sn_ind_tmt_orm_order_Characteristic_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Das Feld „Merkmal_Option_Wert“ der Tabelle „sn_ind_tmt_orm_order_Merkmal_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.valueType | Typ des Merkmalwerts. Datentyp: Zeichenfolge Mögliche Werte:
|
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Hinweis:
Änderungsreihenfolgen ( productOrderItem.actionIst Ändern ) Werden je nach Wert von unterschiedlich verarbeitet sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderSystemeigenschaft. Der Wert dieser Systemeigenschaft bestimmt, wie der Auftrag verarbeitet wird, wenn der Produktbestand eine andere Version als in der Bestellung angegeben ist.
Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.id | Erforderlich, wenn productOrderItem.product.productSpecificationParameter wird verwendet. Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.internalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.version | External_Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das E-Mail-Feld der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das Feld „first_Name“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.id | SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge Gespeichert in: Das Feld „sys_ID“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das Feld lastName der Tabelle sn_ind_tmt_orm_order_line_item_contact. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Feld „Business_Phone“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | |
| productOrderItem.product.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produkt . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | Erforderlich, wenn productOrderItem.productOfferingParameter wird verwendet. Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| productOrderItem.productOffering.internalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| productOrderItem.productOffering.version | External_Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOrderItem.quantity | Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl Gespeichert in: Das Mengenfeld von sn_ind_tmt_orm_order. Standard: Null |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | Erforderlich, wenn productOrderItem.productOrderItemRelationshipParameter wird verwendet. Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Gespeichert in: Das Feld parent_line_item der Tabelle „debsn_ind_tmt_orm_order_line_item“. Standard: Leere Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte:
HasChild Und Übergeordnetes Element Werden für übergeordnete/untergeordnete Beziehungen verwendet. Erforderlich Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten).Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der bestellten Artikel. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| ProduktOrderElement.revisionVorgang | Typ der Aktualisierung, die für die Position ausgeführt werden soll. Wenn dieser Wert leer ist, wird die vorhandene Position aktualisiert, oder eine neue Position wird hinzugefügt, wenn sie nicht bereits vorhanden ist. Wenn dieser Wert ist Abbrechen , Die Position wird abgebrochen. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | |
| ZugehörigPartei.ID | |
| relatedParty.name | |
| RelatedParty.@referredType | |
| RelatedParty.@type | |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Gespeichert in: Das Feld expected_end_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge Gespeichert in: Feld expected_Start_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
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. |
| 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 |
|---|---|
| 201 | Erfolgreich. Wenn Probleme mit den Informationen zur Option „Merkmale“ oder „Merkmale“ auftreten, speichert der Endpunkt die folgenden Kommentare in den Feldern „Arbeitsnotizen“ des zugehörigen Kundenauftrags-Positionselementdatensatzes:
|
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen.
Datentyp: Array von Objekten |
| Kanal.ID | Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| id | SYS_ID des Kundenauftrags, der für diese Anforderung aktualisiert wurde. Datentyp: Zeichenfolge |
| externalId | Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat.
Datentyp: Array von Objekten |
| Hinweis.Text | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung.
Datentyp: Zeichenfolge |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten |
| ProduktbestellungElement.Aktion | Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert.
Datentyp: Zeichenfolge |
| ProduktbestellungElement.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.id | Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist.
Datentyp: Array von Objekten |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludeAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludeAmount.unit | Währungscode, in dem der Preis dargestellt wird.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludeAmount.value | Preis des Produkts, einschließlich Steuern.
Datentyp: Zahl |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat .
Datentyp: Zeichenfolge |
| productOrderItem.product | Beschreibung der Instanzdetails des vom Kunden gekauften Produkts.
Datentyp: Objekt |
| productOrderItem.product.id | Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld „sys_ID“ oder „sn_ind_tmt_orm_external_ID“ der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory].
Datentyp: Zeichenfolge |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll.
Datentyp: Objekt |
| productOrderItem.product.place.id | SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts.
Datentyp: Array von Objekten |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist.
Datentyp: Objekt |
| productOrderItem.product.productSpecification.id | Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten.
Datentyp: Array von Objekten |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.id | SYS_ID des Positionskontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact].
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts.
Datentyp: Zeichenfolge Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden.
Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produkt . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist.
Datentyp: Objekt |
| productOrderItem.productOffering.id | Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen.
Datentyp: Array von Objekten |
| productOrderItem.productOrderItemRelationship.id | Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren.
Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der zugeordneten Artikel, die bestellt werden sollen.
Datentyp: Zahl |
| ProduktbestellungElement.Status | Aktueller Status des Produktbestellelements. Datentyp: Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält.
Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer].
Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers.
Datentyp: Zeichenfolge |
| ZugehörigPartei.Typ | Typ des Kunden.
Mögliche Werte:
Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum.
Datentyp: Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags.
Datentyp: Zeichenfolge |
| Status | Aktueller Status des Auftrags. Datentyp: Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel aktualisiert den Kanal für einen Kundenauftrag.
curl -X PATCH "https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder/6be0a925c3a220103e2e73ce3640ddfe" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
]
}
Antworttext.
{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization"
"valueType": "Choice",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder",
"id": "6be0a925c3a220103e2e73ce3640ddfe",
"state": "in_progress"
}
Produktbestellungs-API – POST /sn_ind_tmt_orm/cancelproductorder
Storniert den angegebenen Kundenauftrag.
URL-Format
Standard-URL: /api/sn_ind_tmt_orm/cancelproductorder
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| AbbruchReason | Grund für Stornierung. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Produktbestellung | Enthält Daten zur Produktbestellung. Datentyp: Objekt |
| productOrder.id | Erforderlich. SYS_ID des zu stornierenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order] |
| Produktbestellung.href | URL des zu stornierenden Kundenauftrags. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| ProductOrder.@referredType | Der Wert für diesen Parameter muss sein Produktbestellung .Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| AnfordertAbbruchdatum | Datum, an dem der Auftrag storniert werden soll. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| @TYPE | Der Wert für diesen Parameter muss sein CancelProductOrder .Datentyp: Zeichenfolge Standard: Leere 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 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| AbbruchReason | Grund für Stornierung. Datentyp: Zeichenfolge |
| href | URL des stornierten Auftrags. Datentyp: Zeichenfolge |
| id | SYS_ID des stornierten Auftrags. Datentyp: Zeichenfolge |
| Produktbestellung | Daten zur Produktbestellung. Datentyp: Objekt |
| Produktbestellungs-ID | SYS_ID des stornierten Auftrags. Datentyp: Zeichenfolge |
| Produktbestellung.href | URL des stornierten Auftrags. Datentyp: Zeichenfolge |
| ProductOrder.@referredType | Der Wert für diesen Parameter ist Produktbestellung .Datentyp: Zeichenfolge |
| AnfordertAbbruchdatum | Datum, an dem der Auftrag storniert werden soll. Datentyp: Zeichenfolge |
| Status | Status der Stornierung. Wenn die Stornierungsanforderung erfolgreich verarbeitet wurde (Statuscode 201), ist der Wert für diesen Parameter Fertig .Datentyp: Zeichenfolge |
| @TYPE | Der Wert für diesen Parameter ist CancelProductOrder .Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel storniert einen Kundenauftrag.
curl -X POST "https://instance.servicenow.com/api/sn_ind_tmt_orm/cancelproductorder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"cancellationReason": "Duplicate order",
"requestedCancellationDate": "2019-04-30T12:56:21.931Z",
"productOrder": {
"id": "163ee2805358811032a4ddeeff7b122d",
"href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
"@referredType": "ProductOrder"
},
"@type": "CancelProductorder"
}
{
"id": "163ee2805358811032a4ddeeff7b122d",
"href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
"cancellationReason": "Duplicate order",
"requestedCancellationDate": "2019-04-30T12:56:21.931Z",
"@type": "CancelProductorder",
"productOrder": {
"id": "163ee2805358811032a4ddeeff7b122d",
"href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
"@referredType": "ProductOrder"
},
"state": "done"
}
Produktbestellungs-API – POST /sn_ind_tmt_orm/order/productOrder
Erstellt den angegebenen Kundenauftrag und die Kundenauftragspositionen.
- Kundenauftrag [sn_ind_tmt_orm_order]
- Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
- Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
- Auftragspositionselementkontakt [sn_ind_tmt_orm_order_line_item_contact]
- Auftragspositionsbezogene Elemente [sn_ind_tmt_orm_order_line_related_items]
URL-Format
Standard-URL: /api/sn_ind_tmt_orm/order/productOrder
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Modus | Aktiviert die asynchrone Auftragsverarbeitung. Das heißt, der Auftrag wird der zu erstellenden Tabelle „eingehende Warteschlange“ [sn_tmt_Core_inbound_Queue] hinzugefügt. Wenn nicht enthalten, wird der Auftrag synchron verarbeitet. Gültiger Wert: Asynchron Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order |
| Kanal.ID | Erforderlich. Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld external_ID der Tabelle „Verteilungskanal“ [sn_prd_pm_Distribution_Channel]. Datentyp: Zeichenfolge Gespeichert in: Das Kanalfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen werden auf der Registerkarte Auswahlliste im Kanalwörterbucheintrag der Tabelle „sn_ind_tmt_orm_order“ definiert. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| committedDueDate | Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss.
Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „sn_ind_tmt_orm_order“. |
| externalId | Eindeutiger Bezeichner für den Kundenauftrag. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| href | Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| note | Zusätzliche Hinweise des Kunden bei der Bestellung. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order |
| Hinweis.Text | Erforderlich. Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Das Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| Bestellwährung | Erforderlich. Währungscode für den Auftrag und die Auftragspositionen. Die Währung muss für alle Elemente des Auftrags und Auftragspositionen identisch sein, andernfalls wird ein Fehler zurückgegeben und der Auftrag nicht erstellt. Sobald ein Auftrag erstellt wurde, kann sein Währungscode nicht geändert werden. Datentyp: Zeichenfolge |
| ProductOrderItem | Erforderlich. Artikel, die der Produktbestellung und der zugehörigen Aktion zugeordnet sind. Datentyp: Array von Objekten Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] |
| ProduktbestellungElement.Aktion | Erforderlich. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert. Mögliche Werte:
Datentyp: Zeichenfolge Gespeichert in: Aktionsfeld der Tabelle „Auftragsposition“ [sn_ind_tmt_orm_order_line_item]. |
| ProduktbestellungElement.actionReason | Optional. Beschreibung des Grunds für die Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Dem Feld action_reason der Auftragspositionstabelle [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.committedDueDate | Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss.
Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. |
| ProduktbestellungElement.extern Produktbestand | Externe IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten |
| ProduktbestellungElement.externalProduktbestand.externalProduktbestellungId | Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Dem Feld „external_Inventory_ID“ der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item] und dem Feld „sn_prd_invt_external_ID“ der Tabelle „sn_prd_invt_Product_Inventory“. |
| productOrderItem.id | Erforderlich. Eindeutiger Bezeichner der Position. Datentyp: Zeichenfolge Gespeichert in: Feld „external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Maximale Länge: 40 Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice | Preis, der dem Produkt zugeordnet ist. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludedAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer. Datentyp: Objekt Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Währungscode, in dem der Preis ausgedrückt wird. Datentyp: Zeichenfolge Gespeichert in: Dem Feld mrc oder nrc der Tabelle „Auftragspositionen“ [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Gespeichert in: Dem Feld mrc oder nrc der Tabelle „Auftragspositionen“ [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.priceType | Gibt an, ob der Preis des Artikels wiederkehrend oder nicht wiederkehrend ist. Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat . Datentyp: Zeichenfolge |
| productOrderItem.product | Erforderlich, wenn productOrderItem.actionIst Change oder DELETE. Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.product.id | Erforderlich, wenn productOrderItem.actionIst Change oder DELETE. Eindeutiger Bezeichner des verkauften Produkts. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „sn_ind_tmt_orm_external_ID“ der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory]. |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll. Datentyp: Objekt Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.product.place.id | Erforderlich. SYS_ID des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] Gespeichert in: Das Feld „Standort“ der Tabelle „Auftragsposition“ [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.product.place.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Ort . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: Merkmal [sn_prd_pm_Merkmal] Gespeichert in: Das Merkmalsfeld der Tabelle „sn_ind_tmt_orm_order_characteristic_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Das Feld „previous_Characteristic_Option_value“ der Tabelle „sn_ind_tmt_orm_order_Characteristic_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Das Feld „Merkmal_Option_Wert“ der Tabelle „sn_ind_tmt_orm_order_Merkmal_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.valueType | Typ des Merkmalwerts. Mögliche Werte:
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Optional. Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Hinweis:
Änderungsreihenfolgen ( productOrderItem.actionIst Ändern ) Werden je nach Wert von unterschiedlich verarbeitet sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderSystemeigenschaft. Der Wert dieser Systemeigenschaft bestimmt, wie der Auftrag verarbeitet wird, wenn der Produktbestand eine andere Version als in der Bestellung angegeben ist.
Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.id | Erforderlich. Anfangsversion oder externe ID der Produktspezifikation. Die Anfangsversion ist die sys_ID der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.internalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.version | Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Parteirollen, die mit einem OrderLineItemContact verknüpft sind. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das E-Mail-Feld der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das Feld „first_Name“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das Feld lastName der Tabelle sn_ind_tmt_orm_order_line_item_contact. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Feld „Business_Phone“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produkt . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Erforderlich. Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | Erforderlich. Anfangsversion oder externe ID des Produktangebots. Die Anfangsversion ist die sys_ID der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.internalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| productOrderItem.productOffering.name | Name des Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| productOrderItem.productOrderItem.quantity | Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Null |
| productOrderItem.productOrderItemRelationship | Erforderlich. Liste, die die übergeordnete/untergeordnete Beziehung zwischen Auftragselementen beschreibt. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | Erforderlich. Identisch mit productOrderItem.idWert. Wird für eine übergeordnete/untergeordnete Beziehung verwendet Datentyp: Zeichenfolge Gespeichert in: Das Feld parent_line_item der Tabelle sn_ind_tmt_orm_order_line_item. Standard: Leere Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Erforderlich. Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der bestellten Artikel. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts oder Kundenkontakts, der dem Auftrag zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Account [Customer_Account], Kontakt [Customer_contact]-Tabelle oder Verbraucher [csm_Consumer] |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Erforderlich. Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge |
| RelatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Gespeichert in: Das Feld expected_end_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge Gespeichert in: Feld expected_Start_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . 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 |
|---|---|
| 201 | Erfolgreich. Wenn Probleme mit den Informationen zur Option „Merkmale“ oder „Merkmale“ auftreten, speichert der Endpunkt die folgenden Kommentare in den Feldern „Arbeitsnotizen“ des zugehörigen Kundenauftrags-Positionselementdatensatzes:
|
| 202 | Akzeptiert. Erfolgreiche Anforderung für einen Auftrag im asynchronen Modus. Das heißt, die Anforderung wurde mit gestellt modeParameter auf festgelegt Asynchron Und die Verarbeitung des Datensatzes in der Tabelle „eingehende Warteschlange“ [sn_tmt_Core_inbound_Queue] ist geplant. |
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen.
Datentyp: Array von Objekten |
| Kanal.ID | Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| committedDueDate | Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge |
| externalId | Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge |
| href | Relativer Link zum Produktbestellungsdatensatz. Datentyp: Zeichenfolge |
| id | SYS_ID des Kundenauftrags, der für diese Anforderung erstellt wurde. Datentyp: Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat.
Datentyp: Array von Objekten |
| Hinweis.Text | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung.
Datentyp: Zeichenfolge |
| Bestellwährung | Währungscode für den Auftrag und die Auftragspositionen. Datentyp: Zeichenfolge |
| orderId | SYS_ID des zu erstellenden Auftrags. Bei erfolgreicher Anforderung wird der Auftrag der Tabelle „eingehende Warteschlange“ [sn_tmt_Core_inbound_Queue] in einem zu verarbeitenden Zeitplan hinzugefügt. Hinweis:
Dieser Wert ist das einzige Ergebnis, wenn der Auftrag asynchron mit erstellt wird modeAbfrageparameter. Datentyp: Zeichenfolge |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten |
| ProduktbestellungElement.Aktion | Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert.
Datentyp: Zeichenfolge |
| ProduktbestellungElement.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.committedDueDate | Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge |
| ProduktbestellungElement.extern Produktbestand | Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array von Objekten |
| ProduktbestellungElement.externalProduktbestand.externalProduktbestellungId | Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge |
| productOrderItem.id | Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist.
Datentyp: Array von Objekten |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludeAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludeAmount.unit | Währungscode, in dem der Preis dargestellt wird.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludeAmount.value | Preis des Produkts, einschließlich Steuern.
Datentyp: Zahl |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat .
Datentyp: Zeichenfolge |
| productOrderItem.product | Beschreibung der Instanzdetails des vom Kunden gekauften Produkts.
Datentyp: Objekt |
| productOrderItem.product.id | Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld „sys_ID“ oder „sn_ind_tmt_orm_external_ID“ der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory].Dieser Parameter wird nur zurückgegeben, wenn productOrderItem.actionIst Ändern Oder Löschen . Wenn sowohl sys_ID als auch external_ID vorhanden sind, wird die external_ID zurückgegeben. Datentyp: Zeichenfolge |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll.
Datentyp: Objekt |
| productOrderItem.product.place.id | SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts.
Datentyp: Array von Objekten |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productRelationship | Liste der Produktbeziehungsdetails für eine Auftragsposition. Datentyp: Array |
| productOrderItem.product.productRelationship.id | SYS_ID oder sn_prd_invt_external_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Feld „SYS_ID“ oder „sn_prd_invt_external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_Product_Inventory]. |
| productOrderItem.product.productRelationship.relationshipType | Typ der Beziehung zwischen der Auftragsposition und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.product.productSpecification.id | Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. Wenn sowohl sys_ID als auch external_ID vorhanden sind, wird die external_ID zurückgegeben. Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.internalId | Anfangsversion der Produktspezifikation. Die Anfangsversion ist die sys_ID der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.internalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.version | Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten. Datentyp: Array von Objekten |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts.
Datentyp: Zeichenfolge Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden.
Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produkt . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt |
| productOrderItem.productOffering.id | Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Wenn sowohl sys_ID als auch external_ID vorhanden sind, wird die external_ID zurückgegeben. Datentyp: Zeichenfolge |
| productOrderItem.productOffering.internalId | Anfangsversion des Produktangebots. Die Anfangsversion ist die sys_ID der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.internalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOffering.version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen.
Datentyp: Array von Objekten |
| productOrderItem.productOrderItemRelationship.id | Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren.
Mögliche Werte:
HasChild Und Übergeordnetes Element Werden für übergeordnete/untergeordnete Beziehungen verwendet. Erforderlich Wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten).Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der zugeordneten Artikel, die bestellt werden sollen.
Datentyp: Zahl |
| ProduktbestellungElement.Status | Aktueller Status des Produktbestellelements. Dieser Wert ist immer Neu . Datentyp: Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält.
Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer].
Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers.
Datentyp: Zeichenfolge |
| ZugehörigPartei.Typ | Typ des Kunden.
Mögliche Werte:
Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum.
Datentyp: Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags.
Datentyp: Zeichenfolge |
| Status | Aktueller Status des Auftrags. Für diesen Endpunkt ist dieser Wert immer Neu . Datentyp: Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
Asynchrone Verarbeitung
Dieses Beispiel zeigt die Verwendung von modeAbfrageparameter zum asynchronen Erstellen einer Bestellung. Der Auftrag wird der Tabelle „eingehende Warteschlange“ [sn_tmt_Core_inbound_Queue] in einem zu erstellenden Zeitplan hinzugefügt.
curl -X POST 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder?mode=async' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"orderDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-4ddd56",
"orderCurrency": "USD",
"note": [
{
"id": "1",
"author": "Jean Pontus",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration"
},
{
"id": "2",
"author": "Jean Pontus1",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "100",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"product": {
"isBundle": false,
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "110",
"relationshipType": "HasChild"
},
{
"id": "120",
"relationshipType": "HasChild"
},
{
"id": "130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem"
},
{
"id": "110",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"description": "Access Fee",
"name": "Access Fee",
"priceType": "nonRecurring",
"price": {
"taxRate": 0,
"dutyFreeAmount": {
"unit": "USD",
"value": 100
},
"taxIncludedAmount": {
"unit": "USD",
"value": 220
}
}
}
],
"product": {
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "string",
"value": "Premium (>50 sites)"
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"@type": "ProductSpecificationRef"
},
"place": {
"@type": "Place",
"id": "5671dd2ec3a53010188473ce3640dd81"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
},
{
"id": "120",
"action": "add",
"actionReason":"adding service package OLI",
"quantity": 1,
"itemPrice": [
{
"description": "Tariff plan monthly fee",
"name": "MonthlyFee",
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxRate": 0,
"dutyFreeAmount": {
"unit": "USD",
"value": 300
},
"taxIncludedAmount": {
"unit": "USD",
"value": 349
}
}
}
],
"product": {
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Model",
"valueType": "string",
"value": "ASR"
},
{
"name": "WAN Optimization",
"valueType": "string",
"value": "Advance"
},
{
"name": "CPE Type",
"valueType": "string",
"value": "Physical"
},
{
"name": "Routing",
"valueType": "string",
"value": "Premium"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"place": {
"@type": "Place",
"id": "5671dd2ec3a53010188473ce3640dd81"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
},
{
"id": "130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"description": "Tariff plan monthly security",
"name": "MonthlySecurity",
"priceType": "nonRecurring",
"price": {
"taxRate": 0,
"dutyFreeAmount": {
"unit": "USD",
"value": 30
},
"taxIncludedAmount": {
"unit": "USD",
"value": 30
}
}
}
],
"product": {
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "string",
"value": "Premium"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"place": {
"@type": "Place",
"id": "5671dd2ec3a53010188473ce3640dd81"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder"
}'
Antworttext.
{
"orderId": "304e877ac3ab5110856d73ce3640dde5"
}
Wird synchron verarbeitet (Standard)
Das folgende Beispiel zeigt, wie Sie eine Produktbestellung erstellen.
curl -X POST "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"currencyCode": "USD",
"channel": [
{
"id": "2",
"name": "Online channel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
],
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI130",
"relationshipType": "Requires"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder"
}
Antworttext.
{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"currencyCode": "USD",
"channel": [
{
"id": "2",
"name": "Online chanel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"internalVersion": "1",
"version": "v1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"internalVersion": "1",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"internalVersion": "1",
"version": "v1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
],
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"internalVersion": "1",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI130",
"relationshipType": "Requires"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"internalVersion": "1",
"version": "v1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"internalVersion": "1",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder",
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"state": "new"
}
Produktbestellungs-API – POST /sn_ind_tmt_orm/productorder
Erstellt den angegebenen Kundenauftrag und die Kundenauftragspositionen.
- Kundenauftrag [sn_ind_tmt_orm_order]
- Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
- Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
- Auftragspositionselementkontakt [sn_ind_tmt_orm_order_line_item_contact]
URL-Format
Standard-URL: /api/sn_ind_tmt_orm/productorder
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order |
| Kanal.ID | Erforderlich. Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld external_ID der Tabelle „Verteilungskanal“ [sn_prd_pm_Distribution_Channel]. Datentyp: Zeichenfolge Gespeichert in: Das Kanalfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen werden auf der Registerkarte Auswahlliste im Kanalwörterbucheintrag der Tabelle „sn_ind_tmt_orm_order“ definiert. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| committedDueDate | Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss.
Dieser Wert muss mit oder nach dem übereinstimmen committedDueDateWerte für jede Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „sn_ind_tmt_orm_order“. |
| externalId | Eindeutiger Bezeichner für den Kundenauftrag. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Gespeichert in: Das Feld „external_ID“ der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| href | Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| note | Zusätzliche Hinweise des Kunden bei der Bestellung. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order |
| Hinweis.Text | Erforderlich. Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Das Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| Bestellwährung | Erforderlich. Währungscode für den Auftrag und die Auftragspositionen. Die Währung muss für alle Elemente des Auftrags und Auftragspositionen identisch sein, andernfalls wird ein Fehler zurückgegeben und der Auftrag nicht erstellt. Sobald ein Auftrag erstellt wurde, kann sein Währungscode nicht geändert werden. Datentyp: Zeichenfolge |
| ProductOrderItem | Erforderlich. Artikel, die der Produktbestellung und der zugehörigen Aktion zugeordnet sind. Datentyp: Array von Objekten Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] |
| ProduktbestellungElement.Aktion | Erforderlich. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert. Mögliche Werte:
Datentyp: Zeichenfolge Gespeichert in: Aktionsfeld der Tabelle „Auftragsposition“ [sn_ind_tmt_orm_order_line_item]. |
| ProduktbestellungElement.actionReason | Optional. Beschreibung des Grunds für die Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Dem Feld action_reason der Auftragspositionstabelle [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.committedDueDate | Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss.
Datentyp: Zeichenfolge Gespeichert in: Feld „commit_due_date“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. |
| ProduktbestellungElement.extern Produktbestand | Externe IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten |
| ProduktbestellungElement.externalProduktbestand.externalProduktbestellungId | Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Dem Feld „external_Inventory_ID“ der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item] und dem Feld „sn_prd_invt_external_ID“ der Tabelle „sn_prd_invt_Product_Inventory“. |
| productOrderItem.id | Erforderlich. Eindeutiger Bezeichner der Position. Datentyp: Zeichenfolge Gespeichert in: Feld „external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Maximale Länge: 40 Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice | Preis, der dem Produkt zugeordnet ist. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] Standard: Leere Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludedAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer. Datentyp: Objekt Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | Währungscode, in dem der Preis ausgedrückt wird. Datentyp: Zeichenfolge Gespeichert in: Dem Feld mrc oder nrc der Tabelle „Auftragspositionen“ [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Gespeichert in: Dem Feld mrc oder nrc der Tabelle „Auftragspositionen“ [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.itemPrice.priceType | Gibt an, ob der Preis des Artikels wiederkehrend oder nicht wiederkehrend ist. Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat . Datentyp: Zeichenfolge |
| productOrderItem.product | Erforderlich, wenn productOrderItem.actionIst Change oder DELETE. Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.product.id | Erforderlich, wenn productOrderItem.actionIst Change oder DELETE. Eindeutiger Bezeichner des verkauften Produkts. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „sn_ind_tmt_orm_external_ID“ der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory]. |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll. Datentyp: Objekt Gespeichert in: Auftragsposition [sn_ind_tmt_orm_order_line_item] |
| productOrderItem.product.place.id | Erforderlich. SYS_ID des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] Gespeichert in: Das Feld „Standort“ der Tabelle „Auftragsposition“ [sn_ind_tmt_orm_order_line_item]. |
| productOrderItem.product.place.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Ort . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: Merkmal [sn_prd_pm_Merkmal] Gespeichert in: Das Merkmalsfeld der Tabelle „sn_ind_tmt_orm_order_characteristic_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Das Feld „previous_Characteristic_Option_value“ der Tabelle „sn_ind_tmt_orm_order_Characteristic_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Das Feld „Merkmal_Option_Wert“ der Tabelle „sn_ind_tmt_orm_order_Merkmal_value“. Standard: Leere Zeichenfolge |
| productOrderItem.product.productCharacteristic.valueType | Typ des Merkmalwerts. Mögliche Werte:
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Optional. Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Hinweis:
Änderungsreihenfolgen ( productOrderItem.actionIst Ändern ) Werden je nach Wert von unterschiedlich verarbeitet sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrderSystemeigenschaft. Der Wert dieser Systemeigenschaft bestimmt, wie der Auftrag verarbeitet wird, wenn der Produktbestand eine andere Version als in der Bestellung angegeben ist.
Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.id | Erforderlich. Anfangsversion oder externe ID der Produktspezifikation. Die Anfangsversion ist die sys_ID der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.internalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| productOrderItem.product.productSpecification.version | Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Parteirollen, die mit einem OrderLineItemContact verknüpft sind. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das E-Mail-Feld der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das Feld „first_Name“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Das Feld lastName der Tabelle sn_ind_tmt_orm_order_line_item_contact. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Gespeichert in: Feld „Business_Phone“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Erforderlich. Typ des Kunden. Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.product.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produkt . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Erforderlich. Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | Erforderlich. Anfangsversion oder externe ID des Produktangebots. Die Anfangsversion ist die sys_ID der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.internalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| productOrderItem.productOffering.name | Name des Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| productOrderItem.productOffering.version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| productOrderItem.productOrderItem.quantity | Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Null |
| productOrderItem.productOrderItemRelationship | Erforderlich. Liste, die die übergeordnete/untergeordnete Beziehung zwischen Auftragselementen beschreibt. Datentyp: Array von Objekten Gespeichert in: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | Erforderlich. Identisch mit productOrderItem.idWert. Wird für eine übergeordnete/untergeordnete Beziehung verwendet Datentyp: Zeichenfolge Gespeichert in: Das Feld parent_line_item der Tabelle sn_ind_tmt_orm_order_line_item. Standard: Leere Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Erforderlich. Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der bestellten Artikel. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält. Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts oder Kundenkontakts, der dem Auftrag zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Account [Customer_Account], Kontakt [Customer_contact]-Tabelle oder Verbraucher [csm_Consumer] |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Erforderlich. Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge |
| RelatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Gespeichert in: Das Feld expected_end_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags. Datentyp: Zeichenfolge Gespeichert in: Feld expected_Start_date der Tabelle sn_ind_tmt_orm_order. Standard: Leere Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
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. |
| 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 |
|---|---|
| 201 | Erfolgreich. Wenn Probleme mit den Informationen zur Option „Merkmale“ oder „Merkmale“ auftreten, speichert der Endpunkt die folgenden Kommentare in den Feldern „Arbeitsnotizen“ des zugehörigen Kundenauftrags-Positionselementdatensatzes:
|
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Kanal | Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen.
Datentyp: Array von Objekten |
| Kanal.ID | Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| channel.name | Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll.
Datentyp: Zeichenfolge |
| id | SYS_ID des Kundenauftrags, der für diese Anforderung erstellt wurde. Datentyp: Zeichenfolge |
| externalId | Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge |
| note | Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat.
Datentyp: Array von Objekten |
| Hinweis.Text | Zusätzliche Notizen/Kommentare des Kunden während der Bestellung.
Datentyp: Zeichenfolge |
| ProductOrderItem | Liste, die Artikel beschreibt, die der Produktbestellung zugeordnet sind, und die zugehörige Aktion. Datentyp: Array von Objekten |
| ProduktbestellungElement.Aktion | Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle „sn_ind_tmt_orm_order_line_item“ definiert.
Datentyp: Zeichenfolge |
| ProductOderItem.actionReason | Grund für das Hinzufügen der Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld action_reason der Tabelle sn_ind_tmt_orm_order_line_item. |
| productOrderItem.id | Eindeutiger Bezeichner der Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice | Liste, die den Preis beschreibt, der dem Produkt zugeordnet ist.
Datentyp: Array von Objekten |
| productOrderItem.itemPrice.price | Beschreibung des Preises des zugehörigen Produkts.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludeAmount | Beschreibung des Preises des zugehörigen Produkts, einschließlich der Steuer.
Datentyp: Objekt |
| productOrderItem.itemPrice.price.taxIncludeAmount.unit | Währungscode, in dem der Preis dargestellt wird.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.price.taxIncludeAmount.value | Preis des Produkts, einschließlich Steuern.
Datentyp: Zahl |
| productOrderItem.itemPrice.priceType | Typ des Artikelpreises, wiederkehrend oder nicht wiederkehrend.
Datentyp: Zeichenfolge |
| productOrderItem.itemPrice.recurringChargePeriod | Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. Monat .
Datentyp: Zeichenfolge |
| productOrderItem.product | Beschreibung der Instanzdetails des vom Kunden gekauften Produkts.
Datentyp: Objekt |
| productOrderItem.product.id | Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld „sys_ID“ oder „sn_ind_tmt_orm_external_ID“ der Tabelle „Produktbestand“ [sn_ind_tmt_orm_Product_Inventory].Dieser Parameter wird nur zurückgegeben, wenn productOrderItem.actionIst Ändern Oder Löschen . Wenn sowohl sys_ID als auch external_ID vorhanden sind, wird die external_ID zurückgegeben. Datentyp: Zeichenfolge |
| productOrderItem.product.place | Karten der Standorte, an denen das Produkt installiert werden soll.
Datentyp: Objekt |
| productOrderItem.product.place.id | SYS_ID des zugeordneten Standortdatensatzes in der Tabelle „Standort“ [cmn_location].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic | Liste der Merkmale des zugehörigen Produkts.
Datentyp: Array von Objekten |
| productOrderItem.product.productCharacteristic.name | Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_Merkmal].
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.previousValue | Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag gilt. Die Anforderung ist ein Change-Auftrag, wenn der productOrderItem.actionParameter ist ein anderer als Hinzufügen . Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.value | Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options.
Datentyp: Zeichenfolge |
| productOrderItem.product.productCharacteristic.valueType | Typ des Merkmalwerts. Mögliche Werte:
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification | Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist.
Datentyp: Objekt |
| productOrderItem.product.productSpecification.id | Initial_Version oder external_ID der Produktspezifikation. „Initial_Version“ ist die sys_ID der ersten Version der Spezifikation. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. Wenn sowohl sys_ID als auch external_ID vorhanden sind, wird die external_ID zurückgegeben. Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.name | Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification].
Datentyp: Zeichenfolge |
| productOrderItem.product.productSpecification.@type | Teil des TMF Open API-Standards. Dieser Wert ist immer ProduktspezifikationRef . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty | Liste der Kontakte für Einzelposten. Datentyp: Array von Objekten |
| productOrderItem.product.relatedParty.email | E-Mail-Adresse des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.firstName | Vorname des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.lastName | Nachname des Kontakts.
Datentyp: Zeichenfolge Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.phone | Geschäftliche Telefonnummer des Kontakts.
Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@referredType | Typ des Kunden.
Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge |
| productOrderItem.product.relatedParty.@type | Teil des TMF Open API-Standards. Anmerkung für Auftragspositionskontakt. Dieser Wert ist immer Zugehörige Partei . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.product.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produkt . Diese Informationen werden nicht gespeichert.
Datentyp: Zeichenfolge |
| productOrderItem.productOffering | Beschreibung des Produktangebots, das dem Produkt zugeordnet ist.
Datentyp: Objekt |
| productOrderItem.productOffering.id | Initial_Version oder external_ID des Produktangebots. „Initial_Version“ ist die sys_ID der ersten Version des Angebots. Befindet sich im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Wenn sowohl sys_ID als auch external_ID vorhanden sind, wird die external_ID zurückgegeben. Datentyp: Zeichenfolge |
| productOrderItem.productOffering.name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship | Liste der Beziehungen zwischen Auftragspositionen.
Datentyp: Array von Objekten |
| productOrderItem.productOrderItemRelationship.id | Eindeutiger Bezeichner der zugehörigen Position. Befindet sich im Feld „sn_ind_tmt_orm_external_ID“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
Datentyp: Zeichenfolge |
| productOrderItem.productOrderItemRelationship.relationshipType | Typ der Beziehung zwischen den beiden Einzelposten. Diese Informationen werden verwendet, um die Beziehungshierarchie zu identifizieren.
Datentyp: Zeichenfolge |
| ProduktbestellungArtikel.Menge | Anzahl der zugeordneten Artikel, die bestellt werden sollen.
Datentyp: Zahl |
| ProduktbestellungElement.Status | Aktueller Status des Produktbestellelements. Dieser Wert ist immer Neu . Datentyp: Zeichenfolge |
| ProductOrderItem.@type | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer ProductOrderItem . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucherkontoinformationen enthält.
Datentyp: Array von Objekten |
| relatedParty.id | SYS_ID oder external_ID des Accounts, Kundenkontakts oder Verbrauchers, der der Bestellung zugeordnet ist. Befindet sich in der Tabelle „Account“ [Customer_Account], „Kontakt“ [Customer_contact] oder „Verbraucher“ [csm_Consumer].
Datentyp: Zeichenfolge |
| relatedParty.name | Name des Accounts, Kunden oder Verbrauchers.
Datentyp: Zeichenfolge |
| ZugehörigPartei.Typ | Typ des Kunden.
Mögliche Werte:
Datentyp: Zeichenfolge |
| AnfordertCompletionDate | Vom Kunden angefordertes Lieferdatum.
Datentyp: Zeichenfolge |
| AnfordertStartdatum | Vom Kunden angefordertes Startdatum des Auftrags.
Datentyp: Zeichenfolge |
| Status | Aktueller Status des Auftrags. Für diesen Endpunkt ist dieser Wert immer Neu . Datentyp: Zeichenfolge |
| @TYPE | Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer Produktbestellung . Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel erstellt einen Kundenauftrag.
curl -X POST "https://servicenow-instance/api/sn_ind_tmt_orm/productorder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"channel": [
{
"id": "2",
"name": "Online channel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"valueType": "Object",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Object",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder"
}
Antworttext.
{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"channel": [
{
"id": "2",
"name": "Online chanel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"valueType": "Object",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Object",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder",
"id": "6be0a925c3a220103e2e73ce3640ddfe",
"state": "new"
}