Product Order Open API

Freigeben Version: Yokohama

Aktualisiert 30. Januar 2025

128 Minuten Lesedauer

Die Product Order Open API bietet Endpunkte, die einen standardisierten Mechanismus für die Bestellung von Produkten ermöglichen.

Eine Produktbestellung wird basierend auf einem Produktangebot erstellt, das in einem Produktkatalog definiert und veröffentlicht wird. Das Produktangebot identifiziert das Produkt oder die Produktgruppe, die einem Kunden zur Verfügung steht, und enthält die relevanten Produktmerkmale, die die eindeutigen Optionen eines Produkts erfassen, und andere relevante Attribute wie Preisgestaltung, Vertragsbedingungen und Verfügbarkeit.

Für den Zugriff auf diese API muss das Plugin „Order Management for Telecommunications“ (sn_ind_tmt_orm) aktiviert sein.

Diese API wird im Namespace sn_ind_tmt_orm bereitgestellt.

Der anrufende Benutzer muss über die Rolle sn_ind_tmt_orm.order_integrator verfügen.

Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unterProduct Order Open API Developer Guide.

Die Product Order Open API ist eine ServiceNow® -Implementierung der REST-Spezifikation TM Forum TMF622 Product Ordering Management API und wurde vom TM Forum für ihre Konformität zertifiziert.

TMF-Konformitätslogo

Offene API für Produktbestellung – GET /sn_ind_tmt_orm/order/productOrder

Ruft alle Produktbestellungen ab.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenbestellung [sn_ind_tmt_orm_order]
Bestellposition [sn_ind_tmt_orm_order_line_item]
Bestellmerkmal [sn_ind_tmt_orm_order_characterist_value]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Bestellposition [sn_ind_tmt_orm_order_line_related_items]

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/order/productOrder

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 2. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Alle zurückgegebenen Felder.
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 20 Maximum: 100
Offset	Startindex, ab 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
state	Filtern Sie Bestellungen nach Status. In der Antwort werden nur Aufträge zurückgegeben, deren Status dem Wert dieses Parameters entspricht. Datentyp: Zeichenfolge Standard: Nicht nach Status sortieren.

Tabelle : 3. Parameter des Anforderungstexts (JSON)
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.

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` und `Limit=3`, ist der Wert des Content-Range -Headers `Elemente 3-5`.
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter vorheriger
X-Gesamtzahl	Für paginierte 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 HTTP-Antwortcodes der REST-API.

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
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 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
Kanalname	Name des Kanals, der für den 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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge
href	Relativer Link zum Produktbestelldatensatz. Datentyp: Zeichenfolge
id	Sys_id der Produktbestellung. Datentyp: Zeichenfolge
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
Anmerkung.Autor	Anwendername der Person, die den zugehörigen Hinweis verfasst hat. Datentyp: Zeichenfolge
Notiz.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für den Auftrag erreicht wurde. Mögliche Werte: wahr: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Datentyp: Boolesch
productOrderItem	Liste, die die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
„productOrderItem.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“
produktbestellelement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
Bestellelement.externerProduktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
Bestellelement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
productOrderItem.id	Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
„productOrderItem.itemPrice.Preis.SteuerEnthalteneBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Wert	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.ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für den Auftrag erreicht wurde. Mögliche Werte: wahr: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Datentyp: Boolesch
ProduktBestellelement.Produkt	Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Karten der Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Es werden nur Produktmerkmale zurückgegeben, deren value sich von den previousValue unterscheiden. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, 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 Bestellposition. Datentyp: Array von Objekten `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
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 dem Auftragspositionselement und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
productOrderItem.product.productSpecification	Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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
Bestellelement.Produkt.Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Die Ausgangsversion ist die sys_id der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld 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
Produktbestellelement.Produkt.Produktspezifikation.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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array von Objekten `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
„productOrderItem.product.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden im Feld „sys_id“ oder „external_id“ der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
„productOrderItem.productOffering.internalId“	Anfangsversion des Produktangebots. Die ursprüngliche Version ist die sys_id der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.interneVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld 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
ProduktBestellelement.Produktangebot.Version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
Produktbestellungselement.Menge	Anzahl der gekauften Produktartikel. Datentyp: Zahl
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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 Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. `„Erfordert“` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
„productOrderItem.state“	Status der Reihenfolge des zugeordneten Produktelements. Datentyp: Zeichenfolge
ProduktBestellelement.Version	Bestellversion. Datentyp: Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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örigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
state	Aktueller Status des Auftrags. Datentyp: Zeichenfolge
version	Bestellversion. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrder`. 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"
   }
]

Offene API für Produktbestellung – GET /sn_ind_tmt_orm/order/productOrder/{id}

Ruft die angegebene Produktbestellung ab.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenbestellung [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characterist_value]
Bestellposition [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Bestellposition [sn_ind_tmt_orm_order_line_related_items]

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/order/productOrder/{id}

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
id	Sys_id oder external_id des abzurufenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]

Tabelle : 8. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 9. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodes der REST-API.

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung). Die Antwort gibt erfolgreich mit einer Fehlermeldung zurück, wenn der ausgewählte Auftrag Verarbeitungsprobleme hat. Die Antwort „200 OK“ erfolgt, wenn sich der Auftrag in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] befindet und darauf wartet, dass der Planer den zu verarbeitenden Datensatz auswählt. Das Feld „Fehlermeldung“ enthält Details für den Datensatz. Zum Beispiel: `{ "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] }` Die Antwort 200 OK erfolgt, wenn die Auftragserstellung fehlschlägt und der Datensatz in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] einen Fehlerstatus aufweist. Das Feld „Fehlermeldung“ enthält Details in für den Datensatz der eingehenden Warteschlangentabelle. Zum Beispiel: `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
206	Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
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 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
Kanalname	Name des Kanals, der für den 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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge
href	Relativer Link zum Produktbestelldatensatz. Datentyp: Zeichenfolge
id	Sys_id der Produktbestellung. Datentyp: Zeichenfolge
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
Anmerkung.Autor	Anwendername der Person, die den zugehörigen Hinweis verfasst hat. Datentyp: Zeichenfolge
Notiz.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für den Auftrag erreicht wurde. Mögliche Werte: wahr: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Datentyp: Boolesch
productOrderItem	Liste, die die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
„productOrderItem.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“
produktbestellelement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
Bestellelement.externerProduktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
Bestellelement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
productOrderItem.id	Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
„productOrderItem.itemPrice.Preis.SteuerEnthalteneBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Wert	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.ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für den Auftrag erreicht wurde. Mögliche Werte: wahr: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Datentyp: Boolesch
ProduktBestellelement.Produkt	Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Karten der Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Es werden nur Produktmerkmale zurückgegeben, deren value sich von den previousValue unterscheiden. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, 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 Bestellposition. Datentyp: Array von Objekten `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
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 dem Auftragspositionselement und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
productOrderItem.product.productSpecification	Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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
Bestellelement.Produkt.Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Die Ausgangsversion ist die sys_id der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld 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
Produktbestellelement.Produkt.Produktspezifikation.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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array von Objekten `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
„productOrderItem.product.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden im Feld „sys_id“ oder „external_id“ der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
„productOrderItem.productOffering.internalId“	Anfangsversion des Produktangebots. Die ursprüngliche Version ist die sys_id der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.interneVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld 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
ProduktBestellelement.Produktangebot.Version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
Produktbestellungselement.Menge	Anzahl der gekauften Produktartikel. Datentyp: Zahl
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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 Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. `„Erfordert“` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
„productOrderItem.state“	Status der Reihenfolge des zugeordneten Produktelements. Datentyp: Zeichenfolge
ProduktBestellelement.Version	Bestellversion. Datentyp: Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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örigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
state	Aktueller Status des Auftrags. Datentyp: Zeichenfolge
version	Bestellversion. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrder`. 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"
}

Offene API für Produktbestellung – GET /sn_ind_tmt_orm/productorder

