Get Pickup Order

This request is used to get previously created pickup order. It can be used by sending a GET request to: https://api.deftship.com/pickup-orders/{pickup_order_id}.

Endpoint

Method URI Headers
GET pickup-orders/{pickup_order_id} default

Response

Field Type Description
success Boolean true or false
data Object Pickup order data container
+id Integer This is the id of your pickup order
+from_address Object This is the from address detail object
++name String Name of the sender
++attention String Attention of the sender
++street_1 String Street line 1
++street_2 String Street line 2
++street_3 String Street line 3
++city String City
++zip String Postal Zip code
++state String State
++country String Country (code) for the list please refer to country-codes
++telephone String Telephone Number
++is_residential Boolean If the address is residential
+piece_count Integer Total piece count
+status String Status
+carrier String Carrier is one of the following [ups, dhl, usps, canadapost]
+pieces Array Piece details
++readable_service String Readable service name
++is_gfp Boolean If the piece is Ground Freight.
++service String Service Code
++container_type String Container Type
++quantity Integer Pieces Quantity
++weight Integer Weight
++destination_country_code String Country of the destination country (code) for the list please refer to country-codes
+total_weight String Total weight in pounds
+ready_time String Ready time of order
+close_time String Close time of order
+pickup_date String Pickup date

Response Examples

Successful

{
    "success": true,
    "data": {
        "from_address": {
            "id": 1387235969,
            "name": "NV",
            "attention": "NV",
            "city": "LAS VEGAS",
            "state": "NV",
            "zip": "89107",
            "country": "US",
            "telephone": "888888888888",
            "is_residential": false,
            "street_1": "556 Vanguard Way Suite D",
            "street_2": null,
            "street_3": null
        },
        "id": 740102512,
        "piece_count": 1,
        "status": "ready",
        "carrier": "ups",
        "pieces": [
            {
                "readable_service": "UPS® Ground",
                "is_gfp": false,
                "service": "03",
                "container_type": "package",
                "quantity": 2,
                "weight": 20,
                "destination_country_code": "US"
            }
        ],
        "total_weight": "40 LBS",
        "ready_time": "13:30",
        "close_time": "15:30",
        "pickup_date": "05-01-2023"
    }
}

Failed

{
    "success": false,
    "message": "Pickup Order does not exist"
}