Pickup Request Web Service

The Pickup Request Web Service allows a pickup request to be submitted and a confirmation message returned. A POST request containing the pickup information is sent to the web service. A valid MyPyle login and password are required. The username and password are base64 encoded.

You can use the commmand line to convert text to base64. Example: echo -n "mail@example.com:pass" | base64

Example cURL Request

POST

/1/shipment/createPickup

curl -X POST https://api.aduiepyle.com/1/shipment/createPickup \
  -H "Content-Type:application/json" \
  -H "Authorization: Basic username:password (Base64 encoded)" \
  -d '{...}' # pickup object

Pickup Object

If shipping PPS the consignee name and address are Required, otherwise neither are needed.
If indicator is set to A then airway is required.
If indicator is set to O then ocean is required.

Name
requester.name
Type
string – Required
Description
Name of the requester.
Name
requester.phone
Type
string – Required
Description
Phone of the requester.
Name
requester.extension
Type
string
Description
Extension of the requester.
Name
requester.developer
Type
boolean
Description
If true then the pickup is regarded as a test.
Name
shipper.name
Type
string – Required
Description
Name of the shipper.
Name
shipper.address.streetAddress
Type
string – Required
Description
Street address of shipper company.
Name
shipper.address.city
Type
string – Required
Description
City of the shipper.
Name
shipper.address.state
Type
string – Required
Description
State of the shipper.
Name
shipper.address.zip
Type
string – Required
Description
Zip of the shipper.
Name
consignee.name
Type
string
Description
Name of consignee.
Name
consignee.address.streetAddress
Type
string
Description
Street address of consignee company.
Name
consignee.address.city
Type
string
Description
City of the consignee.
Name
consignee.address.state
Type
string
Description
State of the consignee.
Name
consignee.address.zip
Type
string
Description
Zip of the consignee.
Name
consInstr
Type
string
Description
Consignee special instructions for pickup. Combined length of consInstr and shipInstr cannot exceed 30,000 characters.
Name
shipInstr
Type
string
Description
Shipper special instructions for pickup. Combined length of consInstr and shipInstr cannot exceed 30,000 characters.
Name
pickupDate
Type
string – Required
Description
Pickup date in YYYY-MM-DD format.
Name
readyTime
Type
string – Required
Description
Ready time in HH:MM:SS format.
Name
closingTime
Type
string – Required
Description
Shipper closing time in HH:MM:SS format.
Name
details.units
Type
number – Required
Description
Pieces/Pallets.
Name
details.containerType
Type
string – Required
Description
Container Type.
Code Description
PCS Pieces
PLT Pallet
BAG Bag
BOX Box
BDL Bundle
CTN Carton
CRT Crate
CYL Cylinder
DRM Drum
PLS Pail
ROL Roll
TOT Tote
Name
details.weight
Type
number – Required
Description
Weight between 1-45000 lbs.
Name
details.isHazardous
Type
boolean
Description
True if shipping hazardous freight.
Name
details.isFreezable
Type
boolean
Description
True if shipping freezable freight.
Name
details.destinationZip
Type
string – Required
Description
Postal code of freight.
Name
details.packagingGroup
Type
string
Description
For food. Required if isHazardous is True.
Code Description
PG I Do not load with food
PG II Do not load with food
PG III Okay to load with food
Name
details.pps
Type
number
Description
Pyle priority service.
Code Description
10 10 AM
12 12 PM
17 5 PM
Name
details.bol
Type
string
Description
Bill of Lading.
Name
importIndicator.indicator
Type
string
Description
If set then the corresponding fields below are required.
Code Description
A air
O ocean
Name
importIndicator.airway.airBill
Type
string
Description
Air bill number.
Name
importIndicator.airway.airRef
Type
string
Description
Air reference number.
Name
importIndicator.ocean.oceanRef
Type
string
Description
Ocean reference number.
Name
importIndicator.ocean.oceanCon
Type
string
Description
Ocean container number.
Name
importIndicator.ocean.oceanBill
Type
string
Description
Ocean bill number.
Name
lastFreeDay
Type
string
Description
Last free day of import storage.
Name
paperwork
Type
boolean
Description
Does driver need paperwork.
Name
specialReq.straightTruckReq
Type
boolean
Description
Straight truck required for pickup.
Name
specialReq.wideTrailerReq
Type
boolean
Description
102” wide trailer required.
Name
specialReq.tallFreight
Type
boolean
Description
Tall freight over 94” high.
Name
specialReq.liftgate
Type
number
Description
Lift gate is required.
Code Description
1 Shipper lift gate
2 Consignee lift gate
3 Both shipper and consignee lift gates
Name
specialReq.insidePickup
Type
boolean
Description
Inside pickup.
Name
specialReq.residential
Type
boolean
Description
Residential area pickup.
Name
specialReq.limitedAccess
Type
boolean
Description
Limited access pickup.

