Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

GET merchants-Info · Web API v3 · Deutsch

API-ReferenzWeb API v3 · Deutschmerchants

GET merchants-Info

Web API v3 · Deutsch v3merchants
Aktualität laut Confluence unklar. Die englische POS API v3 ist die aktuelle Referenz.
GET/merchants/{qnipsUserName}/info

Im Response erhalten Sie eine Liste der brands, welche für den merchant mit dem angegebenen qnipsUserName in unserem System hinterlegt sind. Dabei kann in jedem brand-Objekt eine Liste der outlets mit jeweils einer Id und einem Namen stecken. Beispiel:

[ { "brandId": 1, "brandName": "Caesar's", "outlets": [ { "Id": 1, "Name": "Caesar's Hemmingen - (Hemmingen, Rathausplatz 6A)" }, { "Id": 2, "Name": "Caesar's Hannover - (Hannover, Weidendamm 8)" } ] } ]

Rückgabe Beschreibung
brandId Id des Brands.
brandName Name des Brands, welchen Sie z.B. in einer DropDown-Box im UI zur Selektion anzeigen könnten.
outlet.Id Id des Standort-Eintrags (Filiale) .
outlet.Name Name der Filiale, welchen Sie z.B. in einer DropDown-Box im UI zur Selektion anzeigen könnten.

Sie können nun entweder unter Nutzung einer vom Nutzer selektierten brandId einen neuen Outlet anlegen (siehe POST merchants/{qnipsUserName}/outlets)
oder unter Nutzung einer selektierten outletId mit direkter Registrierung einer trackingUnit fortfahren (siehe GET trackingUnits)

Parameter

qnipsUserNamestringErforderlich

Lassen Sie den Merchant seinen qnipsUserName eintragen und fügen Sie diesen hier ein. Der Wert sollte URL-konform escaped werden, da er Umlaute enthalten kann, z.B. 'hans.möller@firma.de' -> 'hans.m%C3%B6ller@firma.de'.

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

Request-Header

Accept
application/json
DevKey
{Ihr Key}
Kontext: merchants

Wie im Kapitel Client-Registrierung beschrieben, muss sich jeder Client an unserem System zunächst als eine trackingUnit registrieren. Für diese Registrierung wird eine sogenannte outletId benötigt, die uns hilft, die trackingUnit sofort zu einer realen Filiale/Standort eines merchants zuzuordnen. Eine outletId lässt sich auf zwei unterschiedlichen Wegen besorgen:

  • Abrufen von bereits existierenden brands und outlets, um eine zu registrierende trackingUnit in einem bestehenden outlet einzuordnen. Bauen Sie dies wie folgt ein:

    • Fragen Sie bei der menio-Aktivierung den Usernamen des menio-Accounts ab
    • Führen Sie GET merchants/{qnipsUserName}/info aus und stellen Sie das Ergebnis im UI dar
    • Lassen Sie den Bediener eine outletId auswählen
    • Registrieren Sie die trackingUnit über GET trackingUnits

  • Verfügt Ihre Software über Standortinformationen, bestehend mind. aus PLZ, Stadt, Straße und Straßennummer, ist es möglich, einen automatischen Export der Standorte aus Ihrem in unser System zu ermöglichen. Bauen Sie dies ggf. wie folgt ein:

    • Fragen Sie bei der menio-Aktivierung den Usernamen des menio-Accounts ab
    • Führen Sie GET merchants/{qnipsUserName}/info aus und stellen Sie das Ergebnis im UI dar
    • Lassen Sie den Bediener eine brandId auswählen
    • Erstellen Sie in der Brand einen neuen Outlet über POST merchants/{qnipsUserName}/outlets
    • Registrieren Sie die trackingUnit über GET trackingUnits
Originaler Blueprint-Ausschnitt
API Blueprint
### GET merchants-Info [GET]
Im Response erhalten Sie eine Liste der `brands`, welche für den `merchant` mit dem angegebenen `qnipsUserName` in unserem System
hinterlegt sind. Dabei kann in jedem brand-Objekt eine Liste der `outlets` mit jeweils einer Id und einem Namen stecken. Beispiel:

        [
            {
                "brandId": 1,
                "brandName": "Caesar's",
                "outlets": [
                  {
                    "Id": 1,
                    "Name": "Caesar's Hemmingen - (Hemmingen, Rathausplatz 6A)"
                  },
                  {
                    "Id": 2,
                    "Name": "Caesar's Hannover - (Hannover, Weidendamm 8)"
                  }
                ]
            }
        ]

| Rückgabe | Beschreibung |
| ---    | --- |
|`brandId`|Id des Brands.|
|`brandName`|Name des Brands, welchen Sie z.B. in einer DropDown-Box im UI zur Selektion anzeigen könnten.|
|`outlet.Id`|Id des Standort-Eintrags (Filiale) .|
|`outlet.Name`|Name der Filiale, welchen Sie z.B. in einer DropDown-Box im UI zur Selektion anzeigen könnten.|

Sie können nun entweder unter Nutzung einer vom Nutzer selektierten `brandId` einen neuen Outlet anlegen 
(siehe *[POST merchants/{qnipsUserName}/outlets](#reference/merchants/outlet-erstellen/post-merchants/{qnipsusername}/outlets)*)  
oder unter Nutzung einer selektierten `outletId` mit direkter Registrierung einer `trackingUnit` fortfahren 
(siehe *[GET trackingUnits](#reference/trackingunits/registrieren/get-trackingunits)*)

+ Parameters
    + qnipsUserName (string, `hans.m%C3%B6ller@firma.de`) ... Lassen Sie den Merchant seinen `qnipsUserName` eintragen und fügen Sie diesen hier ein. Der Wert sollte URL-konform escaped werden, da er Umlaute enthalten kann, z.B. `'hans.möller@firma.de' -> 'hans.m%C3%B6ller@firma.de'`.

+ Request

    + Headers

            Accept: application/json
            DevKey: {Ihr Key}

+ Response 200

        [
            {
                "brandId": 1,
                "brandName": "Caesar's",
                "outlets": [
                  {
                    "Id": 1,
                    "Name": "Caesar's Hemmingen - (Hemmingen, Rathausplatz 6A)"
                  },
                  {
                    "Id": 2,
                    "Name": "Caesar's Hannover - (Hannover, Weidendamm 8)"
                  }
                ]
            }
        ]

+ Response 500

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

+ Response 401 

        // HTTP-Unauthorized: DevKey nicht angegeben oder nicht vorhanden

+ Response 404

        // HTTP-NotFound: qnipsUserName unbekannt oder hat keine brands