Freewebstore Help
Freewebstore.comLoginSign UpPricing
  • Home
  • Start
    • Overview
    • Pricing
    • Become a Freewebstore Affiliate
    • Getting Started
  • Orders
    • Orders Overview
    • Your Orders
      • Order Status Information
      • Close/Re-open an Order
      • Cancel an Order
      • Delete an Order
      • Send a Dispatch Email
      • Refund an Order
      • Order Logs
      • Order Insights
      • Changing the next order number
      • Copy Delivery Address
    • Payment Gateways
      • PayPal Setup
      • Stripe Setup
      • PayUmoney Setup
      • Offline Payment Checkouts
        • Add Funds to Credit Balance
      • Tipping
    • Customers
      • Customer Information
      • Viewing Customer Orders
      • Delete an Existing Customer Account
      • Editing your Customers Account
      • Export your Customer Accounts
      • Disable Customer Accounts
      • Customer Wishlists
    • Notification Emails
    • Dispatch Emails
    • Generating Shipping Labels
      • How do I pay for my shipping Labels
      • How do I find the nearest shops where I can drop my packages off?
      • How do I download my label(s)?
      • How do I void my label?
    • Invoices
      • Download an Order Invoice
      • Invoice Layout
      • Invoice Details
      • Invoice Translations
    • Picklists
    • Export
    • Abandoned Carts
    • Accounting
      • KashFlow
    • Live Cart Activity
  • Manage
    • Manage Overview
    • Products
      • Your Products
        • Add a New Product
        • Copy an Existing Product
        • Delete an Existing Product
        • Restore a Deleted Product
        • Searching/Filtering Products
        • Add a Special Offer to a Product
        • Set up Addons/Variations
          • How Do I Add Images for my Options?
          • How do I Manage the Stock for my Options?
        • Featured Products
        • Browsing Options
        • Bulk Buying
        • Setting Order Quantity Limits
        • Adding a Video to a Product
        • Related Products
      • Stock Management
        • Filtering Stock Lists
        • Updating Stock Levels
        • Recent Stock Changes
        • Stock Requests
        • Export Stock Levels to CSV
      • Checkout Forms
      • Suppliers
      • Digital Products
      • Reviews
      • Export Products
      • Import Products
        • What data can I import?
        • Import Etsy Products
        • Import Shopify Products
      • Brands
      • Categories
      • Groups
      • Dropshipping Services
      • Search Tags
    • Pages
      • What is the Navigation/Menu
      • Change the Display Order of Pages
      • Adding a New Page
      • Renaming a Page
      • Hiding a Page
      • Editing a Page
      • Deleting a Page
      • Add an FAQ Page
      • Adding a Link to a Page
      • Blog
      • Setting a Minimum Order Value
      • Custom 404 Pages
      • Editing the Cart Page
      • Editing the Contact Page
      • Editing the Special Offers Page
      • Adding a Video to a page
    • Images
      • Upload an Image
      • Edit an Image
      • Delete an Image
      • Image Graphics
      • Optimizing Images
      • Import Images
      • Export Images
    • Shipping
      • Shipping Terms and Phrases
      • The Basics
      • Specify a Shipping Region
        • Shipping Regions US
        • Shipping Regions UK
      • Add a Tracking Code
      • Tips for your Shipping Rules
      • Editing my Shipping Rules
  • Design
    • Theme Editor
      • Logo
      • Slideshow
      • Search Bar
      • Currency
      • Language Packs
      • Notification Bar
      • FAQ Page
      • Custom CSS
      • Fonts
      • Age Verification
      • Colors
      • Favicon
      • Background
      • Featured Products
      • Preview Store
      • Banners
    • Switch Themes
    • Live Chat Widgets
    • Site Speed
      • Optimizing your Images
  • Marketing
    • Marketing Overview
    • Domains
      • Connecting a Domain Name
      • Disconnect a Domain
      • Linking External Websites To Your Freewebstore
      • Web Forwarding
      • Changing your Free URL
      • Advanced DNS Settings
      • Editing the Registered Address for my Domain
      • Assigning a Primary Domain
      • Connecting a domain name with DNS records
    • Page
    • SEO
      • How do I set up SEO for my Store?
      • How do I set up SEO for my products?
      • How do I edit the URL of my product
      • How do I set up SEO for my categories?
      • Image SEO
    • Email Campaigns
      • Cart Saver
        • Locating & First Look
        • Initial Setup
        • Managing
        • Cart Saver Pricing
      • Review Invites
      • MailChimp
    • Social Media
      • Instagram Gallery
      • Share Icons on the Product Page
      • Twitter
      • Social Media Icons
    • Facebook
      • Facebook Pixel
      • Facebook/Instagram Shops
    • Google
      • Google Adsense
      • Google Analytics
      • Order Conversion Tracking
      • Google Shopping
        • How do I map categories for Google Shopping?
        • My categories are ineligible for Google Shopping, what can I do?
      • Webmaster tools
      • Blocked by robots.txt
      • Gsuite
    • Site Verification
      • Google Site Verification
      • Pinterest Site Verification
      • Facebook & Instagram Site Verification
      • Bing Site Verification
      • Custom Site Verification
    • Meta Tags
    • Discount Codes
      • Basic Details
      • Offer Details
      • Discount Groups
      • Advanced Details
      • Distributing my Discount Codes
      • Import Discount Codes
      • Discount Code Reports
    • Promotions
      • Promotions Overview
      • Adding a Promotion
        • Money Off Order
        • Money Off Item
        • Cheapest Free
        • Buy X for $
        • Free Shipping
        • Free Tax
      • Deleting a Promotion
      • FAQs
        • How do I remove Brands, Categories, Suppliers or Product Groups from my promotions?
    • Newsletter
      • Enable/Disable Newsletter Feature
      • Manually add a Subscriber
      • Deleting a Subscriber
      • Export Subscribers
      • Send Newsletters
    • Statistics
      • Overview
      • Order Stats
      • Visitor Stats
      • Product Stats
      • Search Engine Hits
      • Web Spider Hits
      • Live Orders Map
      • Product Search Terms
    • Cookie Consent
    • QR Codes
    • Product Feeds
    • Loyalty Points
  • Settings
    • Settings Overview
    • Changing your Store Name
    • Publishing my Store
    • Setting the Default Currency
    • Editing the Default Tax
    • Setting Product prices to Include/Exclude Tax
    • Set the Default Weight Units up for your Store
    • Changing the Character Set
  • My Account
    • My Account Overview
    • Login Details
      • Forgotten Login Details?
    • Billing
      • Billing Details
      • Subscription
        • Upgrade Subscription
        • Subscription Plan History
        • Cancel Subscription
      • Payment Methods
      • Invoices
      • Account Restricted
    • Usage
      • Business Size
      • Storage Usage
      • Bandwidth Usage
    • Staff Accounts
    • Achievements
    • Close Store
    • Customer Support
      • Roadmap & Updates
      • Request a Feature
    • Messages
    • Create Multiple Stores
    • Account Notification Emails
  • Useful links and Pages
    • Freewebstore API
    • Contact our Support Team
    • FAQs
      • General
        • 2-Factor Authentication
        • Is Freewebstore really Free?
        • How long does it take for the support team to reply?
        • How do I cancel my subscription?
        • How do I close my store?
        • Can my staff have login details for my store?
        • How do you get a professional email address that matches my store name?
        • How do I make sure my customers spend over a certain amount on my store?
        • How can I set a customer order limit on product items?
        • What is the App Center?
        • How do add a PDF file to the page content?
        • How do I change the email displayed on the cart saver email?
        • How do I turn off Customer Reviews?
        • How do I view how many views my blog has had?
      • Orders
        • How do I close/Re-open an Order?
        • How do I refund an order?
        • How do I download multiple invoices at the same time?
      • Products
        • How do I copy an existing Product?
        • How do I restore a product I deleted?
        • How do I edit the stock for my product options?
        • How do I choose which products appear in the Featured Section?
        • How do I ask a customer to leave information so I can customize their product?
        • How do I add digital products?
        • Are you integrated with any drop shipping services?
      • Domain FAQs
        • How do I connect an existing domain?
        • How do I transfer my domain to Freewebstore?
        • How do I claim a free domain?
        • How often do I need to pay for my Domain?
        • How do I transfer a domain away from Freewebstore?
      • Payment Gateways
        • I am not eligible for Advanced Card Payments, can I still use PayPal?
        • How do I change the PayPal account attached to my store?
        • How do I setup Cash on Delivery?
        • How do I set up Cash on Delivery Payment?
      • Pages
        • How do I hide a page?
        • How do I add a link to a page?
      • Shipping
        • How do I limit my shipping rules so I only ship to my region?
      • Settings
        • How do I turn on/off the Terms and Conditions checkbox on the checkout page?
        • How do I publish my store?
        • How do I set up tax?
        • How do I include the tax in the price of my products?
      • Notification Emails
        • How do I edit my notification emails?
        • How can I change the email address notification emails are sent to?
      • Images
        • How do I make my images small in size?
      • Theme Editor FAQs
        • How do I translate my store?
        • Can I save my Theme?
      • Errors
        • "Error: The transaction was refused. Verify the transaction and try the request again."
        • Google: "Blocked by ROBOTS.TXT"
      • Browser Support
        • Brave Browser
Powered by GitBook
On this page
  • Getting Started with our API
  • How do I obtain an API key?
  • How do I delete an API key?
  • How do I add a webhook to the API?
  • How do I delete a webhook connected to the API?
  • How do I download my API keys to a CSV file?
  • How do I filter the API call types?

Was this helpful?

  1. Useful links and Pages

Freewebstore API

A brief guide and explanation detailing the perks of using Freewebstore's API feature and how to gain an API key from within your control panel.

PreviousAccount Notification EmailsNextFAQs

Last updated 3 years ago

Was this helpful?

Getting Started with our API

The API allows you to connect to your store data directly via code. This opens up limitless integration possibilities. Perhaps link your store directly to your warehouse for order processing? Or hook it up to your email marketing campaigns?

It really is powerful stuff, the possibilities are endless.

If you have not been given an API Key yet, simply click the Request an API Key button in the Store API panel.

For more information view our .

How do I obtain an API key?

To gain an API key:

  1. Log in to your freewebstore control panel.

  2. Click the API button located at the bottom of the side panel on the left.

  3. Once the page has loaded, simply click the Request an API Key button.

You will then be provided with your API key for your control panel and online store. Further actions open up to along with being able to see all requests the API has received.

How do I delete an API key?

To delete an API key:

  1. Log in to your freewebstore control panel.

  2. Click the API button located at the bottom of the side panel on the left.

  3. Click the Revoke button next to your API key.

This will delete your current API key. If you need another in the future, you will need to request a new one.

How do I add a webhook to the API?

To add a webhook:

  1. Log in to your freewebstore control panel.

  2. Click the API button located at the bottom of the side panel on the left.

  3. When the page has loaded, you will see that the bottom panel has two tabs, API requests and Webhooks. Click Webhooks.

  4. The bottom panel will then change so that you can see the webhooks (if any) you already have in place. To add a webhook, click the Add Webhook button here.

  5. A new window will open with two fields that you will need to complete, simply enter the URL for the webhook you wish to add and select the desired webhook type.

  6. Click "Create" when you are happy.

You will now see that the webhook is added to the Webhooks panel.

How do I delete a webhook connected to the API?

To delete a webhook:

  1. Log in to your freewebstore control panel.

  2. Click the API button located at the bottom of the side panel on the left.

  3. Click to view the Webhooks tab.

  4. Locate the webhook you wish to delete and click the Delete button.

How do I download my API keys to a CSV file?

To export your API keys to a CSV file:

  1. Log in to your freewebstore control panel.

  2. Click the API button located at the bottom of the side panel on the left.

  3. Click the Download as CSV File button at the bottom of the API keys panel. A download will then start and you will receive the requested file containing information such as:

    • your API Key

    • usage of the API key

    • overall percentage

How do I filter the API call types?

In order to filter the different calls made to the API:

  1. Log in to your freewebstore control panel.

  2. Click the API button located at the bottom of the side panel on the left.

  3. To the right of your screen, you will notice a panel labeled Page Filters. Here, by checking the appropriate boxes, you can change the different API calls that appear in the API Requests panel.

The filters you can use here are:

  • All

  • GET

  • POST

  • DELETE

  • PUT

  • Errors

API documentation