Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

GET trackingUnits · Web API v3 · Deutsch

API-ReferenzWeb API v3 · DeutschtrackingUnits

GET trackingUnits

Web API v3 · Deutsch v3trackingUnits
Aktualität laut Confluence unklar. Die englische POS API v3 ist die aktuelle Referenz.
GET/trackingUnits?qnipsUserName={qnipsUserName}&outletId={outletId}&sortimentId={sortimentId}&instanceName={instanceName}

Jeder Call auf diese Ressource wird immer einen neuen, sich vom vorherigen Call unterscheidenden Identifier, die sog. trackingUnitId sowie ein checksumSecret im Response liefern.

Rückgabe Beschreibung
trackingUnitId Diese Id werden Sie bei jedem weiteren Call im TrackingUnitId-Request-Header setzen müssen, ohne welchen jeder Call von unserem Backend abgewiesen würde.
checksumSecret Diesen Secret werden Sie zur Bildung einer Prüfziffer benötigen, die bei einigen Calls unserer API als Sicherheitskriterium mit übermittelt werden muss.

Rufen Sie diese Ressource daher in jedem zu registrierenden Terminal nur einmal auf, persistieren Sie die beiden Werte aus dem Response und sorgen Sie dafür, dass der checksumSecret geheim bleibt.

Parameter

qnipsUserNamestringErforderlich

Lassen Sie den Merchant seinen menio-Username eintragen und geben Sie diesen hier an. Der Wert sollte URL-konform escaped werden, da er Umlaute enthalten kann: hans.möller@firma.de -> hans.m%C3%B6ller@firma.de

Beispiel: hans.m%C3%B6ller@firma.de
outletIdlongErforderlich

Hier bitte die Id des outlets angeben, in welchem die trackingUnit zu registrieren ist.

Beispiel: 123
sortimentIdlong

Hier bitte optional die Id des Sortiments angeben, auf welchem die trackingUnit arbeitet

Beispiel: 234
instanceNamestring

Lassen Sie den Merchant im Zuge der menio-Aktivierung einen Namen für die zu aktivierende Instanz eintragen und geben Sie diese hier an. Der hier eingegebene Name wird im menio-Webportal für den Merchant sichtbar sein und hilft dem Merchant, diese Instanz ggf. korrekt einzuordnen. Der Wert sollte URL-konform escaped werden, da er z.B. Umlaute und Leerzeichen enthalten kann: 'Kasse im Gang 1' -> 'Kasse%20im%20Gang%201'

Beispiel: Kasse%20im%20Gang%201

Request-Header

Accept
application/json
DevKey
{Ihr Key}
Originaler Blueprint-Ausschnitt
API Blueprint
### GET trackingUnits [GET]
Jeder Call auf diese Ressource wird immer einen neuen, sich vom vorherigen Call unterscheidenden Identifier, 
die sog. `trackingUnitId` sowie ein `checksumSecret` im Response liefern.

| Rückgabe | Beschreibung |
| ---    | --- |
|`trackingUnitId`|Diese Id werden Sie bei jedem weiteren Call im `TrackingUnitId-Request-Header` setzen müssen, ohne welchen jeder Call von unserem Backend abgewiesen würde.|
|`checksumSecret`|Diesen `Secret` werden Sie zur Bildung einer Prüfziffer benötigen, die bei einigen Calls unserer API als Sicherheitskriterium mit übermittelt werden muss.|

Rufen Sie diese Ressource daher in jedem zu registrierenden Terminal nur einmal auf, persistieren Sie die beiden Werte aus dem Response und sorgen Sie dafür, dass der `checksumSecret` geheim bleibt.

+ Parameters
    + qnipsUserName (`hans.m%C3%B6ller@firma.de`) ... Lassen Sie den Merchant seinen qnips-Username eintragen und geben Sie diesen hier an. Der Wert sollte URL-konform escaped werden, da er Umlaute enthalten kann: *hans.möller@firma.de -> hans.m%C3%B6ller@firma.de* 
    + outletId (long, `123`) ... Hier bitte die Id des outlets angeben, in welchem die trackingUnit zu registrieren ist.
    + sortimentId (optional, long, `234`) ... Hier bitte optional die Id des Sortiments angeben, auf welchem die trackingUnit arbeitet
    + instanceName (optional, string, `Kasse%20im%20Gang%201`) ... Lassen Sie den Merchant im Zuge der qnips-Aktivierung einen Namen für die zu aktivierende Instanz eintragen und geben Sie diese hier an. Der hier eingegebene Name wird im qnips-Webportal für den Merchant sichtbar sein und hilft dem Merchant, diese Instanz ggf. korrekt einzuordnen. Der Wert sollte URL-konform escaped werden, da er z.B. Umlaute und Leerzeichen enthalten kann: *'Kasse im Gang 1' -> 'Kasse%20im%20Gang%201'* 

+ Request

    + Headers

            Accept: application/json
            DevKey: {Ihr Key}

+ Response 200

        {
            "trackingUnitId" = "1234567890", 
            "checksumSecret" = "def567",
        }

+ Response 500

        // HTTP-InternalServerError: Ein unbekannten Problem bei der Verarbeitung aufgetreten

+ Response 401 

        // HTTP-Unauthorized: DevKey oder trackingUnitId nicht angegeben oder nicht vorhanden
            
+ Response 400

        {
            "ErrorId":123,
            "ErrorText":"Details zum Fehler"
        }
        
        // hier alle möglichen ErrorCodes inkl. Texte für diese Ressource
        // 10001: unbekannter qnipsUserName
        // 10002: kein Instanz-Name angegeben