GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2} · Web API v3 · Entwurf

GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2}

Web API v3 · Entwurf v3sortiments

Entwurf; für neue Integrationen die aktuelle POS API v3 verwenden.

GET/sortiments?thirdPartySortimentIdentifier={string1}&name={string2}

Bevor ein Artikel im menio-System hochgeladen bzw. upgedated werden kann, muss die trackingUnit sich an einem Sortiment anmelden. Dies geschieht mit diesem Call. Im Response erhalten Sie eine sogenannte qnipsSortimentId, die künftig bei jeder Operation auf dem Sortiment anzugeben ist. Existiert noch kein Sortiment mit den angegebenen Parametern, wird eins angelegt und dessen ID zurückgeliefert.

Speichern Sie die Rückgabe.

{ "qnipsSortimentId":"sortiment123" }

Wird die Kasse in Ihrem System mit einem anderen Sortiment verknüpft, rufen Sie diese Resource erneut auf und speichern Sie die Rückgabe erneut ab.

Parameter

string1stringErforderlich

hier ist der unique Identifier des Sortiments anzugeben, unter welchem er in Ihrem eigenen System geführt wird

Beispiel: 1234567890

string2string

ein für den merchant verständlicher Name, unter welchem er das Sortiment im menio-Dashboard sehen und ggf. bearbeiten können wird. Der Wert sollte URL-konform escaped werden.

Beispiel: 'Sortiment Lounge-Bar' -> 'Sortiment%20Lounge-Bar'

Request-Header

DevKey

{Ihr Key}

TrackingUnitId

{trackingUnitId}

Originaler Blueprint-Ausschnitt

API Blueprint

### GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2} [GET]
Bevor ein Artikel im Qnips-System hochgeladen bzw. upgedated werden kann, muss die trackingUnit sich an einem Sortiment anmelden.
Dies geschieht mit diesem Call. Im Response erhalten Sie eine sogenannte `qnipsSortimentId`, die künftig bei jeder Operation auf dem
Sortiment anzugeben ist. Existiert noch kein Sortiment mit den angegebenen Parametern, wird eins angelegt und dessen ID 
zurückgeliefert.

Speichern Sie die Rückgabe. 

    {
        "qnipsSortimentId":"sortiment123"
    }

Wird die Kasse in Ihrem System mit einem anderen Sortiment verknüpft, rufen Sie diese Resource erneut auf und speichern Sie die Rückgabe erneut ab.

+ Parameters
    + string1 (string, `1234567890`) ... hier ist der unique Identifier des Sortiments anzugeben, unter welchem er in Ihrem eigenen System geführt wird
    + string2 (optional, string, `'Sortiment Lounge-Bar' -> 'Sortiment%20Lounge-Bar'` ) ...  ein für den merchant verständlicher Name, unter welchem er das Sortiment im Qnips-Dashboard sehen und ggf. bearbeiten können wird. Der Wert sollte URL-konform escaped werden.

+ Request

    + Headers

            DevKey: {Ihr Key}
            TrackingUnitId: {trackingUnitId}

+ Response 200

        {
            "qnipsSortimentId":"sortiment123"
        }

+ Response 403 

        // HTTP-Forbidden: trackingUnitId ist noch nicht vom Merchant aktiviert
            
+ Response 401 
            
        // HTTP-Unauthorized: DevKey oder trackingUnitId nicht angegeben oder nicht vorhanden

+ Response 500

        // HTTP-InternalServerError: Ein unbekannten Problem bei der Verarbeitung aufgetreten
        {
            "ErrorMessage":"some explanation"
            "StackTrace":"text"
        }

Request

cURL

curl --request GET \
  'http://pos.dev.qnips.com/api/pos/v3/sortiments?thirdPartySortimentIdentifier={string1}&name={string2}' \
  --header 'DevKey: {YOUR_DEV_KEY}' \
  --header 'TrackingUnitId: {trackingUnitId}'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

Response 200

{
    "qnipsSortimentId":"sortiment123"
}

Response 403

// HTTP-Forbidden: trackingUnitId ist noch nicht vom Merchant aktiviert

Response 401

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

Response 500

// HTTP-InternalServerError: Ein unbekannten Problem bei der Verarbeitung aufgetreten
{
    "ErrorMessage":"some explanation"
    "StackTrace":"text"
}