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. For assistance, contact byrd support.