User Guide
Table Of Contents
- Button Manager API (NVP)
- Preface
- Intended Audience
- Revision History
- PayPal Payments Standard Button Manager API Overview
- Using the Button Manager API With NVP
- Button Manager API Reference
- HTML Variables for PayPal Payments Standard
- Technical HTML Variables
- HTML Variables for Individual Items
- HTML Variables for Payment Transactions
- HTML Variables for Shopping Carts
- HTML Variables for Recurring Payments Buttons
- HTML Variables for Displaying PayPal Checkout Pages
- HTML Variables for Filling Out PayPal Checkout Pages Automatically
- HTML Variables for the Instant Update API
Button Manager API Reference
BMGetInventory API Operation
3
48 April 2012 Button Manager NVP API
Item Tracking Details Fields
Option Tracking Details Fields
TRACKPNL Whether to track the gross profit associated with inventory changes. It is one
of the following values:
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
Field Description
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
Field Description
L_OPTIONNUMBER
n 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_OPTIONQTY
n 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_OPTIONSELECT
n 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.
Field Description