DELETE sortiments/{qnipsSortimentId}/article/{PLU}?groupId={groupId} · Web API v3 · Deutsch

DELETE sortiments/{qnipsSortimentId}/article/{PLU}?groupId={groupId}

Web API v3 · Deutsch v3sortiments

Aktualität laut Confluence unklar. Die englische POS API v3 ist die aktuelle Referenz.

DELETE/sortiments/{qnipsSortimentId}/article/{PLU}?groupId={groupId}

Artikel können in Warengruppen organisiert sein. Dazu muss das Feld GroupId des Artikels mit der Id der Gruppe gesetzt werden und die Warengruppe zuvor im menio-System angelegt worden sein.
Die zwei mindestens notwendige Angaben zu einem Artikel sind PLU und Name
alle anderen Felder sind optional.

Hier also eine Minimal-Variante:


    {
       "PLU":”123”,
       "Name":[{ "lang":"de-DE", "val":"Bier 0.5L" }]
    }

Und hier die Maximalvariante. Jeder Properties-Subset dazwischen ist natürlich auch möglich:


    {  
       "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
       }
    }

Property	Beschreibung
`PLU`	string: Was die `Id` für die Warengruppe ist, ist die PLU für den Artikel.
`Name`	translatable: Der Name sowie einige andere Properties eines Artikels können in beliebig vielen Übersetzungen im Format, das weiter unten beschrieben wird, angegeben werden. Bitte geben Sie mindestens eine Sprache an.
`GroupId`	string: Das ist die Id der Warengruppe, unter welcher der Artikel eingeordnet werden soll. Die Warengruppe muss bereits angelegt worden sein, sonst wird der Call abgewiesen. Wird diese Angabe unterlassen, wird der Artikel auf oberster Ebene, ungruppiert, im Sortiment eingeordnet.
`Rateable`	bool: Kann der merchant die Bewertbarkeit eines Artikels in Ihrer Software angeben, so können Sie diese Einstellung hier an menio übermitteln, um bestimmte Artikel aus den Bewertungsbögen fernzuhalten. Bietet Ihr System keine Möglichkeit an, die Bewertbarkeit der Artikel zu erfassen, so belegen Sie dieses Feld mit `null` bzw. lassen Sie es komplett aus.
`Description`	translatable: Existiert zum Artikel eine Beschreibung, kann sie mehrsprachig hier übermittelt werden. Diese kann in bestimmten Fällen den Konsumenten in der App angezeigt werden
`Ingredients`	translatable: Existiert diese Angabe, kann sie mehrsprachig hier übermittelt werden und ist ggf. für die Konsumenten in der App sichtbar.
`SoldOut`	string: Kann ein Artikel in Ihrer Software als ausverkauft markiert werden, sollten Sie diese Zustandsänderung über dieses Feld an menio übermitteln. Dadurch können wir den Artikel z.B. in öffentlichen elektronisch angezeigten Speiseplänen dynamisch und zeitnah in der Speisekarte ausblenden.
`PictureUrl`	string: Existiert ein über eine URL öffentlich zugängliches Bild zum Artikel, kann dessen URL hier angegeben werden.
`Prices`	List of Price: Hier können beliebig viele Preisebenen angegeben werden, wobei eine Preisebene immer aus einem `Tag` als öffentlich sichtbarem Bezeichner und dem eigentlichen Preis als decimal-Wert besteht.
`Allergens`	List of ints: Hier kann eine Liste der Allergen-IDs angegeben werden, die im Artikel enthalten sind. Siehe hierzu die Allergenauflistung unten.
`Traces`	List of ints: Hier kann eine Liste der Allergen-Spuren angegeben werden, die im Artikel enthalten sind. Lister Sie hier die AllergenIDs auf, deren Spuren im Artikel enthalten sein können. Siehe hierzu die Allergenauflistung unten.
`Additives`	List of ints: Hier kann eine Liste der nach LMIV-Verordnung mindestens ausweispflichtiger Zusatzstoffe angegeben werden, die im Artikel enthalten sind. Siehe hierzu die Zusatzstoff-Auflistung unten.
`Tags`	List of strings: Sind für einen merchant eigene individuelle Artikel-Auszeichnungen implementiert worden, die sich nicht über bisherige Properties übermitteln ließen, und dennoch von Bedeutung für eine der menio-Funktionen (z.B. individuelle Artikelauszeichnungen in öffentlichen Speiseplänen), können sie über diese Listen-Property angegeben werden.
`WeightInGramms`	decimal: Existiert die Angabe in Ihrer Software, geben sie hier an uns weiter.
`Fats`	decimal: Angabe des Fettanteils in Gramm je 100 Gramm Artikelgewicht.
`Carbs`	decimal: Angabe des Kohlenhydrate-Anteils in Gramm je 100 Gramm Artikelgewicht.
`Protein`	decimal: Angabe des Proteinanteils in Gramm je 100 Gramm Artikelgewicht.
`KJoule`	decimal: KJoule je 100 Gramm Artikelgewicht.
`KCal`	decimal: KCal je 100 Gramm Artikelgewicht.

