Customer List

From WMS Wiki
Jump to: navigation, search

Contents

URL

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

Description

Returns the list of customers that are associated with the API user.

Request

  • authenticationToken [varchar]

Response

  • status [int]: returns 1 when successful and 0 when unsuccessful.
  • error [varchar]: returns "Invalid Security Token" if status is 0.
  • customers [array]: returns an array with the customer id, name and code.
    • customerId [int]
    • customerCode [varchar] (If sending shipment XML files please use this as the customer code)
    • customerName [varchar]
    • phone [varchar]
    • fax [varchar]
    • armelliniAccount [varchar]
    • street [varchar]
    • city [varchar]
    • state [varchar]
    • zipCode [varchar]
    • country [varchar]
    • email [varchar]

Example

Request

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

Response

Successful
  1. {
  2.     "customers": [
  3.         {
  4.             "customerName": "Vertical Technologies",
  5.             "customerId": 472,
  6.             "customerCode": "VT",
  7.             "phone": "786-206-0554",
  8.             "fax": "(305) 328-5063",
  9.             "armelliniAccount": "F002123",
  10.             "street": "951 Brickell Avenue #3210",
  11.             "city": "Miami",
  12.             "state": "FL",
  13.             "zipCode": "33131",
  14.             "country": "USA",
  15.             "email": "sales@vertical-tech.com"
  16.         },
  17.         {
  18.             "customerName": "Customer1",
  19.             "customerId": 473,
  20.             "customerCode": "C1",
  21.             "phone": "786-206-0554",
  22.             "fax": "(305)328-5063",
  23.             "armelliniAccount": "F002123",
  24.             "street": "951BrickellAvenue#3210",
  25.             "city": "Miami",
  26.             "state": "FL",
  27.             "zipCode": "33131",
  28.             "country": "USA",
  29.             "email":"info@customer1.com"
  30.         },
  31.         {
  32.             "customerName": "Customer2",
  33.             "customerId": 474,
  34.             "customerCode": "C2",
  35.             "phone": "786-206-0554",
  36.             "fax": "(305)328-5063",
  37.             "armelliniAccount": "F002123",
  38.             "street": "951BrickellAvenue#3210",
  39.             "city": "Miami",
  40.             "state": "FL",
  41.             "zipCode": "33131",
  42.             "country": "USA",
  43.             "email":""
  44.         }
  45.     ],
  46.     "status": 1
  47. }

Bulb.png Your user must be associated with customers in the WMS. If you don't get any customers then check with a WMS admin.

Unsuccessful
     {"error":"Invalid Security Token.","status":0}


Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox