Carrier List

From WMS Wiki
Jump to: navigation, search

Contents

URL

http://<wms-url>/api/carriers.list

Description

Gets a list of carriers available in the system with their cutoff times in EST. The hour format is HHMM (example: 1000 for 10am, 1030 for 10:30am).

Request

  • authenticationToken [varchar]

Response

  • status [int]: returns 1 when successful and 0 when unsuccessful.
  • error [varchar]: returns "Invalid Security Token" if status is 0.
  • carriers [array]: returns an array with the carrier Id, name and code.
    • carrierId [int]
    • carrierName [varchar]
    • carrierCode [varchar]
    • cutoffTime [varchar]

Example

Request

     http://<wms-url>/api/carriers.list?authenticationToken=rl52rgk7o2sa8njg9i0ttgsepl

Response

Successful
  1. {
  2.     "carriers": [
  3.         {
  4.             "cutoffTime": "1000",
  5.             "carrierId": 91,
  6.             "carrierName": "3D Flowers",
  7.             "carrierCode": "3D"
  8.         },
  9.         {
  10.             "cutoffTime": "1300",
  11.             "carrierId": 4,
  12.             "carrierName": "AA - American Airlines",
  13.             "carrierCode": "AA"
  14.         }
  15.     ],
  16.     "status": 1
  17. }
Unsuccessful
     {"error":"Invalid Security Token.","status":0}


Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox