Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

DELETE sortiments/{qnipsSortimentId}/group/{Id}} · Web API v3 · Deutsch

API-ReferenzWeb API v3 · Deutschsortiments

DELETE sortiments/{qnipsSortimentId}/group/{Id}}

Web API v3 · Deutsch v3sortiments
Aktualität laut Confluence unklar. Die englische POS API v3 ist die aktuelle Referenz.
DELETE/sortiments/{qnipsSortimentId}/group/{Id}

Warengruppen sind wie folgt aufgebaut:


    {
       "Id":”123”,
       "UpGroupId":"234",
       "Name":[
            { "lang":"de-DE", "val":"Getränke" }, 
            { "lang":"de-CH", "val":"Getränke" }, 
            { "lang":"it-CH", "val":"Bevande" },
            { "lang":"fr-UK", "val":"Boissons" }
        ]
    }
Property Beschreibung
Id string: Das ist der eindeutige Identifier für diese Warengruppe. Er kann als UpGroupId von einer anderen Warengruppe referenziert werden, wodurch eine beliebig tief geschachtelte Warengruppen-Hierarchie abgebildet werden kann.
UpGroupId string: Ist diese Warengruppe eine Gruppe auf oberster Ebene, ist diese Angabe nicht erforderlich. Sonst geben Sie hier den Identifier der Warengruppe, welcher diese Einheit untergeordnet werden soll.
Name translatable: Hier kann der Name der Warengruppe in beliebig vielen Übersetzungen im Format, das weiter unten beschrieben wird, angegeben werden. Bitte geben Sie den Namen stets mindestens in einer Sprache an.
Übersetzbare Properties (translatable)

Manche String-Properties von einigen Entitäten, wie z.B. der Name eines Artikels im Sortiment kann unser System in mehreren Übersetzungen entgegennehmen. In dieser Dokumentation sind solche Properties als translatable markiert. Die Übergabe der Werte für solche Properties ist immer als eine Liste von Translatable-Objekten zu erfolgen. Im lang-Property des Translatable-Objekts ist der Language-Tag nach RFC 5646 und die Übersetzung des Wertes in der entsprechenden Sprache im val-Feld anzugeben.

JSON-Beispiel:


    "Name":[
        { "lang":"de-DE", "val":"Getränke" }, 
        { "lang":"de-CH", "val":"Getränke" }, 
        { "lang":"it-CH", "val":"Bevande" },
        { "lang":"fr-UK", "val":"Boissons" }
    ]

Parameter

qnipsSortimentIdstringErforderlich

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

Beispiel: 'sortiment123'
IdstringErforderlich

geben Sie hier die PLU des zu löschenden Artikels oder die Id der zu löschenden Warengruppe an.

Beispiel: 'A12'

Request-Header

DevKey
{Ihr Key}
TrackingUnitId
{trackingUnitId}
Originaler Blueprint-Ausschnitt
API Blueprint
### DELETE sortiments/{qnipsSortimentId}/group/{Id}} [DELETE]
Warengruppen sind wie folgt aufgebaut:

<pre>
<code>
    {
       "Id":”123”,
       "UpGroupId":"234",
       "Name":[
            { "lang":"de-DE", "val":"Getränke" }, 
            { "lang":"de-CH", "val":"Getränke" }, 
            { "lang":"it-CH", "val":"Bevande" },
            { "lang":"fr-UK", "val":"Boissons" }
        ]
    }
</code>
</pre>

| Property | Beschreibung |
| --- | --- |
|`Id`|**string**: Das ist der eindeutige Identifier für diese Warengruppe. Er kann als `UpGroupId` von einer anderen Warengruppe referenziert werden, wodurch eine beliebig tief geschachtelte Warengruppen-Hierarchie abgebildet werden kann. |
|`UpGroupId`|**string**: Ist diese Warengruppe eine Gruppe auf oberster Ebene, ist diese Angabe nicht erforderlich. Sonst geben Sie hier den Identifier der Warengruppe, welcher diese Einheit untergeordnet werden soll.|
|`Name`|**translatable**: Hier kann der Name der Warengruppe in beliebig vielen Übersetzungen im Format, das weiter unten beschrieben wird, angegeben werden. Bitte geben Sie den Namen stets mindestens in einer Sprache an. |

#### Übersetzbare Properties (`translatable`)
Manche String-Properties von einigen Entitäten, wie z.B. der Name eines Artikels im Sortiment kann unser System in mehreren Übersetzungen entgegennehmen. 
In dieser Dokumentation sind solche Properties als `translatable` markiert. Die Übergabe der Werte für solche Properties ist immer als eine Liste von
Translatable-Objekten zu erfolgen. Im `lang`-Property des Translatable-Objekts ist der Language-Tag nach [RFC 5646]() und die Übersetzung des Wertes 
in der entsprechenden Sprache im `val`-Feld anzugeben.

JSON-Beispiel:

<pre>
<code>
    "Name":[
        { "lang":"de-DE", "val":"Getränke" }, 
        { "lang":"de-CH", "val":"Getränke" }, 
        { "lang":"it-CH", "val":"Bevande" },
        { "lang":"fr-UK", "val":"Boissons" }
    ]
</code>
</pre>

+ Parameters
    + qnipsSortimentId (string, `'sortiment123'`) ... das ist die `qnipsSortimentId`, die beim Call auf `GET sortiments?thirdPartySortimentIdentifier={string1}&name={string2}` zurückgeliefert wurde. 
    + Id (string, `'A12'` ) ...  geben Sie hier die PLU des zu löschenden Artikels oder die Id der zu löschenden Warengruppe an.

+ 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":12000,
            "ErrorText":"Details zum Fehler"
        }
        
        // hier alle möglichen ErrorCodes inkl. Texte für diese Ressource
        // 12001: qnipsSortimentId unbekannt
        // 12006: Kein Item unter angegebener Id gefunden