User Guide

Button Manager SOAP API June, 2009 41
Button Manager API Reference
BMSetInventory API Operation
Item Tracking Details Fields
TrackInv xs:string
(Required) 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
(Required) 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
(Optional) Item tracking details for the button
OptionIndex xs:string
(Optional) 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
(Optional) Option tracking details for menu items associated with the button
SoldoutURL xs:string
(Optional) The URL to which the buyer’s browser is redirected when the
inventory drops to 0
NOTE: Specifying a URL 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
(Optional) The ID for an item associated with this button
ItemQty xs:string
The quantity you want to specify for the item associated with this button.
Specify either the absolute quantity in this field or the change in quantity in the
quantity delta field
Field Description