Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

GET merchants/{qnipsUserName}/brands · Web API v3 · Entwurf

API-ReferenzWeb API v3 · Entwurfmerchants

GET merchants/{qnipsUserName}/brands

Web API v3 · Entwurf v3merchants
Entwurf; für neue Integrationen die aktuelle POS API v3 verwenden.
GET/merchants/{qnipsUserName}/brands
Rückgabe Beschreibung
brandId Id des Brands.
brandName Name des Brands.

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

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

Request-Header

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

Die im menio-System registrierten Händler werden merchantsgenannt. Ein Merchant wird mit seinem qnipsUserName identifiziert, mit welchem er sich auch im Webportal von menio (unter http://my.qnips.com) anmelden kann. Jeder Merchant kann mehrere Handelsmarken mit jeweils mehreren Standorten besitzen. Daher braucht unser System für die Registrierung eines Zugangs für Ihr System immer mindestens zwei Angaben:

  • qnipsUserName

  • brandId

Nach Eingabe eines qnipsUserName durch den Bediener, sollte Ihr System mit GET merchants/{qnipsUserName}/brands die brands abrufen und dem Bediener zur Auswahl anzeigen.

Wird im Response nur ein brand zurückgeliefert wird, so kann die Registrierung über einen GET trackingUnits-Call direkt erfolgen.

Originaler Blueprint-Ausschnitt
API Blueprint
### GET merchants/{qnipsUserName}/brands [GET]

| Rückgabe | Beschreibung |
| ---    | --- |
|`brandId`|Id des Brands.|
|`brandName`|Name des Brands.|


+ Parameters
    + qnipsUserName (string, `'hans.möller@firma.de' -> '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.|

+ Request

    + Headers

            Accept: application/json
            DevKey: {Ihr Key}

+ Response 200

        [
            {
                "brandId": 1,
                "brandName": "Caesar's"
            },
            {
                "brandId": 2,
                "brandName": "Apostels"
            },
        ]

+ 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