POST api/PickupManifest
Request Information
URI Parameters
None.
Body Parameters
PickupManifestParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| PickupGUID | string |
None. |
|
| LoadReferenceList | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"PickupGUID": "sample string 2",
"LoadReferenceList": true
}
application/xml, text/xml
Sample:
<PickupManifestParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <LoadReferenceList>true</LoadReferenceList> <PickupGUID>sample string 2</PickupGUID> <auth>sample string 1</auth> </PickupManifestParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PickupManifestResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| Items | Collection of PickupManifestItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"Items": [
{
"ShipmentGUID": "sample string 1",
"ShipmentNumber": 2,
"PickupGUID": "sample string 3",
"TotalDistance": 1,
"TotalDistanceUOM": "sample string 4",
"ServiceID": 5,
"ServiceCode": "sample string 6",
"WorkflowID": "sample string 7",
"Pieces": 8,
"Weight": 1.0,
"DimWeight": 1.0,
"WeightUOM": "sample string 9",
"Contents": "sample string 10",
"Reference": "sample string 11",
"TrackingNumber": "sample string 12",
"DelCompanyName": "sample string 13",
"DelAddress1": "sample string 14",
"DelAddress2": "sample string 15",
"DelAddress3": "sample string 16",
"DelCityName": "sample string 17",
"DelStateProvID": "sample string 18",
"DelPostalCode": "sample string 19",
"DelCountryID": "sample string 20",
"DelTimezoneID": "sample string 21",
"DelAttention": "sample string 22",
"DelUpdatedDeliveryDateTime": "2024-09-19T09:07:11.9877627+00:00",
"DelDeliverWhen": "sample string 23",
"DelInstructions": "sample string 24",
"OrderSummary": "sample string 25",
"DeliveryDisplay": "sample string 26",
"LineHaulDisplay": "sample string 27",
"HasNotes": true,
"ReferenceList": "sample string 29",
"TSANameOnID": "sample string 30",
"TSATypeOfID": "sample string 31",
"TSAVerifierName": "sample string 32",
"TrackingOrShipmentNumber": "sample string 33",
"OrderSummaryVendor": "sample string 34",
"ShipmentReferenceID1": 1,
"ShipmentReferenceID2": 1,
"ShipmentReferenceID3": 1,
"ShipmentReferenceID4": 1,
"ShipmentReferenceID5": 1,
"ShipmentReferenceID6": 1,
"ShipmentReferenceID7": 1,
"ShipmentReferenceID8": 1,
"ReferenceValue1": "sample string 35",
"ReferenceValue2": "sample string 36",
"ReferenceValue3": "sample string 37",
"ReferenceValue4": "sample string 38",
"ReferenceValue5": "sample string 39",
"ReferenceValue6": "sample string 40",
"ReferenceValue7": "sample string 41",
"ReferenceValue8": "sample string 42",
"ReferenceLabel1": "sample string 43",
"ReferenceLabel2": "sample string 44",
"ReferenceLabel3": "sample string 45",
"ReferenceLabel4": "sample string 46",
"ReferenceLabel5": "sample string 47",
"ReferenceLabel6": "sample string 48",
"ReferenceLabel7": "sample string 49",
"ReferenceLabel8": "sample string 50"
},
{
"ShipmentGUID": "sample string 1",
"ShipmentNumber": 2,
"PickupGUID": "sample string 3",
"TotalDistance": 1,
"TotalDistanceUOM": "sample string 4",
"ServiceID": 5,
"ServiceCode": "sample string 6",
"WorkflowID": "sample string 7",
"Pieces": 8,
"Weight": 1.0,
"DimWeight": 1.0,
"WeightUOM": "sample string 9",
"Contents": "sample string 10",
"Reference": "sample string 11",
"TrackingNumber": "sample string 12",
"DelCompanyName": "sample string 13",
"DelAddress1": "sample string 14",
"DelAddress2": "sample string 15",
"DelAddress3": "sample string 16",
"DelCityName": "sample string 17",
"DelStateProvID": "sample string 18",
"DelPostalCode": "sample string 19",
"DelCountryID": "sample string 20",
"DelTimezoneID": "sample string 21",
"DelAttention": "sample string 22",
"DelUpdatedDeliveryDateTime": "2024-09-19T09:07:11.9877627+00:00",
"DelDeliverWhen": "sample string 23",
"DelInstructions": "sample string 24",
"OrderSummary": "sample string 25",
"DeliveryDisplay": "sample string 26",
"LineHaulDisplay": "sample string 27",
"HasNotes": true,
"ReferenceList": "sample string 29",
"TSANameOnID": "sample string 30",
"TSATypeOfID": "sample string 31",
"TSAVerifierName": "sample string 32",
"TrackingOrShipmentNumber": "sample string 33",
"OrderSummaryVendor": "sample string 34",
"ShipmentReferenceID1": 1,
"ShipmentReferenceID2": 1,
"ShipmentReferenceID3": 1,
"ShipmentReferenceID4": 1,
"ShipmentReferenceID5": 1,
"ShipmentReferenceID6": 1,
"ShipmentReferenceID7": 1,
"ShipmentReferenceID8": 1,
"ReferenceValue1": "sample string 35",
"ReferenceValue2": "sample string 36",
"ReferenceValue3": "sample string 37",
"ReferenceValue4": "sample string 38",
"ReferenceValue5": "sample string 39",
"ReferenceValue6": "sample string 40",
"ReferenceValue7": "sample string 41",
"ReferenceValue8": "sample string 42",
"ReferenceLabel1": "sample string 43",
"ReferenceLabel2": "sample string 44",
"ReferenceLabel3": "sample string 45",
"ReferenceLabel4": "sample string 46",
"ReferenceLabel5": "sample string 47",
"ReferenceLabel6": "sample string 48",
"ReferenceLabel7": "sample string 49",
"ReferenceLabel8": "sample string 50"
}
]
}
application/xml, text/xml
Sample:
<PickupManifestResp 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>
<Items>
<PickupManifestItem>
<Contents>sample string 10</Contents>
<DelAddress1>sample string 14</DelAddress1>
<DelAddress2>sample string 15</DelAddress2>
<DelAddress3>sample string 16</DelAddress3>
<DelAttention>sample string 22</DelAttention>
<DelCityName>sample string 17</DelCityName>
<DelCompanyName>sample string 13</DelCompanyName>
<DelCountryID>sample string 20</DelCountryID>
<DelDeliverWhen>sample string 23</DelDeliverWhen>
<DelInstructions>sample string 24</DelInstructions>
<DelPostalCode>sample string 19</DelPostalCode>
<DelStateProvID>sample string 18</DelStateProvID>
<DelTimezoneID>sample string 21</DelTimezoneID>
<DelUpdatedDeliveryDateTime>2024-09-19T09:07:11.9877627+00:00</DelUpdatedDeliveryDateTime>
<DeliveryDisplay>sample string 26</DeliveryDisplay>
<DimWeight>1</DimWeight>
<HasNotes>true</HasNotes>
<LineHaulDisplay>sample string 27</LineHaulDisplay>
<OrderSummary>sample string 25</OrderSummary>
<OrderSummaryVendor>sample string 34</OrderSummaryVendor>
<PickupGUID>sample string 3</PickupGUID>
<Pieces>8</Pieces>
<Reference>sample string 11</Reference>
<ReferenceLabel1>sample string 43</ReferenceLabel1>
<ReferenceLabel2>sample string 44</ReferenceLabel2>
<ReferenceLabel3>sample string 45</ReferenceLabel3>
<ReferenceLabel4>sample string 46</ReferenceLabel4>
<ReferenceLabel5>sample string 47</ReferenceLabel5>
<ReferenceLabel6>sample string 48</ReferenceLabel6>
<ReferenceLabel7>sample string 49</ReferenceLabel7>
<ReferenceLabel8>sample string 50</ReferenceLabel8>
<ReferenceList>sample string 29</ReferenceList>
<ReferenceValue1>sample string 35</ReferenceValue1>
<ReferenceValue2>sample string 36</ReferenceValue2>
<ReferenceValue3>sample string 37</ReferenceValue3>
<ReferenceValue4>sample string 38</ReferenceValue4>
<ReferenceValue5>sample string 39</ReferenceValue5>
<ReferenceValue6>sample string 40</ReferenceValue6>
<ReferenceValue7>sample string 41</ReferenceValue7>
<ReferenceValue8>sample string 42</ReferenceValue8>
<ServiceCode>sample string 6</ServiceCode>
<ServiceID>5</ServiceID>
<ShipmentGUID>sample string 1</ShipmentGUID>
<ShipmentNumber>2</ShipmentNumber>
<ShipmentReferenceID1>1</ShipmentReferenceID1>
<ShipmentReferenceID2>1</ShipmentReferenceID2>
<ShipmentReferenceID3>1</ShipmentReferenceID3>
<ShipmentReferenceID4>1</ShipmentReferenceID4>
<ShipmentReferenceID5>1</ShipmentReferenceID5>
<ShipmentReferenceID6>1</ShipmentReferenceID6>
<ShipmentReferenceID7>1</ShipmentReferenceID7>
<ShipmentReferenceID8>1</ShipmentReferenceID8>
<TSANameOnID>sample string 30</TSANameOnID>
<TSATypeOfID>sample string 31</TSATypeOfID>
<TSAVerifierName>sample string 32</TSAVerifierName>
<TotalDistance>1</TotalDistance>
<TotalDistanceUOM>sample string 4</TotalDistanceUOM>
<TrackingNumber>sample string 12</TrackingNumber>
<TrackingOrShipmentNumber>sample string 33</TrackingOrShipmentNumber>
<Weight>1</Weight>
<WeightUOM>sample string 9</WeightUOM>
<WorkflowID>sample string 7</WorkflowID>
</PickupManifestItem>
<PickupManifestItem>
<Contents>sample string 10</Contents>
<DelAddress1>sample string 14</DelAddress1>
<DelAddress2>sample string 15</DelAddress2>
<DelAddress3>sample string 16</DelAddress3>
<DelAttention>sample string 22</DelAttention>
<DelCityName>sample string 17</DelCityName>
<DelCompanyName>sample string 13</DelCompanyName>
<DelCountryID>sample string 20</DelCountryID>
<DelDeliverWhen>sample string 23</DelDeliverWhen>
<DelInstructions>sample string 24</DelInstructions>
<DelPostalCode>sample string 19</DelPostalCode>
<DelStateProvID>sample string 18</DelStateProvID>
<DelTimezoneID>sample string 21</DelTimezoneID>
<DelUpdatedDeliveryDateTime>2024-09-19T09:07:11.9877627+00:00</DelUpdatedDeliveryDateTime>
<DeliveryDisplay>sample string 26</DeliveryDisplay>
<DimWeight>1</DimWeight>
<HasNotes>true</HasNotes>
<LineHaulDisplay>sample string 27</LineHaulDisplay>
<OrderSummary>sample string 25</OrderSummary>
<OrderSummaryVendor>sample string 34</OrderSummaryVendor>
<PickupGUID>sample string 3</PickupGUID>
<Pieces>8</Pieces>
<Reference>sample string 11</Reference>
<ReferenceLabel1>sample string 43</ReferenceLabel1>
<ReferenceLabel2>sample string 44</ReferenceLabel2>
<ReferenceLabel3>sample string 45</ReferenceLabel3>
<ReferenceLabel4>sample string 46</ReferenceLabel4>
<ReferenceLabel5>sample string 47</ReferenceLabel5>
<ReferenceLabel6>sample string 48</ReferenceLabel6>
<ReferenceLabel7>sample string 49</ReferenceLabel7>
<ReferenceLabel8>sample string 50</ReferenceLabel8>
<ReferenceList>sample string 29</ReferenceList>
<ReferenceValue1>sample string 35</ReferenceValue1>
<ReferenceValue2>sample string 36</ReferenceValue2>
<ReferenceValue3>sample string 37</ReferenceValue3>
<ReferenceValue4>sample string 38</ReferenceValue4>
<ReferenceValue5>sample string 39</ReferenceValue5>
<ReferenceValue6>sample string 40</ReferenceValue6>
<ReferenceValue7>sample string 41</ReferenceValue7>
<ReferenceValue8>sample string 42</ReferenceValue8>
<ServiceCode>sample string 6</ServiceCode>
<ServiceID>5</ServiceID>
<ShipmentGUID>sample string 1</ShipmentGUID>
<ShipmentNumber>2</ShipmentNumber>
<ShipmentReferenceID1>1</ShipmentReferenceID1>
<ShipmentReferenceID2>1</ShipmentReferenceID2>
<ShipmentReferenceID3>1</ShipmentReferenceID3>
<ShipmentReferenceID4>1</ShipmentReferenceID4>
<ShipmentReferenceID5>1</ShipmentReferenceID5>
<ShipmentReferenceID6>1</ShipmentReferenceID6>
<ShipmentReferenceID7>1</ShipmentReferenceID7>
<ShipmentReferenceID8>1</ShipmentReferenceID8>
<TSANameOnID>sample string 30</TSANameOnID>
<TSATypeOfID>sample string 31</TSATypeOfID>
<TSAVerifierName>sample string 32</TSAVerifierName>
<TotalDistance>1</TotalDistance>
<TotalDistanceUOM>sample string 4</TotalDistanceUOM>
<TrackingNumber>sample string 12</TrackingNumber>
<TrackingOrShipmentNumber>sample string 33</TrackingOrShipmentNumber>
<Weight>1</Weight>
<WeightUOM>sample string 9</WeightUOM>
<WorkflowID>sample string 7</WorkflowID>
</PickupManifestItem>
</Items>
</PickupManifestResp>