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

Retreive information for Pickup Alert Task (CONFALERTPU)

Request Information

URI Parameters

Name	Description	Type	Additional information
UserGUID	Unique system generated user identifier	string	Required
EntityGUID	Unique system generated entity identifier (PickupGUID)	string	Required

Body Parameters

None.

Response Information

Resource Description

TaskPickupAlertResp

Name	Description	Type	Additional information
EntityGUID	Unique system generated entity identifier (PickupGUID)	string	None.
PickupFrom	Pickup from address	string	None.
DeliverTo	Deliver to address	string	None.
Instructions	Pickup instructions	string	None.
NumberOfOrders	Number of orders on pickup	integer	None.
NumberOfPieces	Number of pieces on pickup	integer	None.
TotalWeight	Total weight of all shipments on pickup	decimal number	None.
WeightUOM	Weight unit of measure	string	None.
TrackingNumberDisplay	Tracking number to display	string	None.
Shipments	List of shipments on this pickup alert	Collection of ShipmentToPickup	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",
  "PickupFrom": "sample string 2",
  "DeliverTo": "sample string 3",
  "Instructions": "sample string 4",
  "NumberOfOrders": 5,
  "NumberOfPieces": 6,
  "TotalWeight": 7.0,
  "WeightUOM": "sample string 8",
  "TrackingNumberDisplay": "sample string 9",
  "Shipments": [
    {
      "OrderNumber": "sample string 1",
      "ShipmentGUID": "sample string 2",
      "DeliverTo": "sample string 3",
      "Reference": "sample string 4",
      "Pieces": 5,
      "Weight": 1.0,
      "WeightUOM": "sample string 6",
      "Contents": "sample string 7",
      "Length": 1,
      "Width": 1,
      "Height": 1,
      "SizeUOM": "sample string 8",
      "DeliverToLabel": "sample string 9",
      "ShipmentInfo": "sample string 10",
      "ShipmentSummary": "sample string 11",
      "FinalDelivery": "sample string 12"
    },
    {
      "OrderNumber": "sample string 1",
      "ShipmentGUID": "sample string 2",
      "DeliverTo": "sample string 3",
      "Reference": "sample string 4",
      "Pieces": 5,
      "Weight": 1.0,
      "WeightUOM": "sample string 6",
      "Contents": "sample string 7",
      "Length": 1,
      "Width": 1,
      "Height": 1,
      "SizeUOM": "sample string 8",
      "DeliverToLabel": "sample string 9",
      "ShipmentInfo": "sample string 10",
      "ShipmentSummary": "sample string 11",
      "FinalDelivery": "sample string 12"
    }
  ],
  "IsSuccessful": true,
  "ErrorMessage": "sample string 11"
}

application/xml, text/xml

Sample:

<TaskPickupAlertResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 11</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <DeliverTo>sample string 3</DeliverTo>
  <EntityGUID>sample string 1</EntityGUID>
  <Instructions>sample string 4</Instructions>
  <NumberOfOrders>5</NumberOfOrders>
  <NumberOfPieces>6</NumberOfPieces>
  <PickupFrom>sample string 2</PickupFrom>
  <Shipments>
    <ShipmentToPickup>
      <Contents>sample string 7</Contents>
      <DeliverTo>sample string 3</DeliverTo>
      <DeliverToLabel>sample string 9</DeliverToLabel>
      <FinalDelivery>sample string 12</FinalDelivery>
      <Height>1</Height>
      <Length>1</Length>
      <OrderNumber>sample string 1</OrderNumber>
      <Pieces>5</Pieces>
      <Reference>sample string 4</Reference>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <ShipmentInfo>sample string 10</ShipmentInfo>
      <ShipmentSummary>sample string 11</ShipmentSummary>
      <SizeUOM>sample string 8</SizeUOM>
      <Weight>1</Weight>
      <WeightUOM>sample string 6</WeightUOM>
      <Width>1</Width>
    </ShipmentToPickup>
    <ShipmentToPickup>
      <Contents>sample string 7</Contents>
      <DeliverTo>sample string 3</DeliverTo>
      <DeliverToLabel>sample string 9</DeliverToLabel>
      <FinalDelivery>sample string 12</FinalDelivery>
      <Height>1</Height>
      <Length>1</Length>
      <OrderNumber>sample string 1</OrderNumber>
      <Pieces>5</Pieces>
      <Reference>sample string 4</Reference>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <ShipmentInfo>sample string 10</ShipmentInfo>
      <ShipmentSummary>sample string 11</ShipmentSummary>
      <SizeUOM>sample string 8</SizeUOM>
      <Weight>1</Weight>
      <WeightUOM>sample string 6</WeightUOM>
      <Width>1</Width>
    </ShipmentToPickup>
  </Shipments>
  <TotalWeight>7</TotalWeight>
  <TrackingNumberDisplay>sample string 9</TrackingNumberDisplay>
  <WeightUOM>sample string 8</WeightUOM>
</TaskPickupAlertResp>