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-PODs - Get Package Quote

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

---

2. v1-PODs - Replace Service Quote

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

---

3. v1-PODs - Check Postal Code Availability

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

---

4. v1-Authorization - Obtain a token

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

---

5. v1-Leads - Create a lead

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

---

6. v1-Leads - Get a lead

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

---

7. v1-Leads - Update a lead

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

---

8. v1-Leads - Cancel a lead

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

---

9. v1-PODs - Create Package Quote

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

---

10. v1-PODs - Create Flexible Service Quotes

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

---