Ruft alle Produktbestellungen ab.

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Offene API für Produktbestellung – GET /sn_ind_tmt_orm/order/productOrder.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenbestellung [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characterist_value]
Bestellposition [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/productorder

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Alle zurückgegebenen Felder.
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 20 Maximum: 100
Offset	Startindex, ab 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
state	Filtern Sie Bestellungen nach Status. In der Antwort werden nur Aufträge zurückgegeben, deren Status dem Wert dieses Parameters entspricht. Datentyp: Zeichenfolge Standard: Alle zurückgegebenen Status.

Tabelle : 15. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 16. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 17. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` und `Limit=3`, ist der Wert des Content-Range -Headers `Elemente 3-5`.
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter vorheriger
X-Gesamtzahl	Für paginierte 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 HTTP-Antwortcodes der REST-API.

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
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 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
Kanalname	Name des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": { "author": "String", "date": "String", "text": "String" }`
Anmerkung.Autor	Anwendername der Person, die den zugehörigen Hinweis verfasst hat. Datentyp: Zeichenfolge
Notiz.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für den Auftrag erreicht wurde. Mögliche Werte: wahr: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Datentyp: Boolesch
productOrderItem	Liste, die die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
„productOrderItem.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. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
„productOrderItem.itemPrice.Preis.SteuerEnthalteneBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Wert	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.ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für den Auftrag erreicht wurde. Mögliche Werte: wahr: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Datentyp: Boolesch
ProduktBestellelement.Produkt	Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Karten der Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Es werden nur Produktmerkmale zurückgegeben, deren value sich von den previousValue unterscheiden. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, 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 `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array von Objekten `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
„productOrderItem.product.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden 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
Produktbestellungselement.Menge	Anzahl der gekauften Produktartikel. Datentyp: Zahl
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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 Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. `„Erfordert“` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
„productOrderItem.state“	Status der Reihenfolge des zugeordneten Produktelements. Datentyp: Zeichenfolge
ProduktBestellelement.Version	Bestellversion. Datentyp: Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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örigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
state	Aktueller Status des Auftrags. Datentyp: Zeichenfolge
version	Bestellversion. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrder`. 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"
   }
]

Offene API für Produktbestellung – GET /sn_ind_tmt_orm/productorder/{id}

Ruft die angegebene Produktbestellung ab.

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Offene API für Produktbestellung – GET /sn_ind_tmt_orm/order/productOrder/{id}.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenbestellung [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characterist_value]
Bestellposition [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/productorder/{id}

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter
Name	Beschreibung
id	Sys_id oder external_id des abzurufenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]

Tabelle : 20. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 21. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 22. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 23. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodes der REST-API.

Tabelle : 24. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Kann einen der folgenden Gründe haben: Fehlender Abfrageparameter Ungültiger URI
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 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
Kanalname	Name des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Objekt `"note": { "author": "String", "date": "String", "text": "String" }`
Anmerkung.Autor	Anwendername der Person, die den zugehörigen Hinweis verfasst hat. Datentyp: Zeichenfolge
Notiz.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für den Auftrag erreicht wurde. Mögliche Werte: wahr: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Datentyp: Boolesch
productOrderItem	Liste, die die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
„productOrderItem.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. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
„productOrderItem.itemPrice.Preis.SteuerEnthalteneBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Wert	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.ponr	Kennzeichnung, die angibt, ob der Punkt ohne Rückkehr für den Auftrag erreicht wurde. Mögliche Werte: wahr: Der Punkt ohne Rückkehr für den Auftrag wurde erreicht. „falsch“: Der Punkt ohne Rückkehr für den Auftrag wurde nicht erreicht. Datentyp: Boolesch
ProduktBestellelement.Produkt	Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	Karten der Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Es werden nur Produktmerkmale zurückgegeben, deren value sich von den previousValue unterscheiden. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, 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 `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Objekt `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
„productOrderItem.product.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden 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
Produktbestellungselement.Menge	Anzahl der gekauften Produktartikel. Datentyp: Zahl
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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 Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. `„Erfordert“` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
„productOrderItem.state“	Status der Reihenfolge des zugeordneten Produktelements. Datentyp: Zeichenfolge
ProduktBestellelement.Version	Bestellversion. Datentyp: Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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örigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
state	Aktueller Status des Auftrags. Datentyp: Zeichenfolge
version	Bestellversion. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Codebeispiel wird ein vorhandener Kundenauftrag angefordert.

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"
}

Open API für Produktbestellung – 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

Tabelle : 25. Pfadparameter
Name	Beschreibung
id	Sys_id des zu aktualisierenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]

Tabelle : 26. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 27. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Kanal	Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array von Objekten `"channel": [ { "id": "String", "name": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
channel.id	Erforderlich, wenn der Parameter channel verwendet wird. Eindeutiger Bezeichner des Kanals, der für den 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: Feld „channel“ der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
Kanalname	Name des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen sind auf der Registerkarte „Auswahlliste“ im Wörterbucheintrag „Kanal“ 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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Wenn die Aktion für Auftragspositionen `„aussetzen“` oder `„fortsetzen“`ist, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „committed_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: Feld „external_id“ der Tabelle „sn_ind_tmt_orm_order“ Standard: Leere Zeichenfolge
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. 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 die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.action	Erforderlich, wenn der Parameter productOrderItem verwendet wird. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change delete kein Change resume anhalten Datentyp: Zeichenfolge Gespeichert in: Das Aktionsfeld der Tabelle „sn_ind_tmt_orm_order_line_item“. Standard: add
„productOrderItem.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“
produktbestellelement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Wenn die Aktion für das Element `„unterbrechen“` oder `„fortsetzen“`lautet, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „committed_due_date“ der Tabelle sn_ind_tmt_orm_order_line_item
Bestellelement.externerProduktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Hinweis: Zuvor wurde beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID der Vorgang abgebrochen und ein Fehler zurückgegeben. Mit dem Release Xanadu wird dieser Parameter einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben und kein Fehler ausgegeben wird.
Bestellelement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Feld „external_inventory_id“ der Tabelle „sn_ind_tmt_orm_order_line_item“ und Feld „sn_prd_invt_external_id“ der Tabelle „sn_prd_invt_product_inventory“.
productOrderItem.id	Erforderlich, wenn der Parameter productOrderItem verwendet wird. Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Gespeichert in: Feld „external_id“ der Tabelle „sn_ind_tmt_orm_order_line_item“ Maximale Länge: 40 Standard: Leere Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }` Gespeichert in: sn_ind_tmt_orm_order_line_item Standard: Leere Zeichenfolge
„productOrderItem.itemPrice.Preis.SteuerEnthalteneBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }` Gespeichert in: sn_ind_tmt_orm_order_line_item
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge Gespeichert in: Feld mrc oder nrc in der Tabelle sn_ind_tmt_orm_order_line_item.
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Gespeichert in: Feld mrc oder nrc 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
ProduktBestellelement.Produkt	Erforderlich, wenn productOrderItem.action „ändern“ oder „löschen“ ist. Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Erforderlich, wenn productOrderItem.action „ändern“ oder „löschen“ ist. 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 Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.product.place.id	Erforderlich, wenn der Parameter productOrderItem.product.place verwendet wird. Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [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 den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_characterist_value
productOrderItem.product.productMerkmal.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge Gespeichert in: Feld „Merkmale“ der Tabelle „sn_ind_tmt_orm_order_characterist_value“ Standard: Leere Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Der previous_charakterist_option_wert der Tabelle sn_ind_tmt_orm_order_characterist_value. Standard: Leere Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Feld „feature_option_value“ der Tabelle sn_ind_tmt_orm_order_characterist_value Standard: Leere Zeichenfolge
productOrderItem.product.productSpecification	Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Hinweis: Change-Aufträge (productOrderItem.action ist `change`) werden je nach Wert der Systemeigenschaft sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder unterschiedlich verarbeitet. Der Wert dieser Systemeigenschaft bestimmt, wie die Bestellung verarbeitet wird, wenn der Produktbestand eine andere Version aufweist als die im Auftrag angegebene. Wenn diese Systemeigenschaft auf „true“ (Standard) festgelegt ist, wird der Produktbestand automatisch auf die Version im Auftrag aktualisiert, indem die referenzierte Produktspezifikation geändert wird. Dadurch kann der Auftrag erfolgreich verarbeitet werden. Wenn diese Systemeigenschaft auf „false“ festgelegt ist und der Produktbestand eine andere Version als die in der Bestellung angegebene aufweist, schlägt die Bestellung aufgrund der Versionsabweichung fehl. Datentyp: Objekt `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Erforderlich, wenn der Parameter productOrderItem.product.productSpecification verwendet wird. 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.interneVersion	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
Produktbestellelement.Produkt.Produktspezifikation.Version	Externe_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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array von Objekten `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item_contact
ProduktBestellelement.Produkt.zugehörigePartei.E-Mail	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld „E-Mail“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld first_name der Tabelle sn_ind_tmt_orm_order_line_item_contact Standard: Leere Zeichenfolge
productOrderItem.product.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge Gespeichert in: Feld „sys_id“ der Tabelle sn_ind_tmt_orm_order_line_item_contact Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld „lastName“ der Tabelle sn_ind_tmt_orm_order_line_item_contact Standard: Leere Zeichenfolge
ProduktBestellelement.Produkt.zugehörigePartei.Telefon	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.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. 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
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
ProduktBestellelement.Produktangebot.ID	Erforderlich, wenn der Parameter productOrderItem.productOffering verwendet wird. Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden im Feld „sys_id“ oder „external_id“ der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
ProduktBestellelement.Produktangebot.interneVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.Name	Name des Produktangebots Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
ProduktBestellelement.Produktangebot.Version	Externe_Version des Produktangebots Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
Produktbestellungselement.Produktbestellungselement.Menge	Anzahl der Artikel, die der Bestellung zugeordnet sind. Datentyp: Zahl Gespeichert in: Das Mengenfeld von „sn_ind_tmt_orm_order“. Standard: null
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item
„productOrderItem.productOrderItemRelationship.id“	Erforderlich, wenn der Parameter productOrderItem.productOrderItemRelationship verwendet wird. Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Gespeichert in: Feld „parent_line_item“ der Tabelle „bsn_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 Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. `„Erfordert“` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
Produktbestellungselement.Menge	Anzahl der bestellten Artikel. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
productOrderItem.revisionOperation	Typ der Aktualisierung, die für die Position durchgeführt werden soll. Wenn dieser Wert leer ist, wird die vorhandene Position aktualisiert, oder es wird eine neue Position hinzugefügt, wenn sie noch nicht vorhanden ist. Wenn dieser Wert `gleich „stornieren“`ist, wird die Position storniert. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
Zugehörigepartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
Zugehörigepartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge Gespeichert in: Feld „expected_end_date“ der Tabelle „sn_ind_tmt_orm_order“ Standard: Leere Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. 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 `ProductOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

Kopfzeilen

Tabelle : 28. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 29. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodes der REST-API.

Tabelle : 30. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Wenn Probleme mit den Merkmalen oder Merkmalsoptionsinformationen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizen-Feldern des zugehörigen Kundenauftragspositionselement-Datensatzes: `Die folgenden Merkmale für Bestellelemente sind nicht vorhanden: Überprüfen Sie die Spezifikation <characteristic.name>, und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen.` `Merkmal des Bestellelements: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: `Ungültige Nutzlast: Anforderungstext fehlt` – Nutzlast wurde im Anforderungstext nicht übergeben. `Ungültige Nutzlast: productOrderItem fehlt` – Objekt für Produktauftragsposition oder JSON fehlt. `Ungültige Nutzlast: productOrderItem-ID fehlt` – Der Parameter id fehlt in der Produktbestellposition der Nutzlast. `Ungültige Nutzlast: Aktion „productOrderItem“ fehlt` – Der Parameter action fehlt in der Produktbestellposition der Nutzlast. `Ungültige Nutzlast: productOrderItem Produktangebot fehlt` – Das Produktangebotsobjekt oder JSON fehlt in der Produktbestellposition in der Nutzlast. `Ungültige Nutzlast: Produktangebots-ID fehlt` – Der Parameter id fehlt in der Produktbestellposition des Produktangebotsobjekts in der Nutzlast. `Ungültige Nutzlast: Produktangebot ist nicht vorhanden` – Das Produktangebot in der Produktauftragsposition ist nicht gültig. `Ungültige Nutzlast: Produkt „productOrderItem“ fehlt` : Das Produktobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produkt, Produktspezifikation fehlt` – Das Produktspezifikationsobjekt oder JSON in der Produktbestellposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikations-ID fehlt` – Der Parameter id in der Produktbestellposition des Produktspezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikation ist nicht vorhanden` – Die Produktspezifikation in der Produktauftragsposition ist ungültig. `Ungültige Nutzlast: Produktbestand nicht vorhanden` – In einem Change-Auftrag (Aktion = Change) ist die Menge eines Artikels größer als der Bestand. `Ungültige Nutzlast: Produktbestands-ID fehlt` – in einem Change-Auftrag fehlt product.id in der Nutzlast. `Ungültige Nutzlast: Verkauftes Produkt ist inaktiv` – In einem Change-Auftrag ist ein in der Nutzlast angegebenes Produkt inaktiv. `Ungültige Nutzlast: „relatedParty“ fehlt` : Das Objekt der zugehörigen Partei fehlt in der Nutzlast. `Kunden-Account oder Verbraucher fehlt` : Das Kunden- oder Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Verbraucher nicht vorhanden` – Der angegebene Verbraucher der zugehörigen Partei ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Kunden-Account nicht vorhanden` – Der angegebene zugehörige Vertragspartei-Kunde ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Auftragserstellung fehlgeschlagen` – Der angeforderte Auftrag kann nicht erstellt werden. `In-Ausführungs-Überarbeitung von Auftragswährung nicht unterstützt` : Der Parameter orderCurrency kann nicht aktualisiert werden, nachdem der Auftrag erstellt wurde. `Diese Bestellung muss noch in der Kundenauftragstabelle erstellt werden. Weitere Details finden Sie in der eingehenden Warteschlange.` : Die angegebene Auftrags-ID befindet sich nicht in der Kundenauftragstabelle. `Patch-Anforderung kann nicht gestellt werden, da der Erfüllungstyp des Auftrags nicht „liefern“ ist.` – Die Patch-Anforderung wurde für einen Auftrag gestellt, der einen anderen Erfüllungstyp als „Liefern“ hat.

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 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
Kanalname	Name des Kanals, der für den 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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge
externalId	Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge
href	Relativer Link zum Produktbestelldatensatz. Datentyp: Zeichenfolge
id	Sys_id des Kundenauftrags für diese Anforderung aktualisiert. Datentyp: Zeichenfolge
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]`
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. Datentyp: Zeichenfolge
productOrderItem	Liste, die die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
„productOrderItem.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“
produktbestellelement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
Bestellelement.externerProduktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Hinweis: Zuvor wurde beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID der Vorgang abgebrochen und ein Fehler zurückgegeben. Mit dem Release Xanadu wird dieser Parameter einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben und kein Fehler ausgegeben wird.
Bestellelement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
productOrderItem.id	Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
„productOrderItem.itemPrice.Preis.SteuerEinschlussBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
ProduktAuftragselement.Elementpreis.Preis.SteuerEinschlussBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge
ProduktAuftragselement.Elementpreis.Preis.SteuerEinschlussBetrag.Wert	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
ProduktBestellelement.Produkt	Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
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 Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, 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 `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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
Bestellelement.Produkt.Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Die Ausgangsversion ist die sys_id der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld 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
Produktbestellelement.Produkt.Produktspezifikation.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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array von Objekten `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
„productOrderItem.product.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. 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
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden im Feld „sys_id“ oder „external_id“ der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
„productOrderItem.productOffering.internalId“	Anfangsversion des Produktangebots. Die ursprüngliche Version ist die sys_id der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.interneVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld 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
ProduktBestellelement.Produktangebot.Version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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
Produktbestellungselement.Menge	Anzahl der Artikel, die der Bestellung zugeordnet sind. Datentyp: Zahl
„productOrderItem.state“	Aktueller Status des Produktbestellartikels. Datentyp: Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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örigePartei.Typ	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
state	Aktueller Status des Auftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrder`. 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"
}

Open API für Produktbestellung – PATCH /sn_ind_tmt_orm/productorder/{id}

Aktualisiert den angegebenen Kundenauftrag.

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Open API für Produktbestellung – PATCH /sn_ind_tmt_orm/order/productOrder/{id}.

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/productorder/{id}

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter
Name	Beschreibung
id	Sys_id des zu aktualisierenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]

