POST api/Vendor/UpdateTaskPickup

Update information for Pickup Task (PICKUP)

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGUID	Unique system assigned user identifier	string	None.
ShipmentGUIDList	Comma separated list of shipment identifier to mark picked-up	string	None.
WaitingTime	Waiting time at pickup in minutes	string	None.
Attempts	Number of attempts at pickup	string	None.
Comment	Comment from the ground agent	string	None.
LocationData	Geolocation provided at time task is completed	string	None.
IsNextTask	true=driver is departed to airport(air) or out for delivery(ground), false=(default)	boolean	None.
Weight	The weight of the shipment picked-up (used only if ShipmentGUIDList has one shipment)	decimal number	None.
WeightUOM	Weight unit of measure (KG,LB) (used only if ShipmentGUIDList has one shipment)	string	None.
Length	Length of the shipment (used only if ShipmentGUIDList has one shipment)	integer	None.
Width	Width of the shipment (used only if ShipmentGUIDList has one shipment)	integer	None.
Height	Height of the shipment (used only if ShipmentGUIDList has one shipment)	integer	None.
SizeUOM	Size unit of measure (CM,IN) (used only if ShipmentGUIDList has one shipment)	string	None.
Signature	The text signature	string	None.
SignatureImage	The signature image (base64)	string	None.
Photos	List of photo images (base64)	Collection of string	None.
Shipments	Provided values for each shipment (weight, length, width, height are only fields updated)	Collection of ShipmentToPickup	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "ShipmentGUIDList": "sample string 2",
  "WaitingTime": "sample string 3",
  "Attempts": "sample string 4",
  "Comment": "sample string 5",
  "LocationData": "sample string 6",
  "IsNextTask": true,
  "Weight": 1.0,
  "WeightUOM": "sample string 8",
  "Length": 1,
  "Width": 1,
  "Height": 1,
  "SizeUOM": "sample string 9",
  "Signature": "sample string 10",
  "SignatureImage": "sample string 11",
  "Photos": [
    "sample string 1",
    "sample string 2"
  ],
  "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"
    }
  ]
}

application/xml, text/xml

Sample:

<TaskPickupParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <Attempts>sample string 4</Attempts>
  <Comment>sample string 5</Comment>
  <Height>1</Height>
  <IsNextTask>true</IsNextTask>
  <Length>1</Length>
  <LocationData>sample string 6</LocationData>
  <Photos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Photos>
  <ShipmentGUIDList>sample string 2</ShipmentGUIDList>
  <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>
  <Signature>sample string 10</Signature>
  <SignatureImage>sample string 11</SignatureImage>
  <SizeUOM>sample string 9</SizeUOM>
  <UserGUID>sample string 1</UserGUID>
  <WaitingTime>sample string 3</WaitingTime>
  <Weight>1</Weight>
  <WeightUOM>sample string 8</WeightUOM>
  <Width>1</Width>
</TaskPickupParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	Description	Type	Additional information
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:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>