|
Aufträge |
  
|
|
Aufträge |
|
Beschreibung
Im API Endpunkt der orders können Aufträge in verschiedenen Formen abgerufen werden.
Zum einen können Listen von Aufträgen in kompakter Form als auch einzelne Aufträge mit detaillierten Daten abgerufen werden.
Aufträge
Abrufbar unter api/[MANDANT]/orders im folgenden Format mit den folgenden Filtermöglichkeiten:
Format
Schlüssel |
Wert |
Datentyp |
id |
Auftragsnummer |
int |
orderDate |
Datum |
date YYYY-MM-DD 00:00:00 |
status |
Status
0 = Neu |
int |
shopId |
Shop- bzw. Marktplatznummer |
int |
externalOrderId |
externe Bestellnummer |
string |
deliveryMethodId |
ID der Versandart |
int |
paymentMethodId |
ID der Zahlungsart |
int |
totalGross |
Gesamtbetrag (Brutto) |
float |
totalNet |
Gesamtbetrag (Netto) |
float |
amount |
Endbetrag |
float |
customerId |
Kundennummer |
int |
customerEmail |
eMail- Adresse des Kunden |
string |
Filter
Parameter |
Wert |
Datentyp |
||||||||
searchTerm |
Volltextsuche nach ...
|
string |
||||||||
customerId |
Kundennummer |
int |
||||||||
shopId |
Shopnummer |
int |
||||||||
ebayAccount |
eBay Benutzername |
string |
||||||||
eMail-Adresse |
string |
|||||||||
dateFrom |
Aufträge ab diesem Datum |
date TT.MM.JJJJ |
||||||||
dateTo |
Aufträge bis zu diesem Datum |
date TT.MM.JJJJ |
Beispiel JSON-Antwort
[
{
"id":40,
"orderDate":"2018-01-08T00:00:00",
"status":0,
"shopId":null,
"externalOrderId":null,
"deliveryMethodId":0,
"paymentMethodId":0,
"totalGross":908.97,
"totalNet":784.22,
"amount":908.97,
"customerId":10009,
"customerEmail":"john@doe.de"
},
{
"id":39,
"orderDate":"2018-01-16T00:00:00",
"status":3,
"shopId":4,
"externalOrderId":"20001",
"deliveryMethodId":3,
"paymentMethodId":30,
"totalGross":24.45,
"totalNet":20.54,
"amount":24.45,
"customerId":10018,
"customerEmail":"max@muster.de"
}
]
Auftrag
Abrufbar unter api/[MANDANT]/orders/[ID] im folgenden Format:
Format
Schlüssel |
Wert |
Datentyp |
id |
Auftragsnummer |
int |
orderDate |
Datum |
date YYYY-MM-DD 00:00:00 |
status |
Status
0 = Neu |
int |
languageCode |
Sprachkennzeichen |
string |
shopId |
Shop- bzw. Marktplatznummer |
int |
externalOrderId |
externe Bestellnummer |
string |
deliveryMethodId |
ID der Versandart |
int |
deliveryMethodName |
Versandart |
string |
shippingDate |
Versanddatum |
date YYYY-MM-DD 00:00:00 |
deliveryDate |
(geplantes) Lieferdatum |
date YYYY-MM-DD 00:00:00 |
deliveryPriority |
Versandpriorität
0 = keine Prio. 1 = Prio. |
int |
deliveryCostsGross |
Versandkosten (Brutto) |
float |
deliveryCostsNet |
Versandkosten (Netto) |
float |
paymentMethodId |
ID der Zahlungsart |
int |
paymentMethodName |
Zahlungsart |
string |
paymentDate |
Zahlungseingangsdatum |
date YYYY-MM-DD 00:00:00 |
transactionId |
Transaktions- ID |
string |
taxClass |
Steuerkennzeichen (MwSt. Satz) |
float |
priceGroup |
Preisgruppe |
int |
customerGroup |
Kundengruppe (ID) |
string |
discount |
Rabatt |
float |
totalGross |
Gesamtbetrag (Brutto) |
float |
totalNet |
Gesamtbetrag (Netto) |
float |
amount |
Endbetrag |
float |
balance |
Restbetrag |
float |
weight |
Gewicht (in KG) |
float |
volume |
Volumen |
float |
customerId |
Kundennummer |
string |
marketplaceAccount |
Marktplatz Verkäuferkonto |
string |
customerEmail |
eMail- Adresse des Kunden |
string |
customerAccount |
Benutzername/Shop-KdNr. |
string |
customerPhone1 |
Telefon 1 |
string |
customerPhone2 |
Telefon 2 |
string |
customerFax |
Fax |
string |
customerBirthday |
Geburtstag |
date YYYY-MM-DD 00:00:00 |
messageInternal |
Memo |
string |
messageExternal |
Mitteilung |
string |
textFooter |
Fußtext |
string |
textAdditional |
Sondertext |
string |
trackingCodes |
Paketnummern |
string |
Rechnungsanschrift |
||
billingSalutation |
Anrede |
string |
billingFirstname |
Vorname |
string |
billingName1 |
Name1 |
string |
billingName2 |
Name2 |
string |
billingStreet |
Straße |
string |
billingZip |
PLZ |
string |
billingCity |
Stadt |
string |
billingCountry |
Land |
string |
Lieferanschrift |
||
deliveryCustomerId |
Kundennummer der Lieferanschrift |
int |
deliverySalutation |
Anrede |
string |
deliveryFirstname |
Vorname |
string |
deliveryName1 |
Name1 |
string |
deliveryName2 |
Name2 |
string |
deliveryStreet |
Straße |
string |
deliveryZip |
PLZ |
string |
deliveryCity |
Stadt |
string |
Positionen |
||
positions |
Liste mit Artikeln |
array |
Artikelformat
Schlüssel |
Wert |
Datentyp |
artcode |
Artikelcode |
string |
title |
Titel |
string |
description |
Langtext |
string |
unit |
Einheit |
string |
costsGross |
Einzelpreis (Brutto) |
float |
costsNet |
Einzelpreis (Netto) |
float |
totalGross |
Gesamtpreis (Brutto) |
float |
totalNet |
Gesamtpreis (Netto) |
float |
quantity |
Menge |
float |
discount |
Positionsrabatt |
float |
priceUnit |
Preiseinheit |
int |
taxRate |
MwSt. Satz |
float |
Beispiel JSON-Antwort
{
"id":41,
"orderDate":"2018-04-09T00:00:00",
"createdBy":"Gastbenutzer",
"status":0,
"languageCode":"DE",
"shopId":4,
"externalOrderId":"20001",
"deliveryMethodId":3,
"deliveryMethodName":"Postpaket",
"shippingDate":"2018-04-09T00:00:00",
"deliveryDate":"2015-06-16T00:00:00",
"deliveryPriority":0,
"deliveryCostsGross":4.9,
"deliveryCostsNet":4.12,
"paymentMethodId":30,
"paymentMethodName":"Vorauskasse 2% Skonto",
"paymentDate":"2018-04-09T00:00:00",
"transactionId":null,
"taxClass":2,
"priceGroup":9,
"customerGroup":null,
"discount":0.0,
"totalGross":24.85,
"totalNet":20.88,
"amount":24.85,
"balance":0.0,
"weight":0.12,
"volume":0.0,
"customerId":10018,
"marketplaceAccount":null,
"customerEmail":"max@muster.de",
"customerAccount":"20003",
"customerPhone1":null,
"customerPhone2":null,
"customerFax":null,
"customerBirthday":null,
"billingSalutation":"Herr",
"billingFirstname":"Max",
"billingName1":"Muster",
"billingName2":null,
"billingStreet":"Musterstr. 1",
"billingZip":"12345",
"billingCity":"Musterstadt",
"billingCountry":"DE",
"deliveryCustomerId":null,
"deliverySalutation":null,
"deliveryFirstname":null,
"deliveryName1":null,
"deliveryName2":null,
"deliveryStreet":null,
"deliveryZip":null,
"deliveryCity":null,
"positions":[
{
"artcode":"TR-03",
"unit":null,
"costsGross":19.95,
"costsNet":16.76,
"totalGross":19.95,
"totalNet":16.76,
"quantity":1.0,
"discount":null,
"priceUnit":1,
"title":"Taschenrechner Modell 03",
"taxRate":19.0,
"description":"Kahsio Taschenrechner aus Plastik, transparent / blaues Gehäuse für den besonderen Look!"
}
],
"messageInternal":"Interne Nachricht",
"messageExternal":"Bitte schnell liefern, Danke!",
"textFooter":"Wir bedanken uns für Ihr Vertrauen.\r\nDiesem Auftrag liegen die Lieferungs- und Zahlungsbedingungen unseres Hauses zugrunde.\r\n",
"textAdditional":"",
"trackingCodes":"123456789"
}