GET api/ManifestShipmentData/manifestIds/{auth}?orderStatusCode={orderStatusCode}&shipmentState={shipmentState}&deliveryAlertStatus={deliveryAlertStatus}&minutesSinceAlerted={minutesSinceAlerted}

Get Manifest Shipment ids for ReportManifestForm/ReportInboundAlert Alerts.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

Unique authorization identifier.

string

Required

orderStatusCode

The code corresponding to the workflow order status.

string

Default value is 240

shipmentState

The pl_shipment.State.

string

Default value is AC

deliveryAlertStatus

The code corresponding to the delivery's alert status.

string

Default value is 120

minutesSinceAlerted

Number of minutes since alert associated with status has been sent out.

integer

Default value is 5

Body Parameters

None.

Response Information

Resource Description

GetManifestIdsResp
NameDescriptionTypeAdditional information
isSuccessful

Set to true if method was successful

boolean

None.

errorMessage

The error message if method call was not successful

string

None.

manifestGUIDS

Manifest ids.

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccessful": true,
  "errorMessage": "sample string 2",
  "manifestGUIDS": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<GetManifestIdsResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.GetManifestShipmentData">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <ManifestGUIDS xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ManifestGUIDS>
</GetManifestIdsResp>