Changelog

2026-10-27

Expanded the API documentation: every method now has tables of what you can send and what you get back, examples are in collapsible blocks; OrderDataType and RemoteAddressType are tables with required fields
Fixed the described response formats of products, categories, remote orders and clients to match the actual API

Updated Get products: each warehouse has a new promotion field — the promotion applied to the product, including one on an additional price (price_type; price before and after it, its end)
Added Sale with a promotion: promotion_id in a sale item counts the sale towards the promotion in HugeProfit; finish_price may be omitted — we fill in the promotion price; new promotion_* errors

Added Rate limits: each key may make 300 requests per minute; responses carry X-RateLimit-* headers, and over the limit the API answers 429 with Retry-After

Updated GET shipments: new payments list — every payment for the goods of the shipment with its date, including deferred and partial ones
Described GET expenses (/bapi/expenses) with the new shipment_id filter — all payments of a shipment regardless of date
Added Productions (/bapi/productions): recipes, history and the new production run — writes the components off, adds the results to stock, records the expenses
Added Write-off (/bapi/write_off) — write goods off a warehouse in one call
Updated Reference: new types write_off_category and production_category

Updated Product Stock: new optional net_price field — sets the cost price on the warehouse; new errors net_price not valid and net_price is set by shipment or cost items; the "nothing to update" error is now quantity, price or net_price should be provided

Updated Clients GET: search by phone — phone finds clients by the whole number in any notation (380671234567, 0671234567, +38 (067) 123-45-67), phone_contains finds clients whose number contains the given digits (at least 3)

Updated InfoType: described the info keys you can send when creating an order and what each of them does in the HugeProfit interface (is_paid, payment_type, order_text, comment, account_id, channel_id, commission, utm, coupons, custom, promotions, promo_delivery, currency_conversion, system_status)
Updated OrderDataType: new optional price_converted field — item price in the base currency of the account

Updated Clients GET: new with_chats parameter (telegram) — returns the client's messenger chats in the chats field (type, integration_id, chat_id)
Fixed Clients GET: a client with several tags is no longer returned as several rows (this also broke limit / offset). All tags are now in the new tags list; client_tag_id / client_tag_name keep the first tag

Updated Remote orders GET: start / end now filter by the modification date (date_modified) and results are sorted by it descending — the endpoint now returns both new and recently changed orders within the range

Added new handler Suppliers (/bapi/suppliers) — get and add suppliers (GET, POST)

Updated Clients GET: response now includes client_tag_id and client_tag_name fields
Updated Clients POST: expanded allowed fields — added middle_name, nickname, balance, card_number, card_url, comment, debt, af, tag_name, tag_id
Added new Clients DELETE method for bulk client removal (up to 3000 records)
Added new handler Client Tags (/bapi/clients/tags) — manage client tags (GET, POST, PUT, DELETE)

Updated Product Stock documentation: added price field, marketplace_id alias for warehouse, requirement that at least one of quantity or price must be provided
Added new possible errors to Product Stock: marketplace_id {} is no access, price not valid, quantity or price should be provided
Added Wrong structure error response to Product Stock section