Transaktionen

Mit dieser Api werden die Transaktionen ausgegeben.

Felder

property	title	required	default	type	examples
tid	Eindeutige ID des Datensatzes			integer
orderOID	Bestellnummer OID		0	integer
customerUID	Benutzer UID		0	integer
deliveryDID	Lieferung DID		0	integer
createDate	Erstelldatum			string
provider	Provider; zum Beispiel paypal, saferpaypp			string
id	Transaction ID des Payment Provider			string
token	Token; Feld zur identifizierung beim payment provider			string
amount	Betrag		0	integer
currency	Währung			string
captureState	Status der Buchung			string
captureAmount	gebuchter Betrag		0	integer
paymentType	PaymentID (Liste der Bezahltypen "shop_payment_type.inc.php" )		0	integer
paymentPID	PID aus der "sh_payment" Tabelle		0	integer
paymentPTID	PTID der Zahlart in der "sh_payment_type" Tabelle		0	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			string
erpCreation	Erstellungsdatum; Datum für den Datenaustausch mit Drittsystemen			string

Eine Transaktion auslesen

Die URL /api/commerce/transaction/[TID] liefert eine Transaktion zurück

{
    "dataset": {
        "39887013-301b-4f06-a3ca-096b109c9e86": {
            "tid": 72,
            "orderOID": 1105,
            "customerUID": 20,
            "deliveryDID": 0,
            "createDate": "2019-12-08T08:46:13",
            "provider": "saferpay",
            "id": "",
            "token": "",
            "amount": 1256,
            "currency": "EUR",
            "captureState": "CAPTURED",
            "captureAmount": 1256,
            "paymentType": 1,
            "paymentPID": 196,
            "paymentPTID": 1,
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "2019-12-08T08:46:13",
            "erpCreation": "0000-01-01T00:00:00"
        }
    },
    "sys": {
        "pagination": {
            "total": 1,
            "currentPage": 1,
            "objectsPerPage": 20,
            "offset": 0,
            "nextOffset": null,
            "prevOffset": null,
            "pages": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Transaktionen auslesen

Die URL /api/commerce/transaction?page=[SEITE]&count=[ANZAHL DER OBJEKTE]&orderby=[SORTIERUNG] liefert alle Transaktionen zurück. Mit dem Pagestepper kann durch die Daten navigiert werden.

Beispiel : /api/commerce/transaction?page=0&count=5

{
    "dataset": {
        "66681c38-1094-4490-e416-9d431fa5ef57": {},
        "caec026c-b9a0-4ea7-af27-0b36e8c47cbd": {},
        "9f9a232a-efc4-4079-f091-035fdb8f1b4c": {},
        "1b3da6a2-994f-4060-a47d-38c12a19a416": {},
        "7555bb79-f8d0-461b-d488-008819447df2": {}
    },
    "sys": {
        "pagination": {
            "total": 47,
            "currentPage": 3,
            "objectsPerPage": 5,
            "offset": 10,
            "nextOffset": 15,
            "prevOffset": 5,
            "pages": 10
        },
        "message": "200 OK",
        "code": 200
    }
}

Transaktionen suchen

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

Beispiel : /api/commerce/transaction/search?q=tid%3D1

{
    "dataset": {
        "66681c38-1094-4490-e416-9d431fa5ef57": {},
        "caec026c-b9a0-4ea7-af27-0b36e8c47cbd": {},
        "9f9a232a-efc4-4079-f091-035fdb8f1b4c": {},
        "1b3da6a2-994f-4060-a47d-38c12a19a416": {},
        "7555bb79-f8d0-461b-d488-008819447df2": {}
    },
    "sys": {
        "pagination": {
            "total": 47,
            "currentPage": 3,
            "objectsPerPage": 5,
            "offset": 10,
            "nextOffset": 15,
            "prevOffset": 5,
            "pages": 10
        },
        "message": "200 OK",
        "code": 200
    }
}