Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

POST sortiments/{qnipsSortimentId}/bulkUpload?changedArticlesOnly={boolean}} · Web API v3 · Entwurf

API-ReferenzWeb API v3 · Entwurfsortiments

POST sortiments/{qnipsSortimentId}/bulkUpload?changedArticlesOnly={boolean}}

Web API v3 · Entwurf v3sortiments
Entwurf; für neue Integrationen die aktuelle POS API v3 verwenden.
POST/sortiments/{qnipsSortimentId}/bulkUpload?changedArticlesOnly={boolean}

  • Im BulkUpload können Sie mehrere Artikel und Warengruppen in einem Rutsch erstellen und updaten

  • Über das boolean-Parameter changedArticlesOnly können Sie angeben, ob der Body einen kompletten Stamm beinhaltet oder lediglich die seit dem letzten Upload in Ihrem System aktualisierten Artikel.

  • Bei changedArticlesOnly=true wird unser System eigenständig die im Vergleich zum vorhergehenden Upload neu hinzugefügten, geänderten oder gelöschten Artikel und Warengruppen ermitteln und lediglich diese Änderungen historisiert abspeichern.

  • Bei changedArticlesOnly=false interpretiert unser System die Angaben im Body als neue, bzw. zu aktualisierende Artikel und Warengruppen. Löschen muss in diesem Fall über Einzellöschungen realisiert werden, wie oben schon beschrieben wurde.

Der Body ist wie folgt für diesen Request anzugeben:

{ "Groups":[ { "Id":”123”, "UpGroupId":"234", "Name":[{ "lang":"de-DE", "val":"Getränke" }] } ], "Products":[ { "PLU":”123”, "Name":[{ "lang":"de-DE", "val":"Bier 0.5L" }] } ] }

Property Beschreibung
Groups Liste der Warengruppen, wie unter Warengruppen bearbeiten spezifiziert.
Products Liste der Artikel, wie unter Artikel bearbeiten spezifiziert.

Parameter

qnipsSortimentIdstringErforderlich

das ist die qnipsSortimentId, die beim Call auf GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2} zurückgeliefert wurde.

Beispiel: 'sortiment123'
changedArticlesOnlybooleanErforderlich

gibt an, ob es sich beim Upload um das Gesamtsortiment, welches mit menio geteilt werden soll, handelt oder dieser Request lediglich die Änderungen zum vorherigen erfolgreichen Upload beinhaltet.

Beispiel: true'

Request-Header

DevKey
{Ihr Key}
TrackingUnitId
{trackingUnitId}
Content-Encoding
gzip (optional) // fügen Sie den Body dieses Requests in gezippter Form an, wenn dieser Header gesetzt ist.
Originaler Blueprint-Ausschnitt
API Blueprint
### POST sortiments/{qnipsSortimentId}/bulkUpload?changedArticlesOnly={boolean}} [POST]

+ Im BulkUpload können Sie mehrere Artikel und Warengruppen in einem Rutsch erstellen und updaten
+ Über das boolean-Parameter `changedArticlesOnly` können Sie angeben, ob der Body einen kompletten Stamm beinhaltet oder lediglich die seit dem letzten Upload in Ihrem System aktualisierten Artikel.
+ Bei `changedArticlesOnly=true` wird unser System eigenständig die im Vergleich zum vorhergehenden Upload neu hinzugefügten, geänderten oder gelöschten Artikel und Warengruppen ermitteln und lediglich diese Änderungen historisiert abspeichern.
+ Bei `changedArticlesOnly=false` interpretiert unser System die Angaben im Body als neue, bzw. zu aktualisierende Artikel und Warengruppen. Löschen muss in diesem Fall über Einzellöschungen realisiert werden, wie oben schon beschrieben wurde.

Der Body ist wie folgt für diesen Request anzugeben:

    {
        "Groups":[
            {
               "Id":”123”,
               "UpGroupId":"234",
               "Name":[{ "lang":"de-DE", "val":"Getränke" }]
            }
        ],
        "Products":[
            {
               "PLU":”123”,
               "Name":[{ "lang":"de-DE", "val":"Bier 0.5L" }]
            }
        ]
    }
    
| Property | Beschreibung |
| --- | --- |
|`Groups`| Liste der Warengruppen, wie unter [Warengruppen bearbeiten](#reference/sortiments/warengruppen-bearbeiten) spezifiziert. |
|`Products`| Liste der Artikel, wie unter [Artikel bearbeiten](#reference/sortiments/artikel-bearbeiten) spezifiziert. |


+ Parameters
    + qnipsSortimentId (string, `'sortiment123'`) ... das ist die `qnipsSortimentId`, die beim Call auf `GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2}` zurückgeliefert wurde. 
    + changedArticlesOnly (boolean, `true'` ) ...  gibt an, ob es sich beim Upload um das Gesamtsortiment, welches mit Qnips geteilt werden soll, handelt oder dieser Request lediglich die Änderungen zum vorherigen erfolgreichen Upload beinhaltet.

+ Request

    + Headers

            DevKey: {Ihr Key}
            TrackingUnitId: {trackingUnitId}
            Content-Encoding: gzip (optional) // fügen Sie den Body dieses Requests in gezippter Form an, wenn dieser Header gesetzt ist.

+ Response 200

+ Response 500

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


+ Response 403 

        // HTTP-Forbidden: trackingUnitId ist noch nicht vom Merchant aktiviert
            
+ 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
        // 1000: Body enthält syntaktische Fehler und kann nicht deserialisiert werden
        // 12001: qnipsSortimentId unbekannt