Logo
Bellhop API Documentation

Bellhop Partner API

Number of APIs: 35


Overview

This is the documentation for the Bellhop API for partners.

Getting Started

Environment

There are two environment variables that you will set up in your environment.

OAUTH_CLIENT_ID
OAUTH_CLIENT_SECRET

These will be used to obtain your token from the Authorization collection. They will identify you in our system and connect the leads you submit to your account. We will provide these to you in a secure manner.

Endpoints

In version 3.x we've added the Quoting resource.

  • Authorization
  • Leads
  • Quoting

Authorization will handle obtaining your access token. These will expire after 86400 seconds, however, we recommend that you obtain one each time you submit data. We will cache your token for you in our system.

Leads will handle the creation/view of leads.


1. v1-Authorization - Obtain a token

POST {{HOST}}/api/partner-api/authorize

Obtain a JWT token with the provided credentials.

Caching
All tokens are cached for 86400 seconds (24 hours) on our server, feel free to call the API as many times as you need.

Available Scopes

  • View
  • Create
  • Update

Note: Scopes
Scopes are attached to a token, and are cached. Any scope changes will take 24 hours to update.


2. v1-Leads - Create a lead

POST {{HOST}}/api/partner-api/v0/sales/leads

Create a sales lead.

Available Fields

  • See examples for a list of available fields (multiple examples)

Required Scopes

  • sales:leads:create


3. v1-Leads - Get a lead

GET {{HOST}}/api/partner-api/v0/sales/leads/{{external_lead_id}}

Get a sales lead.

Required Scopes

  • sales:leads:view

Notes

  • Sales leads are retrieved for an external_id and a lead_source
  • lead_source is determined by your API key
  • You cannot retrieve other users leads in any way


4. v1-Leads - Update a lead

PATCH {{HOST}}/api/partner-api/v0/sales/leads/{{external_id}}

Updates the supplied fields for a lead.

Available Fields

  • close_date
  • description

Required Scopes

  • sales:leads:update


5. v1-Leads - Cancel a lead

DELETE {{HOST}}/api/partner-api/v0/sales/leads/{{external_id}}/cancel

Cancels a lead. The lead will still be accessible, but marked with a 'Lost' status.

Required Scopes

  • sales:leads:update


6. v1-PODs - Check Postal Code Availability

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


7. v1-PODs - Create Package Quote

POST {{HOST}}/api/partner-api/v1/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"
}


8. v1-PODs - Get Package Quote

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


9. v1-PODs - Create Flexible Service Quotes

POST {{HOST}}/api/partner-api/v1/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"
        }
    }
]


10. v1-PODs - Replace Service Quote

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


11. v2-Authorization - Obtain a token

POST {{HOST}}/api/partner-api/authorize

Obtain a JWT token with the provided credentials.

Caching
All tokens are cached for 86400 seconds (24 hours) on our server, feel free to call the API as many times as you need.

Available Scopes

  • View
  • Create
  • Update

Note: Scopes
Scopes are attached to a token, and are cached. Any scope changes will take 24 hours to update.


12. v2-Leads - Create a lead

POST {{HOST}}/api/partner-api/v2/sales/leads

Create a sales lead.

Available Fields

  • See examples for a list of available fields (multiple examples)

Required Scopes

  • sales:leads:create


13. v2-Leads - Get a lead

GET {{HOST}}/api/partner-api/v2/sales/leads/{{external_lead_id}}

Get a sales lead.

Required Scopes

  • sales:leads:view

Notes

  • Sales leads are retrieved for an external_id and a lead_source
  • lead_source is determined by your API key
  • You cannot retrieve other users leads in any way


14. v2-Leads - Update a lead

PATCH {{HOST}}/api/partner-api/v2/sales/leads/{{external_id}}

Updates the supplied fields for a lead.

Available Fields

  • close_date
  • description

Required Scopes

  • sales:leads:update


15. v2-Leads - Cancel a lead

DELETE {{HOST}}/api/partner-api/v2/sales/leads/{{external_id}}/cancel

Cancels a lead. The lead will still be accessible, but marked with a 'Lost' status.

Required Scopes

  • sales:leads:update


16. v2-PODs - Check Postal Code Availability

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


17. v2-PODs - 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"
}


18. v2-PODs - Get Package Quote

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


19. v2-PODs - 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"
        }
    }
]


20. v2-PODs - Replace Service Quote

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


21. v2-PODs - 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.


22. v2-PODs - Container Estimate

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


23. v3-Authorization - Obtain a token

POST {{HOST}}/api/partner-api/authorize

Obtain a JWT token with the provided credentials.

Caching
All tokens are cached for 86400 seconds (24 hours) on our server, feel free to call the API as many times as you need.

Available Scopes

  • View
  • Create
  • Update

Note: Scopes
Scopes are attached to a token, and are cached. Any scope changes will take 24 hours to update.


24. v3-Leads - Create a lead

POST {{HOST}}/api/partner-api/v2/sales/leads

Create a sales lead.

Available Fields

  • See examples for a list of available fields (multiple examples)

Required Scopes

  • sales:leads:create


25. v3-Leads - Get a lead

GET {{HOST}}/api/partner-api/v2/sales/leads/{{external_lead_id}}

Get a sales lead.

Required Scopes

  • sales:leads:view

Notes

  • Sales leads are retrieved for an external_id and a lead_source
  • lead_source is determined by your API key
  • You cannot retrieve other users leads in any way


26. v3-Leads - Update a lead

PATCH {{HOST}}/api/partner-api/v2/sales/leads/{{external_id}}

Updates the supplied fields for a lead.

Available Fields

  • close_date
  • description

Required Scopes

  • sales:leads:update


27. v3-Leads - Cancel a lead

DELETE {{HOST}}/api/partner-api/v2/sales/leads/{{external_id}}/cancel

Cancels a lead. The lead will still be accessible, but marked with a 'Lost' status.

Required Scopes

  • sales:leads:update


28. v3-quoting - Check Postal Code Availability

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


29. v3-quoting - Container Estimate

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


30. v3-quoting - Get Package Quote

GET {{HOST}}/api/partner-api/v3/quotes/:package_quote_id


31. v3-quoting - Create Package Quote

POST {{HOST}}/api/partner-api/v3/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"
}


32. v3-quoting - Create Flexible Service Quotes v2

POST {{HOST}}/api/partner-api/v3/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"
        }
    }
]


33. v3-quoting - Quick Price

POST {{HOST}}/api/partner-api/v3/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.


34. v3-quoting - Create Order

POST {{HOST}}/api/partner-api/v3/orders

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.


35. v3-quoting - Replace Service Quote

PATCH {{HOST}}/api/partner-api/v3/quotes/:package_quote_id/servicequotes/:service_quote_id


  • FAQs

  • More

    Github

    Twitter

    Developer Website

    Claim this page

    Report this page

ENDPOINTS