POST Pickup

Submit a pickup request

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PickupSchedule	Date/time window when the freight will be available for pickup	Schedule	Required
PickupAddress	Location where the freight should be picked up	Address	Required
DeliveryAddress	Location where the freight will be delivered	Address	None.
TotalBills	Total number of freight bills that will be picked up	integer	Required Range: inclusive between 1 and 500
TotalUnits	Total number of handling units that will be picked up	integer	Required Range: inclusive between 1 and 500
TotalWeight	Total weight in pounds that will be picked up	decimal number	Required Range: inclusive between 1 and 999999
Description	General description of the freight to be picked up. Please review prohibited articles and restricted articles in the rules tariff.	string	None.
HazmatTotals	Total weight by hazard class of any hazardous material to be picked up. Please review prohibited articles and restricted articles in the rules tariff.	Collection of PickupHazmat	None.
SpecialInstructions	Any special instructions related to the pickup	string	None.
EmailConfirmation	If provided, an email confirmation will be sent to this email address. For multiple addresses, separate them with a semicolon (;).	string	Matching regular expression pattern: ^[\w\&\+\-\.]+@([\w\d-]+\.)+[\w]{2,}(\;\|$)+$
TestFlag	When true, the pickup will be cancelled immediately after being created, and a driver will not be dispatched.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "PickupSchedule": {
    "After": "2024-11-20T20:25:02.4502808-06:00",
    "Before": "2024-11-20T20:25:02.4502808-06:00",
    "AppointmentRequired": true,
    "AppointmentMade": true
  },
  "PickupAddress": {
    "Name": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "Country": "sample string 7",
    "Contact": "sample string 8",
    "Phone": "sample string 9",
    "Latitude": 1.1,
    "Longitude": 1.1
  },
  "DeliveryAddress": {
    "Name": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "Country": "sample string 7",
    "Contact": "sample string 8",
    "Phone": "sample string 9",
    "Latitude": 1.1,
    "Longitude": 1.1
  },
  "TotalBills": 1,
  "TotalUnits": 2,
  "TotalWeight": 3.1,
  "Description": "sample string 4",
  "HazmatTotals": [
    {
      "HazardClass": 1.1,
      "Weight": 2.1
    },
    {
      "HazardClass": 1.1,
      "Weight": 2.1
    }
  ],
  "SpecialInstructions": "sample string 5",
  "EmailConfirmation": "sample string 6",
  "TestFlag": true
}

application/xml, text/xml

Sample:

<PickupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PickupSchedule>
    <After>2024-11-20T20:25:02.4502808-06:00</After>
    <Before>2024-11-20T20:25:02.4502808-06:00</Before>
    <AppointmentRequired>true</AppointmentRequired>
    <AppointmentMade>true</AppointmentMade>
  </PickupSchedule>
  <PickupAddress>
    <Name>sample string 1</Name>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <City>sample string 4</City>
    <State>sample string 5</State>
    <Zip>sample string 6</Zip>
    <Country>sample string 7</Country>
    <Contact>sample string 8</Contact>
    <Phone>sample string 9</Phone>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
  </PickupAddress>
  <DeliveryAddress>
    <Name>sample string 1</Name>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <City>sample string 4</City>
    <State>sample string 5</State>
    <Zip>sample string 6</Zip>
    <Country>sample string 7</Country>
    <Contact>sample string 8</Contact>
    <Phone>sample string 9</Phone>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
  </DeliveryAddress>
  <TotalBills>1</TotalBills>
  <TotalUnits>2</TotalUnits>
  <TotalWeight>3.1</TotalWeight>
  <Description>sample string 4</Description>
  <HazmatTotals>
    <PickupHazmat>
      <HazardClass>1.1</HazardClass>
      <Weight>2.1</Weight>
    </PickupHazmat>
    <PickupHazmat>
      <HazardClass>1.1</HazardClass>
      <Weight>2.1</Weight>
    </PickupHazmat>
  </HazmatTotals>
  <SpecialInstructions>sample string 5</SpecialInstructions>
  <EmailConfirmation>sample string 6</EmailConfirmation>
  <TestFlag>true</TestFlag>
</PickupRequest>

Response Information

Resource Description

Pickup

