POD Receive

From WMS Wiki
Jump to: navigation, search

Contents

URL

http://<wms-url>/api/pod.receive

Description

Method that updates the status of a POD to "Scanned" and sends the email notification for customers that are setup for instant notifications.

Request

  • token [varchar]
  • billOfLadingId [long]
  • filePath [varchar]

Response

  • status [int]: returns 1 when the Bill Of Lading is successfully marked as scanned 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/pod.validate?authenticationToken=YOUR_TOKEN&billOfLadingId=ID&filePath=XXX

Response

Successful
 
     {"message":"Bill Of Lading successfully marked as scanned","status":1}
     {"message":"Bill Of Lading succesfully marked as scanned but notification failed:Bill Of Lading notification was not sent because customer does not have email notifications","status":1}
Unsuccessful
     {"message":"Invalid Security Token.","status":0}
     {"message":"Parameter billOfLadingId is required.","status":0}

Available Methods

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox