Skip to content

API changelog

Each published version of the documentation, newest first. Older versions stay readable.

  1. v1.3

    Current

    Updated BIRP API Documentation

    • Reads, with an API key: products, categories, customers, warehouses, stock levels, orders and invoices, with cursor pagination and updated_since.

    • Writes: products, categories and customers, with upserts by external id and batches of up to 100; stock adjustments; orders, with confirm and cancel.

    • Invoices: drafts with totals and VAT computed by BIRP, their issue, and payments.

    • External ids on products, categories, customers, warehouses, orders and invoices.

    • GET /v1/tax-codes, the tax codes to put on invoice lines, as the rules of the company's country define them.

    • amount_paid and amount_due of invoices always carry two decimals, such as "0.00".

    • Webhooks: BIRP sends a signed request to your webhook endpoints when products, categories, customers, stock levels, orders and invoices change, with retries, a test event and one page per event type.

    • WooCommerce: a shop connects to BIRP under CRM > E-commerce, without code, for the catalogue, prices, stock, orders and their statuses.

    • Order lines: product_kind takes the value goods, for resale goods on an order received from an online shop.

    Read the current versionOpenAPI file

  2. v1.2

    Archived

    An updated version of BIRP API documentation

    • Reads, with an API key: products, categories, customers, warehouses, stock levels, orders and invoices, with cursor pagination and updated_since.

    • Writes: products, categories and customers, with upserts by external id and batches of up to 100; stock adjustments; orders, with confirm and cancel.

    • Invoices: drafts with totals and VAT computed by BIRP, their issue, and payments.

    • External ids on products, categories, customers, warehouses, orders and invoices.

    • GET /v1/tax-codes, the tax codes to put on invoice lines, as the rules of the company's country define them.

    • amount_paid and amount_due of invoices always carry two decimals, such as "0.00".

    • Webhooks: BIRP sends a signed request to your webhook endpoints when products, categories, customers, stock levels, orders and invoices change, with retries, a test event and one page per event type.

    Read version v1.2OpenAPI file

  3. v1.1

    Archived

    The first published version of the BIRP API documentation.

    • Reads, with an API key: products, categories, customers, warehouses, stock levels, orders and invoices, with cursor pagination and updated_since.

    • Writes: products, categories and customers, with upserts by external id and batches of up to 100; stock adjustments; orders, with confirm and cancel.

    • Invoices: drafts with totals and VAT computed by BIRP, their issue, and payments.

    • External ids on products, categories, customers, warehouses, orders and invoices.

    • GET /v1/tax-codes, the tax codes to put on invoice lines, as the rules of the company's country define them.

    • amount_paid and amount_due of invoices always carry two decimals, such as "0.00".

    Read version v1.1OpenAPI file