Truck Summary by Location

From WMS Wiki
Jump to: navigation, search

Contents

URL

http://<wms-url>/api/truck.summary.location.list

Description

Returns the list of consignees that are being shipped on a truck on a specific date with the box count for each status.

Request

  • authenticationToken [varchar]
  • carrierId [int]
  • truckDate [date]

Response

  • status [int]: returns 1 when successful and 0 when unsuccessful.
  • error [varchar]: returns "Invalid Security Token" if status is 0.
  • locations [array]
    • consigneeId [int]
    • consignee [varchar]
    • groupId [int]
    • group [varchar]
    • qtyFarmShipped
    • qtyPQ [int]
    • qtyReceivedMiami [int]
    • qtyShippedMiami [int]
    • totalFullBoxEquivalence [double]
    • totalPieces [int]

Example

Request

     http://<wms-url>/truck.summary.location.list?authenticationToken=YOUR_TOKEN&truckDate=01/10/2012&carrier=103

Response

Successful
  1. {
  2.     "locations": [
  3.         {
  4.             "consigneeId": 18486,
  5.             "groupId": 18112,
  6.             "qtyFarmShipped": 0,
  7.             "totalFullBoxEquivalence": 0.125,
  8.             "consignee": "FLOWER WHOLESALER, INC.",
  9.             "totalPieces": 1,
  10.             "qtyShippedMiami": 1,
  11.             "qtyReceivedMiami": 0,
  12.             "group": "FLOWERS FROM THE SOUTH",
  13.             "qtyPQ": 0
  14.         },
  15.         {
  16.             "consigneeId": 18757,
  17.             "groupId": 18112,
  18.             "qtyFarmShipped": 0,
  19.             "totalFullBoxEquivalence": 0.625,
  20.             "consignee": "AWESOME ROSES LLC",
  21.             "totalPieces": 5,
  22.             "qtyShippedMiami": 5,
  23.             "qtyReceivedMiami": 0,
  24.             "group": "FLOWERS FROM THE SOUTH",
  25.             "qtyPQ": 0
  26.         }
  27.     ],
  28.     "status": 1
  29. }
Unsuccessful
     {"error":"Invalid Security Token.","status":0}


Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox