Bestell-API

Freigeben Version: Washingtondc

Aktualisiert 1. Februar 2024

21 Minuten Lesedauer

Die Order -API ermöglicht das Abrufen und Erstellen von Aufträgen mit Auftragspositionen für die Anwendung Kundenservice-Management (Customer Service Management, CSM).

Diese API erfordert die Store-Anwendung Order Management für Kundenservice-Management (app-csm-order-mgmt) und wird im Namespace sn_csm_order_mgmt bereitgestellt. Weitere Informationen 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.

Weitere Informationen zu B2B- und B2C-Aufträgen finden Sie unter Customer Data Models for B2B2C.

Order API – GET /sn_csm_order_mgmt/order/{id}

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

URL-Format

Versionierte URL: /api/sn_csm_order_mgmt/{api_version}/order/{id}

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

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 in der Tabelle „Aufträge“ [sn_csm_om_order]. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter
Name	Beschreibung
sysparm_display_value	Kennzeichnung, die angibt, ob der Anzeigewert der Referenzfelder angezeigt werden soll. Gültige Werte: true: Zeigt den Anzeigewert der Referenzfelder, Auswahlfelder und des Datumsfelds in der Antwort an. false: Zeigt den tatsächlichen 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-Antwortcodesder REST-API.

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Der Benutzer ist nicht authentifiziert.
403	Der Anwender ist nicht berechtigt. Der Benutzer verfügt nicht über die erforderlichen Rollen für den Zugriff auf die API. Der Benutzer hat keine Berechtigung zum Lesen der Bestellung. 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.

Antworttextparameter (JSON oder XML)


