# BMButtonSearch API Operation (SOAP) (/api/nvp-soap/button-search-soap)



> **Note:** **Important:** NVP/SOAP is a legacy integration method. We accept new integrations and support existing integrations, but there are newer solutions. If you're starting an integration, [we recommend our latest solutions](/).

Lists your hosted PayPal Payments Standard buttons.

> **Note:** **Important:**
>
> The Button Manager API is deprecated. For new integrations, see the associated topic.
>
> | Button                                          | See                                                                               |
> | ----------------------------------------------- | --------------------------------------------------------------------------------- |
> | **Buy Now**<br />                               | [PayPal Checkout Overview](/checkout)<br />                                       |
> | **Add to Cart**<br />                           | [Solution Providers](https://www.paypal.com/webapps/mpp/solution-providers)<br /> |
> | **Donate**<br />                                | [Create a Donate button](/api/nvp-soap/paypal-payments-pro)<br />                 |
> | **Automatic Billing**<br /> **Subscribe**<br /> | [Subscriptions Overview](/subscriptions/about)<br />                              |

## BMButtonSearch request [#bmbuttonsearch-request]

The request contains optional fields that are not currently used. All hosted buttons are automatically requested.

![](https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/BMButtonSearchRequest.gif)

## BMButtonSearch request parameters [#bmbuttonsearch-request-parameters]

| Field<br />       | Description<br />                                                                                                                                                                   |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `StartDate`<br /> | `xs:dateTime`<br /&#x3E; &#x2A;(Required)* Starting date for the search. The value must be in UTC/GMT format; for example, `2012-08-24T05:38:48Z`. No wild cards are allowed.<br /> |
| `EndDate`<br />   | `xs:dateTime`<br /&#x3E; &#x2A;(Optional)* Ending date for the search. The value must be in UTC/GMT format; for example, `2013-05-01T05:38:48Z`. No wild cards are allowed.<br />   |

## BMButtonSearch response [#bmbuttonsearch-response]

The response contains a list of all hosted buttons and their associated characteristics.

![](https://www.paypalobjects.com/webstatic/en_US/developer/docs/api/BMButtonSearchResponse.gif)

## BMButtonSearch response fields [#bmbuttonsearch-response-fields]

| Name | Description                                         |
| ---- | --------------------------------------------------- |
|      | `ebl:ButtonSearchResult`<br /> Search results<br /> |

## Table 1 . ButtonSearchResult [#table-1--buttonsearchresult]

| `HostedButtonID`<br /> | `xs:string`<br /> The hosted button ID<br />               |
| ---------------------- | ---------------------------------------------------------- |
| `HButtonType`<br />    | `xs:string`<br /> The hosted button ID<br />               |
| `ItemName`<br />       | `xs:string`<br /> The item name<br />                      |
| `ModifyDate`<br />     | `xs:dateTime`<br /> The date created or last changed<br /> |

## BMButtonSearch errors [#bmbuttonsearch-errors]

| Error code | Short and long messages                                                                                                               | User action                                                                                                                                                                                 |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 10001      | Internal Error<br />Internal Error                                                                                                    | To learn more about possible causes and corrective actions, see [What is API error code 10001?](https://www.paypal.com/selfhelp/article/what-is-api-error-code-10001-ts1041/3?channel=MTS). |
| 11994      | Search Warning<br />You have exceeded the maximum number of buttons that can be returned. If required, adjust your search parameters. |                                                                                                                                                                                             |
| 11997      | Invalid Argument<br />A start date value must be specified.                                                                           |                                                                                                                                                                                             |
| 11998      | Invalid Argument<br />The start date specified is invalid.                                                                            |                                                                                                                                                                                             |
| 11999      | Invalid Argument<br />The end date specified is invalid.                                                                              |                                                                                                                                                                                             |