1. Home
  2. Dokumente
  3. storelogix REST api
  4. Applications
  5. Common

Common

Application: Common

https://<server>/rest/Common/<cmd>?param1=““&param2=””&param3=””…..


Login (GET)

Login for connections with the REST server. No login, no cookies.

Parameter:

username                                 storelogix login user name
password                                 password as used in storelogix
DeviceID                                 Device ID               // From QR Code
LocationID                               Location ID             // From QR Code

 

Returns Json:

{
"ErrorCode": 0,                           // 0 = Ok, >0 Error
"Message": "This is an error message",
"AccessToken": “GHFDT-G6RT7-KI79R“        // Accesstoken for further actions
"SendLogfile": 0                          // 0 or 1 (this item is always optional)
"LanguageID" : "FR",                      // DE, EN, ... 
}
Example: https://<server>/rest/Common/Login?UserName=“MyUserName“&password=”mypassword”&DeviceID="MyDevice1234"&LocationID="Berlin Warehouse"

GetMainMenu (GET)

Get the main menu structure.

Parameter:

AccessToken // Received from „/rest/<application>/Login“

Returns Json:

{
"ErrorCode": 0,                           // 0 = Ok, >0 Error
"Message": "This is an error message",
"MenuItems": [

{"MenuGroup": "PICK",      //Attention: Create the first Group Header
"MenuText": "Single Order Picking",
"MenuIcon": <base64 code>, // or NULL
"MenuIconID": 1,
"GotoScreen": "PickStartScreen",
"Task": "single-order-picking"},

{"MenuGroup": "PICK", 
"MenuText": "Batch Picking", 
"MenuIcon": <base64 code>, 
"MenuIconID": 2,
"GotoScreen": "PickStartScreen",
"Task": "batch-picking" } ,
{"MenuGroup": "PICK", 
"MenuText": "Full Pallet", 
"MenuIcon": <base64 code>, 
"MenuIconID": 3,
"GotoScreen": "PalletPickScreen",
"Task": "pallet-picking" },
{ "MenuGroup": "INCOMING",   //Attention: New Group Header
"MenuText": "Receiving", 
"MenuIcon": <base64 code>, 
"MenuIconID": 4,
"GotoScreen": "GetIncomingGoodsScreen", 
"Task": "get-incoming-goods" },

{ "MenuGroup": "INCOMING", //Same Group Header
"MenuText": "Move to Storage", 
"MenuIcon": <base64 code>, 
"MenuIconID": 5,           // 1 is DEFAULT icon 
"GotoScreen": "MoveToStorageScreen", 
"Task": "move-to-storage" },

{ "MenuGroup": "MOVE", //Attention: New Group Header
"MenuText": "Replenishment", 
"MenuIcon": <base64 code>, 
"MenuIconID": 6,
"GotoScreen": "ReplenishmentScreen", 
"Task": "replenishment" },

{ "MenuGroup": "MOVE", //Same Group Header
"MenuText": "Planned Transport", 
"MenuIcon": <base64 code>, 
"MenuIconID": 7,
"GotoScreen": "PlannedTransportScreen", 
"Task": "planned-transport" },

{ "MenuGroup": "MOVE", //Same Group Header
"MenuText": "Create Transport", 
"MenuIcon": <base64 code>, 
"MenuIconID": 8,
"GotoScreen": "CreateTransportScreen", 
"Task": "create-transport" },

{ "MenuGroup": "Pack", //Attention: New Group Header 
"MenuText": "Pack for Shipping", 
"MenuIcon": <base64 code>, 
"MenuIconID": 9, "GotoScreen": 
"PackScreen", 
"Task": "pack-for-shipping" }, 
{ "MenuGroup": "OUTGOING", //Attention: New Group Header
"MenuText": "Order Consolidation", 
"MenuIcon": <base64 code>, 
"MenuIconID": 10,
"GotoScreen": "OrderConsolidationScreen", 
"Task": "order-consolidation" },

{ "MenuGroup": "OUTGOING", //Same Group Header
"MenuText": "Transport Consolidation", 
"MenuIcon": <base64 code>, 
"MenuIconID": 11,
"GotoScreen": "TransportConsolidationScreen", 
"Task": "transport-consolidation" },

{ "MenuGroup": "OUTGOING", //Same Group Header
"MenuText": "Close for Loading", 
"MenuIcon": <base64 code>, 
"MenuIconID": 12,
"GotoScreen": "CloseForLoadingScreen", 
"Task": "close-for-loading" },

{ "MenuGroup": "OUTGOING", //Same Group Header
"MenuText": "Loading", 
"MenuIcon": <base64 code>, 
"MenuIconID": 13,
"GotoScreen": "LoadingScreen", 
"Task": "loading" },

{ "MenuGroup": "STOCK MANAGEMENT", //Attention: New Group Header
"MenuText": "Stocktaking", 
"MenuIcon": <base64 code>, 
"MenuIconID": 14,
"GotoScreen": "StocktakingScreen", 
"Task": "stocktaking" },

{ "MenuGroup": "STOCK MANAGEMENT", //Same Group Header
"MenuText": "Info Scan", 
"MenuIcon": <base64 code>, 
"MenuIconID": 15,
"GotoScreen": "InfoScanScreen", 
"Task": "info-scan" }

]
}
Example: https://<server>/rest/Common/GetMainMenu?AccessToken=“GHFDT-G6RT7-KI79R“

MenuItemSelected (PUT)

Set the language for the current user. This is bound to the user, not the device.

Parameter:

AccessToken                 // Received from „/rest/<application>/Login“
Task                        // task from GetMainMenu ("get-incoming-goods")

Return Json:

{
"ErrorCode": 0,                              // 0=Ok, >0 Error
"Message" : "Oops!",                         // Errormessage
}

 

Example: https://<server>/rest/Common/MenuItemSelected?AccessToken=“GHFDT-G6RT7-KI79R“&Task=”get-incoming-goods”

SetLanguage (PUT)

Set the language for the current user. This is bound to the user, not the device.

Parameter:

AccessToken                 // Received from „/rest/<application>/Login“
LanguageID                  // "DE", "EN", "FR", "RU"....

Return Json:

{
"ErrorCode": 0,                                  // 0=Ok, >0 Error
"Message" : "Oops!",                         // Errormessage
"TextItems" : [

{"TextID" : "lets_start", "Text" : "LET'S START"},
{"TextID" : "need_picklist_to_start", "Text" : "We need a picklist to start picking"},
...
]
}

 

Example: https://<server>/rest/Common/SetLanguage?AccessToken=“GHFDT-G6RT7-KI79R“&LanguageID=”DE”

Logout (GET)

Close a Session

Parameter:

AccessToken             // Received from „/rest/<application>/Login“

 

Example: https://<server>/rest/Common/Logout?AccessToken=“GHFDT-G6RT7-KI79R“&LanguageID=”DE”

GetSKUImage“ (GET)

Get a product image

Parameter:

AccessToken             // Received from „/rest/<application>/Login“
SKU                          // Article Number

Return Json:

{
"ErrorCode" : 0,           // 0=Ok, >0 Error
"Message" : "Oops!",   // Errormessage
"SKU": "AB1234",           // Article Number (Text)
"ImageType" : "jpg",       // Type of image ("jpg" or "png"), text, empty if no image for SKU
"ImageData", Image data, base64 coded, empty if there is no image for SKU
}

Example: https://<server>/rest/Common/GetSkuImage?AccessToken=“GHFDT-G6RT7-KI79R“&LanguageID=”DE”&SKU="1234578"