Bestell-API

Freigeben Version: Yokohama

Aktualisiert 30. Januar 2025

20 Minuten Lesedauer

Die Bestell- API bietet Endpunkte zum Abrufen und Erstellen von Aufträgen mit Bestellpositionen für die Anwendung Kundenservice-Management.

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

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

sn_csm_om.consumer_agent: API-Schreibzugriff auf B2C-Bestellungen beschränkt.
sn_csm_om.customer_agent: API-Schreibzugriff auf B2B-Bestellungen beschränkt.
sn_csm_om.order_admin: API-Schreibzugriff für B2B- oder B2C-Bestellungen.

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

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

Ruft vollständige Bestelldetails durch Angabe der sys_id oder Bestellnummer ab.

URL-Format

URL mit Versionsnummer: /api/sn_ind_tmt_orm/{api_version}/order/{id}

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

Hinweis:

Verfügbare Versionen werden im REST-API-Explorerangegeben. Für geskriptete REST APIs finden Sie zusätzliche Versionsinformationen im Formular „Geskripteter REST-Service“.

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Reihenfolgennummer (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 des Datumsfelds in der Antwort an. „falsch“: Zeigt den Ist-Wert der Referenzfelder, Auswahlfelder und des Datumsfelds 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 HTTP-Antwortcodes der REST-API.

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Der Anwender ist nicht authentifiziert.
403	Der Anwender ist nicht berechtigt. Der Benutzer muss nicht die Rollen haben, um auf die API zuzugreifen. Der Anwender ist nicht berechtigt, den Auftrag zu lesen. Diese API erfordert für den Zugriff sn_csm_om.order_integrator und eine der folgenden Optionen: sn_csm_om.consumer_agent: API-Schreibzugriff auf B2C-Bestellungen beschränkt. sn_csm_om.customer_agent: API-Schreibzugriff auf B2B-Bestellungen beschränkt. sn_csm_om.order_admin: API-Schreibzugriff für B2B- oder B2C-Bestellungen.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
Account	Sys_id eines Datensatzes in der Tabelle „Accounts“ [customer_account]. Identifiziert den Account für B2B-Bestellungen. Datentyp: Zeichenfolge
current_end_date	Enddatum des Auftrags. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
current_start_date	Startdatum des Auftrags. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
billing_city	Name der Rechnungsadresse. Datentyp: Zeichenfolge
billing_country	Abkürzung des Rechnungsadresse: Land. Datentyp: Zeichenfolge
billing_state	Abkürzung des Rechnungsadresse: Bundesland/Kanton. Datentyp: Zeichenfolge
billing_street	Rechnungsadresse. Datentyp: Zeichenfolge
billing_zip	Rechnungsadresse: Postleitzahl. Datentyp: Zeichenfolge
Kommentare	Zusätzliche Informationen für den Auftrag. Datentyp: Zeichenfolge
Verbraucher	Sys_id eines Verbraucherdatensatzes. Identifiziert den Verbraucher für B2C-Bestellungen. Datentyp: Zeichenfolge
Kontakt	Sys_id des Kundenkontakts im Zusammenhang mit dem Account. Datentyp: Zeichenfolge Tabelle: Kontakte [customer_contact]
contract	Sys_id des Vertragsdatensatzes Kundenservice. Datentyp: Zeichenfolge Tabelle: Verträge [ast_contract]
Fehler	Details, die einen während des Anforderungsprozesses aufgetretenen Fehler beschreiben. Datentyp: Objekt `"error": { "detail": "String", "message": "String" }`
Fehler.detail	Details des Fehlers, der während des Anforderungsprozesses aufgetreten ist. Datentyp: Zeichenfolge
Fehlernachricht	Meldung für den Fehler, der während des Anforderungsprozesses aufgetreten ist. Jede Fehlermeldung hat eine entsprechende Beschreibung in der Eigenschaft detail. Datentyp: Zeichenfolge
erwartetes_Enddatum	Erwartetes Enddatum des Auftrags. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
erwartetes_start_datum	Erwartetes Startdatum des Auftrags. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
external_id	Externe ID, die einen zugehörigen Datensatz im System eines Drittanbieters darstellt. Datentyp: Zeichenfolge
external_system	Name des Kundensystems Datentyp: Zeichenfolge
order_category	Kundenauftragstyp. Mögliche Werte: product service Datentyp: Zeichenfolge
order_currency	Währungscode, der die Währung darstellt, in der die Bestellung gekauft wurde. Zum Beispiel `USD` für US-Dollar. Diese Währung wird für alle Betragsfelder im Auftrag und in den Positionsaufträgen verwendet. Währungscodes werden in der Tabelle „Währungen“ [fx_currency] aufgeführt. Hinweis: Diese Eigenschaft ist in früheren Versionen von Auftragsmanagementmöglicherweise nicht verfügbar. 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 von Objekten, die jede Bestellposition im Auftrag definieren. Datentyp: Array Erforderliche Eigenschaften in jedem Auftragspositionselement-Objekt: account für B2B-Bestellungen oder consumer für B2C-Bestellungen. 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: Auftragspositionselemente [sn_csm_om_order_line_item]
order_line_items	Liste von Objekten, die jede Bestellposition 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-Bestellungen. Sys_id des geschäftlichen Accounts, der dieser Bestellposition 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äftlichen Accounts, der dieser Bestellposition zugewiesen ist. Befindet sich in der Tabelle „Accounts“ [customer_account]. Datentyp: Zeichenfolge
order_line_items.action	Aktion, die bestimmt, wie die Auftragsposition zum 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 Bestellposition zugewiesen ist. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
order_line_items.contact	sys_id des Kontakts im Zusammenhang mit dem Account. Datentyp: Zeichenfolge
order_line_items.delivered_quantity	Anzahl der Artikel in der gelieferten Bestellung. Datentyp: Zeichenfolge
order_line_items.effektives_datum	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 Bestellposition. Datentyp: Zeichenfolge
order_line_items.external_system	Externe sys_id der Bestellposition. Datentyp: Zeichenfolge
order_line_items.list_Price	Listenpreis des Produktangebots pro Einheit. Hinweis: Diese Eigenschaft ist in früheren Versionen von Auftragsmanagementmöglicherweise nicht verfügbar. Datentyp: Zeichenfolge
order_line_items.location	Sys_id eines Versandort-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_features	Liste von Objekten, die zugehörige Bestellpositionsmerkmale definieren. Die Merkmale von Bestellpositionen befinden sich in der Tabelle „Bestellpositionsmerkmale“ [sn_csm_om_order_characterist_value]. Datentyp: Array von Objekten `"order_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String" } ]`
order_line_items.order_line_features.feature_option	Eindeutige Option des Produktmerkmals, die die Ausschlussregel auslöst. Zum Beispiel Produktgröße oder Farbe. Datentyp: Zeichenfolge
order_line_items order_line_features Merkmal_Option_Wert	Wert einer Merkmalsoption. Datentyp: Zeichenfolge
order_line_items order_line_features external_id	Externe ID des Merkmals der Bestellposition. Datentyp: Objekt
order_line_items order_line_features.number	Merkmalnummer für Auftragsposition. Datentyp: Zeichenfolge Tabelle: Bestellpositionsmerkmale [sn_csm_om_order_characterist_value]
order_line_items order_line_features order_line_item	Sys_id der Bestellposition dieses Merkmals. Datentyp: Zeichenfolge Tabelle: Auftragspositionselemente [sn_csm_om_order_line_item]
order_line_items order_line_features previous_feature_option_value	Name der vorherigen Merkmalsoption, die dem Produktmodell in der Bestellposition zugeordnet ist. Datentyp: Objekt
order_line_items order_line_features.specification	Servicespezifikation, die dem Serviceauftragsmerkmal zugeordnet ist. Datentyp: Zeichenfolge
order_line_items order_line_features sys_class_name	Systemname der Tabelle, in der sich dieser Datensatz mit den Merkmalen der Bestellposition befindet. Datentyp: Zeichenfolge
order_line_features sys_created_by	Systemname des Anwenders, der diesen Datensatz erstellt hat. Datentyp: Zeichenfolge
order_line_items order_line_features sys_created_on	Datum und Uhrzeit der ursprünglichen Erstellung des Datensatzes. Datentyp: Zeichenfolge
order_line_items order_line_features sys_domain	Domänenbereich, in dem auf den Auftragsdatensatz zugegriffen werden kann. Beispiel: global. Datentyp: Zeichenfolge
order_line_items order_line_features sys_domain_path	Domänenpfad für den Datensatz. Datentyp: Zeichenfolge Standard: / (global)
order_line_items order_line_features sys_id	Sys_id des Auftragsdatensatzes Datentyp: Zeichenfolge Tabelle: Bestellpositionsmerkmale [sn_csm_om_order_characterist_value]
order_line_items order_line_features sys_mod_count	Anzahl der Änderungen dieses Datensatzes. Datentyp: Zeichenfolge
order_line_items order_line_features sys_tags	System-Tags für den Inhalt. Datentyp: Zeichenfolge
order_line_items order_line_features sys_updated_by	Systemname des Anwenders, der diesen Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
order_line_items order_line_features sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. Datentyp: Zeichenfolge
order_line_items order_line_features.type	Typ des Merkmals der Bestellposition. Mögliche Werte: product 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	Identifiziert ggf. einen übergeordneten Einzelposten für diesen Einzelposten. Datentyp: Zeichenfolge
order_line_items. previous_product_model	Sys_id des Produktmodells für das Produkt, das vor diesem Artikel in der Bestellposition aufgeführt ist. Datentyp: Zeichenfolge Tabelle: Produktmodelle [cmdb_model]
order_line_items.Price_list	Sys_id eines Preislistendatensatzes in der Tabelle „Preislisten“ [sn_csm_pricing_Price_list]. Hinweis: Diese Eigenschaft ist in früheren Versionen von Auftragsmanagementmöglicherweise nicht verfügbar. 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 in der Tabelle „Produktmodelle“ [cmdb_model] aufgeführten Produktmodells. Muss mit übereinstimmendem Auftragspositionselement angegeben werden Datentyp: Zeichenfolge
order_line_items.product_specification	Sys_id der Produktspezifikation, die der Auftragsposition zugeordnet ist. sind in der Tabelle „Produktspezifikationen“ [sn_prd_pm_product_specification] aufgeführt. 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 Zielstaats oder der Zielprovinz. Datentyp: Zeichenfolge
order_line_items.shipping_street	Straße des Ziels. Datentyp: Zeichenfolge
order_line_items.shipping_zip	Zielpostleitzahl. Datentyp: Zeichenfolge
order_line_items.short_description	Kurze Beschreibung 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 der Installationsbasis für ein verkauftes Produkt. 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 Bearbeitung oder Abgeschlossen. Datentyp: Zeichenfolge
order_line_items.status	Status des Auftragspositionselements. Mögliche Werte: Fehler Erfolg Datentyp: Zeichenfolge
order_line_items.sys_class_name	Systemname der Tabelle, in der sich dieser Auftragspositionselement-Datensatz 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: Auftragspositionselemente [sn_csm_om_order_line_item]
order_line_items.sys_mod_count	Anzahl der Änderungen dieses Datensatzes. 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 Auftragspositionselemente, die in diesem Auftrag angesammelt wurden. Datentyp: Zeichenfolge
order_line_items.total_Price	Gesamtpreis der Auftragsposition. Die API berechnet den Gesamtbetrag nicht basierend auf Nettopreis und Menge. Datentyp: Zeichenfolge
order_line_items.unit_of_measurement	Sys_id für die bestellte Maßeinheit, die in der Tabelle „Maßeinheiten“ [sn_prd_pm_uom] aufgeführt ist. Hinweis: Diese Eigenschaft ist in früheren Versionen von Auftragsmanagementmöglicherweise nicht verfügbar. Datentyp: Zeichenfolge
order_line_items.unit_of_measurement	Erforderlich. Sys_id für die bestellte Maßeinheit, die in der Tabelle „Maßeinheiten“ [sn_prd_pm_uom] aufgeführt ist. Hinweis: Diese Eigenschaft ist in früheren Versionen von Auftragsmanagementmöglicherweise nicht verfügbar. 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	Interne Freiform-Arbeitsnotizen für die Auftragsposition. Datentyp: Zeichenfolge
order_type	Bestellaktion, die bestimmt, wie die Bestellung hinzugefügt wird. Mögliche Werte: Hinzufügen Change Datentyp: Zeichenfolge
Partner	Bei B2B-Aufträgen die sys_id des zugeordneten Partnerdatensatzes für einen Account. Datentyp: Zeichenfolge Tabelle: Accounts [customer_account]
„partner_contact“	Bei B2B-Bestellungen die 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: Schecknummer. Datentyp: Zeichenfolge
Price_list	Sys_id des zugeordneten Preislistendatensatzes. Der Preis wird von dieser API nicht basierend auf dem Nettopreis und der Menge berechnet. Hinweis: Diese Eigenschaft ist in früheren Versionen von Auftragsmanagementmöglicherweise nicht verfügbar. Datentyp: Zeichenfolge Tabelle: Preislisten [sn_csm_ Pricing_Price_list]
quote_id	Eindeutige ID für das Auftragspreisangebot. Datentyp: Zeichenfolge
sam_as_shipping_address	Kennzeichnung, die angibt, ob die Adresse des Käufers mit der Versandadresse identisch ist. Gültige Werte: wahr: Die Adresse des Käufers ist mit der Versandadresse identisch. „falsch“: Die Adresse des Käufers weicht von der Versandadresse ab. Datentyp: Boolesch
Versandstadt	Name der Zielstadt Datentyp: Zeichenfolge
Versandland	Abkürzung des Ziellandes. Datentyp: Zeichenfolge
Versandort	Sys_id eines Versandort-Datensatzes. Datentyp: Zeichenfolge Tabelle: Standorte [cmn_location]
Versandstatus	Abkürzung des Zielstaats oder der Zielprovinz. Datentyp: Zeichenfolge
Spedition_Street	Straße des Ziels. Datentyp: Zeichenfolge
Versand_ZIP	Zielpostleitzahl. Datentyp: Zeichenfolge
short_description	Kurzbeschreibung der Bestellung. Datentyp: Zeichenfolge
special_instances	Spezialanweisungen für den Auftrag. Datentyp: Zeichenfolge
state	Status des Auftrags. Beispiele: neu, in_Progress oder abgeschlossen. 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	Anzahl der Änderungen dieses Datensatzes. 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 Bestellnummer 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: POST /sn_ind_tmt_orm/order

Erstellt einen neuen Auftrag mit Einzelposten und Merkmalen.

Aufträge mit Einzelposten werden mithilfe von Anforderungstextparametern definiert. Die folgenden Eigenschaften sind in den meisten Versionen von Auftragsmanagementerforderlich:

account für B2B-Bestellungen oder consumer für B2C-Bestellungen.
- 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. Zum Beispiel USD für US-Dollar. Diese Währung wird für alle Betragsfelder im Auftrag und in den Positionsaufträgen verwendet. Währungscodes werden in der Tabelle „Währungen“ [fx_currency] aufgeführt.
order_line_items – Liste von Objekten, die jede Bestellposition im Auftrag definieren. Erforderliche Eigenschaften in jedem Auftragspositionselement-Objekt:
- account für B2B-Bestellungen oder consumer für B2C-Bestellungen.
  - account – Sys_id des geschäftlichen Accounts, der dieser Bestellposition zugewiesen ist. Befindet sich in der Tabelle „Accounts“ [customer_account].
  - consumer – Sys_id des Verbrauchers, der dieser Bestellposition zugewiesen ist. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer].
- order_line_characteristics – Liste von Objekten, die zugehörige Bestellpositionsmerkmale definieren. Die Merkmale von Bestellpositionen befinden sich in der Tabelle „Bestellpositionsmerkmale“ [sn_csm_om_order_characterist_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 bestellte Maßeinheit, die in der Tabelle „Maßeinheiten“ [sn_prd_pm_uom] aufgeführt ist.

Die Tabelle „Parameter des Anforderungstexts“ enthält weitere Details.

URL-Format

URL mit Versionsnummer: /api/sn_ind_tmt_orm/{api_version}/order

Standard-URL: /api/sn_ind_tmt_orm/order