Facetten
Facetten
Über die Facetten können weitere Daten dazu geladen werden. Diese werden Komma getrennt übergeben
Zum Beispiel : /api/account/group/[gid]/member/search?q=user.uid%3E0&facet=memberships,personal
| Facette |
Beschreibung |
| personal |
Person bezogene Daten, wie AnredeName |
| addresses |
Adressen |
| communication |
Kommunikation |
| property |
Eigenschaften |
| memberships |
Mitgliedschaften |
| notices |
Kontaktverfolgung , eMails |
| orders |
Bestellungen |
| relationship |
Beziehungen |
personal
| property |
title |
default |
type |
examples |
| pid |
Personal ID |
0 |
integer |
3 |
| uid |
Benutzer ID |
0 |
integer |
20 |
| alias |
The Alias Schema |
|
string |
|
| formOfAddress |
Anrede |
|
string |
Herr |
| salutation |
Briefanrede |
|
string |
Sehr geehrter Herr Mustermann |
| firstname |
Vorname |
|
string |
Max |
| name1 |
Nachname 1 |
|
string |
Mustermann |
| name2 |
Nachname 2 |
|
string |
|
| title |
Titel |
|
string |
|
| custom1 |
Benutzerdefiniert 1 |
|
string |
Testkunde mit Kundenkonto B2C |
| custom2 |
Benutzerdefiniert 2 |
|
string |
|
| birthday |
Geburtstag |
|
string |
1977-01-04T00:00:00 |
| lastUpdate |
Änderungsdatum |
|
string |
2017-02-01T21:53:17 |
| erpID |
ERP ID |
|
string |
|
| erpName |
ERP Name |
|
string |
|
| erpNumber |
ERP Nummer |
|
string |
|
| erpLastUpdate |
ERP Änderungsdatum |
|
string |
2013-12-15T16:43:53 |
| erpCreation |
ERP Erstelldatum |
|
string |
0000-01-01T00:00:00 |
"personal": {
"dataset": {
"pid": 3,
"uid": 20,
"alias": "",
"formOfAddress": "Herr",
"salutation": "Sehr geehrter Herr Mustermann",
"firstname": "Max",
"name1": "Mustermann",
"name2": "",
"title": "",
"custom1": "Testkunde mit Kundenkonto B2C",
"custom2": "",
"birthday": "1977-01-04T00:00:00",
"lastUpdate": "2017-02-01T21:53:17",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2013-12-15T16:43:53",
"erpCreation": "0000-01-01T00:00:00"
}
}
addresses
| property |
title |
required |
default |
type |
examples |
| aid |
Eindeutige ID des Datensatzes |
|
|
integer |
14 |
| uid |
Benutzer ID |
|
0 |
integer |
29 |
| contact |
Kontakt |
|
|
string |
14 |
| company |
Firma |
|
|
string |
14 |
| address1 |
Strasse und Hausnummer |
|
|
string |
Testweg 1 |
| address2 |
Adressen Zusatz / CO |
|
|
string |
z.H. Alvine Musterfrau |
| city |
Stadt |
|
|
string |
Landsberied |
| state |
Bundesland |
|
|
string |
Bayern |
| zipcode |
Postleitzahl |
|
|
string |
54321 |
| country |
Land |
|
|
string |
de |
| description |
Beschreibung |
|
|
string |
|
| type |
Adresstyp; Die einzelnen Typen werden über die Liste "account_address_type" abgebildet |
|
|
string |
4 |
| preset |
Standard; Wird auf "1" gesetzt, wenn es die standard Adresse ist |
|
0 |
integer |
1 |
| systemUsage |
Systeminterne Verwendung |
|
|
string |
|
| erpID |
Eindeutige ID im Drittsystem; Datum für den Datenaustausch mit Drittsystemen |
|
|
string |
|
| erpName |
Name des Drittsystems; Datum für den Datenaustausch mit Drittsystemen |
|
|
string |
|
| erpNumber |
Eindeutige Nummer im Drittsystem; Datum für den Datenaustausch mit Drittsystemen |
|
|
string |
|
| erpLastUpdate |
Letzte Aktualisierung; Datum für den Datenaustausch mit Drittsystemen |
|
1970-01-01 01:00:00 |
string |
|
| erpCreation |
Erstellungsdatum; Datum für den Datenaustausch mit Drittsystemen |
|
1970-01-01 01:00:00 |
string |
|
| archived |
Archivierungsflag; 0: in Verwendung; 1: Datensatz ist archiviert |
|
0 |
string |
|
"addresses": {
"dataset": [
{
"aid": 14,
"uid": 29,
"contact": "",
"company": "",
"address1": "Testweg 1",
"address2": "",
"city": "Teststadt",
"state": "",
"zipcode": "54321",
"country": "de",
"description": "",
"type": "4",
"preset": 1,
"systemUsage": "",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "0000-01-01T00:00:00",
"erpCreation": "0000-01-01T00:00:00"
}
]
}
communication
| property |
title |
default |
type |
examples |
| cid |
Kommunikations ID |
0 |
integer |
58 |
| uid |
Benutzer ID |
0 |
integer |
29 |
| type |
Kommunikationstyp |
Über die API Standardlisten 'account_communication_type' werden die gültigen Werte geliefert. |
0 |
integer |
| description |
Beschreibung |
|
string |
|
| locator |
Ziel (Nummer, E-Mail) |
|
string |
b2b@example.com |
| preset |
Standard |
|
string |
1 |
| private |
Kommunikation privat |
|
string |
|
| scope |
Bereich |
|
string |
0 |
| lastUpdate |
Änderungsdatum |
|
string |
0000-01-01T00:00:00 |
"communication": {
"dataset": [
{
"cid": 58,
"uid": 29,
"type": 1,
"description": "",
"locator": "[email protected]",
"preset": "1",
"private": "",
"scope": "0",
"lastUpdate": "0000-01-01T00:00:00",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "0000-01-01T00:00:00",
"erpCreation": "0000-01-01T00:00:00"
}
]
}
property
| property |
title |
default |
type |
examples |
| pid |
Eigenschaft ID |
0 |
integer |
91 |
| uid |
Benutzer ID |
0 |
integer |
20 |
| name |
Name |
|
string |
core.property.myteam_subgroup |
| value |
Wert |
|
string |
1 |
| language |
Sprache |
|
string |
|
| country |
Land |
|
string |
|
"property": {
"dataset": [
{
"pid": 91,
"uid": 20,
"name": "core.property.myteam_subgroup",
"value": "1",
"language": "",
"country": ""
}
]
}
memberships
| property |
title |
default |
type |
examples |
| mid |
Mitgliedschaft ID |
0 |
integer |
80 |
| uid |
Benutzer ID |
0 |
integer |
20 |
| gid |
Gruppen ID |
0 |
integer |
8 |
"memberships": {
"dataset": [
{
"mid": 80,
"uid": 20,
"gid": 8
},
{
"mid": 6,
"uid": 20,
"gid": 10
}
]
}
notices
| property |
title |
default |
type |
examples |
| nid |
Nachricht ID |
0 |
integer |
6 |
| uid |
Benutzer ID |
0 |
integer |
2 |
| wuid |
Verfasser Benutzer ID |
0 |
integer |
1001 |
| subject |
Betreff |
|
string |
Ihre uns Bestellung wurde soeben verschickt. 5002 1002 |
| file |
Datei |
|
string |
|
| notice |
Nachrichtentext |
|
string |
Guten Tag ,
Ihre Bestellung hat soeben unser Versandlager verlassen. |
| type |
Nachrichten Typ |
|
string |
4 |
| resubmission |
Wiedervorlagedatum |
|
string |
0000-01-01T00:00:00 |
| date |
Datum |
|
string |
2009-03-03T16:03:00 |
"notices": {
"dataset": [
{
"nid": 6,
"uid": 2,
"wuid": 1001,
"subject": "Ihre uns Bestellung wurde soeben verschickt. 5002 1002",
"file": "",
"notice": "Guten Tag ,<br><br>Ihre Bestellung hat soeben unser Versandlager verlassen. Ihre Bestellung mit der Bestellnummer 5002 hat die Paketnummer 121533000038. Ihr Paket erhalten Sie durch den Lieferservice DHL. Bei Fragen zu Ihrem Paket oder dem Lieferservice finden Sie weitere Informationen unter http://nolp.dhl.de/. Dort können Sie unter Angabe der Paketnummer Ihre Lieferung und deren Status verfolgen. <br><br>Wir versenden Ihre Bestellung an folgende Adresse:<br><br><br>Musterstrasse 54<br>12345 Teststadt<br>Deutschland<br><br>Ihr shop Kundenservice<br><br> ",
"type": "4",
"resubmission": "0000-01-01T00:00:00",
"date": "2009-03-03T16:03:00",
"creation": "2009-03-03T16:03:00",
"lastUpdate": "2009-03-03T16:03:00",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2009-03-03T16:03:00",
"erpCreation": "0000-01-01T00:00:00"
}
]
}
orders
| property |
title |
default |
type |
examples |
| oid |
Bestellnummer |
0 |
integer |
1013 |
| orderDate |
Bestelldatum |
|
string |
2017-07-30T13:17:38 |
| orderState |
Status |
0 |
integer |
57 |
| orderLastStatusChange |
Änderungsdatum des Status |
|
string |
2017-07-30T13:22:25 |
| customerUID |
Benutzer ID |
0 |
integer |
30 |
| customerNotice |
Kundenotiz |
|
string |
|
| billingAddressAID |
ID der Rechnungsadresse |
0 |
integer |
16 |
| deliveryAddressAID |
ID der Lieferadresse |
0 |
integer |
16 |
| deliveryNotice |
Liefernotiz |
|
string |
|
| paymentPID |
ID der Bezahlung |
0 |
integer |
101 |
| assigndTickets |
Zugeordnete Tickets |
|
string |
|
| resubmissionDate |
Datum der Wiedervorlage |
|
string |
0000-01-01T00:00:00 |
| resubmissionInfo |
Wiedervorlage Information |
|
string |
|
| acquisitionPartnerID |
|
0 |
integer |
0 |
| acquisitionInfo |
|
|
string |
|
| acquisitionRedirect |
|
null |
|
|
| acquisitionDate |
|
|
string |
0000-01-01T00:00:00 |
| shippingNotice |
Versandhinweise |
|
string |
|
| shippingDCID |
Lieferkonditions ID |
0 |
integer |
2 |
| retoureRID |
Retouren ID |
0 |
integer |
0 |
| companySHID |
Mandant ID |
0 |
integer |
1 |
| salesmanUID |
Verkäufer Benutzer ID |
0 |
integer |
0 |
| channelOrderID |
Bestellnummer Mandant |
|
string |
|
| channelOrderState |
Bestellstatus Mandant |
|
string |
0 |
| channelOrderDate |
Bestelldatum Mandant |
|
string |
0000-01-01T00:00:00 |
| channelOrderData |
Original Daten der Mandant Bestellung |
|
object |
|
| position |
Bestelldatum Mandant |
|
object |
|
"notices": {
"dataset": [
{
"oid": 1013,
"orderDate": "2017-07-30T13:17:38",
"orderState": 57,
"orderLastStatusChange": "2017-07-30T13:22:25",
"customerUID": 30,
"customerNotice": "",
"billingAddressAID": 16,
"deliveryAddressAID": 16,
"deliveryNotice": "",
"paymentPID": 101,
"assigndTickets": "",
"resubmissionDate": "0000-01-01T00:00:00",
"resubmissionInfo": "",
"acquisitionPartnerID": 0,
"acquisitionInfo": "",
"acquisitionRedirect": null,
"acquisitionDate": "0000-01-01T00:00:00",
"shippingNotice": "",
"shippingDCID": 2,
"retoureRID": 0,
"companySHID": 1,
"salesmanUID": 0,
"channelOrderID": "",
"channelOrderState": "0",
"channelOrderDate": "0000-01-01T00:00:00",
"channelOrderData": {},
"position": {
"dataset": [
{
"scid": 1451,
"parentSCID": null,
"customerUID": 0,
"customerNumber": "",
"customerText": "",
"salesmanUID": 0,
"orderOID": 1013,
"packagingItemIID": 0,
"positionCount": "1.",
"positionVariant": "__UNIQUE__",
"positionDescription": "",
"positionCreated": "0000-01-01T00:00:00",
"positionSerialnumber": "",
"positionCustom1": "",
"positionCustom2": "4900",
"positionCustom3": "",
"positionSystemtext": "",
"restrictionToCount": "0",
"restrictionToVariant": "0",
"stockUpdated": "0",
"itemIID": 10062,
"itemName": "Kopfhörer - Tecfan HD",
"itemSKU": "1",
"itemNumber": "10062",
"itemDealersnumber": "",
"priceVat": 1900,
"priceGross": 4900,
"priceNet": 4118,
"priceDigits": 2,
"priceCurrency": "EUR",
"priceRecommendedGross": 0,
"priceRecommendedNet": 0,
"priceRecommended": "",
"pricePurchasingGross": 0,
"pricePurchasingNet": 0,
"priceBaseNet": null,
"priceBaseGross": null,
"priceBaseMeasureUnit": null,
"priceBaseMesaureReference": null,
"priceBaseMeasureValue": null,
"priceExchangerateLeadCurrency": "EUR",
"priceExchangerateRate": 100000,
"priceExchangerateNet": 4118,
"priceExchangerateGross": 4900,
"priceExchangerateDigits": 2
}
],
"sys": {
"total": {
"EUR": {
"price": {
"vat": {
"1900": {
"net": 4118,
"gross": 4900,
"digits": 2
}
},
"net": 4118,
"gross": 4900,
"digits": 2
},
"recommended": {
"vat": {
"1900": {
"net": 0,
"gross": 0,
"digits": 2
}
},
"net": 0,
"gross": 0,
"digits": 2
},
"purchasing": {
"vat": {
"1900": {
"net": 0,
"gross": 0,
"digits": 2
}
},
"net": 0,
"gross": 0,
"digits": 2
},
"base": {
"vat": {
"1900": {
"net": 0,
"gross": 0,
"digits": 2
}
},
"net": 0,
"gross": 0,
"digits": 2
},
"leadCurrency": {
"vat": {
"1900": {
"net": 4118,
"gross": 4900,
"digits": 2
}
},
"net": 4118,
"gross": 4900,
"digits": 2
}
}
}
}
},
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "2017-07-30T13:17:38",
"erpCreation": "2017-07-30T13:17:38",
"archived": "0"
}
]
}
positions
| property |
title |
default |
type |
examples |
| scid |
Warenkorb ID |
0 |
integer |
1451 |
| parentSCID |
Eltern Warenkorb ID |
null |
|
|
| customerUID |
Benutzer ID |
0 |
integer |
0 |
| customerNumber |
Kundennummer |
|
string |
|
| customerText |
Nachricht vom Kunden |
|
string |
|
| salesmanUID |
Verkäufer Benutzer ID |
0 |
integer |
0 |
| orderOID |
Bestellnummer |
0 |
integer |
1013 |
| packagingItemIID |
Verpackungsprodukt ID |
0 |
integer |
0 |
| positionCount |
Anzahl |
|
string |
1. |
| positionVariant |
Variante |
|
string |
UNIQUE |
| positionDescription |
Beschreibung |
|
string |
|
| positionCreated |
Erstelldatum |
|
string |
0000-01-01T00:00:00 |
| positionSerialnumber |
Seriennummer |
|
string |
|
| positionCustom1 |
Benutzerdefiniert 1 |
|
string |
|
| positionCustom2 |
Benutzerdefiniert 2 |
|
string |
4900 |
| positionCustom3 |
Benutzerdefiniert 3 |
|
string |
|
| positionSystemtext |
System Text |
|
string |
|
| restrictionToCount |
Einschränkung: Die Menge darf nicht geändert werden |
|
string |
0 |
| restrictionToVariant |
Einschränkung: Die Variante darf nicht geändert werden |
|
string |
0 |
| stockUpdated |
Lagerbuchung durchgeführt |
Lagerbuchung durchgeführt 0=nicht gebucht, 1=Bestand gebucht, 2=virtuell gebucht Stücklistenposition |
|
string |
| itemIID |
Produkt IID |
0 |
integer |
10062 |
| itemName |
Name des Produktes |
|
string |
Kopfhörer - Tecfan HD |
| itemSKU |
EAN / SKU |
|
string |
1 |
| itemNumber |
Artikelnummer |
|
string |
10062 |
| itemDealersnumber |
Händlernummer |
|
string |
|
| priceVat |
Steueren |
0 |
integer |
1900 |
| priceGross |
Brutto Preis |
0 |
integer |
4900 |
| priceNet |
Netto Preis |
0 |
integer |
4118 |
| priceDigits |
Nachkommastellen |
0 |
integer |
2 |
| priceCurrency |
Währung |
|
string |
EUR |
| priceRecommendedGross |
empfohlener Preis Brutto |
0 |
integer |
0 |
| priceRecommendedNet |
empfohlener Preis Netto |
0 |
integer |
0 |
| priceRecommended |
empfohlener Preis Info |
|
string |
|
| pricePurchasingGross |
Einkaufspreis Brutto |
0 |
integer |
0 |
| pricePurchasingNet |
Einkaufspreis Netto |
0 |
integer |
0 |
| priceBaseNet |
Grundpreis in Netto |
null |
|
|
| priceBaseGross |
Grundpreis in Brutto |
null |
|
|
| priceBaseMeasureUnit |
Grundpreis Maßeinheit |
zum Beispiel bei kg "1000" |
null |
|
| priceBaseMesaureReference |
Grundpreis Maßeinheit |
Definition welche Maßeinheit für den Grundpreis verwendert wird, wird über die Liste public_item_specification_baseprice_measuretype geregelt, "1" für weight, "2" für volume |
null |
|
| priceBaseMeasureValue |
Grundpreis Maßeinheit Wert |
"100" für 100 g |
null |
|
| priceExchangerateLeadCurrency |
The Priceexchangerateleadcurrency Schema |
|
string |
EUR |
| priceExchangerateRate |
Wechselkurs |
0 |
integer |
100000 |
| priceExchangerateNet |
Wechselkurs Netto |
0 |
integer |
4118 |
| priceExchangerateGross |
Wechselkurs Brutto |
0 |
integer |
4900 |
| priceExchangerateDigits |
Wechselkurs Nachkommastellen |
0 |
integer |
2 |