DELETE sortiments/{qnipsSortimentId}/article/{PLU}?groupId={groupId} · POS API
DELETE sortiments/{qnipsSortimentId}/article/{PLU}?groupId={groupId}
DELETE
/sortips/{qnipsSortimentId}/article/{PLU}?groupId={groupId}Articles can be organized in merchandise categories. To do this, the field GroupId of the article must be set with the ID of the group and the product group must have been created in the menio system beforehand.
The two minimum required details for an article are PLU and name
all other fields are optional.
So here is a minimal variant:
{
"PLU": "123."
"Name": [{ "lang": "de-DE", "val": "Bier 0.5L" }
}
And here the maximum variant. Any properties subset in between is of course also possible:
{
"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"
}
]
}
}
],
"Allergen": [1, 5, 11],
"Traces": [2, 4],
"Additives": [1, 8],
"Tags":[
"Vegan."
"Frisch gezapft"
],
"WeightInGrams":125.0,
"NutritionFacts":{
"Fats":20,
"Carbs":20,
"Protein":20,
"KJoule":200,
"KCal":200
}
}
| Property | Description |
|---|---|
| ``Name` | |
| ``Description` | translatable: If a description exists for the article, it can be transmitted here in several languages. In certain cases this can be displayed to consumers in the app |
| ``Traces` | |
allergen list
| Id | allergens |
|---|---|
| 0 | Gluten-containing grain |
| 1 | Crustaceans and products thereof |
| 2 | Eggs and egg products |
| 3 | Fish and fish products |
| 4 | Peanuts and peanut products |
| 5 | Soya and soya products |
| 6 | Milk and milk products |
| 7 | Nuts and nut products |
| 8 | Celery and celery products |
| 9 | Mustard and mustard products |
| 10 | Sesame and sesame products |
| 11 | sulphur dioxide and sulphites |
| 12 | Lupines and lupine products |
| 13 | Molluscs and mollusc products |
Additives list
| Id | additive name |
|---|---|
| 0 | with dye |
| 1 | with preservative |
| 2 | with antioxidant |
| 3 | with flavour enhancer |
| 4 | sulphurized |
| 5 | blackened |
| 6 | waxed |
| 7 | with phosphate |
| 8 | with sweetener(s) |
| 9 | contains a phenylalanine source |
| 10 | with nitrate |
| 11 | with nitrite pickling salt |
| 12 | caffeinated |
Parameter
qnipsSortimentIdstringErforderlichthis is the qnipsSortimentId' returned by the call to GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2}`.
'sortiment123'PLUstringErforderlichenter the PLU of the article to be deleted here.
A12groupIdstringErforderlichenter the PLU of the product group in which the article to be deleted is located or a '0' if the article is not assigned to a product group
123Request-Header
DevKey{Your Key}TrackingUnitId{trackingUnitId}Originaler Blueprint-Ausschnitt
API Blueprint
### DELETE sortiments/{qnipsSortimentId}/article/{PLU}?groupId={groupId} [DELETE]
+ Articles can be organized in merchandise categories. To do this, the field GroupId of the article must be set with the ID of the group and the product group must have been created in the qnips system beforehand.
+ The two minimum required details for an article are PLU and name
+ all other fields are optional.
So here is a minimal variant:
<pre>
<code>
{
"PLU": "123."
"Name": [{ "lang": "de-DE", "val": "Bier 0.5L" }
}
</code>
</pre>
And here the maximum variant. Any properties subset in between is of course also possible:
<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"
}
]
}
}
],
"Allergen": [1, 5, 11],
"Traces": [2, 4],
"Additives": [1, 8],
"Tags":[
"Vegan."
"Frisch gezapft"
],
"WeightInGrams":125.0,
"NutritionFacts":{
"Fats":20,
"Carbs":20,
"Protein":20,
"KJoule":200,
"KCal":200
}
}
</code>
</pre>
| Property | Description |
| --- | --- |
|| ||PLU||**string**: What the 'ID' is for the product group is the PLU for the article. |
|``Name`|||translatable**: The name as well as some other properties of an article can be given in any number of translations in the format described below. Please specify at least one language. |
|| ||GroupId|||**string**: This is the ID of the product group under which the article is to be classified. The product group must already have been created, otherwise the call is rejected. If this information is omitted, the article is placed at the top level, ungrouped, in the sortiment.
|| ||rateable|||||bool**: If the merchant can specify the rateability of an item in your software, you can transmit this setting to qnips here to keep certain items out of the rating sheets. If your system does not offer a possibility to record the valuability of the items, enter 'zero' in this field or leave it out completely.
|``Description`|**translatable**: If a description exists for the article, it can be transmitted here in several languages. In certain cases this can be displayed to consumers in the app|
|| ||Ingredients||||translatable**: If this information exists, it can be transmitted here in several languages and may be visible to consumers in the app.
|| ||oldOut|||**string**: If an item in your software can be marked as sold out, you should transmit this change of state to qnips via this field. This enables us to hide the article dynamically and promptly in the menu, e.g. in public electronically displayed menus.|
|| ||pictureUrl||||string**: If there is a publicly accessible image for the article via a URL, its URL can be entered here.
|| ||Prices||||List of Price**: Any number of price levels can be specified here, whereby a price level always consists of a 'tag' as a publicly visible identifier and the actual price as a decimal value.|
|| ||List of ints** Here you can specify a list of allergen IDs that are included in the article. See the allergen listing below. |
|``Traces`|||List of ints**: A list of the allergen traces contained in the article can be given here. List here the allergen IDs whose traces may be contained in the article. See the allergen listing below. |
|| ||Additives|||List of ints**: A list of the additives that are required to be identified as a minimum under the LMIV Regulation and that are contained in the article can be given here. See the list of additives below. |
||||||List of strings**: If a merchant has implemented his own individual article labels, which could not be transferred via previous properties, but are still important for one of the qnips functions (e.g. individual article labels in public menus), they can be specified via this list property. |
|| ||WeightInGrams|||**decimal**: If the information exists in your software, you can pass it on to us here. |
|| || Fats'||||**decimal**: Indication of the fat content in grams per 100 grams article weight. |
|| || Carbs|||**decimal**: Indication of the carbohydrate content in grams per 100 grams article weight. |
|| || protein|||**decimal**: Indication of the protein content in grams per 100 grams article weight. |
|| || KJoule|||||decimal**: KJoule per 100 grams article weight. |
|||||| KCal||||**decimal**: KCal per 100 grams article weight. |
#### allergen list
Id|allergens
---|---
0|Gluten-containing grain
1|Crustaceans and products thereof
2| Eggs and egg products
3| Fish and fish products
4| Peanuts and peanut products
5| Soya and soya products
6| Milk and milk products
7| Nuts and nut products
8| Celery and celery products
9| Mustard and mustard products
10| Sesame and sesame products
11| sulphur dioxide and sulphites
12| Lupines and lupine products
13| Molluscs and mollusc products
#### Additives list
Id|additive name
---|---
0| with dye
1| with preservative
2| with antioxidant
3| with flavour enhancer
4| sulphurized
5| blackened
6| waxed
7| with phosphate
8| with sweetener(s)
9| contains a phenylalanine source
10| with nitrate
11| with nitrite pickling salt
12| caffeinated
+ Parameters
+ qnipsSortimentId (string, `'sortiment123'`) ... this is the `qnipsSortimentId' returned by the call to `GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2}`.
+ PLU (string, `A12`) ... enter the PLU of the article to be deleted here.
+ groupId (string, `123`) ... enter the PLU of the product group in which the article to be deleted is located or a '0' if the article is not assigned to a product group
+ Request
+ Headers
DevKey: {Your Key}
TrackingUnitId: {trackingUnitId}
+ response 200
+ response 500
// HTTP-InternalServerError: An unknown problem occurred during processing
{
"ErrorMessage": "some explanation"
"StackTrace": "text"
}
+ response 403
// HTTP-Forbidden: trackingUnitId is not yet activated by the merchant
+ Response 401
// HTTP-Unauthorized: DevKey or trackingUnitId not specified or not available
+ response 400
{
"ErrorId":123,
"ErrorText": "Details of the error"
}
// here all possible error codes incl. texts for this resource
// 12001: qnips sortimentId unknown
// 12006: No item found under specified Id/PLU. Try a POST