BMGetInventory API Operation (NVP)

Shows the inventory levels and other inventory-related information for a button and menu items associated with the button. Typically, you call BMGetInventory to obtain field values before calling BMSetInventory to change the inventory levels.

BMGetInventory Request

The hosted button ID identifies the button whose inventory you want to track.

BMGetInventory Request Fields

Field

Description

METHOD

(Required) BMGetInventory

HOSTEDBUTTONID

(Required) The ID of the hosted button whose inventory information you want to obtain.

L_DIGITALDOWNLOADKEYSn

(Optional) One or more digital download keys, up to a maximum of 1,000 keys.

The variable n in the field name is a number between 0 and 999, inclusive, that specifies the key.

Character length and limitations: 1,000 single-byte alphanumeric characters each.

BMGetInventory Response

The response fields contain inventory information related to the button.

BMGetInventory Response Fields

Field

Description

HOSTEDBUTTONID

The ID of the hosted button whose inventory you want to set.

TRACKINV

Whether to track inventory levels associated with the button. Value is:


  • 0 - do not track inventory

  • 1 - track inventory

TRACKPNL

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: 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.

OPTIONNAMEINDEX

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: 1 single-byte alphanumeric character

SOLDOUTURL

The URL to which the buyer's browser is redirected when the inventory drops to 0

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

ITEMNUMBER

The ID for an item associated with this button

ITEMQTY

The current inventory level of the item associated with this button

ITEMQTYDELTA

Not used

ITEMALERT

The quantity of the item associated with this button below which PayPal sends you an email notification

ITEMCOST

The cost of the item associated with this button

Option Tracking Details Fields

L_OPTIONNUMBERn

The menu item's ID for an option in a dropdown menu

It is a list of variables for each menu item, in which n is a digit between 0 and 9, inclusive.

L_OPTIONQTYn

The current inventory level of the option associated with this menu item

It is a list of variables for each menu item, in which n is a digit between 0 and 9, inclusive.

L_OPTIONSELECTn

The menu item's name in a dropdown menu

It is a list of variables for each menu item, in which n is a digit between 0 and 9, inclusive.

L_OPTIONQTYDELTAn

Not used

It is a list of variables for each menu item, in which n is a digit between 0 and 9, inclusive.

L_OPTIONALERTn

The quantity of the option associated with this menu item below which PayPal sends you an email notification

It is a list of variables for each menu item, in which n is a digit between 0 and 9, inclusive.

L_OPTIONCOSTn

The cost of the option associated with this menu item

It is a list of variables for each menu item, in which n is a digit between 0 and 9, inclusive.

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?.
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.