Drop off and Pickup
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 requestCreate shipment response
curl --location 'https://api.goshippo.com/shipments/' \
--header 'Authorization: ShippoToken <API_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"address_from":{
"name": "Mr. Hippo Australia",
"company": "",
"street_no": "",
"street1": "Bennelong Point",
"street2": "",
"street3": "",
"city": "Sydney",
"state": "NSW",
"zip": "2000",
"country": "AU",
"phone": "(02) 1234 1234",
"email": "mrhippo-australia@goshippo.com",
"is_residential": null
},
"address_to": {
"name": "Mr. Hippo Australia 2",
"company": "",
"street_no": "",
"street1": "53 Elgin Blvd",
"street2": "",
"street3": "",
"city": "Wodonga",
"state": "VIC",
"zip": "3690",
"country": "AU",
"phone": "0266888024",
"email": "mrhippo-australia2@goshippo.com",
"is_residential": null
},
"parcels": {
"length": "10",
"width": "10",
"height": "10",
"distance_unit": "cm",
"weight": "1",
"mass_unit": "kg",
"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
}'{
"object_id": "06bee61d141545d08690631fbb27f602",
"object_created": "2024-06-25T21:41:45.870Z",
"object_updated": "2024-06-25T21:41:46.148Z",
"object_owner": "mrhippo-australia@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 Australia",
"street1": "Bennelong Point",
"street2": "",
"street3": "",
"city": "Sydney",
"state": "NSW",
"zip": "2000",
"country": "AU",
"street_no": "",
"phone": "0212341234",
"email": "mrhippo-australia@goshippo.com",
"company": "",
"is_residential": null,
"test": false,
"object_id": "dc9ab83e3c9d430e9826cf1bea496fac",
"is_complete": true,
"validation_results": {}
},
"address_to": {
"name": "Mr. Hippo Australia 2",
"street1": "53 Elgin Blvd",
"street2": "",
"street3": "",
"city": "Wodonga",
"state": "VIC",
"zip": "3690",
"country": "AU",
"street_no": "",
"phone": "0266888024",
"email": "mrhippo-australia2@goshippo.com",
"company": "",
"is_residential": null,
"test": false,
"object_id": "81db78275d774cfd81bc8f51e8e4e5f4",
"is_complete": true,
"validation_results": {}
},
"parcels": [
{
"object_owner": "mrhippo-australia@goshippo.com",
"object_state": "VALID",
"mass_unit": "kg",
"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": "cm",
"weight": "1.0000",
"line_items": []
}
],
"status": "SUCCESS",
"shipment_date": "2024-06-25T21:41:45.870Z",
"address_return": {
"name": "Mr. Hippo Australia",
"street1": "Bennelong Point",
"street2": "",
"street3": "",
"city": "Sydney",
"state": "NSW",
"zip": "2000",
"country": "AU",
"street_no": "",
"phone": "0212341234",
"email": "mrhippo-australia@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-australia@goshippo.com",
"shipment": "06bee61d141545d08690631fbb27f602",
"amount": "12.45",
"currency": "AUD",
"amount_local": "12.45",
"currency_local": "AUD",
"attributes": [
"FASTEST",
"CHEAPEST",
"BESTVALUE"
],
"provider": "Sendle",
"provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/sendle.png",
"provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/sendle.png",
"arrives_by": "2024-07-05",
"duration_terms": "4 to 6 business days",
"messages": [],
"carrier_account": "425b61f50b3642948fb3afa8b3687581",
"zone": null,
"test": false,
"servicelevel": {
"name": "Sendle Standard Dropoff",
"token": "sendle_standard_dropoff",
"terms": "",
"extended_token": "sendle_standard_dropoff",
"display_name": "Sendle Standard Dropoff",
"parent_servicelevel": null
},
"estimated_days": 6,
"included_insurance_price": null
},
{
"object_id": "eddaf1c7872b432488e93252ae2e1fbf",
"object_created": "2024-06-25T21:41:46.129Z",
"object_owner": "mrhippo-australia@goshippo.com",
"shipment": "06bee61d141545d08690631fbb27f602",
"amount": "12.45",
"currency": "AUD",
"amount_local": "12.45",
"currency_local": "AUD",
"attributes": [
"CHEAPEST",
"BESTVALUE"
],
"provider": "Sendle",
"provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/sendle.png",
"provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/sendle.png",
"arrives_by": "2024-07-05",
"duration_terms": "4 to 6 business days",
"messages": [],
"carrier_account": "425b61f50b3642948fb3afa8b3687581",
"zone": null,
"test": false,
"servicelevel": {
"name": "Sendle Standard Pickup",
"token": "sendle_parcel",
"terms": "",
"extended_token": "sendle_parcel",
"display_name": null,
"parent_servicelevel": null
},
"estimated_days": 6,
"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 sendle_standard_dropoff.
Purchase label for drop off requestPurchase label for drop off response
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_A4",
"metadata": "sendle_rate_qr_code_success"
}'{
"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-australia@goshippo.com",
"test": false,
"rate": "37ccdc9c210940cb8c554610207b553d",
"tracking_number": "SQ734G7",
"tracking_status": "PRE_TRANSIT",
"eta": null,
"tracking_url_provider": "https://track.sendle.com/tracking?ref=SQdfG7",
"label_url": "https://deliver.goshippo.com/c8b2789b5e66sdf167eeb761f9.pdf",
"commercial_invoice_url": null,
"messages": [],
"order": null,
"metadata": "sendle_rate_qr_code_success",
"parcel": "27a76dad79a84655add8eda8866b397e",
"billing": {
"payments": []
},
"qr_code_url": "https://deliver.goshippo.com/c8b2789b5e66420186450167eeb761f9_qr_code.png?Expires=1750887744&Signature=oh~acrNIeZm~2GYtDpVpK745k8eS39h2oTT9KKTtx2s4D0H60YQxS5r4~2bLPHoIl0aaIRIsGgWBpUO6BfVmdoenk4rYgvNnMBM9~KzJC8QmbmZHhGH1of-M435XYLfDx7lTEZgDGSK9iDRUmaW39hkCyV34JIXOmLXyZF2V6MOw8zhw8lSI2CteQompl2MmBuoSRz5xamyh3MIrUuS-I5RhFkMwPW4VQzQBd8bd6JtOJf~~W5v6CxyMVG04sEq2lRdg4zJDBQSBV2G99u8s9wOjx6bzhbGpjF1LGo3ljlaK6rV34BNAdS2rTiGERwIU4HlIN9ioaoOaBrWgAJAhhA__&Key-Pair-Id=APKAJRICFXQ2S4YUQRSQ",
"created_by": {
"first_name": "Mrhippo",
"last_name": "Australia",
"username": "mrhippo-australia@goshippo.com"
}
}You can download and scan the scannable code qr_code_url at supporting drop off locations.
Note
Your carrier will not always return a QR code. This may be because the carrier does not support that feature or because of other limitations. For example, Sendle will not return a QR code when your address_from is not within 25km of a Sendle Print In-Store location.
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 requestDrop off Instalabel response
curl --location 'https://api.goshippo.com/transactions/' \
--header 'Authorization: ShippoToken <API_TOKEN>' \
--header 'Content-Type: application/json'\
--data-raw '{
"shipment": {
"address_from": {
"address_from": {
"name": "Mr. Hippo Australia",
"street1": "4 Cintra Rd",
"city": "Bowen Hills",
"state": "QLD",
"zip": "4006",
"country": "AU",
"phone": "(02) 1234 1234",
"email": "mrhippo-australia@goshippo.com",
"is_residential": null
},
"address_to": {
"name": "Mrs Hippo",
"street1": "69 Dalgety St",
"state" : "QLD",
"city": "Mount Gravatt East",
"zip": "4122",
"country": "AU",
"phone": "413454534567",
"email": "mrhippo@goshippo.com"
},
"parcels": [{
"weight": "1",
"length": "1",
"width": "2",
"height": "3",
"distance_unit": "in",
"mass_unit": "lb"
}]
},
"carrier_account": "2c79a675977d459ca7b74e003ed97854",
"servicelevel_token": "sendle_standard_dropoff"
}'{
"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-australia@goshippo.com",
"test": false,
"rate": "37ccdc9c210940cb8c554610207b553d",
"tracking_number": "SQ734G7",
"tracking_status": "PRE_TRANSIT",
"eta": null,
"tracking_url_provider": "https://track.sendle.com/tracking?ref=SQ734G7",
"label_url": "https://deliver.goshippo.com/c8b2789b5e66420dffdfsdfgfg167eeb761f9.pdf",
"commercial_invoice_url": null,
"messages": [],
"order": null,
"metadata": "sendle_rate_qr_code_success",
"parcel": "27a76dad79a84655add8eda8866b397e",
"billing": {
"payments": []
},
"qr_code_url": null,
"created_by": {
"first_name": "Mr. Hippo",
"last_name": "Australia",
"username": "mrhippo-australia@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 requestCreate a pickup response
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
}' {
"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"
]
}