Farbe

Mit dieser Api werden die Farben ausgegeben.

Felder

property title required default type examples
coid Eindeutige ID des Datensatzes integer 5
name Name string grün
locale Texte je Sprache object
tags Tags; Schlüsselwörter string
hexCode HTML-Farbe; #00000 RGB-Wert, hexadezimal string 4e7041
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
archived Archivierungsflag; false: in Verwendung; true: Datensatz ist archiviert boolean

Eine Farbe auslesen

Die URL /api/commerce/item/specification/color/[COID] liefert eine Farbe zurück

{
    "dataset": {
        "fad7980a-2ac7-4b6d-c5c2-65e33fc15258": {
            "coid": 2,
            "name": "Marine",
            "localeLabel": null,
            "locale": {
                "de": {
                    "description": "",
                    "name": "Marine"
                },
                "nl": {
                    "description": "",
                    "name": "Marine"
                },
                "en": {
                    "description": "",
                    "name": "Navy"
                }
            },
            "tags": "",
            "hexCode": "15092b",
            "ranking": "0",
            "erpID": "",
            "erpName": "EDI",
            "erpNumber": "marine",
            "erpLastUpdate": "0000-01-01T00:00:00",
            "erpCreation": "1970-01-01T00:59:59",
            "archived": false
        }
    },
    "sys": {
        "pagination": {
            "total": 1,
            "currentPage": 1,
            "objectsPerPage": 20,
            "offset": 0,
            "nextOffset": null,
            "prevOffset": null,
            "pages": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Farben auslesen

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

Beispiel : /api/commerce/item/specification/color?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
    }
}

Farbe suchen

Über die URL /api/commerce/item/specification/color/search?q=[QUERY] kann nach Farben gesucht werden

Beispiel: /api/commerce/item/specification/color/search?q=name%3Dweiß

{
    "dataset": {
        "1": {
            "coid": 1,
            "name": "weiß",
            "localeLabel": {
                "de": "weiß",
                "en": "white",
                "fr": "blanc"
            },
            "locale": {
                "de": {
                    "description": ""
                },
                "en": {
                    "description": ""
                },
                "fr": {
                    "description": ""
                }
            },
            "flag": 2,
            "tags": null,
            "hexCode": "ffffff"
        }
    },
    "sys": {
        "pagination": {
            "offset": 0,
            "objectsPerPage": 10,
            "total": 1
        },
        "message": "200 OK",
        "code": 200
    }
}