order_create

Methode zum Anlegen eines Bestellauftrages.

Datenfelder

Informationen zu den Datenfelder des Auftrag-Models finden Sie hier: Daten-Typ "Auftrag". Die Datenfeldern zu den Auftragsposten, die pro Auftragsanlage zusätzlich übergeben werden können, werden im Artikel Daten-Typ "Auftragsposten" näher beschrieben.

Schema

Parameter - Array

$Params	Pflicht	Beschreibung	Beispiel
[fields]	Pflicht	Array. Liste der Felder und ihrer Werte. Es werden nur die Felder berücksichtigt, die dem Model's "Haupt-Table" zugehörig sind. Alle anderen Felder werden (silently) ignoriert. Ist ein Wert null, so wird er auch mit "<field>=NULL" in die Datenbank geschrieben.	["invoice_firstname"] = "Emil" ["invoice_lastname"] = "Matters"
[fields][orderitems][<n>][<orderitem_field>]	optional	Array. Liste der Auftragsposten als 2-dimensionales Unterarray von [fields][orderitems].

$Params

Pflicht

Beschreibung

Beispiel

[fields]

Pflicht

Array. Liste der Felder und ihrer Werte.

Es werden nur die Felder berücksichtigt, die dem Model's "Haupt-Table" zugehörig sind. Alle anderen Felder werden (silently) ignoriert.

Ist ein Wert null, so wird er auch mit "<field>=NULL" in die Datenbank geschrieben.

["invoice_firstname"] = "Emil"
["invoice_lastname"] = "Matters"

[fields][orderitems][<n>][<orderitem_field>]

optional

Array. Liste der Auftragsposten als 2-dimensionales Unterarray von [fields][orderitems].

Return - Array

Array-Key	Typ	Beschreibung
[status]	boolean	TRUE: Wenn das Anlegen erfolgreich durchgeführt werden konnte. FALSE: Wenn es bei der Ausführung einen Fehler gab.
[msg][<n>][type\|text]	string	Message-Stack Ein optionales Array, um Message-Strings zur Ausgabe in der GUI und Message-Codes zurückzugeben. Vor allem bei Ausführungsfehlern ( [status]=FALSE) sollte hier etwas zurückgegeben werden. Numerisches Array (mit n von 0 bis N). Es können prinzipiell beliebig viele Messages zurückgegeben werden. Pro Message können jeweils optional [type] und [text] zurückgegeben werden. [ type] ist typischerweise einer der folgenden Werte: "ERROR" - Schwerer Ausführungsfehler. "WARNING" - Warnung bei Ausführung. "INFO" - Zusätzliche (Debug) Meldungen. "OK" - Ausführung OK.
[data][<fields>]	mixed	Die eigentlichen Daten des angeforderten Datensatzes in einem assoziativen Array.

Array-Key

Typ

Beschreibung

[status]

boolean

TRUE: Wenn das Anlegen erfolgreich durchgeführt werden konnte.

FALSE: Wenn es bei der Ausführung einen Fehler gab.

[msg][<n>][type|text]

string

Message-Stack

Ein optionales Array, um Message-Strings zur Ausgabe in der GUI und Message-Codes zurückzugeben. Vor allem bei Ausführungsfehlern ( [status]=FALSE) sollte hier etwas zurückgegeben werden.

Numerisches Array (mit n von 0 bis N). Es können prinzipiell beliebig viele Messages zurückgegeben werden.
Pro Message können jeweils optional [type] und [text] zurückgegeben werden.

[ type] ist typischerweise einer der folgenden Werte:

"ERROR" - Schwerer Ausführungsfehler.
"WARNING" - Warnung bei Ausführung.
"INFO" - Zusätzliche (Debug) Meldungen.
"OK" - Ausführung OK.

[data][<fields>]

mixed

Die eigentlichen Daten des angeforderten Datensatzes in einem assoziativen Array.

Beispiel

Nachfolgend ein Beispiel zur Nutzung der API Ressource order_create.

a) Bestellung mit einem Posten

Es sollen eine Bestellung mit dem Produkt "TS00001-XS" für den Kunden "K0000290" erzeugt werden.

 
	/*
	 * Beispielaufruf des API-URL-Calls für die zu übergebenen Parameter
	 * Für die Erzeugung der Bestellung ist die personid (Kundennummer) und das orderitem-Array (Auftragsposten) nötig.
	 * In diesem Muss die Artikelnummer (oi_pcode), der Bestellmenge (oi_quantity) und der Brutto-Einzelpreis (oi_price_single_brutto)
	 * übergeben werden.
	 */
	<your_api_url>&resource=order_create&params[fields][personid]=K0000290&params[fields][orderitems][0][oi_pcode]=TS00001-XS
	&params[fields][orderitems][0][oi_quantity]=1&params[fields][orderitems][0][oi_price_single_brutto]=19.95

Das Result der Abfrage ist ein JSON String.

 
	/*
	 * Beispiel-JSON für das Result der Abfrage im Erfolgsfall
	 */
	{
	  "status" : true,
	  "msg" : null,
	  "meta" : {
	     "insert_key" : "oid",
	     "insert_id" : <oid des neuen Auftrages>
	  }
	}

order_create

Datenfelder

Schema

Parameter - Array

Return - ​Array

Beispiel

a) Bestellung mit einem Posten

Return - Array