Bestellungen auslesen¶

Felder¶

property	title	default	type
oid	Eindeutige ID des Datensatzes; Bestellnummer		integer
orderDate	Bestelldatum		string
orderState	Bestellstatus		integer
orderLastStatusChange	Letzter Zeitpunkt der Statusänderung		string
customerUID	Benutzer ID		integer
customerNotice	Benutzer Notiz		string
billingAddressAID	ID Rechnungsadresse		integer
deliveryAddressAID	ID Lieferadresse		integer
deliveryNotice	Liefer Notiz		string
paymentPID	ID der Bezahlart		integer
assigndTickets	Zugeordnete Tickets		string
resubmissionDate	Wiedervorlage Datum		string
resubmissionInfo	Wiedervorlage Information		string
acquisitionPartnerID	Partner ID; Affiliate ID		integer
acquisitionInfo			string
acquisitionRedirect			string
acquisitionDate			string
shippingNotice	Versand Notiz		string
shippingDCID	Frachtführer ID		integer
retoureRID	Retouren ID		integer
companySHID	Mandanten ID		integer
salesmanUID	Verkäufer ID		integer
channelOrderID	Portal Bestellnummer; Bestellnummer bei einem anderen Anbieter , zum Beispiel Amazon		string
channelOrderState	Portal Status der Bestellung; 1: Bestellung in Bearbeitung, Portal kann nicht mehr updaten; 2: an das Portal zurückgemeldet		string
channelOrderDate	Portal Bestelldatum		string
channelOrderData	Portal Bestellung; serializierte Daten		object
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		string
erpCreation	Erstellungsdatum; Datum für den Datenaustausch mit Drittsystemen		string
archived	Archivierungsflag; 0: in Verwendung; 1: Datensatz ist archiviert	0	string
position	Facette Positionen		object
delivery	Facette Lieferungen		object

Facetten¶

Über die Facetten können weitere Daten dazu geladen werden. Diese werden Komma getrennt übergeben
Zum Beispiel : /api/commerce/orders/search?q=[QUERY]&facet=position,delivery

Facette	Beschreibung
position	Positionen der Bestellung
delivery	Lieferungen

Bestellung suchen¶

Über die URL /api/commerce/orders/search?q=[QUERY] können Bestellungen gesucht werden. Mit dem Pagestepper kann durch die Daten navigiert werden.

Beispiel : /api/commerce/orders/search?q=order.customerUID%3D48&orderby=oid%20DESC&count=2

