Truck Summary

From WMS Wiki
Jump to: navigation, search

Contents

URL

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

Description

This method returns the list of carriers with the truck date and box count under each status.

Request

  • authenticationToken [varchar]
  • dateFrom [date]
  • dateTo [date]

Response

  • status [int]: returns 1 when successful and 0 when unsuccessful.
  • error [varchar]: returns "Invalid Security Token" if status is 0.
  • carriers [array]
    • carrierName [varchar]
    • carrierId [int]
    • truckDate [date]: Format must be mm/dd/yyyy.
    • qtyFarmShipped [int]
    • qtyPQ [int]
    • qtyReceivedMiami [int]
    • qtyShippedMiami [int]
    • totalPieces [int]
    • totalFullBoxEquivalence [decimal]

Example

Request

     http://<wms-url>/api/truck.summary.list?authenticationToken=YOUR_TOKEN&dateFrom=01/10/2012&dateTo=01/10/2012

Response

Successful
  1. {
  2.     "carriers": [
  3.         {
  4.             "qtyFarmShipped": 0,
  5.             "totalFullBoxEquivalence": 0.75,
  6.             "carrierId": 103,
  7.             "totalPieces": 6,
  8.             "carrierName": "Anthony truck",
  9.             "qtyShippedMiami": 6,
  10.             "qtyReceivedMiami": 0,
  11.             "truckDate": "01/10/2012",
  12.             "qtyPQ": 0
  13.         },
  14.         {
  15.             "qtyFarmShipped": 0,
  16.             "totalFullBoxEquivalence": 0.25,
  17.             "carrierId": 51,
  18.             "totalPieces": 1,
  19.             "carrierName": "Prime Truck",
  20.             "qtyShippedMiami": 1,
  21.             "qtyReceivedMiami": 0,
  22.             "truckDate": "01/10/2012",
  23.             "qtyPQ": 0
  24.         },
  25.         {
  26.             "qtyFarmShipped": 0,
  27.             "totalFullBoxEquivalence": 0.125,
  28.             "carrierId": 35,
  29.             "totalPieces": 1,
  30.             "carrierName": "Reliable of Miami Inc.",
  31.             "qtyShippedMiami": 1,
  32.             "qtyReceivedMiami": 0,
  33.             "truckDate": "01/10/2012",
  34.             "qtyPQ": 0
  35.         },
  36.         {
  37.             "qtyFarmShipped": 0,
  38.             "totalFullBoxEquivalence": 0.25,
  39.             "carrierId": 50,
  40.             "totalPieces": 2,
  41.             "carrierName": "Starvann",
  42.             "qtyShippedMiami": 2,
  43.             "qtyReceivedMiami": 0,
  44.             "truckDate": "01/10/2012",
  45.             "qtyPQ": 0
  46.         },
  47.         {
  48.             "qtyFarmShipped": 0,
  49.             "totalFullBoxEquivalence": 0.75,
  50.             "carrierId": 86,
  51.             "totalPieces": 6,
  52.             "carrierName": "West Michigan Floral",
  53.             "qtyShippedMiami": 6,
  54.             "qtyReceivedMiami": 0,
  55.             "truckDate": "01/10/2012",
  56.             "qtyPQ": 0
  57.         }
  58.     ],
  59.     "status": 1
  60. }
Unsuccessful
     {"error":"Invalid Security Token.","status":0}


Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox