Box Availability

From WMS Wiki
Jump to: navigation, search

Contents

URL

http://<wms-url>/api/box.availability.list

Description

Gets the list of boxes that have a FS (farm shipped) and RM (received Miami) status and no customer, ship date and carrier assigned. These are the boxes that are available as open market inventory.

Request

  • authenticationToken [varchar]

Response

  • status [int]: returns 1 when successful and 0 when unsuccessful.
  • error [varchar]: returns "Invalid Security Token" if status is 0.
  • boxes [array]: returns the box Id, status Id and box code (the bar code label value) for each box.
    • boxId [int]: this is the internal code used by the WMS to identify the box.
    • boxStatusId [int]
    • boxCode [varchar]: this is the external code (the one sent by the grower or the Cargo Agent) used to identify the box. This is the code that is printed in the barcode.
    • boxPosition [varchar]: the physical rack location of the box in the warehouse. This information will only be available if the warehouse is scanning the rack location when storing the boxes.
    Bulb.png If the boxes are entered directly into the AWB Shipping section of the WMS then the box code and the box Id will be the same.  
       This only happens when growers manually enter the shipment information into the WMS.  If the shipment is loaded via an XML file then
       the box code will represent the barcode sent by the grower.

Example

Request

     http://<wms-url>/api/box.availability.list?authenticationToken=38qkkq6p8hc2b41et342hk5q4o

Response

Successful
  1. {
  2.     "boxes": [
  3.         {
  4.             "boxId": 426236,
  5.             "boxCode": "1369915",
  6.             "boxStatusId": 2,
  7.             "boxPosition": "A 05"
  8.         },
  9.         {
  10.             "boxId": 512179,
  11.             "boxCode": "1429454",
  12.             "boxStatusId": 2,
  13.             "boxPosition": "A 06"
  14.         },
  15.         {
  16.             "boxId": 512180,
  17.             "boxCode": "1429455",
  18.             "boxStatusId": 2,
  19.             "boxPosition": "A 07"
  20.         },
  21.         {
  22.             "boxId": 538658,
  23.             "boxCode": "1447211",
  24.             "boxStatusId": 2,
  25.             "boxPosition": ""
  26.         }
  27.     ],
  28.     "status": 1
  29. }
Unsuccessful
     {"error":"Invalid Security Token.","status":0}


Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox