Using APIs

APIs are a good solution if you are looking for more flexiblity. There are APIs to access the entire catalog, specific product, or products within a predefined frame. Once you have products displayed, you can use the cart API for checkout functionality.

There are 4 basic steps to integrate ecommerce into your site using the Shoppable platform. Use the navigation at the left to get more details.

Step 1

Sign on to the Publisher Dashboard to create a partner token, which is required for any type of access to Shoppable technology. See API Token for more details.

Step 2

Use API(s) to return products in JSON format.

Available APIs:

  • Catalog API - get all products at part_number level.
  • Product API - get products at SKU level. You must use the Product API to pass SKU to the Cart API

Part_number vs SKU: Each individual size and color of a product have its own SKU while all sharing the same part number. The Cart API expects SKU in order to capture user size and color. For example, a black dress with size 7 and size 9 will have the same part_number, but each size will have a unique SKU.

Step 3 (optional)

Set up a secure web page on your site that will host the secure checkout frame served from the Shoppable platform. This will involve getting an SSL certificate for your site if you don't already have one.

You can skip this step if you want Shoppable to handle checkout. Once a user clicks checkout, they will be redirected to Shoppable for checkout and redirected back after the confirmation.

Step 4

Once you are rendering products, you are ready for users to add them to the cart or shopping bag. Implement the Cart API. It is important to note that the Cart API expects a SKU number, which is only provided by the Product API.