Skip to main content

​
Drop off

A drop off is a location where you can bring your parcel, with a printed label, to be collected by your carrier and delivered to its destination. This is a service that is offered by some carriers. Drop off locations can be places like shipping centers, lockers, or retail locations.

​
Create a drop off shipment

You can create drop off shipment using a carrier with a drop off service level. Review our carriers to see which support drop offs. Some carriers support creating a scannable code like a barcode or QR code that you can bring to your drop off location without printing a label. This code can be presented at the drop off location using a user’s mobile device and the appropriate shipping label can be printed and attached to the parcel. This is particularly useful for users without printing facilities. To request a scannable code, set extra.qr_code_requested to true.
Create shipment request
curl --location 'https://api.goshippo.com/shipments/' \
--header 'Authorization: ShippoToken <API_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    
  "address_from":{
    "name": "Mr. Hippo",
    "company": "",
    "street1": "215 Clayton St.",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94117",
    "country": "US",
    "phone": "4151234567",
    "email": "mrhippo@goshippo.com",
    "is_residential": null
   },
   "address_to": {
    "name": "Mrs. Hippo",
    "company": "",
    "street1": "1092 Indian Summer Ct",
    "city": "San Jose",
    "state": "CA",
    "zip": "95122",
    "country": "US",
    "phone": "4159876543",
    "email": "mrshippo@goshippo.com",
    "is_residential": null

    },
   "parcels": {
    "length": "10",
    "width": "10",
    "height": "10",
    "distance_unit": "in",
    "weight": "1",
    "mass_unit": "lb",
    "metadata": "Customer ID 123456"
  },
    "extra": {
        "reference_1": "Created on",
        "reference_2": "Shippo",
        "qr_code_requested": true
    },
    
    "metadata": "Customer ID 123456",
    "carrier_accounts": ["<your carrier account object_id>"],
    "async": false
}'
Create shipment response
{
    "object_id": "06bee61d141545d08690631fbb27f602",
    "object_created": "2024-06-25T21:41:45.870Z",
    "object_updated": "2024-06-25T21:41:46.148Z",
    "object_owner": "mrhippo@goshippo.com",
    "test": false,
    "metadata": "Customer ID 123456",
    "messages": [],
    "extra": {
        "qr_code_requested": true,
        "reference_1": "Created on",
        "reference_2": "Shippo"
    },
    "order": null,
    "carrier_accounts": [
        "425b61f50b3642948fb3afa8b3687581"
    ],
    "address_from": {
        "name": "Mr. Hippo",
        "street1": "215 Clayton St.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94117",
        "country": "US",
        "phone": "4151234567",
        "email": "mrhippo@goshippo.com",
        "company": "",
        "is_residential": null,
        "test": false,
        "object_id": "dc9ab83e3c9d430e9826cf1bea496fac",
        "is_complete": true,
        "validation_results": {}
    },
    "address_to": {
        "name": "Mrs. Hippo",
        "street1": "1092 Indian Summer Ct",
        "city": "San Jose",
        "state": "CA",
        "zip": "95122",
        "country": "US",
        "phone": "4159876543",
        "email": "mrshippo@goshippo.com",
        "company": "",
        "is_residential": null,
        "test": false,
        "object_id": "81db78275d774cfd81bc8f51e8e4e5f4",
        "is_complete": true,
        "validation_results": {}
    },
    "parcels": [
        {
            "object_owner": "mrhippo@goshippo.com",
            "object_state": "VALID",
            "mass_unit": "lb",
            "template": null,
            "extra": {},
            "metadata": "Customer ID 123456",
            "test": false,
            "object_id": "27a76dad79a84655add8eda8866b397e",
            "object_created": "2024-06-25T21:41:45.870Z",
            "object_updated": "2024-06-25T21:41:45.870Z",
            "length": "10.0000",
            "width": "10.0000",
            "height": "10.0000",
            "distance_unit": "in",
            "weight": "1.0000",
            "line_items": []
        }
    ],
    "status": "SUCCESS",
    "shipment_date": "2024-06-25T21:41:45.870Z",
    "address_return": {
        "name": "Mr. Hippo",
        "street1": "215 Clayton St.",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94117",
        "country": "US",
        "phone": "4151234567",
        "email": "mrhippo@goshippo.com",
        "company": "",
        "is_residential": null,
        "test": false,
        "object_id": "dc9ab83e3c9d430e9826cf1bea496fac",
        "is_complete": true,
        "validation_results": {}
    },
    "rates": [
        {
            "object_id": "37ccdc9c210940cb8c554610207b553d",
            "object_created": "2024-06-25T21:41:46.129Z",
            "object_owner": "mrhippo@goshippo.com",
            "shipment": "06bee61d141545d08690631fbb27f602",
            "amount": "8.45",
            "currency": "USD",
            "amount_local": "8.45",
            "currency_local": "USD",
            "attributes": [
                "FASTEST",
                "CHEAPEST",
                "BESTVALUE"
            ],
            "provider": "USPS",
            "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/usps.png",
            "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/usps.png",
            "arrives_by": "2024-07-05",
            "duration_terms": "2 to 3 business days",
            "messages": [],
            "carrier_account": "425b61f50b3642948fb3afa8b3687581",
            "zone": null,
            "test": false,
            "servicelevel": {
                "name": "Ground Advantage",
                "token": "usps_ground_advantage",
                "terms": "",
                "extended_token": "usps_ground_advantage",
                "display_name": "Ground Advantage",
                "parent_servicelevel": null
            },
            "estimated_days": 3,
            "included_insurance_price": null
        }
    ],
    "alternate_address_to": null,
    "customs_declaration": null
}
Use the rate object_id associated with the new service level token that supports drop off in the transactions endpoint to purchase the label. In this example use the token usps_ground_advantage.
Purchase label for drop off request
curl --location --request POST 'https://api.goshippo.com/transactions' \
--header 'Authorization: ShippoToken <API_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "rate": "37ccdc9c210940cb8c554610207b553d",
  "async": false,
  "label_file_type": "PDF",
  "metadata": "usps_rate_qr_code_success"
}'
Purchase label for drop off response
{
  "object_state": "VALID",
  "status": "SUCCESS",
  "object_created": "2024-06-25T21:42:19.048Z",
  "object_updated": "2024-06-25T21:42:24.926Z",
  "object_id": "c8b2789b5e66420186450167eeb761f9",
  "object_owner": "mrhippo@goshippo.com",
  "test": false,
  "rate": "37ccdc9c210940cb8c554610207b553d",
  "tracking_number": "92055901755477000000000015",
  "tracking_status": "PRE_TRANSIT",
  "eta": null,
  "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92055901755477000000000015",
  "label_url": "https://shippo-delivery-east.s3.amazonaws.com/c8b2789b5e66420186450167eeb761f9.pdf",
  "commercial_invoice_url": null,
  "messages": [],
  "order": null,
  "metadata": "usps_rate_qr_code_success",
  "parcel": "27a76dad79a84655add8eda8866b397e",
  "billing": {
    "payments": []
  },
  "qr_code_url": "https://shippo-delivery-east.s3.amazonaws.com/c8b2789b5e66420186450167eeb761f9_qr_code.png",
  "created_by": {
    "first_name": "Mr.",
    "last_name": "Hippo",
    "username": "mrhippo@goshippo.com"
  }
}
You can download and scan the scannable code qr_code_url at supporting drop off locations.
NoteYour carrier will not always return a QR code. This may be because the carrier does not support that feature or because of other limitations.

