---
title: Integrate Through the byrd API
description: Follow these steps to integrate your e-commerce system through the byrd API.
---

[Skip to content](https://support.getbyrd.com/en/knowledge-base/integrate-through-the-byrd-api#main-content)

English

Show submenu for translations

[Submit a ticket](https://support.getbyrd.com/en/knowledge-base/kb-tickets/new?hsLang=en)

![byrd\_logo\_classic\_transparent (3)](https://support.getbyrd.com/hs-fs/hubfs/byrd_logo_classic_transparent%20(3).png?width=85&height=40&name=byrd_logo_classic_transparent%20(3).png)

- [Knowledge base](https://support.getbyrd.com/en/knowledge-base)
- [Ticket overview](https://support.getbyrd.com/tickets)
- [What's new 💡](https://app.getbeamer.com/byrd/en)

Open main navigation

Close main navigation

- [Knowledge base](https://support.getbyrd.com/en/knowledge-base)
- [Ticket overview](https://support.getbyrd.com/tickets)
- [What's new 💡](https://app.getbeamer.com/byrd/en)
- English
  
  Show submenu for translations
- [Submit a ticket](https://support.getbyrd.com/en/knowledge-base/kb-tickets/new)
- [Go to getbyrd.com](https://www.getbyrd.com/en)

[Go to getbyrd.com](https://www.getbyrd.com/en)

 Hi there! How can we help today?

- There are no suggestions because the search field is empty.

1. [Customer Service Hub - FAQs](https://support.getbyrd.com/en/knowledge-base?hsLang=en)
2. [Integrations](https://support.getbyrd.com/en/knowledge-base/integrations?hsLang=en)

# Integrate Through the byrd API

## Follow these steps to integrate your e-commerce system through the byrd API.

Follow these steps to integrate your e-commerce system through the byrd API:

### **1. Preparation**

**Request Credentials:**

- Contact byrd for your API credentials.

**Set Up Environment:**

- Enter company details in the byrd dashboard.
- Create products and announce deliveries manually or through the API.

### **2. Development**

**Choose API flows:**

- Implement necessary API flows. In most of cases shipment creation is required, but we recommend adding tracking and stock level flows.
- Don’t hesitate to contact us if you need help choosing the flows to implement.

### **3. Test**

**Test Integration:**

- Test your API integration thoroughly.
- Use the byrd dashboard to check operation results. You may need to contact byrd if you want to move the shipment between status that need a warehouse action because your account is not a live account.

**Live Test:**

- Schedule a live test with byrd.

### **4. Go Live**

**Get Production Access:**

- Obtain production access from byrd.

**Configure Environment:**

- Set up your environment for live operations with byrd's help.

For detailed instructions, refer to the byrd API documentation [here](https://developers.getbyrd.com/). For assistance, contact byrd support.

- [Additional FAQs](https://support.getbyrd.com/en/knowledge-base/additional-faqs?hsLang=en)
- [How to get started with byrd](https://support.getbyrd.com/en/knowledge-base/how-to-get-started-with-byrd?hsLang=en)
- [General](https://support.getbyrd.com/en/knowledge-base/general?hsLang=en)
- [Integrations](https://support.getbyrd.com/en/knowledge-base/integrations?hsLang=en)
- [Invoicing & Costs](https://support.getbyrd.com/en/knowledge-base/invoicing-costs?hsLang=en)
- [Shipments](https://support.getbyrd.com/en/knowledge-base/shipments?hsLang=en#main-content)

    - [B2B Shipments](https://support.getbyrd.com/en/knowledge-base/shipments?hsLang=en#b2b-shipments)
- [Products & Inventory](https://support.getbyrd.com/en/knowledge-base/products-inventory?hsLang=en)
- [Inbound deliveries](https://support.getbyrd.com/en/knowledge-base/inbound-deliveries?hsLang=en)
- [Returns](https://support.getbyrd.com/en/knowledge-base/returns?hsLang=en)
- [International shipments](https://support.getbyrd.com/en/knowledge-base/international-shipments?hsLang=en)
- [Peak Season](https://support.getbyrd.com/en/knowledge-base/peak-season?hsLang=en)

- [Knowledge base](https://support.getbyrd.com/en/knowledge-base)
- [Ticket overview](https://support.getbyrd.com/tickets)
- [What's new 💡](https://app.getbeamer.com/byrd/en)

[![byrd\_logo\_new\_green\_inversed](https://support.getbyrd.com/hs-fs/hubfs/byrd_logo_new_green_inversed.png?width=100&height=46&name=byrd_logo_new_green_inversed.png "byrd_logo_new_green_inversed")](http://getbyrd.com)

Copyright © 2025, byrd technologies GmbH