For developers
The Bimp public REST API gives access to documents, directories and stock balances. Start with authorization, then use the method reference by resource, ready-made integration scenarios and webhooks.
- API limits, pagination and errorsLimit of 15 requests per second, a queue of 30 requests and the 429 response, offset, page and cursor pagination types, and Bimp API error formats.
- External IDs in the Bimp API: mapping objects to your systemHow to map Bimp products, counterparties, orders and sales to IDs in your system using api-saveExternalId, readByExternalId and other methods.
- Bimp API method referenceAll Bimp REST API methods by resource: orders, sales, purchasing, inventory, production, finance, directories, with parameters, response fields and curl examples.
Scenarios
- Syncing orders with an online store via the APIHow to pass orders from an online store or CRM to Bimp via the API without duplicates: customers, external IDs, statuses, payments and order_status webhooks.
- Exporting stock balances and prices to a website via the APIHow to export stock balances and prices from Bimp to a website or marketplace: full export, increments, the inventory_balance webhook, pagination and request limits.
- Syncing the product catalog via the APIHow to sync the product catalog between Bimp and a website or marketplace via the API: groups, modifications, external IDs, increments and the product_upsert webhook.
- Purchasing via the API: from a supplier order to paymentHow to automate purchasing via the Bimp API: Supplier order, Goods receipt, Supplier payment and returns. Method order, examples and common errors.
- Payments and expenses via the API: customer payment, refund, expensesHow to pass customer payments, refunds, other expenses and income, and transfers between accounts to Bimp via the API: methods, fields and request examples.
- Exporting Bimp data for analytics via the APIHow to export sales, purchases, stock, prices and money from Bimp via the API to your own storage or BI: methods, pagination, incremental updates and limits.