An API (Application Programming Interface) is used in many different contexts in this industry. 2Checkout offers a full featured Back Office API that provides suppliers and 3rd party developers with the ability to automate account, product and order management processes. Using the 2Checkout Back Office API along with the Instant Notification Service (INS) alleviates the necessity of logging into the standard GUI account interface on a day-to-day basis.
The current supported methods offered by our API allow the user to retrieve:
- Detailed account information including both company and contact information.
- Detailed payment information for both pending and past payments.
- Detailed product information including product options and coupons.
- Detailed sales information supporting both simple and complex search queries.
The current supported update calls allow the user to:
- Create, edit and delete products, product options and coupons.
- Refund sales by both invoice and individual line item.
- Stop recurring line items.
- Reauthorize and mark sales as shipped.
- Add order comments and send comments to the customer.
If you are interested, please review our Back Office API documentation for a full specification on each supported method and instructions on how to create an API username.
For site integration with 2Checkout, we offer a Common Gateway Interface (CGI). This means a site will need to contain an HTML form or link with cgi parameters appended which passes the correct parameters (and the customer) to our site for checkout. Passing in the Proper Parameters will result in the customer going through the rest of our checkout process (such as entering their credit card information), and after verification, a successful sale.
A site/shopping cart can pass orders into our purchase routine by using one of our supported parameter sets listed below.
When using a third party cart parameter set you will need to make sure that you implement the Product Identification parameters listed in the articles above.
If you would like to test your integration of these parameter sets, please try using the testing tools available in our developers area.
This article was updated January 27, 2010 to include the new Back Office API information.