​
Create a drop off Instalabel shipment

Use the following example to create an Instalabel for a drop off shipment. Before creating an Instalabel, you must have your carrier object ID and the service level token that supports drop off.
Drop off Instalabel request
curl --location 'https://api.goshippo.com/transactions/' \
--header 'Authorization: ShippoToken <API_TOKEN>' \
--header 'Content-Type: application/json'\
--data-raw '{
  "shipment": {
    "address_from": {
            "name": "Mr. Hippo",
            "street1": "215 Clayton St.",
            "city": "San Francisco",
            "state": "CA",
            "zip": "94117",
            "country": "US",
            "phone": "4151234567",
            "email": "mrhippo@goshippo.com",
            "is_residential": null
    },
    "address_to": {
      "name": "Mrs. Hippo",
      "street1": "1092 Indian Summer Ct",
      "city": "San Jose",
      "state": "CA",
      "zip": "95122",
      "country": "US",
      "phone": "4159876543",
      "email": "mrshippo@goshippo.com"
    },
    "parcels": [{
      "weight": "1",
      "length": "10",
      "width": "10",
      "height": "10",
      "distance_unit": "in",
      "mass_unit": "lb"
    }]
  },
  "carrier_account": "2c79a675977d459ca7b74e003ed97854",
  "servicelevel_token": "usps_ground_advantage"
}'
Drop off Instalabel response
{
  "object_state": "VALID",
  "status": "SUCCESS",
  "object_created": "2024-06-25T21:42:19.048Z",
  "object_updated": "2024-06-25T21:42:24.926Z",
  "object_id": "c8b2789b5e66420186450167eeb761f9",
  "object_owner": "mrhippo@goshippo.com",
  "test": false,
  "rate": "37ccdc9c210940cb8c554610207b553d",
  "tracking_number": "92055901755477000000000015",
  "tracking_status": "PRE_TRANSIT",
  "eta": null,
  "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92055901755477000000000015",
  "label_url": "https://shippo-delivery-east.s3.amazonaws.com/c8b2789b5e66420dffdfsdfgfg167eeb761f9.pdf",
  "commercial_invoice_url": null,
  "messages": [],
  "order": null,
  "metadata": "usps_rate_qr_code_success",
  "parcel": "27a76dad79a84655add8eda8866b397e",
  "billing": {
    "payments": []
  },
  "qr_code_url": null,
  "created_by": {
    "first_name": "Mr.",
    "last_name": "Hippo",
    "username": "mrhippo@goshippo.com"
  }
}

