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

Retreive information for Pickup Task (PICKUP)

Request Information

URI Parameters

Name	Description	Type	Additional information
UserGUID		string	Required
EntityGUID		string	Required

Body Parameters

None.

Response Information

Resource Description

TaskPickupResp

Name	Description	Type	Additional information
PickupGUID		string	None.
PickupFrom		string	None.
WaitingTime		integer	None.
AttemptCount		integer	None.
QuotedPickupDateTime		date	None.
NextTaskName		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",
  "WaitingTime": 1,
  "AttemptCount": 1,
  "QuotedPickupDateTime": "2024-09-19T09:15:41.9463686+00:00",
  "NextTaskName": "sample string 3",
  "IsSuccessful": true,
  "ErrorMessage": "sample string 5"
}

application/xml, text/xml

Sample:

<TaskPickupResp 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>
  <AttemptCount>1</AttemptCount>
  <NextTaskName>sample string 3</NextTaskName>
  <PickupFrom>sample string 2</PickupFrom>
  <PickupGUID>sample string 1</PickupGUID>
  <QuotedPickupDateTime>2024-09-19T09:15:41.9463686+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>
  <WaitingTime>1</WaitingTime>
</TaskPickupResp>