REST API

Zur Abfrage der Bestellungen bietet der WSi4 Shop eine REST API.

Die API Zugriffe sind beschraenkt auf Nutzer mit API Zugangsrechten und koennen entweder per Digest access authentication oder HTTP Basic authentication authentifiziert werden.

Bestelluebersicht

Zur Abfrage einer Liste der eingegangenen Bestellungen kann folgender URL per GET Aufruf abgefragt werden:

URL
/api/wsi4_shop/orders

Der Aufruf unterstuetzt folgende Parameter, die als GET Parameter uebergeben werden (z.B. /api/wsi4_shop/orders?limit=100)

Parameter	Typ	Beschreibung
limit	int (optional)	Begrenzt das Ergebnis auf die letzten [limit] Eintraege

Als Ergebnis wird ein JSON Objekt mit folgendem Aufbau geliefert:

Feld	Beschreibung
success	true bei erfolgreicher Bearbeitung, false im Falle eines Fehlers
data	Die Liste an Bestellungen in Form eines Arrays von Bestellungen bestehend aus der Bestellnumer number und der Bestellzeit order_time im ISO Zeitformat.

Bestelldetails

Zur Abfrage einer einzelnen Bestellung kann folgender URL per GET Aufruf abgefragt werden:

URL
/api/wsi4_shop/order

Der Aufruf unterstuetzt folgende Parameter, die als GET Parameter uebergeben werden (z.B. /api/wsi4_shop/order?number=1)

Parameter	Typ	Beschreibung
number	int (pflicht)	Die Bestellnummer deren Details abgefragt werden sollen (aus /orders Request, <strong>number</strong> Feld des jeweiligen Eintrags.

Als Ergebnis wird ein JSON Objekt mit folgendem Aufbau geliefert:

Feld	Beschreibung
success	true bei erfolgreicher Bearbeitung, false im Falle eines Fehlers
data/customer/number	Die Kundennummer im Online-Shop.
data/customer/email	Die Email-Adresse des Kunden
data/customer/billing_address	Die Rechnungs-Adresse des Kunden, bestehend aus den Feldern company, department, salutation, title, first_name, last_name, street, zip_code, city, phone, ustid, additional_address_line1, additional_address_line2, country und state
data/customer/shipping_address	Die Liefer-Adresse des Kunden, bestehend aus den Feldern company, department, salutation, title, first_name, last_name, street, zip_code, city, phone, ustid, additional_address_line1, additional_address_line2, country und state
data/order/number	Die Bestellnummer im Online-Shop
data/order/order_time	Die Bestellzeit im ISO Format
data/order/payment_type	Die vom Kunden gewaehlte Zahlungsmethode
data/order/shipping_method	Die vom Kunden gewaehlte Versandart
data/order/expected_delivery	Die im Shop angegebene Lieferzeit
data/order/invoice_amount_net	Der Rechnungsbetrag, netto
data/order/invoice_amount	Der Rechnungsbetrag, brutto
data/order/invoice_shipping_net	Die Versandkosten, netto
data/order/invoice_shipping	Die Versandkosten, brutto
data/order/items	Ein Array mit den bestellten Artikeln. Inklusive WSi4-Datei und Graphen, Binaerdaten sind Base64-Kodiert.