Name	Beschreibung
Account	Sys_id eines Datensatzes in der Tabelle „Accounts“ [customer_account]. Identifiziert den Account für B2B-Aufträge. Datentyp: Zeichenfolge
tatsächliches_end_datum	Enddatum der Bestellung. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
tatsächliches_start_datum	Startdatum der Bestellung. Format: UTC-Format, jjjj-MM-tt HH:mm:ss Datentyp: Zeichenfolge
„billing_city“.	Name des Rechnungsstandorts. Datentyp: Zeichenfolge
„billing_country“	Abkürzung des Rechnungslandes. Datentyp: Zeichenfolge
„billing_state“	Abkürzung für Bundesstaat oder Region der Rechnungsadresse. Datentyp: Zeichenfolge
„billing_street“.	Rechnungsadresse: Straße und Hausnummer. Datentyp: Zeichenfolge
billing_zip	Rechnungsadresse: Postleitzahl. Datentyp: Zeichenfolge
Kommentare	Zusätzliche Informationen für die Bestellung. Datentyp: Zeichenfolge
consumer	Sys_id eines Datensatzes in der Tabelle „Verbraucher“ [csm_consumer]. Identifiziert den Verbraucher für B2C-Bestellungen. Datentyp: Zeichenfolge
Kontakt	Sys_id des Kundenkontakts, der sich auf den Account bezieht. Wird in der Tabelle „Kontakte“ [customer_contact] aufgeführt. Datentyp: Zeichenfolge
contract	Sys_id des Vertrags [ Kundenservice, der in der Tabelle „Verträge“ [ast_contract] aufgeführt ist. Datentyp: Zeichenfolge
Fehler	Details, die einen während des Anforderungsprozesses aufgetretenen Fehler beschreiben. Datentyp: Objekt `"error": { "detail": "String", "message": "String" }`
Fehler.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 der Eigenschaft detail. Datentyp: Zeichenfolge
erwartetes_end_datum	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 einer Drittpartei darstellt. Datentyp: Zeichenfolge
external_system	Name des Kundensystems. 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 erworben wurde. 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 Order Managementmö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, der in der Tabelle „Aufträge“ [sn_csm_om_order] aufgeführt ist. Datentyp: Zeichenfolge
order_line_items	Erforderlich. Liste der Objekte, die jede Auftragsposition im Auftrag definieren. Befindet sich in der Tabelle „Bestellpositionen“ [sn_csm_om_order_line_item]. Datentyp: Array Erforderliche Eigenschaften in jedem Auftragspositionsobjekt: account für B2B-Aufträge oder consumer fü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" } ]
order_line_items	Liste der Objekte, die jede Auftragsposition im Auftrag definieren. Befindet sich in der Tabelle „Bestellpositionen“ [sn_csm_om_order_line_item]. Datentyp: Array "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 Bestellposition zugewiesen ist. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
order_line_items.contact	Kontakt-sys_id, die sich auf den Account bezieht. Datentyp: Zeichenfolge
order_line_items.delivered_quantity	Anzahl der in der Bestellung gelieferten Artikel. 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 Auftragsposition. 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 Order Managementmöglicherweise nicht verfügbar. Datentyp: Zeichenfolge
order_line_items.location	Sys_id eines Versandorts, der in der Tabelle „Standorte“ [cmn_location] aufgeführt ist. Datentyp: Zeichenfolge
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 Auftragspositionen definieren. Die Merkmale der Bestellposition befinden sich in der Tabelle „Merkmale der Bestellposition“ [sn_csm_om_order_characteristic_value]. `"order_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String" } ]` Datentyp: Array
order_line_items.order_line_characteristics.characteristic_option	Eindeutige Option für Produktmerkmale, die die Ausschlussregel auslöst. Zum Beispiel Produktgröße oder -farbe. Datentyp: Zeichenfolge
order_line_items order_line_characteristics. feature_option_value	Wert einer Merkmalsoption. Datentyp: Zeichenfolge
order_line_items order_line_characteristics. external_id	Externe ID des Merkmals der Auftragsposition. Datentyp: Objekt
order_line_items order_line_characteristics. Nummer	Merkmalnummer der Bestellposition, die in der Tabelle „Merkmale der Bestellposition“ [sn_csm_om_order_characteristic_value] aufgeführt ist. Datentyp: Zeichenfolge
order_line_items order_line_characteristics. order_line_item	Sys_id der Auftragsposition dieses Merkmals in der Tabelle „Auftragspositionen“ [sn_csm_om_order_line_item]. Datentyp: Zeichenfolge
order_line_items order_line_characteristics. previous_characteristic_option_value	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 Auftragspositionsmerkmal-Datensatz befindet. Datentyp: Zeichenfolge
order_line_characteristics. sys_created_by	Systemname des Benutzers, 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 Bestelldatensatzes in der Tabelle „Merkmale der Bestellposition“ [sn_csm_om_order_characteristic_value]. Datentyp: Zeichenfolge
order_line_items order_line_characteristics. sys_mod_count	Anzahl der Änderungen an diesem Datensatz. 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 Benutzers, 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 Merkmals der Bestellposition. 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	Identifiziert ggf. einen übergeordneten Einzelposten für diesen Einzelposten. Datentyp: Zeichenfolge
order_line_items. previous_product_model	Identifiziert das Produktmodell für das Produkt, das vor diesem Artikel in der Auftragsposition aufgeführt ist. Sys_id des Produkts, das in der Tabelle „Produktmodelle“ [cmdb_model] aufgeführt ist. Datentyp: Zeichenfolge
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 Order Managementmöglicherweise nicht verfügbar. Datentyp: Zeichenfolge
order_line_items.product	Sys_id des Produkts, das in der Tabelle „Produktmodelle“ [cmdb_model] aufgeführt ist. Datentyp: Zeichenfolge
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. Wird 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 Zielregion. Datentyp: Zeichenfolge
order_line_items.shipping_street	Straße und Hausnummer des Ziels. Datentyp: Zeichenfolge
order_line_items.shipping_zip	Ziel-Postleitzahl. Datentyp: Zeichenfolge
order_line_items.short_description	Kurzbeschreibung der Bestellposition. 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 verkauften Produkts mit Installationsbasis, das in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product] aufgeführt ist. Datentyp: Zeichenfolge
order_line_items.specification	Spezifikation der Bestellposition. 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 Bestellposition. Mögliche Werte: Erfolg Fehler 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 Benutzers, 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 in der Tabelle „Bestellpositionen“ [sn_csm_om_order_line_item]. Datentyp: Zeichenfolge
order_line_items.sys_mod_count	Anzahl der Änderungen an diesem Datensatz. Datentyp: Zeichenfolge
order_line_items.sys_tags	System-Tags für den Inhalt. Datentyp: Zeichenfolge
order_line_items.sys_updated_by	Systemname des Benutzers, 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 in diesem Auftrag kumulierten Auftragspositionen. 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 in früheren Versionen von Order Managementmöglicherweise nicht verfügbar. 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 in früheren Versionen von Order Managementmöglicherweise nicht verfügbar. Datentyp: Zeichenfolge
order_line_items.unit_price	Nettopreis des Produktangebots pro Einheit, der in der Tabelle „Währungsinstanzen“ [fx_currency_instance] aufgeführt ist. Datentyp: Zeichenfolge
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	Für B2B-Aufträge die sys_id des zugeordneten Partners für einen Account, der in der Accounts-Tabelle [customer_account] aufgeführt ist. Datentyp: Zeichenfolge
„partner_contact“.	Für B2B-Aufträge sys_id des primären Kontakts des Partners für den Partner-Account. Wird in der Tabelle „Kontakte“ [customer_contact] aufgeführt. Datentyp: Zeichenfolge
„payment_ref_id“	Eindeutiger Bezeichner der Zahlung. Beispiel: Schecknummer. Datentyp: Zeichenfolge
price_list	Sys_id der zugeordneten Preisliste, die in der Tabelle „Preislisten“ [sn_csm_pricing_price_list] aufgeführt ist. Der Preis wird von dieser API nicht basierend auf dem Nettopreis und der Menge berechnet. Hinweis: Diese Eigenschaft ist in früheren Versionen von Order Managementmöglicherweise nicht verfügbar. Datentyp: Zeichenfolge
quot_id	Eindeutige ID für das Auftragspreisangebot. Datentyp: Zeichenfolge
same_as_shipping_address	Kennzeichnung, die angibt, ob die Adresse des Käufers mit der Versandadresse identisch ist. Gültige Werte: true: Die Adresse des Käufers stimmt mit der Versandadresse überein. false: 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 Versandorts, der in der Tabelle „Standorte“ [cmn_location] aufgeführt ist. Datentyp: Zeichenfolge
shipping_state	Abkürzung des Zielstaats oder der Zielregion. Datentyp: Zeichenfolge
shipping_street	Straße und Hausnummer des Ziels. Datentyp: Zeichenfolge
shipping_zip	Ziel-Postleitzahl. Datentyp: Zeichenfolge
short_description	Kurzbeschreibung der Bestellung. Datentyp: Zeichenfolge
spezielle_Anweisungen	Spezielle Anweisungen für die Bestellung. Datentyp: Zeichenfolge
Status	Status der Bestellung. Zum Beispiel „new“, „in_progress“ oder „completed“. Datentyp: Zeichenfolge
status	Status der Bestellung. Mögliche Werte: Erfolg Fehler Datentyp: Zeichenfolge
sys_class_name	Systemname der Tabelle, in der sich dieser Bestelldatensatz befindet. Datentyp: Zeichenfolge
sys_created_by	Systemname des Benutzers, 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 Auftrags, der in der Tabelle „Aufträge“ [sn_csm_om_order] aufgeführt ist. Datentyp: Zeichenfolge
sys_mod_count	Anzahl der Änderungen an diesem Datensatz. Datentyp: Zeichenfolge
sys_tags	System-Tags für den Inhalt. Datentyp: Zeichenfolge
sys_updated_by	Systemname des Benutzers, 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 eine Reihenfolge anhand ihrer Reihenfolgennummer abgerufen wird.

