POST api/PickupRequest

Use this function to submit a Pickup Request for a shipment via the POST of an HttpRequestMessage where the PickupRequest structure may be submitted in either XML or JSON format.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

PickupResults

Name	Description	Type	Additional information
_RequestSubmitted	The HttpRequestMessage submitted with your API call will also be returned in this field. It must be submitted in either XML or JSON format in accordance with the [PickupRequest] schema (drill-down for details):	PickupRequest	None.
ErrorInfo	This field will be empty (blank) if the Pickup Request API was processed successfully; a non-blank entry will document the nature of the error(s) encountered during processing.	string	None.
PickupNumber	A successful Pickup Request submission will return the Pickup Number assigned by the system (values range between 1 and 2,147,483,647)	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "_RequestSubmitted": {
    "Logon": "sample string 1",
    "Pass": "sample string 2",
    "PickupDate": "sample string 3",
    "ReadyByTime": "sample string 4",
    "ClosingTime": "sample string 5",
    "PPDorCOL": "sample string 6",
    "ShipperCode": "sample string 7",
    "ShipperName": "sample string 8",
    "ShipperAddress": "sample string 9",
    "ShipperCity": "sample string 10",
    "ShipperState": "sample string 11",
    "ShipperZip": "sample string 12",
    "ShipperContact": "sample string 13",
    "ShipperPhone": "sample string 14",
    "ConsigneeCode": "sample string 15",
    "ConsigneeName": "sample string 16",
    "ConsigneeAddress": "sample string 17",
    "ConsigneeCity": "sample string 18",
    "ConsigneeState": "sample string 19",
    "ConsigneeZip": "sample string 20",
    "ConsigneeContact": "sample string 21",
    "ConsigneePhone": "sample string 22",
    "BOL": "sample string 23",
    "PONUM": "sample string 24",
    "SID": "sample string 25",
    "QuoteNum": 26,
    "CODAmountInCents": 27,
    "Comments": "sample string 28",
    "FreightList": [
      {
        "FreightDescription": "sample string 1",
        "FreightClass": "sample string 2",
        "Weight": 3,
        "PalletCount": 4,
        "PieceCount": 5,
        "Length": 6,
        "Height": 7,
        "Width": 8,
        "HazmatUNnumber": "sample string 9",
        "HazmatClass": "sample string 10",
        "HazmatPackingGroup": "sample string 11",
        "HazmatProperName": "sample string 12"
      },
      {
        "FreightDescription": "sample string 1",
        "FreightClass": "sample string 2",
        "Weight": 3,
        "PalletCount": 4,
        "PieceCount": 5,
        "Length": 6,
        "Height": 7,
        "Width": 8,
        "HazmatUNnumber": "sample string 9",
        "HazmatClass": "sample string 10",
        "HazmatPackingGroup": "sample string 11",
        "HazmatProperName": "sample string 12"
      }
    ],
    "AccessorialList": [
      {
        "AccessorialCode": "sample string 1"
      },
      {
        "AccessorialCode": "sample string 1"
      }
    ]
  },
  "ErrorInfo": "sample string 1",
  "PickupNumber": 2
}

application/xml, text/xml

Sample:

<PickupResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUBLAPI">
  <ErrorInfo>sample string 1</ErrorInfo>
  <PickupNumber>2</PickupNumber>
  <_RequestSubmitted>
    <AccessorialList>
      <Accessorial>
        <AccessorialCode>sample string 1</AccessorialCode>
      </Accessorial>
      <Accessorial>
        <AccessorialCode>sample string 1</AccessorialCode>
      </Accessorial>
    </AccessorialList>
    <BOL>sample string 23</BOL>
    <CODAmountInCents>27</CODAmountInCents>
    <ClosingTime>sample string 5</ClosingTime>
    <Comments>sample string 28</Comments>
    <ConsigneeAddress>sample string 17</ConsigneeAddress>
    <ConsigneeCity>sample string 18</ConsigneeCity>
    <ConsigneeCode>sample string 15</ConsigneeCode>
    <ConsigneeContact>sample string 21</ConsigneeContact>
    <ConsigneeName>sample string 16</ConsigneeName>
    <ConsigneePhone>sample string 22</ConsigneePhone>
    <ConsigneeState>sample string 19</ConsigneeState>
    <ConsigneeZip>sample string 20</ConsigneeZip>
    <FreightList>
      <FreightDetail>
        <FreightClass>sample string 2</FreightClass>
        <FreightDescription>sample string 1</FreightDescription>
        <HazmatClass>sample string 10</HazmatClass>
        <HazmatPackingGroup>sample string 11</HazmatPackingGroup>
        <HazmatProperName>sample string 12</HazmatProperName>
        <HazmatUNnumber>sample string 9</HazmatUNnumber>
        <Height>7</Height>
        <Length>6</Length>
        <PalletCount>4</PalletCount>
        <PieceCount>5</PieceCount>
        <Weight>3</Weight>
        <Width>8</Width>
      </FreightDetail>
      <FreightDetail>
        <FreightClass>sample string 2</FreightClass>
        <FreightDescription>sample string 1</FreightDescription>
        <HazmatClass>sample string 10</HazmatClass>
        <HazmatPackingGroup>sample string 11</HazmatPackingGroup>
        <HazmatProperName>sample string 12</HazmatProperName>
        <HazmatUNnumber>sample string 9</HazmatUNnumber>
        <Height>7</Height>
        <Length>6</Length>
        <PalletCount>4</PalletCount>
        <PieceCount>5</PieceCount>
        <Weight>3</Weight>
        <Width>8</Width>
      </FreightDetail>
    </FreightList>
    <Logon>sample string 1</Logon>
    <PONUM>sample string 24</PONUM>
    <PPDorCOL>sample string 6</PPDorCOL>
    <Pass>sample string 2</Pass>
    <PickupDate>sample string 3</PickupDate>
    <QuoteNum>26</QuoteNum>
    <ReadyByTime>sample string 4</ReadyByTime>
    <SID>sample string 25</SID>
    <ShipperAddress>sample string 9</ShipperAddress>
    <ShipperCity>sample string 10</ShipperCity>
    <ShipperCode>sample string 7</ShipperCode>
    <ShipperContact>sample string 13</ShipperContact>
    <ShipperName>sample string 8</ShipperName>
    <ShipperPhone>sample string 14</ShipperPhone>
    <ShipperState>sample string 11</ShipperState>
    <ShipperZip>sample string 12</ShipperZip>
  </_RequestSubmitted>
</PickupResults>