# BMGetInventory API Operation (SOAP) (/api/nvp-soap/get-inventory-soap) > **Note:** **Important:** NVP/SOAP is a legacy integration method. We accept new integrations and support existing integrations, but there are newer solutions. If you're starting an integration, [we recommend our latest solutions](/). Shows the inventory levels and other inventory-related information for a button and menu items associated with the button. > **Note:** **Important:** > > The Button Manager API is deprecated. For new integrations, see the associated topic. > > | Button | See | > | ----------------------------------------------- | ------------------------------------------------------------------------------------ | > | **Buy Now**
| [PayPal Checkout Overview](/checkout)
| > | **Add to Cart**
| [Solution Providers](https://www.paypal.com/us/webapps/mpp/solution-providers)
| > | **Donate**
| [Create a Donate button](/api/nvp-soap/paypal-payments-pro)
| > | **Automatic Billing**
**Subscribe**
| [Subscriptions Overview](/subscriptions/about)
| Typically, you call `BMGetInventory` to obtain field values before calling `BMSetInventory` to change the inventory levels. ## BMGetInventory request [#bmgetinventory-request] The hosted button ID identifies the button for which to track inventory. ### BMGetInventory request parameters [#bmgetinventory-request-parameters] | Field
| Description
| | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `HostedButtonID`
| `xs:string`
| | `DigitalDownloadKeys`
| `xs:string`
Character length and limitations: 1,000 single-byte alphanumeric characters each.
| ## BMGetInventory response [#bmgetinventory-response] The response fields contain inventory information related to the button. ### BMGetInventory response fields [#bmgetinventory-response-fields] | Field
| Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `HostedButtonID`
| `xs:string`
The ID of the hosted button whose inventory you want to set.
| | `TrackInv`
| `xs:string`
Whether to track inventory levels associated with the button. Value is:
`0`. Do not track inventory
`1`. Track inventory.
| | `TrackPnl`
| `xs:string`
Whether to track the gross profit associated with inventory changes. Value is:
`0`. Do not track the gross profit
`1`. Track the gross profit.
> **Note:** **Note:** The gross profit is calculated as the price of the item less its cost, multiplied by the change in the inventory level since the last call to `BMSetInventory`. | | | `ebl:ItemTrackingDetails`
Item tracking details for the button.
| | `OptionIndex`
| `xs:string`
Option index, which identifies the button. Option index 0 is the menu that contains the price if one exists; otherwise, it is the first menu without a price.
Character length and limitations: One single-byte alphanumeric character.
| | | `ebl:OptionTrackingDetails`
Option tracking details for menu items associated with the button.
| | `SoldoutURL`
| `xs:string`
The URL to which the buyer's browser is redirected when the inventory drops to 0
> **Note:** **Note:** A value in this field also prevents a sale when the inventory drops to 0; otherwise, sales can continue even when inventory is unavailable. Character length and limitations: 127 single-byte alphanumeric characters
| ### Item tracking details fields [#item-tracking-details-fields] | Field | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | `ItemNumber`
| `xs:string`
The ID for an item associated with this button
| | `ItemQty`
| `xs:string`
The current inventory level of the item associated with this button
| | `ItemQtyDelta`
| `xs:string`
Not used
| | `ItemAlert`
| `xs:string`
The quantity of the item associated with this button below which PayPal sends you an email notification
| | `ItemCost`
| `xs:string`
The cost of the item associated with this button
| ### Option tracking details fields [#option-tracking-details-fields] | Field | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `OptionNumber`
| `xs:string`
The menu item's ID for an option in a drop-down menu
| | `OptionQty`
| `xs:string`
The current inventory level of the option associated with this menu item
| | `OptionSelect`
| `xs:string`
The menu item's name in a drop-down menu
| | `OptionQtyDelta`
| `xs:string`
Not used
| | `OptionAlert`
| `xs:string`
The quantity of the option associated with this menu item below which PayPal sends you an email notification
| | `OptionCost`
| `xs:string`
The cost of the option associated with this menu item
| ## BMGetInventory errors [#bmgetinventory-errors] | Error code | Short and long messages | User action | | ---------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 10001 | Internal Error
Internal Error | To learn more about possible causes and corrective actions, see [What is API error code 10001?](https://www.paypal.com/us/selfhelp/article/what-is-api-error-code-10001-ts1041/3?channel=MTS). | | 11950 | Invalid Data
A hosted button ID must be specified. | | | 11951 | Invalid Argument
The hosted button ID specified is invalid. | | | 11953 | Invalid Data
You can only track inventory and profit & loss for buy now, cart or subscription buttons. | | | 11991 | Invalid Data
The hosted button id specified does not have any inventory or cost associated with it. | | | 11992 | Invalid Argument
You do not have permissions to access this button. Please check the hosted button ID and try again. | |