Application: Packing
Version 1.6 13.11.2019
GetNextPackList (GET):
Get a new list for packing one customer order with multiple items.
Parameter
AccessToken // Received from „/rest/Picklist/Login“
ContainerNumber // Container with collected items (Shopping Cart)
Return Json:
{
"ErrorCode" : 0, // 0=Ok, >0 Error
"Message": "Oops!", // an error message
"Customer" : "John Doe", // The name of the customer for this order
"OrderNumber" : 12298, //Number of customer order, if empty then there is currently nothing to do
"Carrier" : "UPS", // The name of the carrier for shipping (DHL, UPS, Hermes...)
"ShippingBoxType" : "Box", // Type of packing container (palette, shipping box...)
"BoxScanRequired" : 1, //
"Items":
[
{
"ItemID" : 12, // id of the Item (Number)
"ArticleText" : "Budweiser Beer", // Article Text, e.g. Name (Text)
"SKU" : "123456", // Article Number (Text)
"Quantity" : 12, // How many pieces to pick (Number)
"Barcode" : [
"123456", "XYZ789086", "GH7897"
], // Barcode array, Article Barcode, EAN13 (Array of text)
"ItemScanRequired" : 1 // 0 or 1. No manual increasing of item count
"HintText" : "Gift Box", // Hint text for this position
"ImageAvailable" : "1" // 0 or 1
}
]
}
Example: https://<server>/rest/Packing/GetNextPacklist?AccessToken=“GHFDT-G6RT7-KI79R“&Containernumber="123456"
CheckPackingBoxBarcode (GET)
Check the barcode of the box where the packer puts items, for example a shipping box
Parameter:
AccessToken Get from „/rest/Picklist/Login“
Barcode Scanned Barcode (Text)
BarcodeType Type of scanned barcode (from Scan Engine): EAN13, EAN128, CODE128, OTHER
Return Json:
{
"ErrorCode" : 0, // 0=Ok, >0 Error (Number)
"Message" : "Oops!", // Some error message (Text)
"PackingBoxNumber" : "ABCD123456" // Packing box number from scan (Text)
}
Example: https://<server>/rest/Packing/CheckPackingBoxBarcode?AccessToken=“GHFDT-G6RT7-KI79R“&Barcode="XY1234567"&BarcodeType="CODE128"
FinishShippingBox (POST)
Parameter:
AccessToken Get from „/rest/Picklist/Login“ Json in Body { "OrderNumber" : "12298", // Number of customer order, - > GetNextPackList.OrderNumber "ShippingBoxType" : "Box 5", // Type of packing container (palette, shipping box...) "Carrier" : "UPS", // The name of the carrier for shipping (DHL, UPS, Hermes...) "Items": [ // List of Items in the box { "ItemID" : 2, // id of the Item (Number) -> GetNextPackList.Items[].ItemID "SKU" : "123456", // Article Number (Text) -> GetNextPackList.Items.SKU "Quantity" : 1 // How many pieces in the box (Number) }, { "ItemID" : 4, // id of the Item (Number) -> GetNextPackList.Items[].ItemID "SKU" : "12367568-456", // Article Number (Text) -> GetNextPackList.Items[].SKU "Quantity" : 2 // How many pieces in the box (Number) } ] }
Return Json
{ "ErrorCode" : 0, // 0=Ok, >0 Error (Number) "Message" : "Oops!" // Some error message (Text) "Label": // Shippinglabel to print for this shipping box { "Type": "ZPL", // PDF, ZPL, PNG (ZPL is native printer language for label printers) "Content": <base64> }, "Page": [ //List of documentes to print for this shipping box { "Type": "PDF", "Description": "Delivery Note", "Contend":<base64> }, { "Type": "PDF", "Description": "Customs declaration of contents", "Contend":<bas64> }, { "Type":"PDF", "Description":"Invoice", "Content":<base64> } ] }
Example: https:///rest/Picklist/FinishShippingBox?AccessToken=“GHFDT-G6RT7-KI79R"
GetAbortSelection (GET)
This function provided a list of reasons why the packer aborts the packing process
Parameter:
AccessToken // Received from "/rest/Picklist/Login" ContainerNumber // Container with collected items (Shopping Cart), Get from Parameter "ContainerNumber" while call "/rest/Packing/GetNextPackList"
Return Json:
{ "ErrorCode" : 0, // 0=Ok, >0 Error "Message": "Oops!", // an error message "Items": [ { "ReasonText" : "Missing article", // Text to be displayed "ReasonCode" : "Missing" // The reason that is returned via the request AbortPacking-> "AbortReason" }, { "ReasonText" : "Article demaged", "ReasonCode" : "Damaged" } ] }
Example: https://<server>/rest/Packing/GetAbortPackingSelection?AccessToken="GHFDT-G6RT7-KI79R"&ContainerNumber="501000997"
AbortPacking (POST)
The user aborts the packing process in the middle of working on an order
Parameter:
AccessToken // Get from "/rest/Picklist/Login" ContainerNumber // Container with collected items (Shopping Cart), Get from Parameter "ContainerNumber" while call "/rest/Packing/GetNextPackList"
Json in Body
{
"AbortReason" : "Some Text" // Why was the packing process aborted prematurely, Selection comes from „/rest/Packing/GetAbortSelection ReasonCode"
}
Return Json { "ErrorCode" : 0, // 0=Ok, >0 Error (Number) "Message" : "Oops!" // Some error message (Text) }
Example: https://<server>/rest/Packing/AbortPacking?AccessToken="GHFDT-G6RT7-KI79R"&ContainerNumber="501000997"