Name	Description	Type	Additional information
FreightBillNum	Pickup confirmation number	string	None.
Message	Informational message displaying errors, conflicts, and service notices	string	None.
PickupSchedule	Date/time window when the freight will be available for pickup	Schedule	Required
PickupAddress	Location where the freight should be picked up	Address	Required
DeliveryAddress	Location where the freight will be delivered	Address	None.
TotalBills	Total number of freight bills that will be picked up	integer	Required Range: inclusive between 1 and 500
TotalUnits	Total number of handling units that will be picked up	integer	Required Range: inclusive between 1 and 500
TotalWeight	Total weight in pounds that will be picked up	decimal number	Required Range: inclusive between 1 and 999999
Description	General description of the freight to be picked up. Please review prohibited articles and restricted articles in the rules tariff.	string	None.
HazmatTotals	Total weight by hazard class of any hazardous material to be picked up. Please review prohibited articles and restricted articles in the rules tariff.	Collection of PickupHazmat	None.
SpecialInstructions	Any special instructions related to the pickup	string	None.
EmailConfirmation	If provided, an email confirmation will be sent to this email address. For multiple addresses, separate them with a semicolon (;).	string	Matching regular expression pattern: ^[\w\&\+\-\.]+@([\w\d-]+\.)+[\w]{2,}(\;\|$)+$
TestFlag	When true, the pickup will be cancelled immediately after being created, and a driver will not be dispatched.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "PickupSchedule": {
    "After": "2024-11-20T20:25:02.4532822-06:00",
    "Before": "2024-11-20T20:25:02.4532822-06:00",
    "AppointmentRequired": true,
    "AppointmentMade": true
  },
  "PickupAddress": {
    "Name": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "Country": "sample string 7",
    "Contact": "sample string 8",
    "Phone": "sample string 9",
    "Latitude": 1.1,
    "Longitude": 1.1
  },
  "DeliveryAddress": {
    "Name": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "Zip": "sample string 6",
    "Country": "sample string 7",
    "Contact": "sample string 8",
    "Phone": "sample string 9",
    "Latitude": 1.1,
    "Longitude": 1.1
  },
  "TotalBills": 3,
  "TotalUnits": 4,
  "TotalWeight": 5.1,
  "Description": "sample string 6",
  "HazmatTotals": [
    {
      "HazardClass": 1.1,
      "Weight": 2.1
    },
    {
      "HazardClass": 1.1,
      "Weight": 2.1
    }
  ],
  "SpecialInstructions": "sample string 7",
  "EmailConfirmation": "sample string 8",
  "TestFlag": true,
  "FreightBillNum": "sample string 1",
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<Pickup xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PickupSchedule>
    <After>2024-11-20T20:25:02.4532822-06:00</After>
    <Before>2024-11-20T20:25:02.4532822-06:00</Before>
    <AppointmentRequired>true</AppointmentRequired>
    <AppointmentMade>true</AppointmentMade>
  </PickupSchedule>
  <PickupAddress>
    <Name>sample string 1</Name>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <City>sample string 4</City>
    <State>sample string 5</State>
    <Zip>sample string 6</Zip>
    <Country>sample string 7</Country>
    <Contact>sample string 8</Contact>
    <Phone>sample string 9</Phone>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
  </PickupAddress>
  <DeliveryAddress>
    <Name>sample string 1</Name>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <City>sample string 4</City>
    <State>sample string 5</State>
    <Zip>sample string 6</Zip>
    <Country>sample string 7</Country>
    <Contact>sample string 8</Contact>
    <Phone>sample string 9</Phone>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
  </DeliveryAddress>
  <TotalBills>3</TotalBills>
  <TotalUnits>4</TotalUnits>
  <TotalWeight>5.1</TotalWeight>
  <Description>sample string 6</Description>
  <HazmatTotals>
    <PickupHazmat>
      <HazardClass>1.1</HazardClass>
      <Weight>2.1</Weight>
    </PickupHazmat>
    <PickupHazmat>
      <HazardClass>1.1</HazardClass>
      <Weight>2.1</Weight>
    </PickupHazmat>
  </HazmatTotals>
  <SpecialInstructions>sample string 7</SpecialInstructions>
  <EmailConfirmation>sample string 8</EmailConfirmation>
  <TestFlag>true</TestFlag>
  <FreightBillNum>sample string 1</FreightBillNum>
  <Message>sample string 2</Message>
</Pickup>