Tabelle : 32. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 33. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Kanal	Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array von Objekten `"channel": [ { "id": "String", "name": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
channel.id	Erforderlich, wenn der Parameter channel verwendet wird. Eindeutiger Bezeichner des Kanals, der für den 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: Feld „channel“ der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
Kanalname	Name des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen sind auf der Registerkarte „Auswahlliste“ im Wörterbucheintrag „Kanal“ 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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Wenn die Aktion für Auftragspositionen `„aussetzen“` oder `„fortsetzen“`ist, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „committed_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: Feld „external_id“ der Tabelle „sn_ind_tmt_orm_order“ Standard: Leere Zeichenfolge
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. 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 die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.action	Erforderlich, wenn der Parameter productOrderItem verwendet wird. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change delete kein Change resume anhalten Datentyp: Zeichenfolge Gespeichert in: Das Aktionsfeld der Tabelle „sn_ind_tmt_orm_order_line_item“. Standard: add
„productOrderItem.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“
produktbestellelement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Wenn die Aktion für das Element `„unterbrechen“` oder `„fortsetzen“`lautet, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Gespeichert in: Feld „committed_due_date“ der Tabelle sn_ind_tmt_orm_order_line_item
Bestellelement.externerProduktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` Hinweis: Zuvor wurde beim Erstellen eines PATCH-Auftrags mit einer bereits vorhandenen externen Produktbestands-ID der Vorgang abgebrochen und ein Fehler zurückgegeben. Mit dem Release Xanadu wird dieser Parameter einfach ignoriert, wenn eine vorhandene externe Produktbestands-ID angegeben und kein Fehler ausgegeben wird.
Bestellelement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Feld „external_inventory_id“ der Tabelle „sn_ind_tmt_orm_order_line_item“ und Feld „sn_prd_invt_external_id“ der Tabelle „sn_prd_invt_product_inventory“.
productOrderItem.id	Erforderlich, wenn der Parameter productOrderItem verwendet wird. Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Gespeichert in: Feld „external_id“ der Tabelle „sn_ind_tmt_orm_order_line_item“ Maximale Länge: 40 Standard: Leere Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }` Gespeichert in: sn_ind_tmt_orm_order_line_item Standard: Leere Zeichenfolge
„productOrderItem.itemPrice.Preis.SteuerEnthalteneBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }` Gespeichert in: sn_ind_tmt_orm_order_line_item
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge Gespeichert in: Feld mrc oder nrc in der Tabelle sn_ind_tmt_orm_order_line_item.
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Gespeichert in: Feld mrc oder nrc 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
ProduktBestellelement.Produkt	Erforderlich, wenn productOrderItem.action „ändern“ oder „löschen“ ist. Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Erforderlich, wenn productOrderItem.action „ändern“ oder „löschen“ ist. 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 Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.product.place.id	Erforderlich, wenn der Parameter productOrderItem.product.place verwendet wird. Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [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 den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_characterist_value
productOrderItem.product.productMerkmal.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge Gespeichert in: Feld „Merkmale“ der Tabelle „sn_ind_tmt_orm_order_characterist_value“ Standard: Leere Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Der previous_charakterist_option_wert der Tabelle sn_ind_tmt_orm_order_characterist_value. Standard: Leere Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Feld „feature_option_value“ der Tabelle sn_ind_tmt_orm_order_characterist_value Standard: Leere Zeichenfolge
productOrderItem.product.productSpecification	Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Hinweis: Change-Aufträge (productOrderItem.action ist `change`) werden je nach Wert der Systemeigenschaft sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder unterschiedlich verarbeitet. Der Wert dieser Systemeigenschaft bestimmt, wie die Bestellung verarbeitet wird, wenn der Produktbestand eine andere Version aufweist als die im Auftrag angegebene. Wenn diese Systemeigenschaft auf „true“ (Standard) festgelegt ist, wird der Produktbestand automatisch auf die Version im Auftrag aktualisiert, indem die referenzierte Produktspezifikation geändert wird. Dadurch kann der Auftrag erfolgreich verarbeitet werden. Wenn diese Systemeigenschaft auf „false“ festgelegt ist und der Produktbestand eine andere Version als die in der Bestellung angegebene aufweist, schlägt die Bestellung aufgrund der Versionsabweichung fehl. Datentyp: Objekt `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Erforderlich, wenn der Parameter productOrderItem.product.productSpecification verwendet wird. 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.interneVersion	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
Produktbestellelement.Produkt.Produktspezifikation.Version	Externe_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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array von Objekten `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item_contact
ProduktBestellelement.Produkt.zugehörigePartei.E-Mail	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld „E-Mail“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld first_name der Tabelle sn_ind_tmt_orm_order_line_item_contact Standard: Leere Zeichenfolge
productOrderItem.product.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge Gespeichert in: Feld „sys_id“ der Tabelle sn_ind_tmt_orm_order_line_item_contact Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld „lastName“ der Tabelle sn_ind_tmt_orm_order_line_item_contact Standard: Leere Zeichenfolge
ProduktBestellelement.Produkt.zugehörigePartei.Telefon	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.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. 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
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
ProduktBestellelement.Produktangebot.ID	Erforderlich, wenn der Parameter productOrderItem.productOffering verwendet wird. Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden im Feld „sys_id“ oder „external_id“ der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
ProduktBestellelement.Produktangebot.interneVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.Name	Name des Produktangebots Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
ProduktBestellelement.Produktangebot.Version	Externe_Version des Produktangebots Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
Produktbestellungselement.Produktbestellungselement.Menge	Anzahl der Artikel, die der Bestellung zugeordnet sind. Datentyp: Zahl Gespeichert in: Das Mengenfeld von „sn_ind_tmt_orm_order“. Standard: null
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item
„productOrderItem.productOrderItemRelationship.id“	Erforderlich, wenn der Parameter productOrderItem.productOrderItemRelationship verwendet wird. Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Gespeichert in: Feld „parent_line_item“ der Tabelle „bsn_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 Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. `„Erfordert“` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
Produktbestellungselement.Menge	Anzahl der bestellten Artikel. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
productOrderItem.revisionOperation	Typ der Aktualisierung, die für die Position durchgeführt werden soll. Wenn dieser Wert leer ist, wird die vorhandene Position aktualisiert, oder es wird eine neue Position hinzugefügt, wenn sie noch nicht vorhanden ist. Wenn dieser Wert `gleich „stornieren“`ist, wird die Position storniert. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
Zugehörigepartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
Zugehörigepartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge Gespeichert in: Feld „expected_end_date“ der Tabelle „sn_ind_tmt_orm_order“ Standard: Leere Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. 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 `ProductOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

Kopfzeilen

Tabelle : 34. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 35. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodes der REST-API.

Tabelle : 36. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Wenn Probleme mit den Merkmalen oder Merkmalsoptionsinformationen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizen-Feldern des zugehörigen Kundenauftragspositionselement-Datensatzes: `Die folgenden Merkmale für Bestellelemente sind nicht vorhanden: Überprüfen Sie die Spezifikation <characteristic.name>, und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen.` `Merkmal des Bestellelements: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: `Ungültige Nutzlast: Anforderungstext fehlt` – Nutzlast wurde im Anforderungstext nicht übergeben. `Ungültige Nutzlast: productOrderItem fehlt` – Objekt für Produktauftragsposition oder JSON fehlt. `Ungültige Nutzlast: productOrderItem-ID fehlt` – Der Parameter id fehlt in der Produktbestellposition der Nutzlast. `Ungültige Nutzlast: Aktion „productOrderItem“ fehlt` – Der Parameter action fehlt in der Produktbestellposition der Nutzlast. `Ungültige Nutzlast: productOrderItem Produktangebot fehlt` – Das Produktangebotsobjekt oder JSON fehlt in der Produktbestellposition in der Nutzlast. `Ungültige Nutzlast: Produktangebots-ID fehlt` – Der Parameter id fehlt in der Produktbestellposition des Produktangebotsobjekts in der Nutzlast. `Ungültige Nutzlast: Produktangebot ist nicht vorhanden` – Das Produktangebot in der Produktauftragsposition ist nicht gültig. `Ungültige Nutzlast: Produkt „productOrderItem“ fehlt` : Das Produktobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produkt, Produktspezifikation fehlt` – Das Produktspezifikationsobjekt oder JSON in der Produktbestellposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikations-ID fehlt` – Der Parameter id in der Produktbestellposition des Produktspezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikation ist nicht vorhanden` – Die Produktspezifikation in der Produktauftragsposition ist ungültig. `Ungültige Nutzlast: Produktbestand nicht vorhanden` – In einem Change-Auftrag (Aktion = Change) ist die Menge eines Artikels größer als der Bestand. `Ungültige Nutzlast: Produktbestands-ID fehlt` – in einem Change-Auftrag fehlt product.id in der Nutzlast. `Ungültige Nutzlast: Verkauftes Produkt ist inaktiv` – In einem Change-Auftrag ist ein in der Nutzlast angegebenes Produkt inaktiv. `Ungültige Nutzlast: „relatedParty“ fehlt` : Das Objekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Kunden-Account oder Verbraucher fehlt` – Das Kunden- oder Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Verbraucher nicht vorhanden` – Der angegebene Verbraucher der zugehörigen Partei ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Kunden-Account nicht vorhanden` – Der angegebene zugehörige Vertragspartei-Kunde ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Auftragserstellung fehlgeschlagen` – Der angeforderte Auftrag kann nicht erstellt werden. `Ungültige Nutzlast: Dieser Auftrag muss noch in der Kundenauftragstabelle erstellt werden. Weitere Details finden Sie in der eingehenden Warteschlange.` Die Patch-Anforderung wurde für einen Auftrag gestellt, der sich noch nicht in der Kundenauftragstabelle befindet. Der Auftrag befindet sich in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] und wartet darauf, dass der Planer den zu verarbeitenden Datensatz auswählt. `Ungültige Nutzlast: Die Patch-Anforderung kann nicht gestellt werden, da der Erfüllungstyp des Auftrags nicht „liefern“ ist.` Die Patch-Anforderung wurde für einen Auftrag gestellt, der einen anderen Erfüllungstyp als deliverhat.

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 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
Kanalname	Name des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
id	Sys_id des Kundenauftrags für diese Anforderung aktualisiert. Datentyp: Zeichenfolge
externalId	Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]`
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge
productOrderItem	Liste, die die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
„productOrderItem.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. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
„productOrderItem.itemPrice.Preis.SteuerEinschlussBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
ProduktAuftragselement.Elementpreis.Preis.SteuerEinschlussBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge
ProduktAuftragselement.Elementpreis.Preis.SteuerEinschlussBetrag.Wert	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
ProduktBestellelement.Produkt	Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
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 Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, 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 `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array von Objekten `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Auftragspositionselement – Kontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
„productOrderItem.product.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. 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
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden 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
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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
Produktbestellungselement.Menge	Anzahl der Artikel, die der Bestellung zugeordnet sind. Datentyp: Zahl
„productOrderItem.state“	Aktueller Status des Produktbestellartikels. Datentyp: Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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örigePartei.Typ	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
state	Aktueller Status des Auftrags. Datentyp: Zeichenfolge
@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Codebeispiel wird der Kanal für einen Kundenauftrag aktualisiert.

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",
                        "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",
                        "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"
}

