Bestell-API

Freigeben Version: Zurich

Aktualisiert 31. Juli 2025

20 Minuten Lesedauer

Die Reihenfolge Die API stellt Endpunkte zum Abrufen und Erstellen von Aufträgen mit Auftragspositionen für bereit Kundenservice-Management Anwendung.

Diese API erfordert Auftragsmanagement(App-csm-order-mgmt) Store-Anwendung und wird in bereitgestellt sn_ind_tmt_orm Namespace. Informationen hierzu finden Sie unter Sales and Order Management.

Diese API erfordert sn_csm_om.order_integrator für den Zugriff und eine der folgenden Optionen:

sn_csm_om.Consumer_Agent: API-Schreibzugriff auf B2C-Aufträge beschränkt.
sn_csm_om.Customer_Agent: API-Schreibzugriff auf B2B-Aufträge beschränkt.
sn_csm_om.order_admin: API-Schreibzugriff für B2B- oder B2C-Aufträge.

Informationen zu B2B- und B2C-Bestellungen finden Sie unter Kundendatenmodelle für B2B2B2C .

Bestell-API – GET /sn_ind_tmt_orm/order/{ID}

Ruft vollständige Auftragsdetails ab, indem die sys_ID oder die Auftragsnummer angegeben wird.

URL-Format

Versionierte URL: /api/sn_ind_tmt_orm/{api_Version}/order/{ID}