Allergen-Liste

Id	Allergen
0	Glutenhaltiges Getreide
1	Krebstiere und Krebstiererzeugnisse
2	Eier und Eiererzeugnisse
3	Fisch und Fischerzeugnisse
4	Erdnüsse und Erdnusserzeugnisse
5	Soja und Sojaerzeugnisse
6	Milch und Milcherzeugnisse
7	Schalenfrüchte und Schalenfruchterzeugnisse
8	Sellerie und Sellerieerzeugnisse
9	Senf und Senferzeugnisse
10	Sesam und Sesamerzeugnisse
11	Schwefeldioxid und Sulfite
12	Lupinen und Lupinenerzeugnisse
13	Weichtiere und Weichtiererzeugnisse

Zusatzstoff-Liste

Id	Zusatzstoff-Bezeichnung
0	mit Farbstoff
1	mit Konservierungsstoff
2	mit Antioxidationsmittel
3	mit Geschmacksverstärker
4	geschwefelt
5	geschwärzt
6	gewachst
7	mit Phosphat
8	mit Süßungsmittel(n)
9	enthält eine Phenylalaninquelle
10	mit Nitrat
11	mit Nitritpökelsalz
12	koffeinhaltig

Parameter

qnipsSortimentIdstringErforderlich

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

Beispiel: 'sortiment123'

PLUstringErforderlich

geben Sie hier die PLU des zu löschenden Artikels an.

Beispiel: 'A12'

groupIdstringErforderlich

geben Sie hier die PLU der Warengruppe in welcher der zu löschende Artikel steckt oder eine '0' wenn der Artikel keiner Warengruppe zugeordnet ist

Beispiel: '123'

Request-Header

DevKey

{Ihr Key}

TrackingUnitId

{trackingUnitId}

Originaler Blueprint-Ausschnitt

API Blueprint

### DELETE sortiments/{qnipsSortimentId}/article/{PLU}?groupId={groupId} [DELETE]
+ Artikel können in Warengruppen organisiert sein. Dazu muss das Feld GroupId des Artikels mit der Id der Gruppe gesetzt werden und die Warengruppe zuvor im qnips-System angelegt worden sein. 
+ Die zwei mindestens notwendige Angaben zu einem Artikel sind PLU und Name
+ alle anderen Felder sind optional. 


Hier also eine Minimal-Variante:

<pre>
<code>
    {
       "PLU":”123”,
       "Name":[{ "lang":"de-DE", "val":"Bier 0.5L" }]
    }
</code>
</pre>

Und hier die Maximalvariante. Jeder Properties-Subset dazwischen ist natürlich auch möglich:

<pre>
<code>
    {  
       "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
       }
    }
</code>
</pre>

