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

Retrieve information for En Route To Pickup Task (INROUTEPU).

Request Information

URI Parameters

Name	Description	Type	Additional information
UserGUID	Unique user global identifier	string	Required
EntityGUID	Identifier of the entity that is related to the task	string	Required

Body Parameters

None.

Response Information

Resource Description

TaskInRouteToPickupResp

Name	Description	Type	Additional information
PickupGUID		string	None.
PickupFrom		string	None.
QuotedPickupDateTime		date	None.
QuotedDateTimeDisplay		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.
Shipments		Collection of ShipmentToPickup	None.

Response Formats

application/json, text/json

Sample:

{
  "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"
    }
  ],
  "PickupGUID": "sample string 1",
  "PickupFrom": "sample string 2",
  "QuotedPickupDateTime": "2024-09-19T09:10:01.4503513+00:00",
  "QuotedDateTimeDisplay": "sample string 3",
  "IsSuccessful": true,
  "ErrorMessage": "sample string 5"
}

application/xml, text/xml

Sample:

<TaskInRouteToPickupResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 5</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <PickupFrom>sample string 2</PickupFrom>
  <PickupGUID>sample string 1</PickupGUID>
  <QuotedDateTimeDisplay>sample string 3</QuotedDateTimeDisplay>
  <QuotedPickupDateTime>2024-09-19T09:10:01.4503513+00:00</QuotedPickupDateTime>
  <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>
</TaskInRouteToPickupResp>