User Guide

Button Manager SOAP API June, 2009 3
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 1 Website Payments Standard Button Manager API Overview 7
Button Manager Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Generated Button Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Button Hosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Hosted Button Manipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Inventory Management Using Hosted Buttons. . . . . . . . . . . . . . . . . . . . . . . . 10
Button Manager API Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Granting Third-Party Permission for APIs . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Chapter 2 Using the Button Manager API . . . . . . . . . . . . . . .13
Specifying HTML Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Creating a Button Using SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Tracking Inventory for a Button Using SOAP . . . . . . . . . . . . . . . . . . . . . . . . 16
Chapter 3 Button Manager API Reference . . . . . . . . . . . . . . .19
BMCreateButton API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
BMCreateButton Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
BMCreateButton Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
BMCreateButton Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
BMUpdateButton API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
BMUpdateButton Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
BMUpdateButton Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
BMUpdateButton Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
BMButtonSearch API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
BMButtonSearch Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
BMButtonSearch Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
BMButtonSearch Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33