User Guide
Table Of Contents
- Website Payments Standard Button Manager API (SOAP)
- Preface
- Intended Audience
- Revision History
- Website Payments Standard Button Manager API Overview
- Using the Button Manager API
- Button Manager API Reference
- HTML Variables for Website Payments Standard
Button Manager SOAP API June, 2009 47
Button Manager API Reference
BMGetInventory API Operation
Item Tracking Details Fields
TrackInv xs:string
Whether to track inventory levels associated with the button. It is one of the
following values:
z 0 - do not track inventory
z 1 - track inventory
TrackPnl xs:string
Whether to track the gross profit associated with inventory changes. It is one
of the following values:
z 0 - do not track the gross profit
z 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.
— 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: 1 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: 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
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
Field Description