Pass Through Call to Dispatch's "Get Shipment Info" API

This RESTified API will perform a pass-through call to the Dispatch sub-system's "Get Shipment Info" API (when configured).

URL

PUT /up/v5/rest/dispatch/getShipmentInfo

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Dispatch"Get Shipment Info" API.

GetShipmentInfo Object Format

js

GetShipmentInfo Object Properties

Property	Type	Required?	Description	DispatchField Mapping
`Id`	`string`	No	Pass through parameter to the Dispatch"Get Shipment Info" API.	`CallNo`

HTTP Response

Success

On success, a JSON-formatted version of the Dispatch"Get Shipment Info" API response will be returned.

js

Error

On error, a JSON-formatted version of the Dispatch"Get Shipment Info" API response will be returned.

js

Return Codes

In addition to the Standard Return Codes, and the DispatchError codes, individual API calls made have unique codes found on their individual pages.

Browser not supported