BMGetInventory API Operation (SOAP)

Use the BMGetInventory API operation to determine 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

HostedButtonID

xs:string

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

DigitalDownloadKeys

xs:string

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

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

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. It is one of the following values:


  • 0 - do not track inventory

  • 1 - track inventory

TrackPnl

xs:string

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.

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

Item Tracking Details Fields

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

OptionNumber

xs:string

The menu item's ID for an option in a dropdown 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 dropdown 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

Error Code

Short Message

Long Message

Correcting This Error...

10001 Internal Error Internal Error
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.