Kategorie

Mit dieser Api werden die Kategorien ausgegeben.

Felder

property title required default type examples
cid Eindeutige ID des Datensatzes integer
name Name string
token Beschreibung string
flag Aktive Flag boolean
specificationWeight Kaufmännische Einstellungen Gewicht 0 integer
specificationWeightUnit Kaufmännische Einstellungen Gewicht Einheit 0 integer
financesVat Umsatzsteuer object
locale Text je Sprache object
tags Tags string
parentCID Eltern ID 0 integer
ranking Rangfolge der Datensätze; Sortierung der Einträge 0 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 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; false: in Verwendung; true: Datensatz ist archiviert boolean

Eine Kategorie auslesen

Die URL /api/commerce/item/catalog/category/[CID] liefert eine Kategorie zurück

{
    "dataset": {
        "8c86c091-c455-405c-f179-0be241bfbd7c":  {
            "cid": 1,
            "name": "T-Shirt",
            "token": "",
            "flag": true,
            "specificationWeight": 100,
            "specificationWeightUnit": 1,
            "financesVat": {},
            "localeLabel": null,
            "locale": {
                "de": {
                    "name": "T-Shirt"
                },
                "en": {
                    "name": "T-Shirt"
                }
            },
            "tags": [],
            "parentCID": 1,
            "ranking": "0",
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "2009-02-17T00:17:32",
            "erpCreation": "0000-01-01T00:00:00",
            "archived": false
        }
    },
    "sys": {
        "pagination": {
            "total": 1,
            "currentPage": 1,
            "objectsPerPage": 20,
            "offset": 0,
            "nextOffset": null,
            "prevOffset": null,
            "pages": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Kategorien auslesen

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

Beispiel : /api/commerce/item/catalog/category?page=3&count=5&orderby=name%20ASC

{
    "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
    }
}

Kategorien suchen

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

Beispiel : /api/commerce/item/catalog/category/search?q=cid%3D2