Open API für Produktbestellung – POST /sn_ind_tmt_orm/cancelproductorder

Storniert den angegebenen Kundenauftrag.

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/cancelproductorder

Unterstützte Anforderungsparameter

Tabelle : 37. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 38. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 39. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Stornierungsgrund	Grund für Abbruch. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Produktbestellung	Enthält Daten zur Produktbestellung. Datentyp: Objekt `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.id	Erforderlich. Sys_id des zu stornierenden Kundenauftrags. Datentyp: Zeichenfolge Tabelle: Kundenauftrag [sn_ind_tmt_orm_order]
„productOrder.href“	URL des zu stornierenden Kundenauftrags. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
productOrder.@referredType	Der Wert für diesen Parameter muss `ProductOrder`sein. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
RequestCancelationDate	Datum, bis zu dem der Auftrag storniert werden soll. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
@type	Der Wert für diesen Parameter muss `CancelProductOrder`sein. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge

Header

Tabelle : 40. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 41. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodes der REST-API.

Tabelle : 42. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt:<field name> . Ungültige Auftrags-ID. Ungültige Auftrags-ID: `Dieser Auftrag muss noch in der Kundenauftragstabelle erstellt werden`. Die Stornierungsanforderung wurde für einen Auftrag gestellt, der noch nicht erstellt wurde. Der Auftrag befindet sich in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] und wartet darauf, dass der Planer den Datensatz abruft.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Stornierungsgrund	Grund für Abbruch. Datentyp: Zeichenfolge
href	URL des stornierten Auftrags. Datentyp: Zeichenfolge
id	Sys_id des stornierten Auftrags. Datentyp: Zeichenfolge
Produktbestellung	Daten zur Produktbestellung. Datentyp: Objekt `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
Produktbestell.ID	Sys_id des stornierten Auftrags. Datentyp: Zeichenfolge
„productOrder.href“	URL des stornierten Auftrags. Datentyp: Zeichenfolge
productOrder.@referredType	Der Wert für diesen Parameter ist `ProductOrder`. Datentyp: Zeichenfolge
RequestCancelationDate	Datum, bis zu dem der Auftrag storniert werden soll. Datentyp: Zeichenfolge
state	Status des Abbruchs. Wenn die Abbruchanforderung 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"
}

