BMSetInventory API Operation (NVP)
Last updated: Aug 15th, 7:17am
Sets the inventory level and inventory management features for a button so that PayPal can track inventory, calculate the gross profit associated with sales, send you an alert when inventory drops below a specified quantity, and manage sold out conditions.
BMSetInventory request
The request specifies inventory values related to a hosted button as well as inventory values that are specific to each menu item.
BMSetInventory request parameters
Field | Description |
---|---|
| (Required) |
| (Required) The ID of the hosted button whose inventory you want to set. |
| (Required) Whether to track inventory levels associated with the button. Value is:
|
| (Required) Whether to track the gross profit associated with inventory changes. Value is:
|
| (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: One single-byte alphanumeric character. |
| (Optional) The URL to which the buyer's browser is redirected when the inventory drops to 0. Character length and limitations: 127 single-byte alphanumeric characters. |
| (Optional) Whether to reuse download keys:
|
| (Optional) Whether to append download keys:
|
| (Conditional) One or more digital download keys, up to a maximum of 1,000 keys. This field is required if 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. |
Item tracking details fields
| (Optional) The ID for an item associated with this button. |
| The quantity of the item associated with this button. Specify either the absolute quantity in this field or the change in quantity in the quantity delta field. |
| The change in quantity you want to specify for the item associated with this button. Specify either the change in quantity in this field or the absolute quantity in the item quantity field. |
| (Optional) The quantity of the item associated with this button below which PayPal sends you an email notification. |
| (Optional) The cost of the item associated with this button. |
Option tracking details fields
| (Optional) The menu item's ID for an option in a drop-down menu Lists variables for each menu item, where n is a digit between 0 and 9, inclusive. |
| The quantity you want to specify for the option associated with this menu item. Specify either the absolute quantity in this field or the change in quantity in the quantity delta field Lists variables for each menu item, where n is a digit between 0 and 9, inclusive. |
| (Optional) The menu item's name in a drop-down menu Lists variables for each menu item, where n is a digit between 0 and 9, inclusive. |
| The change in quantity you want to specify for the option associated with this menu item. Specify either the change in quantity in this field or the absolute quantity in the quantity field. Lists variables for each menu item, where n is a digit between 0 and 9, inclusive. |
| (Optional) The quantity of the option associated with this menu item below which PayPal sends you an email notification Lists variables for each menu item, where n is a digit between 0 and 9, inclusive. |
| (Optional) The cost of the option associated with this menu item Lists variables for each menu item, where n is a digit between 0 and 9, inclusive. Limitations: Value must be a positive number, with no currency symbol. It must have two decimal places and the decimal separator must be a period (.). It may have an optional comma (,) for the thousands separator. |
BMSetInventory response
The response contains only the transaction ID.
BMSetInventory response fields
Field | Description |
---|---|
| Transaction ID |
BMSetInventory errors
Error code | Short and long messages | |
---|---|---|
10001 | 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. | |
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. | |
11954 | Invalid Data A TrackInv value must be specified. | |
11955 | Invalid Data A TrackPnl value must be specified. | |
11956 | Invalid Argument The TrackInv value specified is invalid. | |
11957 | Invalid Argument The TrackPnl value specified is invalid. | |
11958 | Invalid Data You cannot specify both an ItemQty and ItemQtyDelta value. | |
11959 | Invalid Data You cannot specify both an OptionQty and OptionQtyDelta value. | |
11960 | Invalid Data You cannot specify item level or option level inventory when TrackInv is 0. | |
11961 | Invalid Data You must either track inventory by item or by option when TrackInv is 1. It cannot be tracked by both together or none at all. | |
11964 | Invalid Data You must either track inventory and/or track profit & loss. | |
11965 | Invalid Data You cannot track inventory by item and cost by option at the same time or vice versa. | |
11966 | Invalid Argument Item number specified is invalid. It must be a string less than 127 characters. | |
11967 | Invalid Data You cannot set inventory for more option selections than the number of option selections saved in the button. | |
11968 | Invalid Data Option numbers must be unique within an individual button. | |
11969 | Invalid Data An option name index value must be specified when tracking inventory or profit & loss by option. | |
11970 | Invalid Argument Option name index value specified is invalid. | |
11971 | Invalid Data Inventory and/or profit & loss must be managed by item or an option with price when one is defined. | |
11972 | Invalid Data Option name index value specified does not exist. | |
11973 | Invalid Data ItemQty and/or ItemQtyDelta must be an integer. | |
11974 | Invalid Data An item quantity or item quantity delta value cannot be specified when TrackInv is 0. | |
11975 | Invalid Data The number of option quantity or option quantity delta values specified is greater than the number of option selections in the saved button. | |
11976 | Invalid Data You must specify either option quantity or option quantity delta values with a valid integer value. | |
11977 | Invalid Data An option quantity or option quantity delta value must not be specified when TrackInv is 0. | |
11978 | Invalid Argument Item alert must be specified as a positive integer. | |
11979 | Invalid Argument Item alert must not be specified when TrackInv is 0. | |
11980 | Invalid Data The number of option alert values specified is greater than the number of option selections in the saved button. | |
11981 | Invalid Argument Option alert values must be specified as a positive integer. | |
11982 | Invalid Argument Option alert values cannot be specified when TrackInv is 0. | |
11983 | Invalid Argument Item cost value must be specified when tracking profit & loss by item. | |
11984 | Invalid Argument The item cost value specified is invalid. | |
11985 | Invalid Argument An item cost value cannot be specified when TrackPnl is 0. | |
11986 | Invalid Data The number of option cost values specified is greater than the number of option selections in the saved button. | |
11987 | Invalid Argument Option cost values must be specified when tracking profit & loss by option. | |
11988 | Invalid Argument An option cost value specified is invalid. | |
11989 | Invalid Argument An option cost value cannot be specified when TrackPnl is 0. | |
11990 | Invalid Argument The sold out URL specified is invalid. | |
12210 | Invalid Argument The currency code value specified is invalid. |