POST api/Pickup

Request Information

URI Parameters

None.

Body Parameters

PickupParm
NameDescriptionTypeAdditional information
auth

string

None.
PickupGUID

string

None.
PickupNumber

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "auth": "sample string 1",
  "PickupGUID": "sample string 2",
  "PickupNumber": 1
}

application/xml, text/xml

Sample: 
<PickupParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <PickupGUID>sample string 2</PickupGUID>
  <PickupNumber>1</PickupNumber>
  <auth>sample string 1</auth>
</PickupParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PickupResp
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.
ErrorMessage

string

None.
Pickups

Collection of PickupItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Pickups": [
    {
      "PickupGUID": "sample string 1",
      "PickupNumber": 2,
      "CompanyID": 3,
      "OfficeID": 4,
      "DispatchOfficeID": 1,
      "State": "sample string 5",
      "Status": 6,
      "OrderByName": "sample string 7",
      "OrderByPhone": "sample string 8",
      "OrderByFax": "sample string 9",
      "OrderByEmail": "sample string 10",
      "CustomerID": 11,
      "AddressID": 1,
      "AddressCode": "sample string 12",
      "CompanyName": "sample string 13",
      "Address1": "sample string 14",
      "Address2": "sample string 15",
      "Address3": "sample string 16",
      "CityName": "sample string 17",
      "StateProvID": "sample string 18",
      "PostalCode": "sample string 19",
      "CountryID": "sample string 20",
      "TimezoneID": "sample string 21",
      "PhoneNumber": "sample string 22",
      "AfterHoursNumber": "sample string 23",
      "FaxNumber": "sample string 24",
      "EmailAddress": "sample string 25",
      "PersonToSee": "sample string 26",
      "ReadyDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "CloseDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "SchedPickupDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "SchedPickupDateTimeUTC": "2025-12-03T12:35:59.4085121+00:00",
      "UpdatedPickupDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "UpdatedPickupDateTimeUTC": "2025-12-03T12:35:59.4085121+00:00",
      "ActualPickupArrival": "2025-12-03T12:35:59.4085121+00:00",
      "ActualPickupDepart": "2025-12-03T12:35:59.4085121+00:00",
      "WaitingTime": 1,
      "AttemptCount": 1,
      "AirportID": "sample string 30",
      "Distance": 31,
      "DistanceUOM": "sample string 32",
      "Instructions": "sample string 33",
      "CourierID": 1,
      "CourierKey": "sample string 34",
      "CourierName": "sample string 35",
      "CourierPhoneNumber": "sample string 36",
      "CourierServiceID": 1,
      "AlertStatus": 37,
      "AlertVia": "sample string 38",
      "AlertHow": "sample string 39",
      "AlertUserID": 1,
      "AlertUserName": "sample string 40",
      "SpokeWith": "sample string 41",
      "SentDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "AcceptedDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "ActualWaitingTime": 1,
      "ActualAttemptCount": 1,
      "ActualDistance": 42,
      "ActualDistanceUOM": "sample string 43",
      "ActualWeight": 1.0,
      "ActualWeightUOM": "sample string 44",
      "InsertUserID": 45,
      "InsertDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "UpdateUserID": 1,
      "UpdateDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "Residential": true,
      "DisplayAddress": "sample string 48",
      "DisplayTime": "sample string 49",
      "DisplayStatus": "sample string 50",
      "LockCost": true
    },
    {
      "PickupGUID": "sample string 1",
      "PickupNumber": 2,
      "CompanyID": 3,
      "OfficeID": 4,
      "DispatchOfficeID": 1,
      "State": "sample string 5",
      "Status": 6,
      "OrderByName": "sample string 7",
      "OrderByPhone": "sample string 8",
      "OrderByFax": "sample string 9",
      "OrderByEmail": "sample string 10",
      "CustomerID": 11,
      "AddressID": 1,
      "AddressCode": "sample string 12",
      "CompanyName": "sample string 13",
      "Address1": "sample string 14",
      "Address2": "sample string 15",
      "Address3": "sample string 16",
      "CityName": "sample string 17",
      "StateProvID": "sample string 18",
      "PostalCode": "sample string 19",
      "CountryID": "sample string 20",
      "TimezoneID": "sample string 21",
      "PhoneNumber": "sample string 22",
      "AfterHoursNumber": "sample string 23",
      "FaxNumber": "sample string 24",
      "EmailAddress": "sample string 25",
      "PersonToSee": "sample string 26",
      "ReadyDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "CloseDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "SchedPickupDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "SchedPickupDateTimeUTC": "2025-12-03T12:35:59.4085121+00:00",
      "UpdatedPickupDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "UpdatedPickupDateTimeUTC": "2025-12-03T12:35:59.4085121+00:00",
      "ActualPickupArrival": "2025-12-03T12:35:59.4085121+00:00",
      "ActualPickupDepart": "2025-12-03T12:35:59.4085121+00:00",
      "WaitingTime": 1,
      "AttemptCount": 1,
      "AirportID": "sample string 30",
      "Distance": 31,
      "DistanceUOM": "sample string 32",
      "Instructions": "sample string 33",
      "CourierID": 1,
      "CourierKey": "sample string 34",
      "CourierName": "sample string 35",
      "CourierPhoneNumber": "sample string 36",
      "CourierServiceID": 1,
      "AlertStatus": 37,
      "AlertVia": "sample string 38",
      "AlertHow": "sample string 39",
      "AlertUserID": 1,
      "AlertUserName": "sample string 40",
      "SpokeWith": "sample string 41",
      "SentDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "AcceptedDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "ActualWaitingTime": 1,
      "ActualAttemptCount": 1,
      "ActualDistance": 42,
      "ActualDistanceUOM": "sample string 43",
      "ActualWeight": 1.0,
      "ActualWeightUOM": "sample string 44",
      "InsertUserID": 45,
      "InsertDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "UpdateUserID": 1,
      "UpdateDateTime": "2025-12-03T12:35:59.4085121+00:00",
      "Residential": true,
      "DisplayAddress": "sample string 48",
      "DisplayTime": "sample string 49",
      "DisplayStatus": "sample string 50",
      "LockCost": true
    }
  ]
}

