Files
bitburner-src/markdown/bitburner.warehouseapi.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* Update api-documentor and api-extractor. #1566 follow-up.

I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.

I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).

Stylisticly it could use some whitespace, but it is correctly rendered.

This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.

* Follow up to 5f732a6f35, include `npm run doc` changed docs.

* Add missing license info

* Fix React warning

---------

Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
2025-09-26 14:52:39 -07:00

4.2 KiB

Home > bitburner > WarehouseAPI

WarehouseAPI interface

Corporation Warehouse API

Signature:

export interface WarehouseAPI 

Remarks

Requires the Warehouse API upgrade from your corporation.

Methods

Method

Description

bulkPurchase(divisionName, city, materialName, amt)

Set material to bulk-buy.

buyMaterial(divisionName, city, materialName, amt)

Set material buy data.

cancelExportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName)

Cancel material export.

discontinueProduct(divisionName, productName)

Discontinue a product.

exportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)

Set material export data.

getMaterial(divisionName, city, materialName)

Get material data.

getProduct(divisionName, cityName, productName)

Get product data.

getUpgradeWarehouseCost(divisionName, city, amt)

Get the cost to upgrade a warehouse to the next level.

getWarehouse(divisionName, city)

Get warehouse data.

hasWarehouse(divisionName, city)

Check if you have a warehouse in city.

limitMaterialProduction(divisionName, city, materialName, qty)

Limit material production.

limitProductProduction(divisionName, city, productName, qty)

Limit product production.

makeProduct(divisionName, city, productName, designInvest, marketingInvest)

Create a new product.

purchaseWarehouse(divisionName, city)

Purchase warehouse for a new city.

sellMaterial(divisionName, city, materialName, amt, price)

Set material sell data.

sellProduct(divisionName, city, productName, amt, price, all)

Set product sell data.

setMaterialMarketTA1(divisionName, city, materialName, on)

Set Market-TA1 for a material.

setMaterialMarketTA2(divisionName, city, materialName, on)

Set Market-TA2 for a material.

setProductMarketTA1(divisionName, productName, on)

Set Market-TA1 for a product.

setProductMarketTA2(divisionName, productName, on)

Set Market-TA2 for a product.

setSmartSupply(divisionName, city, enabled)

Set smart supply.

setSmartSupplyOption(divisionName, city, materialName, option)

Set whether smart supply uses leftovers before buying.

upgradeWarehouse(divisionName, city, amt)

Upgrade warehouse.