Produktbestellung offene API

Freigeben Version: Washingtondc

Aktualisiert 1. Februar 2024

123 Minuten Lesedauer

Die Product Order Open API bietet einen standardisierten Mechanismus für die Produktbestellung.

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, sowie 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 innerhalb des Namespace sn_ind_tmt_orm bereitgestellt.

Der aufrufende Benutzer muss die Rolle sn_ind_tmt_orm.order_integrator haben.

Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, Anforderungstextvalidierung, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unterProduct Order Open API-Entwicklerleitfaden.

Die Product Order Open API ist eine ServiceNow® Implementierung der REST-Spezifikation TM Forum TMF622 Product Ordering Management API und ist vom TM Forum konform.

TMF-Konformitätslogo

Product Order Open API – GET /sn_ind_tmt_orm/order/productOrder

Ruft alle Produktbestellungen ab.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenauftrag [sn_ind_tmt_orm_order]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Auftragsposition [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. Wenn dieser Parameter nicht verwendet wird, werden alle Felder zurückgegeben. Datentyp: Zeichenfolge
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. Standard: 20 Höchstwert: 100 Datentyp: Zahl
Offset	Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Standard: 0 Datentyp: Zahl
Status	Filtern Sie Aufträge nach Status. Nur Aufträge mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 3. Anforderungstextparameter (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	Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Wenn beispielsweise `offset=2` und `limit=3`festgelegt ist, lautet der Wert der Kopfzeile Content-Range`items 3-5`.
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter previous
X-Gesamtzahl	Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	In Antwort zurückgegebene Teilressource (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	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher 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	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
Hinweis.Autor	Benutzername der Person, die die zugehörige Notiz verfasst hat. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. false: Der Point of no Return für die Bestellung wurde nicht erreicht. Datentyp: Boolesch
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
productOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
productOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
productOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl
productOrderItem.itemPrice.priceType	Typ des Elementpreises, 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 Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. false: Der Point of no Return für die Bestellung wurde nicht erreicht. Datentyp: Boolesch
productOrderItem.product	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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Es werden nur Produktmerkmale zurückgegeben, deren value sich von [ previousValue unterscheiden. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Datentyp: Zeichenfolge
productOrderItem.product.productRelationship	Liste der Produktbeziehungsdetails für eine Auftragsposition. Datentyp: Array `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld sys_id oder sn_prd_invt_external_id der Produktbestandstabelle [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
productOrderItem.product.productRelationship.relationshipType	Typ der Beziehung zwischen der Bestellposition 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 Produktspezifikationstabelle [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalId	Initial_version der Produktspezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in 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.version	External_version 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
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalId	Initial_version des Produktangebots. „initial_version“ ist die sys_id der ersten Version des Angebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalVersion	Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.version	External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
ProduktBestellposition.Menge	Anzahl der erworbenen Produktartikel. Datentyp: Zahl
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [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: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
produktBestellelement.status	Status der Bestellung des zugeordneten Produktelements. Datentyp: Zeichenfolge
productOrderItem.version	Bestellversion. Datentyp: Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
Status	Aktueller Status der Bestellung. 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"
   }
]

Product Order Open API – GET /sn_ind_tmt_orm/order/productOrder/{id}

Ruft die angegebene Produktbestellung ab.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenauftrag [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Auftragsposition [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. Befindet sich in der Kundenauftragstabelle [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 9. Anforderungstextparameter (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Content-Type	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-Antwortcodesder 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 „Success“ mit einer Fehlermeldung zurück, wenn der ausgewählte Auftrag Verarbeitungsprobleme aufweist. 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 Fehlermeldungsfeld enthält Details für den Datensatz. 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 eine Auftragserstellung fehlschlägt und der Datensatz in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] einen Fehlerstatus aufweist. Das Fehlermeldungsfeld enthält Details in für den Datensatz der Tabelle der eingehenden Warteschlange. Beispiel: `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
206	In Antwort zurückgegebene Teilressource (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	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher 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	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
Hinweis.Autor	Benutzername der Person, die die zugehörige Notiz verfasst hat. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. false: Der Point of no Return für die Bestellung wurde nicht erreicht. Datentyp: Boolesch
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
productOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
productOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
productOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl
productOrderItem.itemPrice.priceType	Typ des Elementpreises, 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 Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. false: Der Point of no Return für die Bestellung wurde nicht erreicht. Datentyp: Boolesch
productOrderItem.product	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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Es werden nur Produktmerkmale zurückgegeben, deren value sich von [ previousValue unterscheiden. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Datentyp: Zeichenfolge
productOrderItem.product.productRelationship	Liste der Produktbeziehungsdetails für eine Auftragsposition. Datentyp: Array `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld sys_id oder sn_prd_invt_external_id der Produktbestandstabelle [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
productOrderItem.product.productRelationship.relationshipType	Typ der Beziehung zwischen der Bestellposition 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 Produktspezifikationstabelle [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalId	Initial_version der Produktspezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in 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.version	External_version 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
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalId	Initial_version des Produktangebots. „initial_version“ ist die sys_id der ersten Version des Angebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalVersion	Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.version	External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
ProduktBestellposition.Menge	Anzahl der erworbenen Produktartikel. Datentyp: Zahl
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [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: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
produktBestellelement.status	Status der Bestellung des zugeordneten Produktelements. Datentyp: Zeichenfolge
productOrderItem.version	Bestellversion. Datentyp: Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
Status	Aktueller Status der Bestellung. 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"
}

Product Order Open API – GET /sn_ind_tmt_orm/productorder

Ruft alle Produktbestellungen ab.

Wichtig:

Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Product Order Open API – GET /sn_ind_tmt_orm/order/productOrder.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenauftrag [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement [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 Felder zurückgegeben.
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. Standard: 20 Höchstwert: 100 Datentyp: Zahl
Offset	Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Standard: 0 Datentyp: Zahl
Status	Filtern Sie Aufträge nach Status. Nur Aufträge mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge Standard: Alle zurückgegebenen Status.

Tabelle : 15. Anforderungstextparameter (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 16. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 17. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Wenn beispielsweise `offset=2` und `limit=3`festgelegt ist, lautet der Wert der Kopfzeile Content-Range`items 3-5`.
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter previous
X-Gesamtzahl	Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	In Antwort zurückgegebene Teilressource (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	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": { "author": "String", "date": "String", "text": "String" }`
Hinweis.Autor	Benutzername der Person, die die zugehörige Notiz verfasst hat. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. false: Der Point of no Return für die Bestellung wurde nicht erreicht. Datentyp: Boolesch
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
productOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl
productOrderItem.itemPrice.priceType	Typ des Elementpreises, 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 Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. false: Der Point of no Return für die Bestellung wurde nicht erreicht. Datentyp: Boolesch
productOrderItem.product	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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Es werden nur Produktmerkmale zurückgegeben, deren value sich von [ previousValue unterscheiden. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. 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 Produktspezifikationstabelle [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
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
ProduktBestellposition.Menge	Anzahl der erworbenen Produktartikel. Datentyp: Zahl
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [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: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
produktBestellelement.status	Status der Bestellung des zugeordneten Produktelements. Datentyp: Zeichenfolge
productOrderItem.version	Bestellversion. Datentyp: Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
Status	Aktueller Status der Bestellung. 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"
   }
]

Product Order Open API – 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 Product Order Open API – GET /sn_ind_tmt_orm/order/productOrder/{id}.

Dieser Endpunkt ruft Bestellinformationen aus den folgenden Tabellen ab:

Kundenauftrag [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement [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. Befindet sich in der Kundenauftragstabelle [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter (JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 22. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 23. Antwortkopfzeilen
Kopfzeile	Beschreibung
Content-Type	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-Antwortcodesder 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: Abfrageparameter fehlt Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Kanal	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
erwartetesAbschlussdatum	Datum, an dem der Auftrag abgeschlossen wird. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note": { "author": "String", "date": "String", "text": "String" }`
Hinweis.Autor	Benutzername der Person, die die zugehörige Notiz verfasst hat. Datentyp: Zeichenfolge
Hinweis.Datum	Datum, an dem die Notiz erstellt wurde. Datentyp: Zeichenfolge
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
ponr	Kennzeichnung, die angibt, ob der Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. false: Der Point of no Return für die Bestellung wurde nicht erreicht. Datentyp: Boolesch
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
productOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl
productOrderItem.itemPrice.priceType	Typ des Elementpreises, 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 Point of no Return für die Bestellung erreicht wurde. Gültige Werte: true: Der Point of no Return für die Bestellung wurde erreicht. false: Der Point of no Return für die Bestellung wurde nicht erreicht. Datentyp: Boolesch
productOrderItem.product	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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Es werden nur Produktmerkmale zurückgegeben, deren value sich von [ previousValue unterscheiden. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. 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 Produktspezifikationstabelle [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
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
ProduktBestellposition.Menge	Anzahl der erworbenen Produktartikel. Datentyp: Zahl
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [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: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
produktBestellelement.status	Status der Bestellung des zugeordneten Produktelements. Datentyp: Zeichenfolge
productOrderItem.version	Bestellversion. Datentyp: Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
Status	Aktueller Status der Bestellung. 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"
}

Product Order Open API – PATCH /sn_ind_tmt_orm/order/productOrder/{id}

Aktualisiert den angegebenen Kundenauftrag.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter
Name	Beschreibung
id	Sys_id des zu aktualisierenden Kundenauftrags. Befindet sich in der Kundenauftragstabelle [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge

Tabelle : 26. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 27. Anforderungstextparameter (JSON)
Name	Beschreibung
Kanal	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
channel.id	Erforderlich, wenn der Parameter channel verwendet wird. Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/channel Standard: Leere Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen werden auf der Registerkarte Auswahlliste im 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 Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Wenn die Aktion für Bestellpositionen `angehalten` oder `fortgesetzt`wird, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/committed_due_date
externe ID	Eindeutiger Bezeichner für den Kundenauftrag. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/external_id Standard: Leere Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/comments Standard: Leere Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. Das Aktualisieren des Währungscodes einer vorhandenen Bestellung 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
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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" } ]` Tabelle/Feld aktualisiert: 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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change löschen no-change resume anhalten Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action Standard: hinzufügen
productOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Wenn die Aktion für das Element `angehalten` oder `fortgesetzt`wird, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/committed_due_date
productOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_inventory_id und sn_prd_invt_product_inventory/sn_prd_invt_external_id
productOrderItem.id	Erforderlich, wenn der Parameter productOrderItem verwendet wird. Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_id Maximale Länge: 40 Standard: Leere Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Tabelle aktualisiert: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item Standard: Leere Zeichenfolge
productOrderItem.itemPrice.price.taxIncludedAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/mrc oder nrc
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/mrc oder nrc
productOrderItem.itemPrice.priceType	Typ des Elementpreises, wiederkehrend oder nicht wiederkehrend. Datentyp: Zeichenfolge
productOrderItem.itemPrice.recurringChargePeriod	Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. `Monat`. Datentyp: Zeichenfolge
productOrderItem.product	Erforderlich, wenn productOrderItem.action auf „Change/Disconnect“ festgelegt ist. Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product:" { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Erforderlich, wenn productOrderItem.action auf „Change/Disconnect“ festgelegt ist. Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld sys_id oder sn_ind_tmt_orm_external_id der Produktbestandstabelle [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" }` Tabelle/Feld aktualisiert: 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 Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/location Standard: Leere Zeichenfolge
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/characteristics Standard: Leere Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/ previous_characteristic_option_value Standard: Leere Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Standard: Leere 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" }` Tabelle/Feld aktualisiert: 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 Produktspezifikationstabelle [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in 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.version	External_version 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
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/email Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/first_name Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/sys_id Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/lastName Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/business_phone 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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `Produkt`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalVersion	Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.version	External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOrderItem.quantity	Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity Standard: null
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Erforderlich, wenn der Parameter productOrderItem.productOrderItemRelationship verwendet wird. Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/parent_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: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
ProduktBestellposition.Menge	Anzahl der bestellten Artikel. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity Standard: Leere Zeichenfolge
productOrderItem.revisionOperation	Typ der Aktualisierung, die für den Einzelposten ausgeführt werden soll. Wenn dieser Wert leer ist, wird der vorhandene Einzelposten aktualisiert oder ein neuer Einzelposten hinzugefügt, falls er noch nicht vorhanden ist. Wenn dieser Wert `storniert`wird, wird die Position storniert. Mögliche Werte: abbrechen Keine Aktualisieren Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_end_date Standard: Leere Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_start_date 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
Content-Type	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-Antwortcodesder 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 Arbeitsnotizfeldern des zugeordneten Datensatzes für die Kundenauftragsposition: `Die folgenden Merkmale der Bestellposition 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 der Bestellposition: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: `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 Produktauftragsposition der Nutzlast. `Ungültige Nutzlast: Aktion „productOrderItem“ fehlt` – Der Parameter action fehlt in der Produktauftragsposition der Nutzlast. `Ungültige Nutzlast: productOrderItem productOffering fehlt` – Das Produktangebotsobjekt oder JSON fehlt in der Produktauftragsposition in der Nutzlast. `Ungültige Nutzlast: ID des Produktangebots 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: productOrderItem Produkt fehlt` : Das Produktobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktproduktspezifikation fehlt` : Das Produktspezifikationsobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikations-ID fehlt`. Der Parameter id in der Produktauftragsposition des Produktspezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikation ist nicht vorhanden` – Die Produktspezifikation in der Produktauftragsposition ist nicht gültig. `Ungültige Nutzlast: Produktbestand ist 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: relatedPartei 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 ist nicht vorhanden` – Der angegebene zugehörige Verbraucher ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Kunden-Account ist nicht vorhanden` – Der angegebene Kunde der zugehörigen Partei ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Auftragserstellung fehlgeschlagen` – der angeforderte Auftrag kann nicht erstellt werden. `Überarbeitung während der Ausführung in Auftragswährung nicht unterstützt` – Der Parameter orderCurrency kann nach dem Erstellen des Auftrags nicht aktualisiert werden. `Dieser Auftrag muss noch in der Kundenauftragstabelle erstellt werden. Weitere Details finden Sie in der eingehenden Warteschlange.` – Die angegebene Auftrags-ID ist nicht in der Kundenauftragstabelle enthalten. `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 „Liefern“ aufweist.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Kanal	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Datentyp: Zeichenfolge
externe ID	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 aktualisiert wurde. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]`
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. Datentyp: Zeichenfolge
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
productOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
productOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
productOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge
productOrderItem.itemPrice.price.taxIncludeAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl
productOrderItem.itemPrice.priceType	Typ des Elementpreises, wiederkehrend oder nicht wiederkehrend. Datentyp: Zeichenfolge
productOrderItem.itemPrice.recurringChargePeriod	Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. `Monat`. Datentyp: Zeichenfolge
productOrderItem.product	Beschreibung der Instanzdetails des vom Kunden 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 Produktbestandstabelle [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.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. 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 Produktspezifikationstabelle [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalId	Initial_version der Produktspezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in 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.version	External_version 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
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `Produkt`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalId	Initial_version des Produktangebots. „initial_version“ ist die sys_id der ersten Version des Angebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalVersion	Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.version	External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [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
ProduktBestellposition.Menge	Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl
produktBestellelement.status	Aktueller Status der Produktbestellposition. Datentyp: Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.typ	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
Status	Aktueller Status der Bestellung. 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"
}

Product Order Open API – 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 Product Order Open API – 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. Befindet sich in der Kundenauftragstabelle [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge

Tabelle : 32. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 33. Anforderungstextparameter (JSON)
Name	Beschreibung
Kanal	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
channel.id	Erforderlich, wenn der Parameter channel verwendet wird. Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/channel Standard: Leere Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen werden auf der Registerkarte Auswahlliste im 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 Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Wenn die Aktion für Bestellpositionen `angehalten` oder `fortgesetzt`wird, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/committed_due_date
externe ID	Eindeutiger Bezeichner für den Kundenauftrag. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/external_id Standard: Leere Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/comments Standard: Leere Zeichenfolge
orderCurrency	Währungscode für den Auftrag und die Bestellpositionen. Das Aktualisieren des Währungscodes einer vorhandenen Bestellung 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
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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" } ]` Tabelle/Feld aktualisiert: 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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change löschen no-change resume anhalten Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action Standard: hinzufügen
productOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Wenn die Aktion für das Element `angehalten` oder `fortgesetzt`wird, kann dieser Parameter nicht aktualisiert werden. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/committed_due_date
productOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_inventory_id und sn_prd_invt_product_inventory/sn_prd_invt_external_id
productOrderItem.id	Erforderlich, wenn der Parameter productOrderItem verwendet wird. Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_id Maximale Länge: 40 Standard: Leere Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Tabelle aktualisiert: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item Standard: Leere Zeichenfolge
productOrderItem.itemPrice.price.taxIncludedAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/mrc oder nrc
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/mrc oder nrc
productOrderItem.itemPrice.priceType	Typ des Elementpreises, wiederkehrend oder nicht wiederkehrend. Datentyp: Zeichenfolge
productOrderItem.itemPrice.recurringChargePeriod	Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. `Monat`. Datentyp: Zeichenfolge
productOrderItem.product	Erforderlich, wenn productOrderItem.action auf „Change/Disconnect“ festgelegt ist. Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product:" { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Erforderlich, wenn productOrderItem.action auf „Change/Disconnect“ festgelegt ist. Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld sys_id oder sn_ind_tmt_orm_external_id der Produktbestandstabelle [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" }` Tabelle/Feld aktualisiert: 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 Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/location Standard: Leere Zeichenfolge
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/characteristics Standard: Leere Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/ previous_characteristic_option_value Standard: Leere Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Standard: Leere 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" }` Tabelle/Feld aktualisiert: 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 Produktspezifikationstabelle [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in 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.version	External_version 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
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/email Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/first_name Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/sys_id Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/lastName Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/business_phone 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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `Produkt`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalVersion	Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.version	External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOrderItem.quantity	Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity Standard: null
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Erforderlich, wenn der Parameter productOrderItem.productOrderItemRelationship verwendet wird. Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/parent_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: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
ProduktBestellposition.Menge	Anzahl der bestellten Artikel. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity Standard: Leere Zeichenfolge
productOrderItem.revisionOperation	Typ der Aktualisierung, die für den Einzelposten ausgeführt werden soll. Wenn dieser Wert leer ist, wird der vorhandene Einzelposten aktualisiert oder ein neuer Einzelposten hinzugefügt, falls er noch nicht vorhanden ist. Wenn dieser Wert `storniert`wird, wird die Position storniert. Mögliche Werte: abbrechen Keine Aktualisieren Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_end_date Standard: Leere Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_start_date 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
Content-Type	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-Antwortcodesder 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 Arbeitsnotizfeldern des zugeordneten Datensatzes für die Kundenauftragsposition: `Die folgenden Merkmale der Bestellposition 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 der Bestellposition: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: `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 Produktauftragsposition der Nutzlast. `Ungültige Nutzlast: Aktion „productOrderItem“ fehlt` – Der Parameter action fehlt in der Produktauftragsposition der Nutzlast. `Ungültige Nutzlast: productOrderItem productOffering fehlt` – Das Produktangebotsobjekt oder JSON fehlt in der Produktauftragsposition in der Nutzlast. `Ungültige Nutzlast: ID des Produktangebots 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: productOrderItem Produkt fehlt` : Das Produktobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktproduktspezifikation fehlt` : Das Produktspezifikationsobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikations-ID fehlt`. Der Parameter id in der Produktauftragsposition des Produktspezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikation ist nicht vorhanden` – Die Produktspezifikation in der Produktauftragsposition ist nicht gültig. `Ungültige Nutzlast: Produktbestand ist 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: relatedPartei 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 ist nicht vorhanden` – Der angegebene zugehörige Verbraucher ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Kunden-Account ist nicht vorhanden` – Der angegebene Kunde der zugehörigen Partei 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	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
id	Sys_id des Kundenauftrags, der für diese Anforderung aktualisiert wurde. Datentyp: Zeichenfolge
externe ID	Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]`
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
productOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge
productOrderItem.itemPrice.price.taxIncludeAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl
productOrderItem.itemPrice.priceType	Typ des Elementpreises, wiederkehrend oder nicht wiederkehrend. Datentyp: Zeichenfolge
productOrderItem.itemPrice.recurringChargePeriod	Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. `Monat`. Datentyp: Zeichenfolge
productOrderItem.product	Beschreibung der Instanzdetails des vom Kunden 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 Produktbestandstabelle [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.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. 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 Produktspezifikationstabelle [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
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.id	Sys_id des Einzelpostenkontakts, der der Auftragsposition zugeordnet ist. Befindet sich in der Tabelle „Bestellpositionskontakt“ [sn_ind_tmt_orm_order_line_item_contact]. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `Produkt`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [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
ProduktBestellposition.Menge	Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl
produktBestellelement.status	Aktueller Status der Produktbestellposition. Datentyp: Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.typ	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
Status	Aktueller Status der Bestellung. 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"
}

Product Order Open API – 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. Anforderungstextparameter (JSON)
Name	Beschreibung
Stornierungsgrund	Grund für den 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. Befindet sich in der Kundenauftragstabelle [sn_ind_tmt_orm_order]. Datentyp: Zeichenfolge
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
angefordertesCancellationDate	Datum, an dem die Bestellung 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
Content-Type	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-Antwortcodesder REST-API.

Tabelle : 42. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: 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 Scheduler den Datensatz abholt.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Stornierungsgrund	Grund für den Abbruch. Datentyp: Zeichenfolge
href	URL des stornierten Auftrags. Datentyp: Zeichenfolge
id	Sys_id des stornierten Auftrags. Datentyp: Zeichenfolge
Produktbestellung	Enthält Daten zur Produktbestellung. Datentyp: Objekt `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.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
angefordertesCancellationDate	Datum, an dem die Bestellung storniert werden soll. Datentyp: Zeichenfolge
Status	Status der Stornierung. Wenn die Stornierungsanforderung erfolgreich verarbeitet wurde (Statuscode 201), lautet der Wert für diesen Parameter `fertig`. Datentyp: Zeichenfolge
@type	Der Wert für diesen Parameter ist `CancelProductOrder`. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Codebeispiel wird ein Kundenauftrag storniert.

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

Product Order Open API – 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:

Kundenauftrag [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement [sn_ind_tmt_orm_order_line_item]
Auftragspositionselement – Kontakt [sn_ind_tmt_orm_order_line_item_contact]
Zugehörige Elemente der Auftragsposition [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 die Bestellung synchron verarbeitet. Möglicher Wert: async Datentyp: Zeichenfolge

Tabelle : 45. Anforderungstextparameter (JSON)
Name	Beschreibung
Kanal	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
channel.id	Erforderlich. Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „ external_id “ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/channel Standard: Leere Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen werden auf der Registerkarte Auswahlliste im 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 Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/committed_due_date
externe ID	Eindeutiger Bezeichner für den Kundenauftrag. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/external_id Standard: Leere Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen enthalten, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Hinweis.Text	Erforderlich. Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/comments 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 Auftragspositionen 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
ProduktBestellelement	Erforderlich. Array von Objekten, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreiben. Datentyp: Array `"productOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.action	Erforderlich. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change löschen no-change resume anhalten Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action
productOrderItem.actionReason	Optional. Beschreibung des Grunds für die Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/committed_due_date
productOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_inventory_id und sn_prd_invt_product_inventory/sn_prd_invt_external_id
productOrderItem.id	Erforderlich. Eindeutiger Identifier des Einzelpostens. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_id Maximale Länge: 40 Standard: Leere Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Tabelle aktualisiert: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item Standard: Leere Zeichenfolge
productOrderItem.itemPrice.price.taxIncludedAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/mrc oder nrc
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/mrc oder nrc
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, geben Sie den wiederkehrenden Zeitraum an, z. B. `Monat`. Datentyp: Zeichenfolge
productOrderItem.product	Erforderlich, wenn productOrderItem.action auf „Change/Disconnect“ festgelegt ist. Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product:" { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Erforderlich, wenn productOrderItem.action auf „Change/Disconnect“ festgelegt ist. Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld sys_id oder sn_ind_tmt_orm_external_id der Produktbestandstabelle [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" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.product.place.id	Erforderlich. Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/location
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/characteristics Standard: Leere Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/ previous_characteristic_option_value Standard: Leere Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Standard: Leere Zeichenfolge
productOrderItem.product.productSpecification	Erforderlich. Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt `"productSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Erforderlich. 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 Produktspezifikationstabelle [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in 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.version	External_version 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
productOrderItem.product.relatedPartei	Array von Objekten, die die mit einem OrderLineItemContact verknüpfte Parteirolle beschreiben. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/email Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/first_name Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/lastName Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/business_phone 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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `Produkt`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	Erforderlich. Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Erforderlich. Initial_version oder external_id des Produktangebots. „initial_version“ ist die sys_id der ersten Version des Angebots. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalVersion	Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.version	External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOrderItem.quantity	Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity Standard: null
productOrderItem.productOrderItemRelationship	Erforderlich. Array von Objekten, die die Beziehung zwischen über- und untergeordneten Elementen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Erforderlich. Identisch mit dem Wert productOrderItem.id. Wird für die Beziehung zwischen über- und untergeordneten Elementen verwendet Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/parent_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: HatNachfolger Übergeordnetes Element Datentyp: Zeichenfolge
ProduktBestellposition.Menge	Anzahl der bestellten Artikel. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity Standard: Leere Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts oder Kundenkontakts, der dem Auftrag zugeordnet ist. Befindet sich entweder in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Erforderlich. Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_end_date Standard: Leere Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_start_date 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
Content-Type	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-Antwortcodesder 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 Arbeitsnotizfeldern des zugeordneten Datensatzes für die Kundenauftragsposition: `Die folgenden Merkmale der Bestellposition 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 der Bestellposition: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
202	Akzeptiert. Erfolgreiche Anforderung für einen Auftrag im asynchronen Modus. Das heißt, die Anforderung wurde mit dem Parameter mode auf `async` gestellt, und der Datensatz ist zur Verarbeitung in der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] geplant.
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: `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 Produktauftragsposition der Nutzlast. `Ungültige Nutzlast: Aktion „productOrderItem“ fehlt` – Der Parameter action fehlt in der Produktauftragsposition der Nutzlast. `Ungültige Nutzlast: productOrderItem productOffering fehlt` – Das Produktangebotsobjekt oder JSON fehlt in der Produktauftragsposition in der Nutzlast. `Ungültige Nutzlast: ID des Produktangebots 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: productOrderItem Produkt fehlt` : Das Produktobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktproduktspezifikation fehlt` : Das Produktspezifikationsobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikations-ID fehlt`. Der Parameter id in der Produktauftragsposition des Produktspezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikation ist nicht vorhanden` – Die Produktspezifikation in der Produktauftragsposition ist nicht gültig. `Ungültige Nutzlast: Produktbestand ist 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: relatedPartei 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 ist nicht vorhanden` – Der angegebene zugehörige Verbraucher ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Kunden-Account ist nicht vorhanden` – Der angegebene Kunde der zugehörigen Partei 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 eine Position hat einen anderen Währungscode als die Auftragswährung`. Nicht alle Einzelposten haben denselben Währungscode wie die Auftragswährung. `Überarbeitung während der Ausführung in Auftragswährung nicht unterstützt` – Der Parameter orderCurrency kann nach dem Erstellen des Auftrags nicht aktualisiert werden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Kanal	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
committedDueDate	Datum und Uhrzeit, zu der die Aktion für den Auftrag ausgeführt werden muss. Dieser Wert muss mit den Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Datentyp: Zeichenfolge
externe ID	Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge
href	Relativer Link zum Produktbestelldatensatz. Datentyp: Zeichenfolge
id	Sys_id des für diese Anforderung erstellten Kundenauftrags. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]`
Hinweis.Text	Zusätzliche Notizen/Kommentare des 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 zu verarbeitenden Zeitplan hinzugefügt. Hinweis: Dieser Wert ist das einzige Ergebnis, wenn die Bestellung asynchron mit dem Abfrageparameter mode erstellt wird. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` Datentyp: Zeichenfolge
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
productOrderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge
productOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet sind. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet ist. Datentyp: Zeichenfolge
productOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge
productOrderItem.itemPrice.price.taxIncludeAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl
productOrderItem.itemPrice.priceType	Typ des Elementpreises, wiederkehrend oder nicht wiederkehrend. Datentyp: Zeichenfolge
productOrderItem.itemPrice.recurringChargePeriod	Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. `Monat`. Datentyp: Zeichenfolge
productOrderItem.product	Beschreibung der Instanzdetails des vom Kunden 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 Produktbestandstabelle [sn_ind_tmt_orm_product_inventory]. Dieser Parameter wird nur zurückgegeben, wenn productOrderItem.action „ `change` “ oder „ `disconnect`“ ist. Wenn sowohl sys_id als auch external_id vorhanden sind, wird die 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.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Datentyp: Zeichenfolge
productOrderItem.product.productRelationship	Liste der Produktbeziehungsdetails für eine Auftragsposition. Datentyp: Array `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.product.productRelationship.id	Sys_id oder sn_prd_invt_external_id des Produktbestands. Befindet sich im Feld sys_id oder sn_prd_invt_external_id der Produktbestandstabelle [sn_prd_invt_product_inventory]. Datentyp: Zeichenfolge
productOrderItem.product.productRelationship.relationshipType	Typ der Beziehung zwischen der Bestellposition 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 Produktspezifikationstabelle [sn_prd_pm_product_specification]. Wenn sowohl sys_id als auch external_id vorhanden sind, wird die external_id zurückgegeben. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalId	Initial_version der Produktspezifikation. initial_version ist die sys_id der ersten Version der Spezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in 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.version	External_version 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
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `Produkt`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Wenn sowohl sys_id als auch external_id vorhanden sind, wird die external_id zurückgegeben. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalId	Initial_version des Produktangebots. „initial_version“ ist die sys_id der ersten Version des Angebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalVersion	Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.version	External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [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: HatNachfolger Übergeordnetes Element Erfordert `„HasChild“` und `„HasParent“` werden für Übergeordnet/Untergeordnet-Beziehungen verwendet. `Erfordert` wird für horizontale Beziehungen verwendet (ein Einzelposten erfordert einen anderen Einzelposten). Datentyp: Zeichenfolge
ProduktBestellposition.Menge	Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl
produktBestellelement.status	Aktueller Status der Produktbestellposition. Dieser Wert ist immer `neu`. Datentyp: Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.typ	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
Status	Aktueller Status der Bestellung. Für diesen Endpunkt ist dieser Wert immer `new`. 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

Dieses Beispiel zeigt, wie Sie den Abfrageparameter mode verwenden, um einen Auftrag asynchron zu erstellen. Die Bestellung wird der Tabelle „Eingehende Warteschlange“ [sn_tmt_core_inbound_queue] nach 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",
          "recurringChargePeriod": "month",
          "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"
}

Product Order Open API – 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 Product Order Open API – POST /sn_ind_tmt_orm/order/productOrder.

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

Kundenauftrag [sn_ind_tmt_orm_order]
Bestellmerkmal [sn_ind_tmt_orm_order_characteristic_value]
Auftragspositionselement [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. Anforderungstextparameter (JSON)
Name	Beschreibung
Kanal	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
channel.id	Erforderlich. Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „ external_id “ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/channel Standard: Leere Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Mögliche Kanalnamen werden auf der Registerkarte Auswahlliste im 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 Werten committedDueDate für jede Auftragsposition identisch oder höher sein. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/committed_due_date
externe ID	Eindeutiger Bezeichner für den Kundenauftrag. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/external_id Standard: Leere Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen enthalten, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order
Hinweis.Text	Erforderlich. Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/comments 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 Auftragspositionen 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
ProduktBestellelement	Erforderlich. Array von Objekten, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreiben. Datentyp: Array `"productOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.action	Erforderlich. Aktion, die für das Produkt ausgeführt werden soll. Mögliche Aktionen werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Mögliche Werte: Hinzufügen Change löschen no-change resume anhalten Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action
productOrderItem.actionReason	Optional. Beschreibung des Grunds für die Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.committedDueDate	Datum und Uhrzeit, zu der die Aktion für die Auftragsposition ausgeführt werden muss. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/committed_due_date
productOrderItem.externalProductInventory	Array von Objekten mit externen IDs, die den für den Auftrag erstellten Produktbeständen zugeordnet werden sollen. Datentyp: Array `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	Externe ID, die dem Produktbestand zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_inventory_id und sn_prd_invt_product_inventory/sn_prd_invt_external_id
productOrderItem.id	Erforderlich. Eindeutiger Identifier des Einzelpostens. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/external_id Maximale Länge: 40 Standard: Leere Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` Tabelle aktualisiert: sn_ind_tmt_orm_order Standard: Leere Zeichenfolge
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item Standard: Leere Zeichenfolge
productOrderItem.itemPrice.price.taxIncludedAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.itemPrice.price.taxIncludedAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/mrc oder nrc
productOrderItem.itemPrice.price.taxIncludedAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/mrc oder nrc
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, geben Sie den wiederkehrenden Zeitraum an, z. B. `Monat`. Datentyp: Zeichenfolge
productOrderItem.product	Erforderlich, wenn productOrderItem.action auf „Change/Disconnect“ festgelegt ist. Beschreibung der Instanzdetails des vom Kunden erworbenen Produkts. Datentyp: Objekt `"product:" { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.product.id	Erforderlich, wenn productOrderItem.action auf „Change/Disconnect“ festgelegt ist. Eindeutiger Bezeichner des verkauften Produkts. Befindet sich im Feld sys_id oder sn_ind_tmt_orm_external_id der Produktbestandstabelle [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" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.product.place.id	Erforderlich. Sys_id des zugeordneten Standortdatensatzes in der Standorttabelle [cmn_location]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/location
productOrderItem.product.place.@type	Teil des TMF Open API-Standards. Anmerkung für Kontakt zu Auftragspositionselement. Dieser Wert ist immer `Ort`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/characteristics Standard: Leere Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change-Auftrag erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/ previous_characteristic_option_value Standard: Leere Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value Standard: Leere Zeichenfolge
productOrderItem.product.productSpecification	Erforderlich. Beschreibung der Produktspezifikation, die dem Produkt zugeordnet ist. Datentyp: Objekt `"productSpecification:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.product.productSpecification.id	Erforderlich. 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 Produktspezifikationstabelle [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in 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.version	External_version 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
productOrderItem.product.relatedPartei	Array von Objekten, die die mit einem OrderLineItemContact verknüpfte Parteirolle beschreiben. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/email Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/first_name Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/lastName Standard: Leere Zeichenfolge
productOrderItem.product.relatedPartei.phone	Geschäftliche Telefonnummer des Kontakts. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item_contact/business_phone 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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `Produkt`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	Erforderlich. Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"productOffering:" { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` Tabelle aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.productOffering.id	Erforderlich. Initial_version oder external_id des Produktangebots. „initial_version“ ist die sys_id der ersten Version des Angebots. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.internalVersion	Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOffering.version	External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOrderItem.quantity	Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity Standard: null
productOrderItem.productOrderItemRelationship	Erforderlich. Array von Objekten, die die Beziehung zwischen über- und untergeordneten Elementen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]` Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item
productOrderItem.productOrderItemRelationship.id	Erforderlich. Identisch mit dem Wert productOrderItem.id. Wird für die Beziehung zwischen über- und untergeordneten Elementen verwendet Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/parent_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: HatNachfolger Übergeordnetes Element Datentyp: Zeichenfolge
ProduktBestellposition.Menge	Anzahl der bestellten Artikel. Datentyp: Zahl Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/quantity Standard: Leere Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts oder Kundenkontakts, der dem Auftrag zugeordnet ist. Befindet sich entweder in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.@referenziertTyp	Erforderlich. Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
relatedPartei.@Typ	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_end_date Standard: Leere Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order/expected_start_date 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
Content-Type	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-Antwortcodesder 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 Arbeitsnotizfeldern des zugeordneten Datensatzes für die Kundenauftragsposition: `Die folgenden Merkmale der Bestellposition 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 der Bestellposition: <characteristic.name> mit Merkmalswert: <characteristic.value>ist ungültig. Korrigieren Sie die Merkmalswerte, bevor Sie den Auftrag genehmigen.`
400	Ungültige Anforderung. Dies kann einen der folgenden Gründe haben: `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 Produktauftragsposition der Nutzlast. `Ungültige Nutzlast: Aktion „productOrderItem“ fehlt` – Der Parameter action fehlt in der Produktauftragsposition der Nutzlast. `Ungültige Nutzlast: productOrderItem productOffering fehlt` – Das Produktangebotsobjekt oder JSON fehlt in der Produktauftragsposition in der Nutzlast. `Ungültige Nutzlast: ID des Produktangebots 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: productOrderItem Produkt fehlt` : Das Produktobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktproduktspezifikation fehlt` : Das Produktspezifikationsobjekt oder JSON in der Produktauftragsposition fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikations-ID fehlt`. Der Parameter id in der Produktauftragsposition des Produktspezifikationsobjekts fehlt in der Nutzlast. `Ungültige Nutzlast: Produktspezifikation ist nicht vorhanden` – Die Produktspezifikation in der Produktauftragsposition ist nicht gültig. `Ungültige Nutzlast: Produktbestand ist 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: relatedPartei 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 ist nicht vorhanden` – Der angegebene zugehörige Verbraucher ist in der Instanz ServiceNow nicht vorhanden. `Ungültige Nutzlast: Kunden-Account ist nicht vorhanden` – Der angegebene Kunde der zugehörigen Partei 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	Array von Objekten, die die Kanäle beschreiben, die für den Verkauf der Produkte verwendet werden sollen. Datentyp: Array `"channel:" [ { "id": "String", "name": "String" } ]`
channel.id	Eindeutiger Bezeichner des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Kanal-ID-Werte befinden sich im Feld „external_id“ der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals, der zum Verkauf der zugehörigen Produkte verwendet werden soll. Datentyp: Zeichenfolge
id	Sys_id des für diese Anforderung erstellten Kundenauftrags. Datentyp: Zeichenfolge
externe ID	Externer Bezeichner für den Kundenauftrag, z. B. eine Bestellnummer. Datentyp: Zeichenfolge
Hinweis	Array von Objekten, die zusätzliche Notizen beschreiben, die der Kunde bei der Bestellung gemacht hat. Datentyp: Array `"note:" [ { "text": "String" } ]`
Hinweis.Text	Zusätzliche Notizen/Kommentare des Kunden während der Bestellung. Datentyp: Zeichenfolge
ProduktBestellelement	Liste, die der Produktbestellung zugeordnete Elemente und die zugehörige Aktion beschreibt. Datentyp: Array `"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 werden auf der Registerkarte Auswahlliste im Aktionswörterbucheintrag der Tabelle sn_ind_tmt_orm_order_line_item definiert. Datentyp: Zeichenfolge
productOderItem.actionReason	Der Grund für das Hinzufügen der Bestellposition. Datentyp: Zeichenfolge Tabelle/Feld aktualisiert: sn_ind_tmt_orm_order_line_item/action_reason
productOrderItem.id	Eindeutiger Identifier des Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [sn_ind_tmt_orm_order_line_item]. Datentyp: Zeichenfolge
productOrderItem.itemPrice	Array von Objekten, die den dem Produkt zugeordneten Preis beschreiben. Datentyp: Array `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	Beschreibung des Preises des zugehörigen Produkts. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	Beschreibung des Preises des zugehörigen Produkts, einschließlich Steuer. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	Währungscode, in dem der Preis angegeben wird. Datentyp: Zeichenfolge
productOrderItem.itemPrice.price.taxIncludeAmount.value	Preis des Produkts, einschließlich Steuern. Datentyp: Zahl
productOrderItem.itemPrice.priceType	Typ des Elementpreises, wiederkehrend oder nicht wiederkehrend. Datentyp: Zeichenfolge
productOrderItem.itemPrice.recurringChargePeriod	Wenn der Preis wiederkehrend ist, der wiederkehrende Zeitraum, z. B. `Monat`. Datentyp: Zeichenfolge
productOrderItem.product	Beschreibung der Instanzdetails des vom Kunden 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 Produktbestandstabelle [sn_ind_tmt_orm_product_inventory]. Dieser Parameter wird nur zurückgegeben, wenn productOrderItem.action „ `change` “ oder „ `disconnect`“ ist. Wenn sowohl sys_id als auch external_id vorhanden sind, wird die 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.productCharacteristic	Array von Objekten, die die Merkmale des zugeordneten Produkts beschreiben. Datentyp: Array `"productCharacteristic:" [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	Name des Merkmalsdatensatzes, der dem Produkt zugeordnet werden soll. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic. previousValue	Vorherige Merkmalsoptionswerte, wenn die Aktualisierung für einen Change erfolgt. Die Anforderung ist ein Change, wenn der Parameter productOrderItem.action nicht `add`lautet. Datentyp: Zeichenfolge
productOrderItem.product.productCharacteristic.value	Merkmalsoptionswerte, die dem Produkt zugeordnet sind. 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 Produktspezifikationstabelle [sn_prd_pm_product_specification]. Wenn sowohl sys_id als auch external_id vorhanden sind, wird die external_id zurückgegeben. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.name	Name der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
productOrderItem.product.productSpecification.@type	Teil des TMF Open API-Standards. Dieser Wert ist immer `ProductSpecificationRef`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei	Liste der Kontakte für Einzelposten. Datentyp: Array `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedPartei.email	E-Mail-Adresse des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.firstName	Vorname des Kontakts. Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.lastName	Nachname des Kontakts. Datentyp: Zeichenfolge Datentyp: Zeichenfolge
productOrderItem.product.relatedPartei.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 Kontakt zu Auftragspositionselement. Dieser Wert ist immer `RelatedPartei`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.product.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `Produkt`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
productOrderItem.productOffering	Beschreibung des Produktangebots, das dem Produkt zugeordnet ist. Datentyp: Objekt `"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. Befindet sich im Feld sys_id oder external_id der Produktangebotstabelle [sn_prd_pm_product_offering]. Wenn sowohl sys_id als auch external_id vorhanden sind, wird die external_id zurückgegeben. Datentyp: Zeichenfolge
productOrderItem.productOffering.name	Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
productOrderItem.productOrderItemRelationship	Array von Objekten, die die Beziehungen zwischen Bestellpositionen beschreiben. Datentyp: Array `"productOrderItemRelationship:" [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	Eindeutiger Identifier des zugehörigen Einzelpostens. Befindet sich im Feld sn_ind_tmt_orm_external_id der Tabelle „Bestellposition“ [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
ProduktBestellposition.Menge	Anzahl der zugeordneten Artikel, die bestellt werden sollen. Datentyp: Zahl
produktBestellelement.status	Aktueller Status der Produktbestellposition. Dieser Wert ist immer `neu`. Datentyp: Zeichenfolge
produktOrderItem.@type	Teil des TMF Open API-Standards. Anmerkung für das Produkt. Dieser Wert ist immer `ProductOrderItem`. Diese Informationen werden nicht gespeichert. Datentyp: Zeichenfolge
relatedPartei	Liste der Kontakte für den Auftrag. Jeder Kontakt ist ein Objekt im Array. Muss mindestens ein Element auflisten, das Kunden-Account- oder Verbraucher-Account-Informationen enthält. Datentyp: Array `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedPartei.id	Sys_id oder external_id des Accounts, Kundenkontakts oder Verbrauchers, der dem Auftrag zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
relatedPartei.name	Name des Accounts, Kunden oder Verbrauchers. Datentyp: Zeichenfolge
relatedPartei.typ	Typ des Kunden. Mögliche Werte: Verbraucher Kunde Kundenkontakt Datentyp: Zeichenfolge
angefordertesAbschlussdatum	Vom Kunden angefordertes Lieferdatum. Datentyp: Zeichenfolge
angefordertesStartdatum	Vom Kunden angefordertes Auftragsstartdatum. Datentyp: Zeichenfolge
Status	Aktueller Status der Bestellung. Für diesen Endpunkt ist dieser Wert immer `new`. 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"
}