application/xml, text/xml

Sample: 
<PickupResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Pickups>
    <PickupItem>
      <AcceptedDateTime>2025-12-03T12:35:59.4085121+00:00</AcceptedDateTime>
      <ActualAttemptCount>1</ActualAttemptCount>
      <ActualDistance>42</ActualDistance>
      <ActualDistanceUOM>sample string 43</ActualDistanceUOM>
      <ActualPickupArrival>2025-12-03T12:35:59.4085121+00:00</ActualPickupArrival>
      <ActualPickupDepart>2025-12-03T12:35:59.4085121+00:00</ActualPickupDepart>
      <ActualWaitingTime>1</ActualWaitingTime>
      <ActualWeight>1</ActualWeight>
      <ActualWeightUOM>sample string 44</ActualWeightUOM>
      <Address1>sample string 14</Address1>
      <Address2>sample string 15</Address2>
      <Address3>sample string 16</Address3>
      <AddressCode>sample string 12</AddressCode>
      <AddressID>1</AddressID>
      <AfterHoursNumber>sample string 23</AfterHoursNumber>
      <AirportID>sample string 30</AirportID>
      <AlertHow>sample string 39</AlertHow>
      <AlertStatus>37</AlertStatus>
      <AlertUserID>1</AlertUserID>
      <AlertUserName>sample string 40</AlertUserName>
      <AlertVia>sample string 38</AlertVia>
      <AttemptCount>1</AttemptCount>
      <CityName>sample string 17</CityName>
      <CloseDateTime>2025-12-03T12:35:59.4085121+00:00</CloseDateTime>
      <CompanyID>3</CompanyID>
      <CompanyName>sample string 13</CompanyName>
      <CountryID>sample string 20</CountryID>
      <CourierID>1</CourierID>
      <CourierKey>sample string 34</CourierKey>
      <CourierName>sample string 35</CourierName>
      <CourierPhoneNumber>sample string 36</CourierPhoneNumber>
      <CourierServiceID>1</CourierServiceID>
      <CustomerID>11</CustomerID>
      <DispatchOfficeID>1</DispatchOfficeID>
      <DisplayAddress>sample string 48</DisplayAddress>
      <DisplayStatus>sample string 50</DisplayStatus>
      <DisplayTime>sample string 49</DisplayTime>
      <Distance>31</Distance>
      <DistanceUOM>sample string 32</DistanceUOM>
      <EmailAddress>sample string 25</EmailAddress>
      <FaxNumber>sample string 24</FaxNumber>
      <InsertDateTime>2025-12-03T12:35:59.4085121+00:00</InsertDateTime>
      <InsertUserID>45</InsertUserID>
      <Instructions>sample string 33</Instructions>
      <LockCost>true</LockCost>
      <OfficeID>4</OfficeID>
      <OrderByEmail>sample string 10</OrderByEmail>
      <OrderByFax>sample string 9</OrderByFax>
      <OrderByName>sample string 7</OrderByName>
      <OrderByPhone>sample string 8</OrderByPhone>
      <PersonToSee>sample string 26</PersonToSee>
      <PhoneNumber>sample string 22</PhoneNumber>
      <PickupGUID>sample string 1</PickupGUID>
      <PickupNumber>2</PickupNumber>
      <PostalCode>sample string 19</PostalCode>
      <ReadyDateTime>2025-12-03T12:35:59.4085121+00:00</ReadyDateTime>
      <Residential>true</Residential>
      <SchedPickupDateTime>2025-12-03T12:35:59.4085121+00:00</SchedPickupDateTime>
      <SchedPickupDateTimeUTC>2025-12-03T12:35:59.4085121+00:00</SchedPickupDateTimeUTC>
      <SentDateTime>2025-12-03T12:35:59.4085121+00:00</SentDateTime>
      <SpokeWith>sample string 41</SpokeWith>
      <State>sample string 5</State>
      <StateProvID>sample string 18</StateProvID>
      <Status>6</Status>
      <TimezoneID>sample string 21</TimezoneID>
      <UpdateDateTime>2025-12-03T12:35:59.4085121+00:00</UpdateDateTime>
      <UpdateUserID>1</UpdateUserID>
      <UpdatedPickupDateTime>2025-12-03T12:35:59.4085121+00:00</UpdatedPickupDateTime>
      <UpdatedPickupDateTimeUTC>2025-12-03T12:35:59.4085121+00:00</UpdatedPickupDateTimeUTC>
      <WaitingTime>1</WaitingTime>
    </PickupItem>
    <PickupItem>
      <AcceptedDateTime>2025-12-03T12:35:59.4085121+00:00</AcceptedDateTime>
      <ActualAttemptCount>1</ActualAttemptCount>
      <ActualDistance>42</ActualDistance>
      <ActualDistanceUOM>sample string 43</ActualDistanceUOM>
      <ActualPickupArrival>2025-12-03T12:35:59.4085121+00:00</ActualPickupArrival>
      <ActualPickupDepart>2025-12-03T12:35:59.4085121+00:00</ActualPickupDepart>
      <ActualWaitingTime>1</ActualWaitingTime>
      <ActualWeight>1</ActualWeight>
      <ActualWeightUOM>sample string 44</ActualWeightUOM>
      <Address1>sample string 14</Address1>
      <Address2>sample string 15</Address2>
      <Address3>sample string 16</Address3>
      <AddressCode>sample string 12</AddressCode>
      <AddressID>1</AddressID>
      <AfterHoursNumber>sample string 23</AfterHoursNumber>
      <AirportID>sample string 30</AirportID>
      <AlertHow>sample string 39</AlertHow>
      <AlertStatus>37</AlertStatus>
      <AlertUserID>1</AlertUserID>
      <AlertUserName>sample string 40</AlertUserName>
      <AlertVia>sample string 38</AlertVia>
      <AttemptCount>1</AttemptCount>
      <CityName>sample string 17</CityName>
      <CloseDateTime>2025-12-03T12:35:59.4085121+00:00</CloseDateTime>
      <CompanyID>3</CompanyID>
      <CompanyName>sample string 13</CompanyName>
      <CountryID>sample string 20</CountryID>
      <CourierID>1</CourierID>
      <CourierKey>sample string 34</CourierKey>
      <CourierName>sample string 35</CourierName>
      <CourierPhoneNumber>sample string 36</CourierPhoneNumber>
      <CourierServiceID>1</CourierServiceID>
      <CustomerID>11</CustomerID>
      <DispatchOfficeID>1</DispatchOfficeID>
      <DisplayAddress>sample string 48</DisplayAddress>
      <DisplayStatus>sample string 50</DisplayStatus>
      <DisplayTime>sample string 49</DisplayTime>
      <Distance>31</Distance>
      <DistanceUOM>sample string 32</DistanceUOM>
      <EmailAddress>sample string 25</EmailAddress>
      <FaxNumber>sample string 24</FaxNumber>
      <InsertDateTime>2025-12-03T12:35:59.4085121+00:00</InsertDateTime>
      <InsertUserID>45</InsertUserID>
      <Instructions>sample string 33</Instructions>
      <LockCost>true</LockCost>
      <OfficeID>4</OfficeID>
      <OrderByEmail>sample string 10</OrderByEmail>
      <OrderByFax>sample string 9</OrderByFax>
      <OrderByName>sample string 7</OrderByName>
      <OrderByPhone>sample string 8</OrderByPhone>
      <PersonToSee>sample string 26</PersonToSee>
      <PhoneNumber>sample string 22</PhoneNumber>
      <PickupGUID>sample string 1</PickupGUID>
      <PickupNumber>2</PickupNumber>
      <PostalCode>sample string 19</PostalCode>
      <ReadyDateTime>2025-12-03T12:35:59.4085121+00:00</ReadyDateTime>
      <Residential>true</Residential>
      <SchedPickupDateTime>2025-12-03T12:35:59.4085121+00:00</SchedPickupDateTime>
      <SchedPickupDateTimeUTC>2025-12-03T12:35:59.4085121+00:00</SchedPickupDateTimeUTC>
      <SentDateTime>2025-12-03T12:35:59.4085121+00:00</SentDateTime>
      <SpokeWith>sample string 41</SpokeWith>
      <State>sample string 5</State>
      <StateProvID>sample string 18</StateProvID>
      <Status>6</Status>
      <TimezoneID>sample string 21</TimezoneID>
      <UpdateDateTime>2025-12-03T12:35:59.4085121+00:00</UpdateDateTime>
      <UpdateUserID>1</UpdateUserID>
      <UpdatedPickupDateTime>2025-12-03T12:35:59.4085121+00:00</UpdatedPickupDateTime>
      <UpdatedPickupDateTimeUTC>2025-12-03T12:35:59.4085121+00:00</UpdatedPickupDateTimeUTC>
      <WaitingTime>1</WaitingTime>
    </PickupItem>
  </Pickups>
</PickupResp>