Standard-URL: /api/sn_ind_tmt_orm/order/{ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: `v1` Oder `v2` . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
id	SYS_ID oder Bestellnummer (order_ID) des abzurufenden Datensatzes. Datentyp: Zeichenfolge Tabelle: Aufträge [sn_csm_om_order]

Tabelle : 2. Abfrageparameter
Name	Beschreibung
sysparm_display_value	Kennzeichnung, die angibt, ob der Anzeigewert der Referenzfelder angezeigt werden soll. Gültige Werte: Wahr: Zeigt den Anzeigewert der Referenzfelder, Auswahlfelder und Datumsfelder in der Antwort an. Falsch: Zeigt den ist-Wert der Referenzfelder, Auswahlfelder und Datumsfelder in der Antwort an. Standardwert: false

Tabelle : 3. Anforderungstextparameter (XML oder 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
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Der Anwender ist nicht authentifiziert.
403	Der Anwender ist nicht autorisiert. Der Anwender verfügt nicht über die erforderlichen Rollen für den Zugriff auf die API. Der Anwender ist nicht berechtigt, die Bestellung zu lesen. Diese API erfordert sn_csm_om.order_integrator für den Zugriff und eine der folgenden Optionen: sn_csm_om.Consumer_Agent: API-Schreibzugriff auf B2C-Aufträge beschränkt. sn_csm_om.Customer_Agent: API-Schreibzugriff auf B2B-Aufträge beschränkt. sn_csm_om.order_admin: API-Schreibzugriff für B2B- oder B2C-Aufträge.

Antworttext-Parameter (JSON oder XML)


Name	Beschreibung
Account	SYS_ID eines Datensatzes in der Tabelle „Accounts“ [Customer_Account]. Gibt den Account für B2B-Aufträge an. Datentyp: Zeichenfolge
Actual_end_date	Enddatum der Bestellung. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
Actual_Start_date	Startdatum der Bestellung. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
Billing_City	Name der Abrechnungsstadt. Datentyp: Zeichenfolge
Billing_Country	Abkürzung des Abrechnungslandes. Datentyp: Zeichenfolge
Abrechnungsstatus	Abkürzung für Bundesland oder Provinz der Abrechnung. Datentyp: Zeichenfolge
Billing_Street	Adresse der Rechnungsadresse. Datentyp: Zeichenfolge
Abrechnungszip	Postleitzahl der Abrechnung. Datentyp: Zeichenfolge
Kommentare	Zusätzliche Informationen für den Auftrag. Datentyp: Zeichenfolge
Verbraucher	SYS_ID eines Verbraucherdatensatzes. Gibt den Verbraucher für B2C-Bestellungen an. Datentyp: Zeichenfolge
Kontakt	SYS_ID des Kundenkontakts, der sich auf den Account bezieht. Datentyp: Zeichenfolge Tabelle: Kontakte [Customer_contact]
contract	SYS_ID des Kundenservice Vertragsdatensatz. Datentyp: Zeichenfolge Tabelle: Verträge [ast_Contract]
Fehler	Details, die einen Fehler beschreiben, der während des Anforderungsprozesses aufgetreten ist. Datentyp: Objekt `"error": { "detail": "String", "message": "String" }`
error.detail	Details des während des Anforderungsprozesses aufgetretenen Fehlers. Datentyp: Zeichenfolge
Fehler.Nachricht	Meldung für den während des Anforderungsprozesses aufgetretenen Fehler. Jede Fehlermeldung hat eine entsprechende Beschreibung in detailEigenschaft. Datentyp: Zeichenfolge
Expected_end_date	Erwartetes Enddatum der Bestellung. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
Expected_Start_date	Erwartetes Startdatum der Bestellung. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
external_id	Externe ID, die einen zugehörigen Datensatz im System einer Drittpartei darstellt. Datentyp: Zeichenfolge
External_System	Name des Systems des Kunden. Datentyp: Zeichenfolge
Order_category	Kundenauftragstyp. Mögliche Werte: Produkt service Datentyp: Zeichenfolge
Order_currency	Währungscode, der die Währung darstellt, in der die Bestellung gekauft wurde. Beispiel: `USD` Für US-Dollar. Diese Währung wird für alle Betragsfelder in den Auftrags- und Positionsaufträgen verwendet. Währungscodes werden in der Tabelle „Währungen“ [fx_currency] aufgeführt. Hinweis: Diese Eigenschaft ist möglicherweise in früheren Versionen von nicht verfügbar Auftragsmanagement. Datentyp: Zeichenfolge
Order_date	Datum und Uhrzeit der Auftragserstellung. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
order_id	Auftragsnummer des Auftrags. Datentyp: Zeichenfolge Tabelle: Aufträge [sn_csm_om_order]
Order_line_items	Erforderlich. Liste der Objekte, die die einzelnen Auftragspositionen im Auftrag definieren. Datentyp: Array Erforderliche Eigenschaften in jedem Auftragspositionsobjekt: accountFür B2B-Aufträge oder consumerFür B2C-Aufträge. product_offering – quantity unit_of_measurements order_line_characteristics "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ] Tabelle: Auftragspositionen [sn_csm_om_order_line_item]
Order_line_items	Liste der Objekte, die die einzelnen Auftragspositionen im Auftrag definieren. Datentyp: Array von Objekten "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ]
Order_line_items.Account	Erforderlich für B2B-Aufträge. SYS_ID des Geschäfts-Accounts, der dieser Auftragsposition zugewiesen ist. Befindet sich in der Tabelle „Accounts“ [Customer_Account]. Die Verbrauchereigenschaft ist für B2C-Bestellungen erforderlich. Datentyp: Zeichenfolge
Order_line_items.Account	SYS_ID des Geschäfts-Accounts, der dieser Auftragsposition zugewiesen ist. Befindet sich in der Tabelle „Accounts“ [Customer_Account]. Datentyp: Zeichenfolge
Order_line_items.action	Aktion, die bestimmt, wie die Auftragsposition dem Auftrag hinzugefügt wird. Mögliche Werte: Hinzufügen Change Datentyp: Zeichenfolge
order_line_items.comments	Zusätzliche Informationen für die Auftragsposition. Datentyp: Zeichenfolge
Order_line_items.Consumer	SYS_ID des Verbrauchers, der dieser Auftragsposition zugewiesen ist. Befindet sich in der Tabelle „Verbraucher“ [csm_Consumer]. Datentyp: Zeichenfolge
Order_line_items.contact	Kontakt-sys_ID im Zusammenhang mit dem Account. Datentyp: Zeichenfolge
order_line_items.delivered_quantity	Anzahl der Artikel in der gelieferten Bestellung. Datentyp: Zeichenfolge
Order_Line_items.effective_date	Gültigkeitsdatum der Auftragsposition. Format: jjjj-MM-TT HH:mm:ss in UTC-Zeitzone Datentyp: Zeichenfolge
Order_Line_items.expiration_date	Ablaufdatum der Auftragsposition. Format: jjjj-MM-TT HH:mm:ss in UTC-Zeitzone Datentyp: Zeichenfolge
Order_line_items.external_ID	Externe ID der Auftragsposition. Datentyp: Zeichenfolge
Order_Line_items.external_System	Externe sys_ID der Auftragsposition. Datentyp: Zeichenfolge
Order_line_items.list_price	Listenpreis des Produktangebots pro Einheit. Hinweis: Diese Eigenschaft ist möglicherweise in früheren Versionen von nicht verfügbar Auftragsmanagement. Datentyp: Zeichenfolge
Order_line_items.location	SYS_ID eines Versandstandort-Datensatzes. Datentyp: Zeichenfolge Tabelle: Standorte [cmn_location]
Order_line_items.order	Die Auftragsnummer dieser Position, wie in der Tabelle „Aufträge“ [sn_csm_om_order] aufgeführt. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics	Liste der Objekte, die die Merkmale der zugehörigen Auftragsposition definieren. Auftragspositionsmerkmale befinden sich in der Tabelle „Merkmale der Auftragsposition“ [sn_csm_om_order_Merkmal_value]. Datentyp: Array von Objekten `"order_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String" } ]`
Order_line_items. Order_Line_characteristics. Merkmal_Option	Eindeutige Option für Produktmerkmal, die die Ausschlussregel auslöst. Zum Beispiel Produktgröße oder -Farbe. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics. Merkmal_Option_Wert	Wert einer Merkmalsoption. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics. External_ID	Externe ID des Auftragspositionsmerkmals. Datentyp: Objekt
Order_line_items. Order_Line_characteristics.number	Merkmalsnummer der Auftragsposition . Datentyp: Zeichenfolge Tabelle: Auftragspositionsmerkmale [sn_csm_om_order_Characteristic_value]
Order_line_items. Order_Line_characteristics. Order_line_item	SYS_ID der Auftragsposition dieses Merkmals. Datentyp: Zeichenfolge Tabelle: Auftragspositionen [sn_csm_om_order_line_item]
Order_line_items. Order_Line_characteristics. Vorheriges_Merkmal_Option_Wert	Name der vorherigen Merkmalsoption, die dem Produktmodell in der Auftragsposition zugeordnet ist. Datentyp: Objekt
Order_line_items. Order_Line_characteristics.Specification	Servicespezifikation, die dem Serviceauftragsmerkmal zugeordnet ist. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics. sys_class_Name	Systemname der Tabelle, in der sich dieser Datensatz für Auftragspositionsmerkmale befindet. Datentyp: Zeichenfolge
Order_Line_characteristics. sys_created_by	Systemname des Anwenders, der diesen Datensatz erstellt hat. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics. sys_created_on	Datum und Uhrzeit der ursprünglichen Erstellung des Datensatzes. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics. sys_Domain	Domänenbereich, in dem auf den Auftragsdatensatz zugegriffen werden kann. Beispiel: Global. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics. sys_Domain_path	Domänenpfad für den Datensatz. Datentyp: Zeichenfolge Standard: / (Global)
Order_line_items. Order_Line_characteristics. sys_ID	SYS_ID des Auftragsdatensatzes Datentyp: Zeichenfolge Tabelle: Auftragspositionsmerkmale [sn_csm_om_order_Characteristic_value]
Order_line_items. Order_Line_characteristics. sys_mod_count	Gibt an, wie oft dieser Datensatz geändert wurde. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics. sys_Tags	System-Tags für den Inhalt. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics. sys_updated_by	Systemname des Anwenders, der diesen Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics. sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. Datentyp: Zeichenfolge
Order_line_items. Order_Line_characteristics.type	Typ des Auftragspositionsmerkmals. Mögliche Werte: Produkt service Datentyp: Zeichenfolge
Order_Line_items.order_line_ID	Auftragsnummer des Auftrags, der dieser Auftragsposition zugeordnet ist. Datentyp: Zeichenfolge
Order_Line_items.parent_line_item	Gibt gegebenenfalls eine übergeordnete Position für diese Position an. Datentyp: Zeichenfolge
Order_Line_items.previous_Product_model	SYS_ID des Produktmodells für das Produkt, das vor diesem Artikel in der Auftragsposition aufgeführt ist. Datentyp: Zeichenfolge Tabelle: Produktmodelle [cmdb_model]
Order_Line_items.Price_list	SYS_ID eines Preislistendatensatzes in der Tabelle „Preislisten“ [sn_csm_price_list]. Hinweis: Diese Eigenschaft ist möglicherweise in früheren Versionen von nicht verfügbar Auftragsmanagement. Datentyp: Zeichenfolge
order_line_items.product	SYS_ID des Produkts Datentyp: Zeichenfolge Tabelle: Produktmodelle [cmdb_model]
order_line_items.product_offering	SYS_ID des Produkts, das in der Tabelle „Produktangebote“ [sn_prd_pm_Product_offering] aufgeführt ist. Datentyp: Zeichenfolge
order_line_items.product	SYS_ID des Produktmodells, das in der Tabelle „Produktmodelle“ [cmdb_model] aufgeführt ist. Muss mit übereinstimmender Auftragsposition angegeben werden Datentyp: Zeichenfolge
order_line_items.product_specification	SYS_ID der Produktspezifikation, die der Auftragsposition zugeordnet ist. Aufgeführt in der Tabelle „Produktspezifikationen“ [sn_prd_pm_Product_Specification]. Datentyp: Zeichenfolge
Order_Line_items.quantity	Anzahl der bestellten Produktmodelle. Datentyp: Zeichenfolge
Order_line_items.Shipping_City	Name der Zielstadt. Datentyp: Zeichenfolge
Order_line_items.Shipping_Country	Abkürzung des Ziellandes. Datentyp: Zeichenfolge
Order_line_items.Shipping_State	Abkürzung des Ziellandes oder der Zielregion. Datentyp: Zeichenfolge
Order_line_items.Shipping_Street	Straße und Hausnummer des Ziels. Datentyp: Zeichenfolge
Order_line_items.Shipping_zip	Postleitzahl des Ziels. Datentyp: Zeichenfolge
Order_Line_items.short_description	Kurzbeschreibung der Auftragsposition. Datentyp: Zeichenfolge
Order_line_items.SKU	Nummer, die von einem Lieferanten generiert wird und ein Produkt eindeutig identifiziert, das von diesem Lieferanten verkauft wird. Datentyp: Zeichenfolge
Order_Line_items.sold_Product	SYS_ID eines Datensatzes für verkaufte Produkte der Installationsbasis. Datentyp: Zeichenfolge Tabelle: Verkaufte Produkte [sn_install_Base_sold_Product]
Order_line_items.Specification	Spezifikation der Auftragsposition. Datentyp: Zeichenfolge
Order_line_items.State	Status der Auftragsposition. Zum Beispiel „Entwurf“, „Neu“, „in_Progress“ oder „Abgeschlossen“. Datentyp: Zeichenfolge
Order_line_items.Status	Status der Auftragsposition. Mögliche Werte: Fehler Erfolg Datentyp: Zeichenfolge
Order_line_items.sys_class_Name	Systemname der Tabelle, in der sich dieser Auftragspositionsdatensatz befindet. Datentyp: Zeichenfolge
Order_line_items.sys_created_by	Systemname des Anwenders, der diesen Datensatz erstellt hat. Datentyp: Zeichenfolge
Order_line_items.sys_created_on	Datum und Uhrzeit der ursprünglichen Erstellung des Datensatzes. Datentyp: Zeichenfolge
Order_line_items.sys_Domain	Domänenbereich, in dem auf den Auftragsdatensatz zugegriffen werden kann. Beispiel: Global. Datentyp: Zeichenfolge
Order_line_items.sys_Domain_path	Domänenpfad für den Datensatz. Datentyp: Zeichenfolge Standard: / (Global)
Order_line_items.sys_ID	SYS_ID des Einzelposten-Datensatzes Datentyp: Zeichenfolge Tabelle: Auftragspositionen [sn_csm_om_order_line_item]
Order_line_items.sys_mod_count	Gibt an, wie oft dieser Datensatz geändert wurde. Datentyp: Zeichenfolge
Order_line_items.sys_Tags	System-Tags für den Inhalt. Datentyp: Zeichenfolge
Order_line_items.sys_updated_by	Systemname des Anwenders, der diesen Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
Order_line_items.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. Datentyp: Zeichenfolge
Order_line_items.Top_line_item	Gesamtpreis aller Auftragspositionen, die in diesem Auftrag angesammelt wurden. Datentyp: Zeichenfolge
Order_Line_items.total_price	Gesamtpreis der Auftragsposition. Die API berechnet die Summe nicht basierend auf Nettopreis und Menge. Datentyp: Zeichenfolge
Order_Line_items.unit_of_Measurement	SYS_ID für die geordnete Maßeinheit, die in der Tabelle „Maßeinheiten“ [sn_prd_pm_uom] aufgeführt ist. Hinweis: Diese Eigenschaft ist möglicherweise in früheren Versionen von nicht verfügbar Auftragsmanagement. Datentyp: Zeichenfolge
Order_line_items. Unit_of_Measurement	Erforderlich. SYS_ID für die geordnete Maßeinheit, die in der Tabelle „Maßeinheiten“ [sn_prd_pm_uom] aufgeführt ist. Hinweis: Diese Eigenschaft ist möglicherweise in früheren Versionen von nicht verfügbar Auftragsmanagement. Datentyp: Zeichenfolge
Order_line_items.unit_price	Nettopreis des Produktangebots pro Einheit. Datentyp: Zeichenfolge Tabelle: Währungsinstanzen [fx_currency_instance]
Order_line_items.work_Notes	Freiform-interne Arbeitsnotizen für die Auftragsposition. Datentyp: Zeichenfolge
Order_type	Auftragsaktion, die bestimmt, wie der Auftrag hinzugefügt wird. Mögliche Werte: Hinzufügen Change Datentyp: Zeichenfolge
Partner	Für B2B-Aufträge sys_ID des zugehörigen Partnerdatensatzes für einen Account. Datentyp: Zeichenfolge Tabelle: Accounts [Customer_Account]
Partner_contact	Für B2B-Aufträge sys_ID des primären Kontakts des Partners für den Partner-Account. Datentyp: Zeichenfolge Tabelle: Kontakte [Customer_contact]
Payment_ref_ID	Eindeutiger Bezeichner der Zahlung. Beispiel: Prüfnummer. Datentyp: Zeichenfolge
Price_list	SYS_ID des zugehörigen Preislistendatensatzes. Der Preis wird von dieser API nicht basierend auf Nettopreis und Menge berechnet. Hinweis: Diese Eigenschaft ist möglicherweise in früheren Versionen von nicht verfügbar Auftragsmanagement. Datentyp: Zeichenfolge Tabelle: Preislisten [sn_csm_price_list]
quote_id	Eindeutige ID für das Bestellpreisangebot. Datentyp: Zeichenfolge
Same_as_Shipping_address	Kennzeichnung, die angibt, ob die Adresse des Käufers mit der Versandadresse identisch ist. Gültige Werte: Wahr: Adresse des Käufers ist mit der Versandadresse identisch. Falsch: Die Adresse des Käufers unterscheidet sich von der Versandadresse. Datentyp: Boolesch
Shipping_City	Name der Zielstadt. Datentyp: Zeichenfolge
Shipping_Country	Abkürzung des Ziellandes. Datentyp: Zeichenfolge
Shipping_location	SYS_ID eines Versandstandort-Datensatzes. Datentyp: Zeichenfolge Tabelle: Standorte [cmn_location]
Shipping_State	Abkürzung des Ziellandes oder der Zielregion. Datentyp: Zeichenfolge
Shipping_Street	Straße und Hausnummer des Ziels. Datentyp: Zeichenfolge
Shipping_zip	Postleitzahl des Ziels. Datentyp: Zeichenfolge
short_description	Kurzbeschreibung der Bestellung. Datentyp: Zeichenfolge
Special_Instructions	Spezielle Anweisungen für den Auftrag. Datentyp: Zeichenfolge
Status	Status des Auftrags. Beispiel: New, in_Progress oder Complete. Datentyp: Zeichenfolge
status	Status des Auftrags. Mögliche Werte: Erfolg Fehler Datentyp: Zeichenfolge
sys_class_name	Systemname der Tabelle, in der sich dieser Auftragsdatensatz befindet. Datentyp: Zeichenfolge
sys_created_by	Systemname des Anwenders, der diesen Datensatz erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der ursprünglichen Erstellung des Datensatzes. Datentyp: Zeichenfolge
sys_domain	Domänenbereich, in dem auf den Auftragsdatensatz zugegriffen werden kann. Beispiel: Global. Datentyp: Zeichenfolge
sys_domain_path	Domänenpfad für den Datensatz. Datentyp: Zeichenfolge Standard: / (Global)
sys_id	SYS_ID des Auftragsdatensatzes. Datentyp: Zeichenfolge Tabelle: Aufträge [sn_csm_om_order]
sys_mod_count	Gibt an, wie oft dieser Datensatz geändert wurde. Datentyp: Zeichenfolge
sys_Tags	System-Tags für den Inhalt. Datentyp: Zeichenfolge
sys_updated_by	Systemname des Anwenders, der diesen Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. Datentyp: Zeichenfolge
Total_amount	Gesamtkosten für den gesamten Auftrag. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie eine Bestellung anhand ihrer Ordnungsnummer abrufen.

curl "https://instance.service-now.com/api/sn_ind_tmt_orm/order/ORD0001034" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antwort:

{
  "result": {
    "actual_start_date": "",
    "payment_ref_id": null,
    "shipping_city": null,
    "channel": "api",
    "expected_end_date": "",
    "sys_updated_on": "2022-03-30 21:59:41",
    "price_list": null,
    "sys_updated_by": "username",
    "sys_created_on": "2022-03-30 21:59:41",
    "contact": "96d0461553ab70101aaeddeeff7b120b",
    "sys_domain": "global",
    "state": "draft",
    "order_type": "add",
    "sys_created_by": "eseruser",
    "shipping_street": null,
    "special_instructions": null,
    "contract": null,
    "quote_id": null,
    "expected_start_date": "",
    "sys_domain_path": "/",
    "billing_street": null,
    "billing_city": null,
    "total_amount": "2000",
    "order_id": "ORD0001034",
    "shipping_country": "USA",
    "status": "new",
    "short_description": null,
    "shipping_state": null,
    "external_id": null,
    "sys_class_name": "sn_csm_om_order",
    "sys_id": "24fdf5bd75eec510f877f30c01a15aa0",
    "shipping_zip": null,
    "billing_state": null,
    "billing_zip": null,
    "same_as_shipping_address": "0",
    "consumer": null,
    "comments": "",
    "order_currency": "USD",
    "billing_country": "USA",
    "sys_mod_count": "1",
    "billing_location": null,
    "shipping_location": null,
    "sys_tags": "",
    "order_date": "2022-03-30 21:59:41",
    "order_category": "product",
    "actual_end_date": "",
    "partner": null,
    "partner_contact": null,
    "account": "c480021553ab70101aaeddeeff7b120f",
    "external_system": null,
    "order_line_items": [
      {
        "short_description": null,
        "shipping_state": "CA",
        "shipping_city": "Santa Clara",
        "product_offering": "2d4376760f740110603bf634a7767e46",
        "external_id": null,
        "sys_updated_on": "2022-03-30 21:59:41",
        "expiration_date": "",
        "sys_class_name": "sn_csm_om_order_line_item",
        "sold_product": null,
        "sys_id": "ecfdf5bd75eec510f877f30c01a15aa3",
        "unit_of_measurement": "cb2795d553020110286eddeeff7b12ff",
        "price_list": null,
        "sys_updated_by": "username",
        "shipping_zip": "94560",
        "sys_created_on": "2022-03-30 21:59:41",
        "contact": "96d0461553ab70101aaeddeeff7b120b",
        "sys_domain": "global",
        "effective_date": "",
        "action": "add",
        "order_line_id": "ORDL0001060",
        "state": "draft",
        "sku": null,
        "consumer": null,
        "sys_created_by": "username",
        "order": "24fdf5bd75eec510f877f30c01a15aa0",
        "previous_product_model": null,
        "shipping_street": "222 Star St",
        "product": "561dba7e0f740110603bf634a7767ebe",
        "quantity": "1",
        "comments": "",
        "total_price": "2000",
        "parent_line_item": null,
        "sys_mod_count": "1",
        "specification": "104f66720f740110603bf634a7767e7d",
        "list_price": "2000",
        "unit_price": "2000",
        "sys_domain_path": "/",
        "sys_tags": "",
        "delivered_quantity": null,
        "top_line_item": null,
        "product_specification": "104f66720f740110603bf634a7767e7d",
        "location": null,
        "work_notes": "",
        "shipping_country": "USA",
        "account": "c480021553ab70101aaeddeeff7b120f",
        "external_system": null,
        "status": "new",
        "order_line_characteristics": [
          {
            "characteristic_option": "1c6ceabe0f340110603bf634a7767e97",
            "sys_mod_count": "0",
            "specification": "104f66720f740110603bf634a7767e7d",
            "external_id": null,
            "sys_updated_on": "2022-03-30 21:59:41",
            "type": "1",
            "sys_domain_path": "/",
            "sys_tags": "",
            "characteristic": "4e76f1b20fb00110603bf634a7767ee3",
            "sys_class_name": "sn_csm_om_order_characteristic_value",
            "previous_characteristic_option_value": null,
            "number": "ORC000001041",
            "sys_id": "acfd79bd75eec510f877f30c01a15a94",
            "sys_updated_by": "username",
            "sys_created_on": "2022-03-30 21:59:41",
            "sys_domain": "global",
            "characteristic_option_value": "1.2 cu",
            "order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
            "sys_created_by": "user"
          },
          {
            "characteristic_option": "2d0d66fe0f340110603bf634a7767ef6",
            "sys_mod_count": "0",
            "specification": "104f66720f740110603bf634a7767e7d",
            "external_id": null,
            "sys_updated_on": "2022-03-30 21:59:41",
            "type": "1",
            "sys_domain_path": "/",
            "sys_tags": "",
            "characteristic": "11e639b20fb00110603bf634a7767e17",
            "sys_class_name": "sn_csm_om_order_characteristic_value",
            "previous_characteristic_option_value": null,
            "number": "ORC000001042",
            "sys_id": "e0fd79bd75eec510f877f30c01a15a95",
            "sys_updated_by": "username",
            "sys_created_on": "2022-03-30 21:59:41",
            "sys_domain": "global",
            "characteristic_option_value": "Stainless steel",
            "order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
            "sys_created_by": "user"
          }
        ]
      }
    ]
  }
}

Bestell-API: /sn_ind_tmt_orm/order VERÖFFENTLICHEN

Erstellt einen neuen Auftrag mit Einzelposten und Merkmalen.

Aufträge mit Einzelposten werden mithilfe von Anforderungstext-Parametern definiert. Die folgenden Eigenschaften sind in den meisten Versionen von erforderlich Auftragsmanagement:

accountFür B2B-Aufträge oder consumerFür B2C-Aufträge.
- account – SYS_ID eines Datensatzes in der Tabelle „Accounts“ [Customer_Account].
- consumer – SYS_ID eines Verbraucherdatensatzes.
order_currency – Währungscode, der die Währung darstellt, in der die Bestellung gekauft wurde. Beispiel: USD Für US-Dollar. Diese Währung wird für alle Betragsfelder in den Auftrags- und Positionsaufträgen verwendet. Währungscodes werden in der Tabelle „Währungen“ [fx_currency] aufgeführt.
order_line_items – Liste der Objekte, die die einzelnen Auftragspositionen im Auftrag definieren. Erforderliche Eigenschaften in jedem Auftragspositionsobjekt:
- accountFür B2B-Aufträge oder consumerFür B2C-Aufträge.
  - account – SYS_ID des Geschäfts-Accounts, der dieser Auftragsposition zugewiesen ist. Befindet sich in der Tabelle „Accounts“ [Customer_Account].
  - consumer – SYS_ID des Verbrauchers, der dieser Auftragsposition zugewiesen ist. Befindet sich in der Tabelle „Verbraucher“ [csm_Consumer].
- order_line_characteristics – Liste der Objekte, die die Merkmale der zugehörigen Auftragsposition definieren. Auftragspositionsmerkmale befinden sich in der Tabelle „Merkmale der Auftragsposition“ [sn_csm_om_order_Merkmal_value].
- product_offering – SYS_ID des Produkts, das in der Tabelle „Produktangebote“ [sn_prd_pm_Product_offering] aufgeführt ist.
- quantity – Anzahl der bestellten Produktmodelle.
- unit_of_measurements – SYS_ID für die geordnete Maßeinheit, die in der Tabelle „Maßeinheiten“ [sn_prd_pm_uom] aufgeführt ist.

Die Tabelle „Anforderungstext-Parameter“ enthält weitere Details.

URL-Format

Versionierte URL: /api/sn_ind_tmt_orm/{api_Version}/order

Standard-URL: /api/sn_ind_tmt_orm/order