POST trackingUnits · Web API v3 · Entwurf

POST trackingUnits

Web API v3 · Entwurf v3trackingUnits

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

POST/trackingUnits

Mit diesem Call können Sie die Standortinformationen der trackingUnit hochladen, sofern in Ihrem System verfügbar. Dies wird dazu führen, dass mit den übermittelten Adressdaten ggf. eine neue Filial-Einheit im menio-System angelegt und die trackingUnit dieser automatisch zugeordnet wird. Bei jedem Call werden die Werte in city, street und postalIndex mit den zuvor für diese trackingUnit abgespeicherten Werten verglichen. Unterscheiden sich diese, wird die trackingUnit automatisch in die neue Filiale verknüpft.

Parameter des Body-Objekts

Name	Beschreibung
`instanceName`	string : optional - Lesbarer Name, unter welchem diese Unit im menio Merchant Portal für den merchant sichtbar sein wird, z.B. „Kasse im Gang 5“
`city`	string : optional - Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird
`street`	string : optional - Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird
`postalIndex`	string : optional - Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird

Request-Header

Content-Type

application/json

DevKey

{Ihr Key}

TrackingUnitId

{trackingUnitId}

Originaler Blueprint-Ausschnitt

API Blueprint

### POST trackingUnits [POST]
Mit diesem Call können Sie die Standortinformationen der trackingUnit hochladen, sofern in Ihrem System verfügbar. Dies wird dazu führen, 
dass mit den übermittelten Adressdaten ggf. eine neue Filial-Einheit im Qnips-System angelegt und die trackingUnit dieser automatisch zugeordnet wird.
Bei jedem Call werden die Werte in city, street und postalIndex mit den zuvor für diese trackingUnit abgespeicherten Werten verglichen. 
Unterscheiden sich diese, wird die trackingUnit automatisch in die neue Filiale verknüpft.

#### Parameter des Body-Objekts

| Name | Beschreibung |
| ---    | --- |
|`instanceName`|**string : optional** - Lesbarer Name, unter welchem diese Unit im Qnips Merchant Portal für den merchant sichtbar sein wird, z.B. „Kasse im Gang 5“|
|`city`|**string : optional** -  Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird|
|`street`|**string : optional** -  Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird|
|`postalIndex`|**string : optional** -  Angabe zum Filialstandort, in welchem diese trackingUnit betrieben wird|

+ Request

    + Headers

            Content-Type: application/json
            DevKey: {Ihr Key}
            TrackingUnitId: {trackingUnitId}

    + Body

            {
               "instanceName":"Filiale 5 - Kasse Gang 1",
               "city":"Hannover",
               "street":"Weidendamm 8",
               "postalIndex":"30167",
            }

+ Response 200

+ Response 500

        // HTTP-InternalServerError: Ein unbekannten Problem bei der Verarbeitung aufgetreten

+ 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

Request

cURL

curl --request POST \
  'http://pos.dev.qnips.com/api/pos/v3/trackingUnits' \
  --header 'Content-Type: application/json' \
  --header 'DevKey: {YOUR_DEV_KEY}' \
  --header 'TrackingUnitId: {trackingUnitId}' \
  --data-raw '{
   "instanceName":"Filiale 5 - Kasse Gang 1",
   "city":"Hannover",
   "street":"Weidendamm 8",
   "postalIndex":"30167",
}
'

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

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