Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.goshippo.com/llms.txt

Use this file to discover all available pages before exploring further.

Some carriers offer the option to deliver packages to customers on Saturdays. To get shipping rates for Saturday deliveries, create a Shipment and set saturday_delivery: true in Shipments Extras.
infoBy setting saturday_delivery: true, only saturday delivery options are returned. This means shipment options for other days are not returned.If you need shipment options for week days and Saturdays, create two Shipments. One with saturday_delivery:true in extra and one without.
The following example shows a request for a Saturday delivery Shipment. Request:
Saturday 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",
        "street1": "965 Mission Street",
        "street2": "Suite 480",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94103",
        "country": "US",
        "phone": "4151234567",
        "email": "mrhippo@goshippo.com"
  },
  "address_to": {
      "name": "Mr Hippo",
      "street1": "2967 Filbert Dr",
      "street2": "APT 3",
      "city": "Walnut Creek",
      "state": "CA",
      "zip": "94598",
      "country": "US",
      "phone": "4151234567",
      "email": "mrhippo@goshippo.com"
  },
  "parcels": [{
    "weight": "8",
    "length": "9",
    "width": "3",
    "height": "8",
    "distance_unit": "in",
    "mass_unit": "lb"
  }],
  "extra": {
    "saturday_delivery": "true"
  },
  "async": false
}'
Response:
Saturday Shipment response
{
    "carrier_accounts": [],
    "object_created": "2024-04-15T12:15:00.500Z",
    "object_updated": "2024-04-15T12:15:00.688Z",
    "object_id": "09f2f253f1bd42418bb586aea7be74cf",
    "object_owner": "mrhippo@goshippo.com",
    "status": "SUCCESS",
    "address_from": {
        "object_id": "75318fbe88084e2abeba8acd41886ffc",
        "is_complete": true,
        "name": "Mr Hippo",
        "company": "",
        "street_no": "",
        "street1": "965 Mission Street",
        "validation_results": {},
        "street2": "Suite 480",
        "street3": "",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94103",
        "country": "US",
        "phone": "4151234567",
        "email": "mrhippo@goshippo.com",
        "is_residential": null,
        "test": true
    },
    "address_to": {
        "object_id": "3f7b80dd96524adc807ac6f579fc4359",
        "is_complete": true,
        "name": "Mr Hippo",
        "company": "",
        "street_no": "",
        "street1": "2967 Filbert Dr",
        "validation_results": {},
        "street2": "APT 3",
        "street3": "",
        "city": "Walnut Creek",
        "state": "CA",
        "zip": "94598",
        "country": "US",
        "phone": "4151234567",
        "email": "mrhippo@goshippo.com",
        "is_residential": null,
        "test": true
    },
    "parcels": [
        {
            "object_state": "VALID",
            "object_created": "2024-04-15T12:15:00.473Z",
            "object_updated": "2024-04-15T12:15:00.506Z",
            "object_id": "cc7df8872e694ab38a6604fb72bf2e28",
            "object_owner": "adrian.collins@goshippo.com",
            "template": null,
            "extra": {},
            "length": "9.0000",
            "width": "8.0000",
            "height": "3.0000",
            "distance_unit": "in",
            "weight": "8.0000",
            "mass_unit": "lb",
            "value_amount": null,
            "value_currency": null,
            "metadata": "",
            "line_items": [],
            "test": true
        }
    ],
    "shipment_date": "2024-04-15T12:15:00.688Z",
    "address_return": {
        "object_id": "75318fbe88084e2abeba8acd41886ffc",
        "is_complete": true,
        "name": "Mr Hippo",
        "company": "",
        "street_no": "",
        "street1": "965 Mission Street",
        "validation_results": {},
        "street2": "Suite 480",
        "street3": "",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94103",
        "country": "US",
        "phone": "4151234567",
        "email": "mrhippo@goshippo.com",
        "is_residential": null,
        "test": true
    },
    "customs_declaration": null,
    "extra": {
        "saturday_delivery": "true"
    },
    "rates": [
        {
            "object_created": "2024-04-15T12:15:01.400Z",
            "object_id": "7cfebbe9de6b4c3dbef3b2ccd9754032",
            "object_owner": "adrian.collins@goshippo.com",
            "shipment": "09f2f253f1bd42418bb586aea7be74cf",
            "attributes": [],
            "amount": "20.32",
            "currency": "USD",
            "amount_local": "20.32",
            "currency_local": "USD",
            "provider": "DHL eCommerce",
            "provider_image_75": "https://shippo-static-v2.s3.amazonaws.com/providers/75/DHL_ecommerce.png",
            "provider_image_200": "https://shippo-static-v2.s3.amazonaws.com/providers/200/DHL_ecommerce.png",
            "servicelevel": {
                "name": "Parcels Expedited",
                "token": "dhl_ecommerce_parcels_expedited",
                "terms": ""
            },
            "estimated_days": 4,
            "arrives_by": null,
            "duration_terms": "",
            "messages": [],
            "carrier_account": "73fe2e0731eb4e4ca6fc68e1bb1291a4",
            "test": true,
            "zone": "USPS08"
        }
    ],
    "metadata": "",
    "test": true,
    "order": null
}