Open API für Produktbestellung – POST /sn_ind_tmt_orm/order/productOrder

Erstellt den angegebenen Kundenauftrag und die Kundenauftragspositionen.

Nach der Verarbeitung werden Datensätze in den folgenden Tabellen erstellt:

Kundenbestellung [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characterist_value]
Bestellposition [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Bestellposition [sn_ind_tmt_orm_order_line_related_items]

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/order/productOrder

Unterstützte Anforderungsparameter

Tabelle : 43. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 44. Abfrageparameter
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

Tabelle : 45. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Kanal	Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array von Objekten `"channel": [ { "id": "String", "name": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
channel.id	Erforderlich. Eindeutiger Bezeichner des Kanals, der für den 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: Feld „channel“ der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
Kanalname	Name des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen sind auf der Registerkarte „Auswahlliste“ im Wörterbucheintrag „Kanal“ 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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge Gespeichert in: Feld „committed_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: Feld „external_id“ der Tabelle „sn_ind_tmt_orm_order“ Standard: Leere Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Hinweis	Zusätzliche Hinweise, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
Anmerkung.Text	Erforderlich. Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
orderCurrency	Erforderlich. Währungscode für den Auftrag und die Bestellpositionen. Die Währung muss für alle Elemente des Auftrags und der Bestellpositionen identisch sein. Andernfalls wird ein Fehler zurückgegeben, und der Auftrag wird nicht erstellt. Sobald ein Auftrag erstellt wurde, kann sein Währungscode nicht mehr geändert werden. Datentyp: Zeichenfolge
productOrderItem	Erforderlich. Elemente, die der Produktbestellung zugeordnet sind, und zugehörige Aktion. Datentyp: Array von Objekten `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item]
productOrderItem.action	Erforderlich. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change delete kein Change resume anhalten Datentyp: Zeichenfolge Gespeichert in: Aktionsfeld der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]
„productOrderItem.actionReason“	Optional. Beschreibung des Grunds für die Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld „action_reason“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]
produktbestellelement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge Gespeichert in: Feld „committed_due_date“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]
Bestellelement.externerProduktbestand	Externe IDs zur Zuordnung zu den für den Auftrag erstellten Produktbeständen. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
Bestellelement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Feld „external_inventory_id“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item] und 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
Produktbestellungselement.Artikelpreis	Preis, der dem Produkt zugeordnet ist. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item] Standard: Leere Zeichenfolge
„productOrderItem.itemPrice.Preis.SteuerEnthalteneBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item]
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge Gespeichert in: Das Feld mrc oder nrc der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Gespeichert in: Das Feld mrc oder nrc der Tabelle „Auftragspositionselement“ [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
ProduktBestellelement.Produkt	Erforderlich, wenn productOrderItem.action „ändern“ oder „löschen“ ist. Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item]
productOrderItem.product.id	Erforderlich, wenn productOrderItem.action „ändern“ oder „löschen“ ist. 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 Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item]
productOrderItem.product.place.id	Erforderlich. Sys_id des zugeordneten Standortdatensatzes. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] Gespeichert in: Standortfeld der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Merkmale des zugeordneten Produkts. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_characterist_value
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: Merkmal [sn_prd_pm_charakteristik] Gespeichert in: Feld „Merkmale“ der Tabelle „sn_ind_tmt_orm_order_characterist_value“ Standard: Leere Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmaloptionswerte, wenn die Aktualisierung für den Change-Auftrag gilt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Feld previous_characterist_option_value der Tabelle sn_ind_tmt_orm_order_characterist_value Standard: Leere Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Feld „feature_option_value“ der Tabelle sn_ind_tmt_orm_order_characterist_value Standard: Leere Zeichenfolge
productOrderItem.product.productSpecification	Erforderlich. Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Hinweis: Change-Aufträge (productOrderItem.action ist `change`) werden je nach Wert der Systemeigenschaft sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder unterschiedlich verarbeitet. Der Wert dieser Systemeigenschaft bestimmt, wie die Bestellung verarbeitet wird, wenn der Produktbestand eine andere Version aufweist als die im Auftrag angegebene. Wenn diese Systemeigenschaft auf „true“ (Standard) festgelegt ist, wird der Produktbestand automatisch auf die Version im Auftrag aktualisiert, indem die referenzierte Produktspezifikation geändert wird. Dadurch kann der Auftrag erfolgreich verarbeitet werden. Wenn diese Systemeigenschaft auf „false“ festgelegt ist und der Produktbestand eine andere Version als die in der Bestellung angegebene aufweist, schlägt die Bestellung aufgrund der Versionsabweichung fehl. Datentyp: Objekt `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Erforderlich. Anfangsversion oder externe ID der Produktspezifikation. Die Ausgangsversion ist die sys_id der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.name	Name der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
Produktbestellelement.Produkt.Produktspezifikation.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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Parteirollen, die mit einem OrderLineItemContact verknüpft sind. Datentyp: Array von Objekten `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld „E-Mail“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld first_name der Tabelle sn_ind_tmt_orm_order_line_item_contact Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Gespeichert in: 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.relatedPartei.@referredType“	Erforderlich. Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. 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
ProduktBestellelement.Produktangebot	Erforderlich. Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Erforderlich. Anfangsversion oder externe ID des Produktangebots. Die ursprüngliche Version ist die sys_id der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.interneVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Name des Produktangebots Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.Version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
Produktbestellungselement.Produktbestellungselement.Menge	Anzahl der Artikel, die der Bestellung zugeordnet sind. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: null
Produktbestellungselement.ProduktbestellungselementBeziehung	Erforderlich. Liste, die die über- und untergeordnete Beziehung zwischen Bestellpositionen beschreibt. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Erforderlich. Identifiziert sich mit dem Wert productOrderItem.id. Wird für die Beziehung zwischen über- und untergeordneten Elementen verwendet Datentyp: Zeichenfolge Gespeichert in: 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: HasChild Hat übergeordnet Datentyp: Zeichenfolge
Produktbestellungselement.Menge	Anzahl der bestellten Artikel. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts oder Kundenkontakts, der dem Auftrag zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Tabelle für Account [customer_account], Kontakttabelle [customer_contact] oder Tabelle für Verbraucher [csm_consumer]
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Erforderlich. Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge Gespeichert in: Feld „expected_end_date“ der Tabelle „sn_ind_tmt_orm_order“ Standard: Leere Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. 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 `ProductOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

Header

Tabelle : 46. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 47. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodes der REST-API.

Tabelle : 48. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Wenn Probleme mit den Merkmalen oder Merkmalsoptionsinformationen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizen-Feldern des zugehörigen Kundenauftragspositionselement-Datensatzes: `Die folgenden Merkmale für Bestellelemente sind nicht vorhanden: Überprüfen Sie die Spezifikation <characteristic.name>, und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen.` `Merkmal des Bestellelements: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
202	Akzeptiert. Erfolgreiche Anforderung für eine Bestellung im asynchronen Modus. Das heißt, bei der Anforderung wurde der Parameter mode auf `async` festgelegt, und der Datensatz ist zur Verarbeitung in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] geplant.
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: `Ungültige Nutzlast: Anforderungstext fehlt` – Nutzlast wurde im Anforderungstext nicht übergeben. `Ungültige Nutzlast: productOrderItem fehlt` – Objekt für Produktauftragsposition oder JSON fehlt. `Ungültige Nutzlast: productOrderItem-ID fehlt` – Der Parameter id fehlt in der Produktbestellposition der Nutzlast. `Ungültige Nutzlast: Aktion „productOrderItem“ fehlt` – Der Parameter action fehlt in der Produktbestellposition der Nutzlast. `Ungültige Nutzlast: productOrderItem Produktangebot fehlt` – Das Produktangebotsobjekt oder JSON fehlt in der Produktbestellposition in der Nutzlast. `Ungültige Nutzlast: Produktangebots-ID fehlt` – Der Parameter id fehlt in der Produktbestellposition des Produktangebotsobjekts in der Nutzlast. `Ungültige Nutzlast: Produktangebot ist nicht vorhanden` – Das Produktangebot in der Produktauftragsposition ist nicht gültig. `Ungültige Nutzlast: Produkt „productOrderItem“ fehlt` : Das Produktobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produkt, Produktspezifikation fehlt` – Das Produktspezifikationsobjekt oder JSON in der Produktbestellposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikations-ID fehlt` – Der Parameter id in der Produktbestellposition des Produktspezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikation ist nicht vorhanden` – Die Produktspezifikation in der Produktauftragsposition ist ungültig. `Ungültige Nutzlast: Produktbestand nicht vorhanden` – In einem Change-Auftrag (Aktion = Change) ist die Menge eines Artikels größer als der Bestand. `Ungültige Nutzlast: Produktbestands-ID fehlt` – im Change-Auftrag fehlt product.id in der Nutzlast. `Ungültige Nutzlast: Verkauftes Produkt ist inaktiv` – In einem Change-Auftrag ist ein in der Nutzlast angegebenes Produkt inaktiv. `Ungültige Nutzlast: „relatedParty“ fehlt` : Das Objekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Kunden-Account oder Verbraucher fehlt` – Das Kunden- oder Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Verbraucher nicht vorhanden` – Der angegebene Verbraucher der zugehörigen Partei ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Kunden-Account nicht vorhanden` – Der angegebene zugehörige Vertragspartei-Kunde ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Auftragserstellung fehlgeschlagen` – Der angeforderte Auftrag kann nicht erstellt werden. `Ungültige Nutzlast: orderCurrency ist erforderlich` – Der Parameter orderCurrency fehlt in der Nutzlast. `Inaktiver Währungscode:` <currency> Die angegebene Währung ist in der Instanz ServiceNow inaktiv. `Mindestens ein Einzelposten hat einen anderen Währungscode als die Auftragswährung` – Nicht alle Einzelposten haben denselben Währungscode wie die Auftragswährung. `In-Ausführungs-Überarbeitung von Auftragswährung nicht unterstützt` : Der Parameter orderCurrency kann nicht aktualisiert werden, nachdem der Auftrag erstellt wurde.

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 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
Kanalname	Name des Kanals, der für den 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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge
externalId	Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge
href	Relativer Link zum Produktbestelldatensatz. Datentyp: Zeichenfolge
id	Sys_id des Kundenauftrags, der für diese Anforderung erstellt wurde. Datentyp: Zeichenfolge
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]`
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. 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 Zeitplan zur Verarbeitung hinzugefügt. Hinweis: Dieser Wert ist das einzige Ergebnis, wenn der Auftrag asynchron mit dem Abfrageparameter mode erstellt wird. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Datentyp: Zeichenfolge
productOrderItem	Liste, die die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
„productOrderItem.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“
produktbestellelement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
Bestellelement.externerProduktbestand	Liste der externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
Bestellelement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
productOrderItem.id	Eindeutiger Bezeichner der Position. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
„productOrderItem.itemPrice.Preis.SteuerEinschlussBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
ProduktAuftragselement.Elementpreis.Preis.SteuerEinschlussBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge
ProduktAuftragselement.Elementpreis.Preis.SteuerEinschlussBetrag.Wert	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
ProduktBestellelement.Produkt	Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
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.action`change` oder `delete`ist. Wenn sowohl „sys_id“ als auch „external_id“ vorhanden sind, wird „external_id“ zurückgegeben. Datentyp: Zeichenfolge
productOrderItem.product.place	Karten der Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, 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 Bestellposition. Datentyp: Array `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
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 dem Auftragspositionselement und dem Produktbestand. Möglicher Wert: Erfordert Datentyp: Zeichenfolge
productOrderItem.product.productSpecification	Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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 „external_id“ zurückgegeben. Datentyp: Zeichenfolge
Bestellelement.Produkt.Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Die Ausgangsversion ist die sys_id der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld 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
Produktbestellelement.Produkt.Produktspezifikation.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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array von Objekten `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
„productOrderItem.product.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. 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
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden 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 „external_id“ zurückgegeben. Datentyp: Zeichenfolge
„productOrderItem.productOffering.internalId“	Anfangsversion des Produktangebots. Die ursprüngliche Version ist die sys_id der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.interneVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld 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
ProduktBestellelement.Produktangebot.Version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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 Hat übergeordnet Erfordert `„HasChild“` und `„HasParent“` werden für Beziehungen zwischen über- und untergeordneten Elementen verwendet. `„Erfordert“` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
Produktbestellungselement.Menge	Anzahl der Artikel, die der Bestellung zugeordnet sind. Datentyp: Zahl
„productOrderItem.state“	Aktueller Status des Produktbestellartikels. Dieser Wert ist immer `neu`. Datentyp: Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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örigePartei.Typ	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
state	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 `ProductOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

Wird asynchron verarbeitet

In diesem Beispiel wird gezeigt, wie der Abfrageparameter mode verwendet wird, um einen Auftrag asynchron zu erstellen. 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"
}

Synchrone Verarbeitung (Standard)

Das folgende Beispiel zeigt, wie eine Produktbestellung erstellt wird.

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"
}

Open API für Produktbestellung – POST /sn_ind_tmt_orm/productorder

Erstellt den angegebenen Kundenauftrag und die Kundenauftragspositionen.

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Open API für Produktbestellung – POST /sn_ind_tmt_orm/order/productOrder.

Nach der Verarbeitung werden in den folgenden Tabellen neue Datensätze erstellt:

Kundenbestellung [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characterist_value]
Bestellposition [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]

URL-Format

Standard-URL: /api/sn_ind_tmt_orm/productorder

Unterstützte Anforderungsparameter

Tabelle : 49. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 50. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 51. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Kanal	Liste der Kanäle, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array von Objekten `"channel": [ { "id": "String", "name": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
channel.id	Erforderlich. Eindeutiger Bezeichner des Kanals, der für den 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: Feld „channel“ der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
Kanalname	Name des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen sind auf der Registerkarte „Auswahlliste“ im Wörterbucheintrag „Kanal“ 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 den committedDueDate -Werten für jede Bestellposition übereinstimmen oder später als diese sein. Datentyp: Zeichenfolge Gespeichert in: Feld „committed_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: Feld „external_id“ der Tabelle „sn_ind_tmt_orm_order“ Standard: Leere Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Hinweis	Zusätzliche Hinweise, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order
Anmerkung.Text	Erforderlich. Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge Gespeichert in: Kommentarfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
orderCurrency	Erforderlich. Währungscode für den Auftrag und die Bestellpositionen. Die Währung muss für alle Elemente des Auftrags und der Bestellpositionen identisch sein. Andernfalls wird ein Fehler zurückgegeben, und der Auftrag wird nicht erstellt. Sobald ein Auftrag erstellt wurde, kann sein Währungscode nicht mehr geändert werden. Datentyp: Zeichenfolge
productOrderItem	Erforderlich. Elemente, die der Produktbestellung zugeordnet sind, und zugehörige Aktion. Datentyp: Array von Objekten `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item]
productOrderItem.action	Erforderlich. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind auf der Registerkarte „Auswahlliste“ im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change delete kein Change resume anhalten Datentyp: Zeichenfolge Gespeichert in: Aktionsfeld der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]
„productOrderItem.actionReason“	Optional. Beschreibung des Grunds für die Auftragsposition. Datentyp: Zeichenfolge Gespeichert in: Feld „action_reason“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]
produktbestellelement.committedFälligkeitsdatum	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge Gespeichert in: Feld „committed_due_date“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]
Bestellelement.externerProduktbestand	Externe IDs zur Zuordnung zu den für den Auftrag erstellten Produktbeständen. Datentyp: Array von Objekten `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
Bestellelement.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Gespeichert in: Feld „external_inventory_id“ der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item] und 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
Produktbestellungselement.Artikelpreis	Preis, der dem Produkt zugeordnet ist. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item] Standard: Leere Zeichenfolge
„productOrderItem.itemPrice.Preis.SteuerEnthalteneBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item]
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge Gespeichert in: Das Feld mrc oder nrc der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
ProduktAuftragselement.Elementpreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Gespeichert in: Das Feld mrc oder nrc der Tabelle „Auftragspositionselement“ [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
ProduktBestellelement.Produkt	Erforderlich, wenn productOrderItem.action „ändern“ oder „löschen“ ist. Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item]
productOrderItem.product.id	Erforderlich, wenn productOrderItem.action „ändern“ oder „löschen“ ist. 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 Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }` Gespeichert in: Bestellposition [sn_ind_tmt_orm_order_line_item]
productOrderItem.product.place.id	Erforderlich. Sys_id des zugeordneten Standortdatensatzes. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] Gespeichert in: Standortfeld der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item].
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `Place`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Merkmale des zugeordneten Produkts. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_characterist_value
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: Merkmal [sn_prd_pm_charakteristik] Gespeichert in: Feld „Merkmale“ der Tabelle „sn_ind_tmt_orm_order_characterist_value“ Standard: Leere Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmaloptionswerte, wenn die Aktualisierung für den Change-Auftrag gilt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Feld previous_characterist_option_value der Tabelle sn_ind_tmt_orm_order_characterist_value Standard: Leere Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, die dem Produkt zugeordnet sind. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge Gespeichert in: Feld „feature_option_value“ der Tabelle sn_ind_tmt_orm_order_characterist_value Standard: Leere Zeichenfolge
productOrderItem.product.productSpecification	Erforderlich. Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Hinweis: Change-Aufträge (productOrderItem.action ist `change`) werden je nach Wert der Systemeigenschaft sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder unterschiedlich verarbeitet. Der Wert dieser Systemeigenschaft bestimmt, wie die Bestellung verarbeitet wird, wenn der Produktbestand eine andere Version aufweist als die im Auftrag angegebene. Wenn diese Systemeigenschaft auf „true“ (Standard) festgelegt ist, wird der Produktbestand automatisch auf die Version im Auftrag aktualisiert, indem die referenzierte Produktspezifikation geändert wird. Dadurch kann der Auftrag erfolgreich verarbeitet werden. Wenn diese Systemeigenschaft auf „false“ festgelegt ist und der Produktbestand eine andere Version als die in der Bestellung angegebene aufweist, schlägt die Bestellung aufgrund der Versionsabweichung fehl. Datentyp: Objekt `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Erforderlich. Anfangsversion oder externe ID der Produktspezifikation. Die Ausgangsversion ist die sys_id der ersten Version der Spezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
productOrderItem.product.productSpecification.name	Name der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
Produktbestellelement.Produkt.Produktspezifikation.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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Parteirollen, die mit einem OrderLineItemContact verknüpft sind. Datentyp: Array von Objekten `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld „E-Mail“ der Tabelle „sn_ind_tmt_orm_order_line_item_contact“. Standard: Leere Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge Gespeichert in: Feld first_name der Tabelle sn_ind_tmt_orm_order_line_item_contact Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Gespeichert in: 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.relatedPartei.@referredType“	Erforderlich. Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. 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
ProduktBestellelement.Produktangebot	Erforderlich. Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Erforderlich. Anfangsversion oder externe ID des Produktangebots. Die ursprüngliche Version ist die sys_id der ersten Version des Angebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.interneVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
productOrderItem.productOffering.name	Name des Produktangebots Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]
ProduktBestellelement.Produktangebot.Version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
Produktbestellungselement.Produktbestellungselement.Menge	Anzahl der Artikel, die der Bestellung zugeordnet sind. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: null
Produktbestellungselement.ProduktbestellungselementBeziehung	Erforderlich. Liste, die die über- und untergeordnete Beziehung zwischen Bestellpositionen beschreibt. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` Gespeichert in: sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Erforderlich. Identifiziert sich mit dem Wert productOrderItem.id. Wird für die Beziehung zwischen über- und untergeordneten Elementen verwendet Datentyp: Zeichenfolge Gespeichert in: 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: HasChild Hat übergeordnet Datentyp: Zeichenfolge
Produktbestellungselement.Menge	Anzahl der bestellten Artikel. Datentyp: Zahl Gespeichert in: Das Mengenfeld der Tabelle „sn_ind_tmt_orm_order“. Standard: Leere Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts oder Kundenkontakts, der dem Auftrag zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Tabelle für Account [customer_account], Kontakttabelle [customer_contact] oder Tabelle für Verbraucher [csm_consumer]
relatedParty.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
zugehörigepartei.@referenztyp	Erforderlich. Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
zugehörigepartei.@typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedParty`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge Gespeichert in: Feld „expected_end_date“ der Tabelle „sn_ind_tmt_orm_order“ Standard: Leere Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. 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 `ProductOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

