Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

POST trackingUnits · Web API v3 · Deutsch

API-ReferenzWeb API v3 · DeutschtrackingUnits

POST trackingUnits

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

Wird eine Kasse in eine andere Filiale gebracht, oder auf ein anderes Sortiment umgeschaltet, sollte dies unserem Systemüber einen POST-Call auf die trackingUnits-Ressource mitgeteilt werden. Damit ordnen wir die trackingUnit entsprechend neu ein.

Im Erfolgsfall wird ein leerer HTTP-200-Response geliefert

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

Content-Type
application/json
DevKey
{Ihr Key}
TrackingUnitId
{trackingUnitId}
Originaler Blueprint-Ausschnitt
API Blueprint
### POST trackingUnits [POST]
Wird eine Kasse in eine andere Filiale gebracht, oder auf ein anderes Sortiment umgeschaltet, sollte dies unserem Systemüber einen 
POST-Call auf die trackingUnits-Ressource mitgeteilt werden. Damit ordnen wir die trackingUnit entsprechend neu ein.

Im Erfolgsfall wird ein leerer HTTP-200-Response geliefert

+ 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

            Content-Type: application/json
            DevKey: {Ihr Key}
            TrackingUnitId: {trackingUnitId}

+ Response 200

+ 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
        // 1000: Body enthält syntaktische Fehler und kann nicht deserialisiert werden