# SkuVault Documentation

## Guides
- [Throttles](https://dev.skuvault.com/docs/throttles.md): Every call is throttled in some way. The tables below lay out throttling levels and limits as well as headers returned in the response.
- [Responses](https://dev.skuvault.com/docs/responses.md)
- [Types of Integrations](https://dev.skuvault.com/docs/types-of-integrations.md): This document will describe some of the basic concepts of how to build an integration to SkuVault.
- [Modifying products](https://dev.skuvault.com/docs/modifying-products.md)
- [Modifying Sales](https://dev.skuvault.com/docs/sale-status-guide.md)
- [API Reference for LLMs](https://dev.skuvault.com/docs/text-file-for-llms.md): Markdown Text File Now Available

## API Reference
- [/addItem](https://dev.skuvault.com/reference/additem.md): **[Moderate](doc:throttles)** throttling Add quantity to a warehouse location. [Bulk version available](doc:additembulk)
- [/addItemBulk](https://dev.skuvault.com/reference/additembulk.md): **[Moderate](doc:throttles)** throttling Add quantity to warehouse locations, 100 at a time.
- [/addShipments](https://dev.skuvault.com/reference/addshipments.md): **[Heavy](doc:throttles)** throttling. Using this call, users can add shipments to a sale.
- [/createBrands](https://dev.skuvault.com/reference/createbrands.md): **[Moderate](doc:throttles)** throttling
- [/createHolds](https://dev.skuvault.com/reference/createholds.md): **[Moderate](doc:throttles)** throttling
- [/createKit](https://dev.skuvault.com/reference/createkit.md): **[Moderate](doc:throttles)** throttling Using this call, users may create a kit inside of SkuVault.
- [/createLot](https://dev.skuvault.com/reference/createlot.md): **[Heavy](doc:throttles)** throttling. Using this call will create a lot number with all the required products
- [/getLots](https://dev.skuvault.com/reference/getlots.md): **[Heavy](doc:throttles)** throttling. Using this call will retrieve all the lots associated with the product
- [/getLotInventoryByLocation](https://dev.skuvault.com/reference/getlotinventorybylocation.md): **[Heavy](doc:throttles)** throttling. Using this call will retrieve all the lots quantities associated with the product
- [/createPO](https://dev.skuvault.com/reference/createpo.md): **[Moderate](doc:throttles)** throttling This call let's you create a PO using our API.
- [/createProduct](https://dev.skuvault.com/reference/createproduct.md): *Throttling: **[Moderate](doc:throttles)*** Create products in SkuVault one at a time. Bulk version available: [/createProducts](doc:createproducts)
- [/createProducts](https://dev.skuvault.com/reference/createproducts.md): **[Heavy](doc:throttles)** throttling Create 100 products per request.
- [/createSuppliers](https://dev.skuvault.com/reference/createsuppliers.md): **[Moderate](doc:throttles)** throttling Creates suppliers and their details in SkuVault. Can create up to 100 suppliers per call.
- [/getAvailableQuantities](https://dev.skuvault.com/reference/getavailablequantities.md): **[Heavy](doc:throttles)** throttling Retrieve a list of SKUs and their total available quantities across all warehouses. Available Quantity is the quantity that is actually available to sell across all your sales channels.
- [/getBrands](https://dev.skuvault.com/reference/getbrands.md): **[Heavy](doc:throttles)** throttling Returns a list of Brands created in SkuVault.
- [/getClassifications](https://dev.skuvault.com/reference/getclassifications.md): **[Heavy](doc:throttles)** throttling Returns classifications and, if they exist, their named attributes.
- [/getExternalWarehouseQuantities](https://dev.skuvault.com/reference/getexternalwarehousequantities.md): **[Heavy](doc:throttles)** throttling This call gets the quantities in a designated External Warehouse. Please note these are different than ordinary warehouses.
- [/getExternalWarehouses](https://dev.skuvault.com/reference/getexternalwarehouses.md): **[Moderate](doc:throttles)** throttling. Returns your external warehouses. No page parameters.
- [/getHandlingTime](https://dev.skuvault.com/reference/gethandlingtime.md)
- [/getIncomingItems](https://dev.skuvault.com/reference/getincomingitems.md): Get incoming items for incomplete purchase orders
- [/getIntegrations](https://dev.skuvault.com/reference/getintegrations.md): **[Severe](doc:throttles)** throttling. Returns a list of your enabled channel accounts. No page parameters.
- [/getInventoryByLocation](https://dev.skuvault.com/reference/getinventorybylocation.md): **[Heavy](doc:throttles)** throttling Returns location and warehouse per product.
- [/getItemQuantities](https://dev.skuvault.com/reference/getitemquantities.md): **[Heavy](doc:throttles)** throttling Returns product quantities.
- [/getKitQuantities](https://dev.skuvault.com/reference/getkitquantities.md): **[Heavy](doc:throttles)** throttling Returns kit quantities.
- [/getKits](https://dev.skuvault.com/reference/getkits.md): **[Heavy](doc:throttles)** throttling Returns kit details.
- [/getLocations](https://dev.skuvault.com/reference/getlocations.md): **[Heavy](doc:throttles)** throttling. Returns all your locations in enabled warehouses.
- [/getOnlineSaleStatus](https://dev.skuvault.com/reference/getonlinesalestatus.md): **[Heavy](doc:throttles)** throttling Returns a list of sales and their statuses.
- [/getPOs](https://dev.skuvault.com/reference/getpos.md): **[Heavy](doc:throttles)** throttling. Returns a list of purchase orders.
- [/getProduct](https://dev.skuvault.com/reference/getproduct.md): **[Light](doc:throttles)** throttling This call returns product (not kit) details. In addition to product information, the response also includes product quantities.
- [/getProducts](https://dev.skuvault.com/reference/getproducts.md): **[Heavy](doc:throttles)** throttling This call returns product (not kit) details. In addition to product information, the response also includes product quantities.
- [/getSerialNumbers](https://dev.skuvault.com/reference/getserialnumbers.md): Using this call, users may get all serial numbers for certain SKU inside of SkuVault.
- [/getReceivesHistory](https://dev.skuvault.com/reference/getreceiveshistory.md): **[Heavy](doc:throttles)** throttling. Returns a list of purchase order receives and receipts.
- [/getSaleItemCost](https://dev.skuvault.com/reference/getsaleitemcost.md): **[Heavy](doc:throttles)** throttling Retrieves the Item Cost for a Product for a Specific Sale.
- [/getSales](https://dev.skuvault.com/reference/getsales.md): **[Heavy](doc:throttles)** throttling Use this call to retrieve a list of sales from SkuVault. 10,000 sales are returned per page. The call also pulls in discount and tax information for the following integrations: Shopify, Big Commerce, eBay, Amazon, ChannelAdvisor, QuickBooks Online, Square, Magento, Lightspeed, WooCommerce, Etsy, Miva, LogicBroker, NewEgg, Skubana, NetSuite.
- [/getSalesByDate](https://dev.skuvault.com/reference/getsalesbydate.md): **[Heavy](doc:throttles)** throttling Returns sales based on a date range. 10,000 sales are returned per page.
- [/getShipments](https://dev.skuvault.com/reference/getshipments.md): **[Heavy](doc:throttles)** throttling. Using this call, users can get current shipment information.
- [/getSoldItems](https://dev.skuvault.com/reference/getsolditems.md): **[Heavy](doc:throttles)** throttling Returns a list of sold items filtered by date. 10,000 sales are returned per page.
- [/getSuppliers](https://dev.skuvault.com/reference/getsuppliers.md): **[Heavy](doc:throttles)** throttling Returns the list of current Suppliers in a SkuVault account.
- [/getTokens](https://dev.skuvault.com/reference/gettokens.md): **[Very Light](doc:throttles)** throttling. Use this call to retrieve your API tokens from SkuVault  for any user/role using your login email and password.
- [/getTransactions](https://dev.skuvault.com/reference/gettransactions.md): **[Heavy](doc:throttles)** throttling Look at your transaction history.
- [/getWarehouseItemQuantities](https://dev.skuvault.com/reference/getwarehouseitemquantities.md): **[Heavy](doc:throttles)** throttling This call returns SKUs and quantities from a specified warehouse. 10,000 SKUs returned per page.
- [/getWarehouseItemQuantity](https://dev.skuvault.com/reference/getwarehouseitemquantity.md): **[Heavy](doc:throttles)** throttling Returns the quantity for a specified SKU.
- [/getWarehouses](https://dev.skuvault.com/reference/getwarehouses.md): **[Severe](doc:throttles)** throttling. Returns all your regular warehouses.
- [/pickItem](https://dev.skuvault.com/reference/pickitem.md): **[Moderate](doc:throttles)** throttling Perform a pick transaction through the API. [Bulk version available]
- [/pickItemBulk](https://dev.skuvault.com/reference/pickitembulk.md): **[Moderate](doc:throttles)** throttling Perform a bulk pick transaction through the API.
- [/receivePOItems](https://dev.skuvault.com/reference/receivepoitems.md): **[Moderate](doc:throttles)** throttling
- [/releaseHeldQuantities](https://dev.skuvault.com/reference/releaseheldquantities.md): **[Moderate](doc:throttles)** throttling Release holds before their expiration date expires.
- [/removeItem](https://dev.skuvault.com/reference/removeitem.md): **[Moderate](doc:throttles)** throttling Remove quantity from a warehouse location. [Bulk version available](doc:removeitembulk)
- [/removeItemBulk](https://dev.skuvault.com/reference/removeitembulk.md): **[Moderate](doc:throttles)** throttling Remove quantity from warehouse locations, 100 at a time.
- [/setItemQuantities](https://dev.skuvault.com/reference/setitemquantities.md): **[Moderate](doc:throttles)** throttling. Sets quantity for multiple products in one request.
- [/setItemQuantity](https://dev.skuvault.com/reference/setitemquantity.md): **[Moderate](doc:throttles)** throttling This lets you explicitly set quantity for an item in a warehouse's location.
- [/syncOnlineSale](https://dev.skuvault.com/reference/synconlinesale.md): **[Moderate](doc:throttles)** throttling Sync an online sale to SkuVault. If the sale does not exists, it's created. If it does exist, it's updated.  ShippingStatus is required to create sale, but not update. ItemSkus is always required. Bulk version available: [/syncOnlineSales](doc:synconlinesales)
- [/syncOnlineSales](https://dev.skuvault.com/reference/synconlinesales.md): **[Severe](doc:throttles)** throttling. :fa-exclamation-circle: Can make this call 2x per minute, 100 sales max
- [/syncShippedSaleAndRemoveItems](https://dev.skuvault.com/reference/syncshippedsaleandremoveitems.md): **[Moderate](doc:throttles)** throttling This method syncs a shipped sale and auto-removes quantity. If the product is in multiple locations, then the remove will occur at the location that is first in alphanumerical order. Quantity can be removed from normal, Reserved, and Backstock locations.  ---  ### :fa-exclamation-triangle: Warning: :fa-exclamation-triangle:  If your account has AutoRemove enabled, then syncing sales using this call will result in the system attempting to remove sale item quantity twice. Please use with caution and if you are unsure if this warning applies to your account, please submit a support ticket [here.](https://support.skuvault.com/support/tickets/new)
- [/syncShippedSaleAndRemoveItemsBulk](https://dev.skuvault.com/reference/syncshippedsaleandremoveitemsbulk.md): **[Moderate](doc:throttles)** throttling This method can sync multiple shipped sales and auto-removes quantity. Up to 100 sales per call.   If warehouseId isn't provided then quantity will only be removed if the item can only be found in one location across all warehouses. If a warehouseId is provided then quantity will be removed if the item is only found in one location within that specified warehouse.  ---  ### :fa-exclamation-triangle: Warning: :fa-exclamation-triangle:  If your account has AutoRemove enabled, then syncing sales using this call will result in the system attempting to remove sale item quantity twice. Please use with caution and if you are unsure if this warning applies to your account, please submit a support ticket [here.](https://support.skuvault.com/support/tickets/new)
- [/updateAltSKUsCodes](https://dev.skuvault.com/reference/updatealtskuscodes.md): **[Moderate](doc:throttles)** throttling Update the Alternate SKUs and Codes for your products.
- [/updateExternalWarehouseQuantities](https://dev.skuvault.com/reference/updateexternalwarehousequantities.md): **[Severe](doc:throttles)** throttling Set the quantity of SKUs in a specified external warehouse. Updating an external warehouse's quantities will overwrite any existing quantities: missed SKU will be zeroed out. In case the SKU was duplicated in the request only the last inventory record will be applied.  The limit is 200,000 SKUs per call.
- [/modifyExternalWarehouseQuantities](https://dev.skuvault.com/reference/modifyexternalwarehousequantities.md): **[Severe](doc:throttles)** throttling Set the quantity of SKUs in a specified external warehouse. Updating an external warehouse's quantities will not overwrite any existing quantities. The limit is 200,000 SKUs per call.
- [/updateHandlingTime](https://dev.skuvault.com/reference/updatehandlingtime.md): **[Severe](doc:throttles)** throttling Update the handling time for each product per Amazon channel account, 500 at a time.
- [/updateOnlineSaleStatus](https://dev.skuvault.com/reference/updateonlinesalestatus.md): **[Light](doc:throttles)** throttling Update the status of a sale.
- [/updatePOs](https://dev.skuvault.com/reference/updatepos.md): **[Heavy](doc:throttles)** throttling Update your existing Purchase Orders. [/updatePOs](doc:updatepos)
- [/updateProduct](https://dev.skuvault.com/reference/updateproduct.md): **[Moderate](doc:throttles)** throttling Update your product details. Bulk version available: [/updateProducts](doc:updateproducts)
- [/updateProducts](https://dev.skuvault.com/reference/updateproducts.md): **[Heavy](doc:throttles)** throttling. Update products in SkuVault, 100 at a time.
- [/updateShipments](https://dev.skuvault.com/reference/updateshipments.md): **[Severe](doc:throttles)** throttling. Using this call, users can update shipments to a sale.

## Changelog
- [Update to SyncOnlineSale(s) Call](https://dev.skuvault.com/changelog/update-to-synconlinesales-call.md)
- [New Call: GetSaleItemCost](https://dev.skuvault.com/changelog/new-call-getsaleitem-cost.md)
- [Update to the GetSalesByDate call!](https://dev.skuvault.com/changelog/update-to-the-getsalesbydate-call.md)
- [New API call: PickItemBulk](https://dev.skuvault.com/changelog/new-api-call-getpickitembulk.md)
- [New Call: getHandlingTime for SKU's by warehouse](https://dev.skuvault.com/changelog/new-call-gethandlingtime-for-skus-by-warehouse.md)