PUT sortiments/{qnipsSortimentId}/article} · Web API v3 · Entwurf

API-ReferenzWeb API v3 · Entwurfsortiments

PUT sortiments/{qnipsSortimentId}/article}

Web API v3 · Entwurf v3sortiments

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

PUT/sortiments/{qnipsSortimentId}/article/{PLU}

Parameter

qnipsSortimentIdstringErforderlich

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

Beispiel: 'sortiment123'

Request-Header

DevKey

{Ihr Key}

TrackingUnitId

{trackingUnitId}

Originaler Blueprint-Ausschnitt

API BlueprintKopieren

gesetzt
        // 12009: In der angegebenen Warengruppe existiert bereits ein Artikel mit der angegebenen PLU

### PUT sortiments/{qnipsSortimentId}/article} [PUT]
+ Parameters
    + qnipsSortimentId (string, `'sortiment123'`) ... das ist die `qnipsSortimentId`, die beim Call auf `GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2}` zurückgeliefert wurde. 

+ Request

    + Headers

            DevKey: {Ihr Key}
            TrackingUnitId: {trackingUnitId}

    + Body

            {  
               "PLU":"123",
               "Name":[{ "lang":"de-DE", "val":"Bier 0.5L" }],
               "GroupId":"234",
               "Rateable":true,
               "ExternalName":[{ "lang":"de-DE", "val":"Bier vom Fass 0.5L" }],
               "Description":[{ "lang":"de-DE", "val":"Frisch gezapft" }],
               "Ingredients":[{ "lang":"de-DE", "val":"Malz, Hopfen, Wasser" }],
               "SoldOut":false,
               "PictureUrl":"http://...",
               "Prices":[  
                  {  
                     "Value":9.95,
                     "CurrencyIso":"EUR",
                     "Tag":{  
                        "Name":[  
                           {  
                              "lang":"de-DE",
                              "val":"Mitarbeiter"
                           }
                        ]
                     }
                  },
                  {  
                     "Value":8.95,
                     "CurrencyIso":"EUR",
                     "Tag":{  
                        "Name":[  
                           {  
                              "lang":"de-DE",
                              "val":"Studenten"
                           }
                        ]
                     }
                  }
               ],
               "Allergens":[1, 5, 11],
               "Traces":[2, 4],
               "Additives":[1, 8],
               "Tags":[  
                  "Vegan",
                  "Frisch gezapft"
               ],
               "WeightInGramms":125.0,
               "NutritionFacts":{  
                  "Fats":20,
                  "Carbs":20,
                  "Protein":20,
                  "KJoule":200,
                  "KCal":200
               }
            }

+ 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
        // 12005: Name wurde nicht angegeben, wird aber in mind. einer Sprache erwartet
        // 12006: Kein Item unter angegebener Id/PLU gefunden. Versuchen Sie einen POST
        // 12007: (Up)GroupId darf nicht geändert werden. Löschen Sie den item statt dessen und legen Sie ihn in der anderen Warengruppe neu an
        // 12008: PLU-Feld nicht gesetzt

Request

cURLKopieren

curl --request PUT \
  'http://pos.dev.qnips.com/api/pos/v3/sortiments/{qnipsSortimentId}/article/{PLU}' \
  --header 'DevKey: {YOUR_DEV_KEY}' \
  --header 'TrackingUnitId: {trackingUnitId}' \
  --data-raw '{  
   "PLU":"123",
   "Name":[{ "lang":"de-DE", "val":"Bier 0.5L" }],
   "GroupId":"234",
   "Rateable":true,
   "ExternalName":[{ "lang":"de-DE", "val":"Bier vom Fass 0.5L" }],
   "Description":[{ "lang":"de-DE", "val":"Frisch gezapft" }],
   "Ingredients":[{ "lang":"de-DE", "val":"Malz, Hopfen, Wasser" }],
   "SoldOut":false,
   "PictureUrl":"http://...",
   "Prices":[  
      {  
         "Value":9.95,
         "CurrencyIso":"EUR",
         "Tag":{  
            "Name":[  
               {  
                  "lang":"de-DE",
                  "val":"Mitarbeiter"
               }
            ]
         }
      },
      {  
         "Value":8.95,
         "CurrencyIso":"EUR",
         "Tag":{  
            "Name":[  
               {  
                  "lang":"de-DE",
                  "val":"Studenten"
               }
            ]
         }
      }
   ],
   "Allergens":[1, 5, 11],
   "Traces":[2, 4],
   "Additives":[1, 8],
   "Tags":[  
      "Vegan",
      "Frisch gezapft"
   ],
   "WeightInGramms":125.0,
   "NutritionFacts":{  
      "Fats":20,
      "Carbs":20,
      "Protein":20,
      "KJoule":200,
      "KCal":200
   }
}
'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

200500403401400

Kein Response-Body in dieser Referenz angegeben.

Response 500Kopieren

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

Response 403Kopieren

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

Response 401Kopieren

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

Response 400Kopieren

{
    "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
// 12005: Name wurde nicht angegeben, wird aber in mind. einer Sprache erwartet
// 12006: Kein Item unter angegebener Id/PLU gefunden. Versuchen Sie einen POST
// 12007: (Up)GroupId darf nicht geändert werden. Löschen Sie den item statt dessen und legen Sie ihn in der anderen Warengruppe neu an
// 12008: PLU-Feld nicht gesetzt