Gutschein¶
Mit dieser Api werden die Gutscheine ausgegeben.
Felder¶
Feld | Typ | Beschreibung | Beispiel |
---|---|---|---|
soid | integer | Gutschein ID | 1 |
name | string | Name | Sommer-Sale 2018 |
description | string | Beschreibung | |
offer | integer | Angebot | 2500 |
currency | string | Währung | EUR |
unit | integer | Einheit (1 Prozent / 2 Absolut) | 1 |
minOrderValue | integer | Mindestbestellwert | 0 |
password | string | Passwort | sale2016 |
state | integer | Status 1-aktiv ; 2-deaktiv | 1 |
financesAttendDiscountAbleFlag | integer | Rabattfähigkeit beachten | 0 |
orderPositionIID | integer | Zuordnungen Position IID | 501 |
availabilityCount | integer | Mengenverfügbarkeit, Gutscheine insgesamt | 0 |
availabilityCountCustomer | integer | Mengenverfügbarkeit, Gutschein je Kunde | 0 |
availabilityNote | integer | Mengenverfügbarkeit, Einschränkung beachten | 0 |
additionalIID | integer | Zugabe-Produkt IID | 10016 |
additionalCount | integer | Zugabenmenge | 1 |
additionalType | integer | Typ Zugabe | 0 |
additionalMinType | integer | Berechnungsgrundlage | 0 |
additionalMinCount | integer | Grenzwert | ab |
start | date | Zeitliche Einschränkungen Start | 0000-01-01T00:00:00 |
end | date | Zeitliche Einschränkungen Ende | 0000-01-01T00:00:00 |
accessUID | integer | Gilt nur für Benutzer UID | 0 |
restrictionCategoryCID | array | Zuordnung Kategorie CID | ["","21","10"] |
restrictionBrandBID | array | Zuordnung Marke BID | ["","1","2"] |
restrictionItemIID | string | Gilt nur für Produktliste IID | 1000,1001 |
restrictionGroupGID | array | Zuordnung Gruppe | [] |
restrictionSalesGroup | array | Zuordnung Verkaufsgruppe | [] |
restrictionCountryIso | array | Land | [] |
shoppingcardAssignMode | string | Berechnungsgrundlage | |
locale | object | Sprachabhängige Texte | |
aid | integer | Affiliate Partner ID | 0 |
erpID | integer | ||
erpName | integer | ||
erpNumber | integer | ||
erpLastUpdate | integer | 0000-01-01T00:00:00 | |
erpCreation | integer | 0000-01-01T00:00:00 | |
archived | integer | 0 |
Einen Gutschein auslesen¶
Die URL /api/commerce/voucher/[ITID]
liefert einen Gutschein zurück
{
"dataset": {
"39887013-301b-4f06-a3ca-096b109c9e86": {
"soid": 1,
"name": "Sommer-Sale 2018",
"description": "",
"offer": 2500,
"currency": "EUR",
"unit": 1,
"minOrderValue": 0,
"password": "sale2018",
"state": 1,
"financesAttendDiscountAbleFlag": "0",
"orderPositionIID": 501,
"availabilityCount": 0,
"availabilityCountCustomer": 0,
"availabilityNote": 0,
"additionalIID": 10016,
"additionalCount": 1,
"additionalType": 0,
"additionalMinType": 0,
"additionalMinCount": 40,
"start": "0000-01-01T00:00:00",
"end": "0000-01-01T00:00:00",
"accessUID": 0,
"restrictionCategoryCID": [
"",
"21",
"10"
],
"restrictionBrandBID": [],
"restrictionItemIID": "",
"restrictionGroupGID": [],
"restrictionSalesGroup": [],
"restrictionCompany": [],
"restrictionCountryIso": [],
"shoppingcardAssignMode": "",
"locale": {
"de": {
"name": "Sommer-Sale 2018"
},
"en": {
"name": "Sommer-Sale 2018"
},
"fr": {
"name": "Sommer-Sale 2018"
}
},
"affiliateID": 0,
"erpID": "",
"erpName": "",
"erpNumber": "",
"erpLastUpdate": "0000-01-01T00:00:00",
"erpCreation": "0000-01-01T00:00:00",
"archived": "0"
}
},
"sys": {
"pagination": {
"total": 1,
"currentPage": 1,
"objectsPerPage": 20,
"offset": 0,
"nextOffset": null,
"prevOffset": null,
"pages": 1
},
"message": "200 OK",
"code": 200
}
}
Gutscheine auslesen¶
Die URL /api/commerce/item/voucher?page=[SEITE]&count=[ANZAHL DER OBJEKTE]&orderby=[SORTIERUNG]
liefert alle Gutscheine zurück.
Mit dem Pagestepper kann durch die Daten navigiert werden.
Beispiel : /api/commerce/item/voucher?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
}
}
Gutscheine suchen¶
Über die URL /api/commerce/voucher/search?q=[QUERY]
können Gutscheine gesucht werden.
Mit dem Pagestepper kann durch die Daten navigiert werden.
Beispiel : /api/commerce/voucher/search?q=itid%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
}
}