👋 Welcome

The Furniture Bros API provides all the tools you need to seamlessly interact with our application and unlock its full functionality.

This documentation assumes you have some basics about Rest API. If you are new, you can start from the Get Started page.

🤖 Postman

The fastest way to start using the API is by using Postman. If you are already familiar with Postman, you can start testing out the endpoints using the Postman collection here:

Some endpoints are public, some require an API key, and others need admin privileges. Learn more about authentication here.

🏃 Quick start

You can also interact with the API directly in this site. Here's how to do so:

Obtain Your API Key: Sign in to your account to access your API credentials. You can use the Get an API key endpoint to obtain a key.
Explore Endpoints: Dive into the detailed API Reference for all available functionality.
Start Building: Use the provided examples to make your first API call.

The API follows REST principles, uses JSON or form-data, and responds with standard HTTP codes. For more information, check out the Making a request page.

📁 Endpoint categories

The endpoints are grouped into the following categories for ease of navigation:

Account - Manage user accounts, view profiles, and update account information.
Product - View, search, and manage product information.
Cart - Add, update, and remove items from the shopping cart.
Address - Add, update, and manage shipping addresses.
Orders

Each of these categories has it's own use cases for your needs. Learn more about them by visiting the Functionalities page.

The API docs may include technical terms specific to their functionality (e.g. pagination, API key, content-type). The Glossary page lists these terms and serves as your reference when needed.

🌾 Integration Examples

If you're familiar with REST API concepts and have your app set up, go to the Examples page for examples of integrating code snippets. Each endpoint in the docs offers code samples in various languages, using either SDKs or built-in libraries—choose what works best for you. You can also use the Postman collection and check the code snippets tab for auto-generated code in different languages.

Need help? Visit our Support Center or contact us at support@furniturebros.com. Also visit our release notes to view our latest updates!

Let’s get started! 🚀 Click here to get your API key and start using the API!