GET api/Vendor/SelectTaskOutForDelivery/{UserGUID}/{EntityGUID}

Retrieve information for Out for Delivery Task (OUTFORDEL)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
UserGUID

Unique system generated user identifier

string

Required

EntityGUID

Unique system generated entity identifier (ShipmentGUID)

string

Required

Body Parameters

None.

Response Information

Resource Description

TaskOutForDeliveryResp
NameDescriptionTypeAdditional information
EntityGUID

Shipment global identifier

string

Required

ShipmentNumber

System assigned unique number for shipment

integer

Required

DeliveryAddress

The complete delivery address for display in mobile app

string

None.

UpdatedDeliveryDateTime

The estimated delivery date/time

date

None.

DspDeliveryDateTime

The formatted estimated delivery date/time

string

None.

Pieces

Number of pieces on this shipment

integer

None.

Weight

Total weight of this shipment

decimal number

None.

WeightUOM

Weight unit of measure (LB,KG)

string

None.

IsSuccessful

Used to determine if method call was successful (true) or failure (false)

boolean

Required

ErrorMessage

The error message if method call was not successful

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EntityGUID": "sample string 1",
  "ShipmentNumber": 2,
  "DeliveryAddress": "sample string 3",
  "UpdatedDeliveryDateTime": "2024-09-19T09:18:42.8166459+00:00",
  "DspDeliveryDateTime": "19-Sep-2024 09:18",
  "Pieces": 4,
  "Weight": 1.0,
  "WeightUOM": "sample string 5",
  "IsSuccessful": true,
  "ErrorMessage": "sample string 7"
}

application/xml, text/xml

Sample:
<TaskOutForDeliveryResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 7</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <DeliveryAddress>sample string 3</DeliveryAddress>
  <EntityGUID>sample string 1</EntityGUID>
  <Pieces>4</Pieces>
  <ShipmentNumber>2</ShipmentNumber>
  <UpdatedDeliveryDateTime>2024-09-19T09:18:42.8166459+00:00</UpdatedDeliveryDateTime>
  <Weight>1</Weight>
  <WeightUOM>sample string 5</WeightUOM>
</TaskOutForDeliveryResp>