Logo
Bellhop API Documentation

v2-PODs

Number of APIs: 7


1. Check Postal Code Availability

GET {{HOST}}/api/partner-api/v2/pods/postalcode/available?postal_code=12345&postal_code=54321



2. Create Package Quote

POST {{HOST}}/api/partner-api/v2/pods/quotes

{
    "id": "c9021e1e-7689-4ff9-a0c7-25dbca3202cc",
    "package": {
        "id": "PODS_LOADING_ONLY"
    },
    "serviceQuotes": [
        {
            "id": "3d8899c9-a1a6-4bdb-98e7-7281d0afdaca",
            "pricingStrategy": "HOURLY",
            "pricing": {
                "currency": "USD",
                "amount": 14000
            },
            "start": "2022-09-23T12:00:00Z",
            "startTimezone": "America/New_York",
            "end": "2022-09-23T14:00:00Z",
            "endTimezone": "America/New_York",
            "duration": 2,
            "workers": 3,
            "available": false,
            "locations": [
                {
                    "id": "c651ef99ef2877c9888ef2b264fdeacb1af8abab9e2cd29bb8a3f40ab3cb501a",
                    "timezone": "America/New_York"
                }
            ],
            "service": {
                "id": "LOADING",
                "name": "Loading"
            }
        }
    ],
    "feeQuotes": [],
    "available": false,
    "name": "PODs Loading"
}



3. Get Package Quote

GET {{HOST}}/api/partner-api/v2/pods/quotes/:package_quote_id



4. Create Flexible Service Quotes v2

POST {{HOST}}/api/partner-api/v2/pods/quotes/:package_quote_id/flexibleservicequotes

Example response:

