Integrate Through the byrd AP

Modified on Wed, 28 Aug at 12:06 PM

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


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.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article