| Property | Beschreibung |
| --- | --- |
|`PLU`|**string**: Was die `Id` für die Warengruppe ist, ist die PLU für den Artikel. |
|`Name`|**translatable**: Der Name sowie einige andere Properties eines Artikels können in beliebig vielen Übersetzungen im Format, das weiter unten beschrieben wird, angegeben werden. Bitte geben Sie mindestens eine Sprache an. |
|`GroupId`|**string**: Das ist die Id der Warengruppe, unter welcher der Artikel eingeordnet werden soll. Die Warengruppe muss bereits angelegt worden sein, sonst wird der Call abgewiesen. Wird diese Angabe unterlassen, wird der Artikel auf oberster Ebene, ungruppiert, im Sortiment eingeordnet.|
|`Rateable`|**bool**: Kann der merchant die Bewertbarkeit eines Artikels in Ihrer Software angeben, so können Sie diese Einstellung hier an qnips übermitteln, um bestimmte Artikel aus den Bewertungsbögen fernzuhalten. Bietet Ihr System keine Möglichkeit an, die Bewertbarkeit der Artikel zu erfassen, so belegen Sie dieses Feld mit `null` bzw. lassen Sie es komplett aus.| 
|`Description`|**translatable**: Existiert zum Artikel eine Beschreibung, kann sie mehrsprachig hier übermittelt werden. Diese kann in bestimmten Fällen den Konsumenten in der App angezeigt werden|
|`Ingredients`|**translatable**: Existiert diese Angabe, kann sie mehrsprachig hier übermittelt werden und ist ggf. für die Konsumenten in der App sichtbar.|
|`SoldOut`|**string**: Kann ein Artikel in Ihrer Software als ausverkauft markiert werden, sollten Sie diese Zustandsänderung über dieses Feld an qnips übermitteln. Dadurch können wir den Artikel z.B. in öffentlichen elektronisch angezeigten Speiseplänen dynamisch und zeitnah in der Speisekarte ausblenden.|
|`PictureUrl`|**string**: Existiert ein über eine URL öffentlich zugängliches Bild zum Artikel, kann dessen URL hier angegeben werden.|
|`Prices`|**List of Price**: Hier können beliebig viele Preisebenen angegeben werden, wobei eine Preisebene immer aus einem `Tag` als öffentlich sichtbarem Bezeichner und dem eigentlichen Preis als decimal-Wert besteht.|
|`Allergens`|**List of ints**: Hier kann eine Liste der Allergen-IDs angegeben werden, die im Artikel enthalten sind. Siehe hierzu die Allergenauflistung unten. |
|`Traces`|**List of ints**: Hier kann eine Liste der Allergen-Spuren angegeben werden, die im Artikel enthalten sind. Lister Sie hier die AllergenIDs auf, deren Spuren im Artikel enthalten sein können. Siehe hierzu die Allergenauflistung unten. |
|`Additives`|**List of ints**: Hier kann eine Liste der nach LMIV-Verordnung mindestens ausweispflichtiger Zusatzstoffe angegeben werden, die im Artikel enthalten sind. Siehe hierzu die Zusatzstoff-Auflistung unten. |
|`Tags`|**List of strings**: Sind für einen merchant eigene individuelle Artikel-Auszeichnungen implementiert worden, die sich nicht über bisherige Properties übermitteln ließen, und dennoch von Bedeutung für eine der qnips-Funktionen (z.B. individuelle Artikelauszeichnungen in öffentlichen Speiseplänen), können sie über diese Listen-Property angegeben werden. |
|`WeightInGramms`|**decimal**: Existiert die Angabe in Ihrer Software, geben sie hier an uns weiter. |
|`Fats`|**decimal**: Angabe des Fettanteils in Gramm je 100 Gramm Artikelgewicht. |
|`Carbs`|**decimal**: Angabe des Kohlenhydrate-Anteils in Gramm je 100 Gramm Artikelgewicht. |
|`Protein`|**decimal**: Angabe des Proteinanteils in Gramm je 100 Gramm Artikelgewicht. |
|`KJoule`|**decimal**: KJoule je 100 Gramm Artikelgewicht. |
|`KCal`|**decimal**: KCal je 100 Gramm Artikelgewicht. |

#### Allergen-Liste

Id|Allergen
---|---
0|Glutenhaltiges Getreide
1|Krebstiere und Krebstiererzeugnisse
2| Eier und Eiererzeugnisse
3| Fisch und Fischerzeugnisse
4| Erdnüsse und Erdnusserzeugnisse
5| Soja und Sojaerzeugnisse
6| Milch und Milcherzeugnisse
7| Schalenfrüchte und Schalenfruchterzeugnisse
8| Sellerie und Sellerieerzeugnisse
9| Senf und Senferzeugnisse
10| Sesam und Sesamerzeugnisse
11| Schwefeldioxid und Sulfite
12| Lupinen und Lupinenerzeugnisse
13| Weichtiere und Weichtiererzeugnisse

#### Zusatzstoff-Liste

Id|Zusatzstoff-Bezeichnung
---|---
0| mit Farbstoff
1| mit Konservierungsstoff
2| mit Antioxidationsmittel
3| mit Geschmacksverstärker
4| geschwefelt
5| geschwärzt
6| gewachst
7| mit Phosphat
8| mit Süßungsmittel(n)
9| enthält eine Phenylalaninquelle
10| mit Nitrat
11| mit Nitritpökelsalz
12| koffeinhaltig

+ Parameters
    + qnipsSortimentId (string, `'sortiment123'`) ... das ist die `qnipsSortimentId`, die beim Call auf `GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2}` zurückgeliefert wurde. 
    + PLU (string, `'A12'` ) ...  geben Sie hier die PLU des zu löschenden Artikels an.
    + groupId (string, `'123'` ) ... geben Sie hier die PLU der Warengruppe in welcher der zu löschende Artikel steckt oder eine '0' wenn der Artikel keiner Warengruppe zugeordnet ist

+ Request

    + Headers

            DevKey: {Ihr Key}
            TrackingUnitId: {trackingUnitId}

+ 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 Ressource
        // 12001: qnipsSortimentId unbekannt
        // 12006: Kein Item unter angegebener Id/PLU gefunden. Versuchen Sie einen POST

Request

cURL

curl --request DELETE \
  'http://pos.prelive.qnips.com/api/pos/v3/sortiments/{qnipsSortimentId}/article/{PLU}?groupId={groupId}' \
  --header 'DevKey: {YOUR_DEV_KEY}' \
  --header 'TrackingUnitId: {trackingUnitId}'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

Kein Response-Body in dieser Referenz angegeben.

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 Ressource
// 12001: qnipsSortimentId unbekannt
// 12006: Kein Item unter angegebener Id/PLU gefunden. Versuchen Sie einen POST