[
    {
        "id": "5b0f4aab-c951-4537-9c54-3ef9ccff0bda",
        "pricingStrategy": "HOURLY",
        "pricing": {
            "currency": "USD",
            "amount": 14000
        },
        "start": "2022-09-23T12:00:00Z",
        "startTimezone": "America/New_York",
        "end": "2022-09-23T14:00:00Z",
        "endTimezone": "America/New_York",
        "duration": 2,
        "workers": 3,
        "available": false,
        "locations": [
            {
                "id": "c651ef99ef2877c9888ef2b264fdeacb1af8abab9e2cd29bb8a3f40ab3cb501a",
                "timezone": "America/New_York"
            }
        ],
        "service": {
            "id": "LOADING",
            "name": "Loading"
        }
    },
    {
        "id": "687d8f3c-8122-4a48-83b2-32ac92cdb350",
        "pricingStrategy": "HOURLY",
        "pricing": {
            "currency": "USD",
            "amount": 14000
        },
        "start": "2022-09-24T12:00:00Z",
        "startTimezone": "America/New_York",
        "end": "2022-09-24T14:00:00Z",
        "endTimezone": "America/New_York",
        "duration": 2,
        "workers": 3,
        "available": false,
        "locations": [
            {
                "id": "c651ef99ef2877c9888ef2b264fdeacb1af8abab9e2cd29bb8a3f40ab3cb501a",

                "timezone": "America/New_York"
            }
        ],
        "service": {
            "id": "LOADING",
            "name": "Loading"
        }
    },
    {
        "id": "3d879c39-5601-4ad6-857d-97a500632bbd",
        "pricingStrategy": "HOURLY",
        "pricing": {
            "currency": "USD",
            "amount": 12000
        },
        "start": "2022-09-25T12:00:00Z",
        "startTimezone": "America/New_York",
        "end": "2022-09-25T14:00:00Z",
        "endTimezone": "America/New_York",
        "duration": 2,
        "workers": 3,
        "available": false,
        "locations": [
            {
                "id": "c651ef99ef2877c9888ef2b264fdeacb1af8abab9e2cd29bb8a3f40ab3cb501a",
                "timezone": "America/New_York"
            }
        ],
        "service": {
            "id": "LOADING",
            "name": "Loading"
        }
    },
    {
        "id": "75090df6-ba65-4d57-a40d-319e689a403b",
        "pricingStrategy": "HOURLY",
        "pricing": {
            "currency": "USD",
            "amount": 12000
        },
        "start": "2022-09-26T12:00:00Z",
        "startTimezone": "America/New_York",
        "end": "2022-09-26T14:00:00Z",
        "endTimezone": "America/New_York",
        "duration": 2,
        "workers": 3,
        "available": false,
        "locations": [
            {
                "id": "c651ef99ef2877c9888ef2b264fdeacb1af8abab9e2cd29bb8a3f40ab3cb501a",
                "timezone": "America/New_York"
            }
        ],
        "service": {
            "id": "LOADING",
            "name": "Loading"
        }
    },
    {
        "id": "92da0ada-5d03-4241-9a35-575cc1a39bdd",
        "pricingStrategy": "HOURLY",
        "pricing": {
            "currency": "USD",
            "amount": 14000
        },
        "start": "2022-09-27T12:00:00Z",
        "startTimezone": "America/New_York",
        "end": "2022-09-27T14:00:00Z",
        "endTimezone": "America/New_York",
        "duration": 2,
        "workers": 3,
        "available": false,
        "locations": [
            {
                "id": "c651ef99ef2877c9888ef2b264fdeacb1af8abab9e2cd29bb8a3f40ab3cb501a",
                "timezone": "America/New_York"
            }
        ],
        "service": {
            "id": "LOADING",
            "name": "Loading"
        }
    },
    {
        "id": "cc590767-479a-4127-a401-c2a0b27f581c",
        "pricingStrategy": "HOURLY",
        "pricing": {
            "currency": "USD",
            "amount": 14000
        },
        "start": "2022-09-28T12:00:00Z",
        "startTimezone": "America/New_York",
        "end": "2022-09-28T14:00:00Z",
        "endTimezone": "America/New_York",
        "duration": 2,
        "workers": 3,
        "available": false,
        "locations": [
            {
                "id": "c651ef99ef2877c9888ef2b264fdeacb1af8abab9e2cd29bb8a3f40ab3cb501a",
                "timezone": "America/New_York"
            }
        ],
        "service": {
            "id": "LOADING",
            "name": "Loading"
        }
    },
    {
        "id": "e30a1b24-a687-4df6-8c0b-b8de56cb1062",
        "pricingStrategy": "HOURLY",
        "pricing": {
            "currency": "USD",
            "amount": 14000
        },
        "start": "2022-09-29T12:00:00Z",
        "startTimezone": "America/New_York",
        "end": "2022-09-29T14:00:00Z",
        "endTimezone": "America/New_York",
        "duration": 2,
        "workers": 3,
        "available": false,
        "locations": [
            {
                "id": "c651ef99ef2877c9888ef2b264fdeacb1af8abab9e2cd29bb8a3f40ab3cb501a",
                "timezone": "America/New_York"
            }
        ],
        "service": {
            "id": "LOADING",
            "name": "Loading"
        }
    },
    {
        "id": "1c675652-f1db-4951-837a-0fa48b150814",
        "pricingStrategy": "HOURLY",
        "pricing": {
            "currency": "USD",
            "amount": 16000
        },
        "start": "2022-09-30T12:00:00Z",
        "startTimezone": "America/New_York",
        "end": "2022-09-30T14:00:00Z",
        "endTimezone": "America/New_York",
        "duration": 2,
        "workers": 3,
        "available": false,
        "locations": [
            {
                "id": "c651ef99ef2877c9888ef2b264fdeacb1af8abab9e2cd29bb8a3f40ab3cb501a",
                "timezone": "America/New_York"
            }
        ],
        "service": {
            "id": "LOADING",
            "name": "Loading"
        }
    }
]



5. Replace Service Quote

PATCH {{HOST}}/api/partner-api/v2/pods/packagequotes/:package_quote_id/servicequotes/:service_quote_id



6. Quick Price

POST {{HOST}}/api/partner-api/v2/pods/quotes/quickprice

Quick Price takes the container configuration, container delivery date, and zip code and gets its own workers/hours estimate then goes and gets the cheapest price for loading within 7 days of the container delivery date and returns the price and the estimation.



7. Container Estimate

GET {{HOST}}/api/partner-api/v2/pods/quotes/containerestimate?eightFt=0&twelveFt=0&sixteenFt=1&serviceID=LOADING



ENDPOINTS