Code	Description
PCS	Pieces
PLT	Pallet
BAG	Bag
BOX	Box
BDL	Bundle
CTN	Carton
CRT	Crate
CYL	Cylinder
DRM	Drum
PLS	Pail
ROL	Roll
TOT	Tote

Code	Description
PG I	Do not load with food
PG II	Do not load with food
PG III	Okay to load with food

Code	Description
10	10 AM
12	12 PM
17	5 PM

Code	Description
A	air
O	ocean

Code	Description
1	Shipper lift gate
2	Consignee lift gate
3	Both shipper and consignee lift gates

Example Object

{
  "requester": {
    "name": "Jack",
    "phone": "999-999-9999",
    "extension": null,
    "developer": true
  },
  "shipper": {
    "name": "A DUIE PYLE",
    "address": {
      "streetAddress": "650 WESTTOWN RD",
      "city": "WEST CHESTER",
      "state": "PA",
      "zip": "19381"
    }
  },
  "consignee": {
    "name": "A DUIE PYLE",
    "address": {
      "streetAddress": "1132 OAK POINT AVE",
      "city": "BRONX",
      "state": "NY",
      "zip": "10474"
    }
  },
  "consInstr": "",
  "shipInstr": "Do not stack.",
  "pickupDate": "2017-11-27",
  "readyTime": "09:00:00",
  "closingTime": "17:00:00",
  "details": {
    "units": 5,
    "containerType": "PLT",
    "weight": 99,
    "destinationZip": "10474",
    "pps": 12
  },
  "specialReq": {
    "straightTruckReq": false,
    "wideTrailerReq": false,
    "tallFreight": false,
    "liftgate": 1,
    "insidePickup": false,
    "residential": false,
    "limitedAccess": false
  }
}

Sample Request

Example cURL Request

POST

/1/shipment/createPickup

curl -X POST https://api.aduiepyle.com/1/shipment/createPickup \
  -H "Content-Type:application/json" \
  -H "Authorization: Basic username:password (Base64 encoded)" \
  -d '{
    "requester":{
        "name":"Jack",
        "phone":"999-999-9999",
        "extension":null,
        "developer":true
        }
    "shipper":{
        "name":"A DUIE PYLE",
        "address":{
            "streetAddress":"650 WESTTOWN RD",
            "city":"WEST CHESTER",
            "state":"PA",
            "zip":"19381"
        }
    },
    "consignee":{
        "name":"A DUIE PYLE",
        "address":{
            "streetAddress":"1132 OAK POINT AVE",
            "city":"BRONX",
            "state":"NY",
            "zip":"10474"
        }
    },
    "consInstr":"",
    "shipInstr":"Do not stack.",	
    "pickupDate":"2017-11-27",
    "readyTime":"09:00:00",
    "closingTime":"17:00:00",
    "details":{
        "units": 5,
        "containerType": "PLT",
        "weight": 99,
        "destinationZip": "10474",
        "pps": 12
    },
    "specialReq":{
        "straightTruckReq":false,
        "wideTrailerReq":false,
        "tallFreight":false,
        "liftgate":1,
        "insidePickup":false,
        "residential":false,
        "limitedAccess":false
    }
}'

Example Response

{
  "pickup": {
    "pickupNumber": "0003",
    "pickupDate": "11/27/2017",
    "comment": "Due to the closure of the GWB, pickups may be delayed."
  }
}

Please note that EDI Services and Web Services are not available between 12 Midnight and 12:15 AM Eastern Time during our server maintenance window.

All customers using the Web Services should sign up for Web Services Notification to be informed whenever one of the Web Service interfaces is updated.

Revision 4 – 11/27/2019