This article applies to Classic Commerce. (Looking for Contextual Commerce documentation?)
An application programming interface (API) is a protocol intended to be used as an interface by software components to communicate with each other. An API allows your servers to talk to our servers. FastSpring offers five types of APIs, each of which is described below.
Create Order API
The create order API may be used to pass one or more products to the shopping cart, finally landing on either the order contents page (shopping cart), or the checkout / user information page. For each call, any existing order may optionally be cleared and its contents are completely replaced. This is a useful option if you have your own forms where the customer is choosing multiple products and / or quantity. With this option some limited customer contact information may be passed along as well, including the customer's first name, last name, company name, email, and phone number. Unfortunately, at this time, we do not support the passing of address information. This API can be found by going to SpringBoard Store Home » Products and Pages. Select a product. Under Store Page URL, click View Additional Page Linking Options. Choose Option 6: Create Order API.
- Page Linking Options (Linking to Your FastSpring Store)
- Displaying Multiple Products on One Page
FastSpring has the ability to generate and retrieve new codes for an existing random coupon via an API. The random coupon set is identified by its custom prefix, which must first be specified in SpringBoard when creating the coupon. A maximum of 10,000 coupons may be randomly generated each day.
Shopping Status Icon
FastSpring offers the ability to show your customers the number of different products in their shopping cart while they continue to browse products on your website.
Localized Price API
FastSpring's localized price API allows specific prices to be retrieved from our servers, and to be displayed on your website, for products in your store, using a server side language such as PHP, based on the customer's country. Their location is determined from our Geo-location service, which detects a customer's IP location, and the API automatically sets the price based on that country. Optionally, you can pass in the customer's country. This API will only work on non-USD currency values that are explicitly defined on the product, and will not return any estimated conversions to other currencies.
Order and Subscription APIs
FastSpring's order API allows you to get an order by its order ID. The subscription APIs allow you to perform the following tasks:
- get a subscription by its reference
- update an existing subscription (including upgrading or downgrading the subscription plan, and changing customer and order details)
- cancel a subscription at the next subscription period
- renew a subscription (Note: This only applies to on-demand subscriptions.)
Note: The initial subscription transactions needs to take place on a branded order page hosted on FastSpring's server but subsequent changes to a respective subscription can be managed through the above APIs.
We're Here to Help
If you need assistance implementing FastSpring's APIs, please open a support ticket.