​
Pickup

A pickup refers to a carrier collecting a parcel from your designated location instead of you bringing the parcel to the carrier location. To request a pickup, use the pickup endpoint.
Create a pickup request
curl https://api.goshippo.com/pickups/  \
-H "Authorization: ShippoToken <API_TOKEN>" \
-H "Content-Type: application/json"  \
-d '{
      "carrier_account":"6c51273296864869829b96a80fb13ea1",
      "location":{
              "building_location_type": "Other",
              "building_type": "suite",
              "instructions": "Behind screen door",
              "address": {
                      "name": "Mrs Hippo",
                      "company": "Hungry Hippos",
                      "street1": "965 Mission St #201",
                      "city": "San Francisco",
                      "state": "CA",
                      "zip": "95122",
                      "country": "US",
                      "phone": "+14159876543",
                      "email": "mrshippo@shippo.com"
                  }
      },
      "transactions": ["7439c279b374494c9a80ca24f59e6fc5"],
      "requested_start_time":"2024-05-12T12:00:00Z",
      "requested_end_time": "2024-05-12T16:00:00Z",
      "metadata": "Customer ID 123456",
      "is_test": false
    }'
Create a pickup response
    {
  "carrier_account": "6c51273296864869829b96a80fb13ea1",
  "location": {
    "address": {
        "name": "Mrs Hippo",
        "company": "Hungry Hippos",
        "street1": "965 Mission St #201",
        "city": "San Francisco",
        "state": "CA",
        "zip": "95122",
        "country": "US",
        "phone": "+14159876543",
        "email": "mrshippo@shippo.com"
    },
    "building_location_type": "Other",
    "building_type": "suite",
    "instructions": "Behind screen door"
  },
  "metadata": "string",
  "requested_end_time": "2024-05-12T16:00:00Z",
  "requested_start_time": "2024-05-12T12:00:00Z",
  "transactions": [
    "7439c279b374494c9a80ca24f59e6fc5"
  ]
}