Bezahlart¶
Mit dieser Api werden die Bezahlarten ausgegeben.
Felder¶
property | title | required | default | type | examples |
---|---|---|---|---|---|
ptid | Eindeutige ID des Datensatzes | integer | |||
name | Name der Bezahlart | string | |||
description | Beschreibung | string | |||
itemIID | Produkt IID | integer | |||
minOrderValue | Mindestbestellwert | integer | |||
paymentFree | Kostenfrei ab | integer | |||
paymentCharge | Kosten | integer | |||
paymentChargeVat | Steuersatz | integer | |||
paymentChargeType | Kostentyp (Aufschlag 10,Prozentualer Aufschlag 20,Abschlag 30,Prozentualer Abschlag 40) | integer | |||
paymentChargeCurrency | Währung | string | |||
availableCountry | Verfügbar nur für bestimmte Länder | array | |||
availableCurrency | Verfügbar nur für bestimmte Währungen | array | |||
availableMinorderValue | Verfügbar ab eines Mindestbestellwertes | integer | |||
availableCustomerRating | Verfügbar ab einem Kundenstatus | string | |||
notAvailableNewCustomerFlag | Nicht bei Neukunden | integer | |||
availableCompany | Verfügbar nur für bestimmte Mandanten | array | |||
availableGroupID | Verfügbar nur für bestimmte Gruppen | array | |||
provider | Provider | string | |||
type | Typ der Bezahlart (Liste der möglichen Typen) | integer | |||
providerDescription | Provider Beschreibung | string |
Eine Bezahlart auslesen¶
Die URL /api/commerce/paymenttype/[PTID]
liefert eine Bezahlart zurück
{
"dataset": {
"39887013-301b-4f06-a3ca-096b109c9e86": {
"ptid": 1,
"description": "saferpaycw_creditcard",
"itemIID": 0,
"minOrderValue": 0,
"paymentFree": 0,
"paymentCharge": 0,
"paymentChargeVat": 0,
"paymentChargeType": 10,
"paymentChargeCurrency": "",
"availableCountry": ",de,at,nl,ch,lu,be,dk,fr,ie,gb",
"availableCurrency": "",
"availableMinorderValue": 0,
"availableCustomerRating": "",
"notAvailableNewCustomerFlag ": "0",
"availableCompany": ",1",
"availableGroupID": "",
"provider": "saferpay",
"type": 1,
"providerDescription": "",
"name": "Kreditkarte",
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "0000-01-01T00:00:00",
"erpCreation": "1970-01-01T00:59:59",
"archived": "0",
"ranking": "0"
}
},
"sys": {
"pagination": {
"total": 1,
"currentPage": 1,
"objectsPerPage": 20,
"offset": 0,
"nextOffset": null,
"prevOffset": null,
"pages": 1
},
"message": "200 OK",
"code": 200
}
}
Bezahlarten auslesen¶
Die URL /api/commerce/paymenttype?page=[SEITE]&count=[ANZAHL DER OBJEKTE]&orderby=[SORTIERUNG]
liefert alle Bezahlarten zurück.
Mit dem Pagestepper kann durch die Daten navigiert werden.
Beispiel : /api/commerce/paymenttype?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
}
}
Bezahlart suchen¶
Über die URL /api/commerce/paymenttype/search?q=[QUERY]
können Bezahlarten gesucht werden.
Mit dem Pagestepper kann durch die Daten navigiert werden.
Beispiel : /api/commerce/paymenttype/search?q=ptid%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
}
}