Create Carrier

From WMS Wiki
Jump to: navigation, search

Contents

URL

http://<wms-url>/api/carrier.put

Description

Create a carrier into system.

Request

  • authenticationToken [varchar] [required]
  • carrierCode [varchar] [required]
  • carrierName [varchar] [required]
  • phone [varchar]
  • fax [varchar]
  • cutOff [varchar]
  • contactName [varchar]
  • contactPhone [varchar]
  • email [varchar]
  • mobile [varchar]
  • street [varchar]
  • city [varchar]
  • state [varchar]
  • zipCode [varchar]
  • country [varchar]

Response

  • status [int]: returns 1 when the carrier is successfully saved into the system.
  • message [varchar]: description of the result.
  • error [varchar]: error message returned when status is 0. It can be "Invalid Security Token" if token is invalid, if someone of the parameters is not valid or if some error occurs in the process.

Example

Request

http://<wms-url>/api/carrier.put?authenticationToken=o814vor93b8ji40cd8ea9ostuu
&carrierCode=XYZ
&carrierName=Test
&phone=4452111
&fax=4452111
&cutOff=1052
&contactName=Vertical Tech
&contactPhone=2685252
&email=noreply@vertical-tech.com
&mobile=320855325
&street=Str 52 96-63
&city=Miami
&state=Florida
&zipCode=000000
&country=United States

Response

Successful
     {"error":"","message":"Carrier saved succesfully.","status":1}
Unsuccessful
     {"error":"Invalid Security Token.","message":"","status":0}
     {"error":"Carrier code is required.","message":"","status":0}
     {"error":"Carrier name is required.","message":"","status":0}
     {"error":"Email is invalid.","message":"","status":0}
     {"error":"Carrier code is duplicated.","message":"","status":0}     
     {"error":"Carrier not saved.","message":"","status":0}


Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox