Retouren auslesen

Felder

property	title	required	default	type	examples
rid	Eindeutige ID des Datensatzes; Retouren ID			integer
customerNotice	Kunden Nachricht			string
transactionNumber				string
reason				string
deliveryDID				string
orderOID				string
customerUID				string
receivingDate				string
paymentPID				string
state				string
channelOrderState				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			string
erpCreation	Erstellungsdatum; Datum für den Datenaustausch mit Drittsystemen			string

Facetten

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

Facette	Beschreibung
quantity	Positionen der Retoure

Retoure suchen

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

Beispiel : /api/commerce/turnover/retoure/search?q=rid%3D1000&count=2

{
    "dataset": {
        "1000": {
            "rid": 1000,
            "customerNotice": "",
            "transactionNumber": "1000-1001-31",
            "reason": 0,
            "action": 5,
            "deliveryDID": 0,
            "orderOID": 1002,
            "customerUID": 31,
            "receivingDate": "2017-02-10T00:00:00",
            "paymentPID": 0,
            "state": 20,
            "channelOrderState": 0,
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "2019-11-13T08:39:25",
            "erpCreation": null
        }
    },
    "sys": {
        "pagination": {
            "currentPage": 1,
            "nextOffset": null,
            "pages": 1,
            "prevOffset": null,
            "offset": 0,
            "objectsPerPage": 20,
            "total": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Positionen

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

Beispiel

{
    "dataset": {
        "1000": {
            "rid": 1000,
            "customerNotice": "",
            "transactionNumber": "1000-1001-31",
            "reason": 0,
            "action": 5,
            "deliveryDID": 0,
            "orderOID": 1002,
            "customerUID": 31,
            "receivingDate": "2017-02-10T00:00:00",
            "paymentPID": 0,
            "state": 20,
            "channelOrderState": 0,
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "2019-11-13T08:39:25",
            "erpCreation": null,
            "quantity": {
                "dataset": [
                    {
                        "srqid": 1,
                        "turnoverOID": 1000,
                        "type": 3,
                        "itemIID": 10065,
                        "positionVariant": "__UNIQUE__",
                        "positionCount": 1,
                        "positionCreated": "2017-02-10T10:43:12",
                        "positionDescription": "",
                        "distributor": 0,
                        "customerUID": 1,
                        "locationLID": 0,
                        "state": 2,
                        "itemSKU": "4867578957529",
                        "positionSerialnumber": "",
                        "reportRID": "",
                        "depositCurrency": "EUR",
                        "depositGross": 8990,
                        "depositNet": 7555,
                        "depositVat": 1900,
                        "depositPurchaseGross": 0,
                        "depositPurchaseNet": 0,
                        "exchangeRate": 0,
                        "exchangeNet": 0,
                        "exchangeGross": 0,
                        "exchangeLeadCurrency": "",
                        "exchangeDigits": 2,
                        "reason": 0,
                        "info": "",
                        "validated": "0",
                        "erpID": "",
                        "erpName": "",
                        "erpNumber": "",
                        "erpLastUpdate": "2019-11-13T08:35:03",
                        "erpCreation": null
                    }
                ],
                "sys": {
                    "total": {
                        "EUR": {
                            "deposit": {
                                "vat": {
                                    "1900": {
                                        "net": 7555,
                                        "gross": 8990,
                                        "digits": 2
                                    }
                                },
                                "net": 7555,
                                "gross": 8990,
                                "digits": 2
                            }
                        }
                    }
                }
            }
        }
    },
    "sys": {
        "pagination": {
            "currentPage": 1,
            "nextOffset": null,
            "pages": 1,
            "prevOffset": null,
            "offset": 0,
            "objectsPerPage": 20,
            "total": 1
        },
        "message": "200 OK",
        "code": 200
    }
}