curl "https://instance.service-now.com/api/sn_csm_order_mgmt/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"
          }
        ]
      }
    ]
  }
}

Auftrags-API – POST /sn_csm_order_mgmt/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 Order Managementerforderlich:

account für B2B-Aufträge oder consumer für B2C-Aufträge.
- account – Sys_id eines Datensatzes in der Tabelle „Accounts“ [customer_account].
- consumer – Sys_id eines Datensatzes in der Tabelle „Verbraucher“ [csm_consumer].
order_currency – Währungscode, der die Währung darstellt, in der die Bestellung erworben wurde. 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 der Objekte, die jede Auftragsposition im Auftrag definieren. Befindet sich in der Tabelle „Bestellpositionen“ [sn_csm_om_order_line_item]. Erforderliche Eigenschaften in jedem Auftragspositionsobjekt:
- account für B2B-Aufträge oder consumer fü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 Bestellposition zugewiesen ist. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer].
- order_line_characteristics – Liste der Objekte, die die Merkmale der zugehörigen Auftragspositionen definieren. Die Merkmale der Bestellposition befinden sich in der Tabelle „Merkmale der Bestellposition“ [sn_csm_om_order_characteristic_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 „Anforderungstextparameter“ enthält weitere Details.

URL-Format

Versionierte URL: /api/sn_csm_order_mgmt/{api_version}/order

Standard-URL: /api/sn_csm_order_mgmt/order