What the BIRP API is for
The four jobs the API does today, who it is for, and what is still in development.
Version v1.3, updated
The BIRP API gives a system you run access to the data of one company in BIRP. Use it to connect a shop, a marketplace or your own software to that company, from a server.
Four jobs it does today
Read the company data: products, categories, customers, warehouses, stock levels, orders and invoices.
Push data in: create and update products, categories and customers, record stock adjustments, create orders, draft and issue invoices, and record payments.
Link records to the ids of your own systems, so each side finds the other side of a record by its external id.
Hear about changes: BIRP sends a signed request to your webhook endpoints when a product, a category, a customer, a stock level, an order or an invoice changes.
Who it is for
Developers who connect a shop, an online marketplace, an automation tool or their own software to a company that uses BIRP. Every call acts for one company, the one that created the API key.
Call the API from a server. Browsers get no cross-origin access, so a key never has to live in a web page or a mobile app.
Base URL and versions
Every operation lives under https://api.birp.io/v1. The v1 in the path is the version of the contract.
New operations and new response fields arrive within v1, so read responses in a way that ignores fields you do not know. A change that breaks existing calls gets a new version in the path.
In development
In development. Ready-made connectors for Shopify and for automation tools are in development. So are keys for platforms that serve several companies.
Until they exist, connect with your own code and the operations of this documentation: Build a custom integration shows the order to follow. A WooCommerce shop connects without code: see WooCommerce.
Related
- first-key
- first-request
- glossary