Kopfzeilen

Tabelle : 52. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 53. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur 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 HTTP-Antwortcodes der REST-API.

Tabelle : 54. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Wenn Probleme mit den Merkmalen oder Merkmalsoptionsinformationen auftreten, speichert der Endpunkt die folgenden Kommentare in den Arbeitsnotizen-Feldern des zugehörigen Kundenauftragspositionselement-Datensatzes: `Die folgenden Merkmale für Bestellelemente sind nicht vorhanden: Überprüfen Sie die Spezifikation <characteristic.name>, und korrigieren Sie das Merkmal und die Merkmalsoption in der Auftragsposition, bevor Sie den Auftrag genehmigen.` `Merkmal des Bestellelements: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: `Ungültige Nutzlast: Anforderungstext fehlt` – Nutzlast wurde im Anforderungstext nicht übergeben. `Ungültige Nutzlast: productOrderItem fehlt` – Objekt für Produktauftragsposition oder JSON fehlt. `Ungültige Nutzlast: productOrderItem-ID fehlt` – Der Parameter id fehlt in der Produktbestellposition der Nutzlast. `Ungültige Nutzlast: Aktion „productOrderItem“ fehlt` – Der Parameter action fehlt in der Produktbestellposition der Nutzlast. `Ungültige Nutzlast: productOrderItem Produktangebot fehlt` – Das Produktangebotsobjekt oder JSON fehlt in der Produktbestellposition in der Nutzlast. `Ungültige Nutzlast: Produktangebots-ID fehlt` – Der Parameter id fehlt in der Produktbestellposition des Produktangebotsobjekts in der Nutzlast. `Ungültige Nutzlast: Produktangebot ist nicht vorhanden` – Das Produktangebot in der Produktauftragsposition ist nicht gültig. `Ungültige Nutzlast: Produkt „productOrderItem“ fehlt` : Das Produktobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produkt, Produktspezifikation fehlt` – Das Produktspezifikationsobjekt oder JSON in der Produktbestellposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikations-ID fehlt` – Der Parameter id in der Produktbestellposition des Produktspezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikation ist nicht vorhanden` – Die Produktspezifikation in der Produktauftragsposition ist ungültig. `Ungültige Nutzlast: Produktbestand nicht vorhanden` – In einem Change-Auftrag (Aktion = Change) ist die Menge eines Artikels größer als der Bestand. `Ungültige Nutzlast: Produktbestands-ID fehlt` – im Change-Auftrag fehlt product.id in der Nutzlast. `Ungültige Nutzlast: Verkauftes Produkt ist inaktiv` – In einem Change-Auftrag ist ein in der Nutzlast angegebenes Produkt inaktiv. `Ungültige Nutzlast: „relatedParty“ fehlt` : Das Objekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Kunden-Account oder Verbraucher fehlt` – Das Kunden- oder Verbraucherobjekt der zugehörigen Partei fehlt in der Nutzlast. `Ungültige Nutzlast: Verbraucher nicht vorhanden` – Der angegebene Verbraucher der zugehörigen Partei ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Kunden-Account nicht vorhanden` – Der angegebene zugehörige Vertragspartei-Kunde ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Auftragserstellung fehlgeschlagen` – Der angeforderte Auftrag kann nicht erstellt werden.

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 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der für den Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
Kanalname	Name des Kanals, der für den 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
Hinweis	Liste der zusätzlichen Notizen, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array von Objekten `"note": [ { "text": "String" } ]`
Anmerkung.Text	Zusätzliche Hinweise/Kommentare vom Kunden während der Bestellung. Datentyp: Zeichenfolge
productOrderItem	Liste, die die der Produktbestellung zugeordneten Elemente und die zugehörige Aktion beschreibt. Datentyp: Array von Objekten `"productOrderItem:" [ { "action": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
productOrderItem.action	Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen sind 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. Zu finden im Feld sn_ind_tmt_orm_external_id der Tabelle „Auftragspositionselement“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
Produktbestellungselement.Artikelpreis	Liste, die den dem Produkt zugeordneten Preis beschreibt. Datentyp: Array von Objekten `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
Produktbestellungselement.Artikelpreis.Preis	Beschreibung des Preises des zugeordneten Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
„productOrderItem.itemPrice.Preis.SteuerEinschlussBetrag“	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
ProduktAuftragselement.Elementpreis.Preis.SteuerEinschlussBetrag.Einheit	Währungscode, in dem der Preis dargestellt wird. Datentyp: Zeichenfolge
ProduktAuftragselement.Elementpreis.Preis.SteuerEinschlussBetrag.Wert	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
ProduktBestellelement.Produkt	Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
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.action`change` oder `delete`ist. Wenn sowohl „sys_id“ als auch „external_id“ vorhanden sind, wird „external_id“ zurückgegeben. Datentyp: Zeichenfolge
productOrderItem.product.place	Karten der Speicherorte, an denen das Produkt installiert werden soll. Datentyp: Objekt `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal	Liste der Merkmale des zugehörigen Produkts. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmaldatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik]. Datentyp: Zeichenfolge
„productOrderItem.product.productFeature. previousValue“	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action etwas anderes als `add`ist. Weitere Informationen zu Merkmalsoptionswerten finden Sie unter Create product characteristics and characteristic options. Datentyp: Zeichenfolge
productOrderItem.product.productMerkmal.Wert	Merkmaloptionswerte, 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 `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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 „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 `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei	Liste der Kontakte für Positionen. Datentyp: Array von Objekten `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	E-Mail-Adresse des Kontakts Datentyp: Zeichenfolge
Bestellelement.Produkt.zugehörigePartei.ersterName	Vorname des Kontakts Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedParty.phone	Geschäftliche Telefonnummer des Kontakts Datentyp: Zeichenfolge
„productOrderItem.product.relatedPartei.@referredType“	Typ des Kunden Möglicher Wert: OrderLineItemContact Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.@type	Teil des TMF Open API-Standards. Anmerkung für den Kontakt des Bestellpositionselements. Dieser Wert ist immer `RelatedParty`. 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
ProduktBestellelement.Produktangebot	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
productOrderItem.productOffering.id	Initial_version oder external_id des Produktangebots. initial_version ist die sys_id der ersten Version des Angebots. Zu finden 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 „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
Produktbestellungselement.ProduktbestellungselementBeziehung	Liste der Beziehungen zwischen Bestellpositionen. Datentyp: Array von Objekten `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Bezeichner des zugehörigen Einzelpostens. Zu finden 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
Produktbestellungselement.Menge	Anzahl der Artikel, die der Bestellung zugeordnet sind. Datentyp: Zahl
„productOrderItem.state“	Aktueller Status des Produktbestellartikels. Dieser Wert ist immer `neu`. Datentyp: Zeichenfolge
produktBestellelement.@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 aufführen, das Informationen zu Kunden- oder Verbraucherkonten enthält. Datentyp: Array von Objekten `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Zu finden 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örigePartei.Typ	Typ des Kunden Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
RequestedCompletionDate	Vom Kunden angefordertes Lieferdatum Datentyp: Zeichenfolge
Angefordertes Startdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
state	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 `ProductOrder`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Codebeispiel wird ein Kundenauftrag erstellt.

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",
            "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",
            "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",
                        "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",
                        "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"
}