BMButtonSearch API Operation (SOAP)

API

Last updated: Aug 15th, 6:02am

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.

Important:

The Button Manager API is deprecated. For new integrations, see the associated topic.

Button	See
Buy Now	PayPal Checkout Overview
Add to Cart	Solution Providers
Donate	Create a Donate button
Automatic Billing Subscribe	Subscriptions Overview

BMButtonSearch request

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

BMButtonSearch request parameters

Field	Description
`StartDate`	`xs:dateTime` (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.
`EndDate`	`xs:dateTime` (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.

Field

Description

StartDate

xs:dateTime

(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.

EndDate

xs:dateTime

(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.

BMButtonSearch response

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

BMButtonSearch response fields

Name Description

Name	Description
	`ebl:ButtonSearchResult` Search results

ebl:ButtonSearchResult

Search results

Table 1 . ButtonSearchResult

`HostedButtonID`	`xs:string` The hosted button ID
`HButtonType`	`xs:string` The hosted button ID
`ItemName`	`xs:string` The item name
`ModifyDate`	`xs:dateTime` The date created or last changed

BMButtonSearch errors

Error code	Short and long messages	User action
10001	Internal Error Internal Error	To learn more about possible causes and corrective actions, see What is API error code 10001?.
11994	Search Warning You have exceeded the maximum number of buttons that can be returned. If required, adjust your search parameters.
11997	Invalid Argument A start date value must be specified.
11998	Invalid Argument The start date specified is invalid.
11999	Invalid Argument The end date specified is invalid.