{
    "dataset": {
        "1000": {
            "oid": 1000,
            "orderDate": "2017-01-16T10:27:18",
            "orderState": 57,
            "orderLastStatusChange": "2017-01-16T10:38:53",
            "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": {},
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "2017-01-16T10:27:18",
            "erpCreation": "2017-01-16T10:27:18",
            "archived": "0",
            "position": {},
            "delivery": {}
        }
    },
    "sys": {
        "pagination": {
            "currentPage": 1,
            "nextOffset": null,
            "pages": 1,
            "prevOffset": null,
            "offset": 0,
            "objectsPerPage": 2,
            "total": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Facetten¶

Über die Facetten können weitere Daten dazu geladen werden. Diese werden Komma getrennt übergeben
Zum Beispiel : /api/commerce/orders/search?q=order.customerUID%3D48&orderby=oid%20DESC&count=2&facet=position,delivery

Facette	Beschreibung
position	Positionen der Bestellung
delivery	Lieferungen der Bestellung

Positionen¶

Mit der Übergabe von &facet=position werden zusätzlich noch alle Positionen geladen.

Felder¶

property	title	default	type
scid	Eindeutige ID des Datensatzes		integer
parentSCID	Referenz auf Elternposition bei SET-Artikeln	0	integer
customerUID	Benutzer ID		integer
customerNumber	Kundennummer		string
customerText	Kundentext		string
salesmanUID	Verkäufer Benutzer ID; UID		integer
orderOID	Bestellnummer		integer
packagingItemIID	Verpackungsartikel IID		integer
positionCount	Menge		string
positionVariant	Variante		string
positionDescription	Beschreibung		string
positionCreated	Erstelldatum; Zeitpunkt an dem die Position in den Warenkorb gelegt wurde		string
positionSerialnumber	Seriennummer		string
positionCustom1	Benutzerdefiniert 1		string
positionCustom2	Benutzerdefiniert 1		string
positionCustom3	Benutzerdefiniert 1		string
positionSystemtext	Systemtext		string
restrictionToCount	Einschränkung,die Menge darf nicht geändert werden		string
restrictionToVariant	Einschränkung,die Variante darf nicht geändert werden		string
stockUpdated	Lagerbuchung durchgeführt; 0 => Nicht gebucht ,1 => Bestand gebucht, 2=virtuell gebucht Stücklistenposition		string
itemIID	Artikel IID		integer
itemName	Artikel Name		string
itemSKU	Artikel EAN		string
itemNumber	Artikelnummer		string
itemDealersnumber	Händlernummer		string
priceVat	Mehrwertsteuer		integer
priceGross	Brutto Preis		integer
priceNet	Netto Preis		integer
priceDigits	Nachkommastellen		integer
priceCurrency	Währung		string
priceRecommendedGross	empfohlener Brutto Preis		integer
priceRecommendedNet	empfohlener Netto Preis		integer
priceRecommendedInfo	empfohlener Preis Information		string
pricePurchasingGross	Brutto Einkaufspreis		integer
pricePurchasingNet	Netto Einkaufspreis		integer
priceBaseNet	Netto Grundpreis		integer
priceBaseGross	Brutto Grundpreis		integer
priceBaseMeasureUnit	Maßeinheit; zum Beispiel bei kg "1000"		string
priceBaseMesaureReference	Maßeinheit Definition; 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		string
priceBaseMeasureValue	Maßeinheit Wert; zum Beispiel für 100g "100"		string
priceExchangerateLeadCurrency	Leitwährung des Wechselkurses		string
priceExchangerateRate	Wechselkurs		integer
priceExchangerateNet	Netto Wechselkurs		integer
priceExchangerateGross	Brutto Wechselkurs		integer
priceExchangerateDigits	Nachkommastellen Wechselkurs		integer

Beispiel¶

Beispiel : /api/commerce/orders/search?q=order.customerUID%3D48&orderby=oid%20DESC&count=2&facet=position

{
    "dataset": [
        {
            "scid": 1413,
            "parentSCID": null,
            "customerUID": 0,
            "customerNumber": "",
            "customerText": "",
            "salesmanUID": 0,
            "orderOID": 1000,
            "packagingItemIID": 0,
            "positionCount": 1,
            "positionVariant": "_UNIQUE_",
            "positionDescription": "",
            "positionCreated": "0000-01-01T00:00:00",
            "positionSerialnumber": "",
            "positionCustom1": "",
            "positionCustom2": "54900",
            "positionCustom3": "",
            "positionSystemtext": "",
            "restrictionToCount": "0",
            "restrictionToVariant": "0",
            "stockUpdated": "1",
            "itemIID": 10077,
            "itemName": "Kühlschrank - R332",
            "itemSKU": "6348778962548",
            "itemNumber": "10077",
            "itemDealersnumber": "",
            "priceVat": 1900,
            "priceGross": 54900,
            "priceNet": 46134,
            "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": 46134,
            "priceExchangerateGross": 54900,
            "priceExchangerateDigits": 2
        }
    ],
    "sys": {
        "total": {
            "EUR": {
                "price": {
                    "vat": {
                        "1900": {
                            "net": 46134,
                            "gross": 54900,
                            "digits": 2
                        }
                    },
                    "net": 46134,
                    "gross": 54900,
                    "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": 46134,
                            "gross": 54900,
                            "digits": 2
                        }
                    },
                    "net": 46134,
                    "gross": 54900,
                    "digits": 2
                }
            }
        }
    }
}

Lieferungen¶

Mit der Übergabe von &facet=delivery werden zusätzlich noch alle Lieferungen geladen.

Felder¶

property	title	required	default	type	examples
did	Eindeutige ID des Datensatzes			integer
orderOID	Bestellnummer		0	integer
deliveryAddress	Lieferadresse; Lieferadresse, zu dem Zeitpunkt als die Lieferung erstellt worden ist			string
billingAddress	Rechnungsadresse; Rechnungsadresse, zu dem Zeitpunkt als die Lieferung erstellt worden ist			string
createDate	Erstelldatum			string
state	Status		0	integer
billNumber	Rechnungsnummer			string
billDate	Rechnungsdatum			string
paymentState	Bezahlstatus		0	integer
archivePrintFlag	Lieferung wurde archiviert; Der Archivedruck wurde bei dieser Lieferung ausgeführt		0	string
serviceNumber	Service Nummer			string
serviceCompany	Service Firma		0	integer
deliveryDate	Lieferdatum			string
shippingDCID	ID des Frachtführer			integer
shippingData	Versanddaten des Frachtführer			object
receivingDate	Annahmedatum; Zeitpunkt an dem die Lieferung beim Kunden angekommen ist			string
packetNumber	Paketnummer; Wenn eine Lieferungen mit mehreren Paketen ausgeliefert wir, werden die Nummern mit "	" getrennt			string
packetNumberRetoure	Paketnummer der Retoure			string
resubmissionDate	Wiedervorlage-Datum		0000-00-00	string
resubmissionInfo	Wiedervorlage-Inforamtion			string
notice	Notiz			string
traceReceivingState	Verfolgungsstatus		0	integer
traceReceivingSign	Verfolgungsstatus Hinweis			string
traceReceivingDate	Verfolgungsstatus Datum			string
picklistID	ID der Pickliste		0	integer
transactionTID	ID der Transaktion			integer
transactionAmount	Geldwert der Transaktion			integer
signatureRequiredFlag	Signature Tracking aktiviert			integer
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			string

Beispiel¶

{
        "did": 1000,
        "orderOID": 1000,
        "deliveryAddress": {
            "contact": "Max Mustermann",
            "company": "Herr",
            "address1": "Teststrase 1",
            "address2": "",
            "city": "Teststadt",
            "state": "",
            "zipcode": "12345",
            "country": "de",
            "description": "",
            "type": "4",
            "preset": "1",
            "systemUsage": "",
            "erpID": "",
            "erpName": "",
            "erpNumber": ""
        },
        "billingAddress": {
            "contact": "Max Mustermann",
            "company": "Herr",
            "address1": "Teststrase 1",
            "address2": "",
            "city": "Teststadt",
            "state": "",
            "zipcode": "12345",
            "country": "de",
            "description": "",
            "type": "4",
            "preset": "1",
            "systemUsage": "",
            "erpID": "",
            "erpName": "",
            "erpNumber": ""
        },
        "createDate": "2017-01-16T11:35:37",
        "state": 15,
        "billNumber": "1000-1000-30",
        "billDate": "2017-01-16T11:35:37",
        "paymentState": 0,
        "archivePrintFlag": "0",
        "serviceNumber": "",
        "serviceCompany": 0,
        "deliveryDate": "2017-01-16T10:38:53",
        "shippingDCID": 0,
        "shippingData": {},
        "receivingDate": "0000-01-01T00:00:00",
        "packetNumber": "",
        "packetNumberRetoure": "",
        "resubmissionDate": "0000-01-01T00:00:00",
        "resubmissionInfo": "",
        "notice": "",
        "traceReceivingState": 0,
        "traceReceivingSign": "",
        "traceReceivingDate": "0000-01-01T00:00:00",
        "picklistID": 0,
        "transactionTID": 0,
        "transactionAmount": 0,
        "signatureRequiredFlag": 0,
        "erpID": "",
        "erpName": "",
        "erpNumber": "",
        "erpLastUpdate": "2017-01-16T10:35:20",
        "erpCreation": "0000-01-01T00:00:00"
    }