Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

GET trackingUnits · Web API v3 · Entwurf

API-ReferenzWeb API v3 · EntwurftrackingUnits

GET trackingUnits

Web API v3 · Entwurf v3trackingUnits
Entwurf; für neue Integrationen die aktuelle POS API v3 verwenden.
GET/trackingUnits?qnipsUserName={string}&brandId={brandId}&instanceName={string}&city={string}&street={string}&postalIndex={string}

Jeder Call auf diese Resource 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 Resource 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.|

Beispiel: 'hans.möller@firma.de' -> 'hans.m%C3%B6ller@firma.de'
instanceNamestringErforderlich

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.|

Beispiel: 'Filiale 5 - Kasse im Gang 1' -> 'Filiale%205%20-%20Kasse%20im%20Gang%201'
citystring

Oprionale Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird. Der Wert sollte URL-konform escaped werden, da er z.B. Umlaute und Leerzeichen enthalten kann.|

Beispiel: 'Köln' -> 'K%C3%B6ln'
streetstring

Oprionale Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird. Der Wert sollte URL-konform escaped werden, da er z.B. Umlaute und Leerzeichen enthalten kann.|

Beispiel: 'Möbiusweg 1' -> 'M%C3%B6biusweg%201'
postalIndexstring

Oprionale Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird.|

Beispiel: '50667'

Request-Header

Accept
application/json
DevKey
{Ihr Key}
Originaler Blueprint-Ausschnitt
API Blueprint
### GET trackingUnits [GET]
Jeder Call auf diese Resource 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 Resource 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 (string, `'hans.möller@firma.de' -> '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.|
    + instanceName (string, `'Filiale 5 - Kasse im Gang 1' -> 'Filiale%205%20-%20Kasse%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.|
    + city (optional, string, `'Köln' -> 'K%C3%B6ln'`) ... Oprionale Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird. Der Wert sollte URL-konform escaped werden, da er z.B. Umlaute und Leerzeichen enthalten kann.|
    + street (optional, string, `'Möbiusweg 1' -> 'M%C3%B6biusweg%201'`) ... Oprionale Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird. Der Wert sollte URL-konform escaped werden, da er z.B. Umlaute und Leerzeichen enthalten kann.|
    + postalIndex (optional, string, `'50667'`) ... Oprionale Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird.|

+ 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 Resource
        // 10001: unbekannter qnipsUserName
        // 10002: kein Instanz-Name angegeben