Volt Commerce's API is not yet open to developers. If you'd like to get notified about early access, enter your email address below.


API Reference (v1)

Volt Commerce's API is meant to provide developers with a way to interact with Volt Commerce Data.

Authentication

Every call made to the API must include your App Key and App Secret. These can either be sent as post variables or appended to the endpoint url. The key and secret are specific to each user so keep yours safe.

https://api.voltcommerce.com/v1/shops/list?appkey=XXXXX&appsecret=XXXXX

Volt Commerce Connect

Volt Commerce Connect allows you to perform actions on behalf of another shop owner. Once the shop owner authenticates your app you will be able to make API calls regarding their shop.

https://voltcommerce.com/authenticate
Send users to the authentication URL with the permissions your app requires. If they allow permission, you can use the access token returned to you to take actions on a shop's behalf.

Request Parameters

appkey (Required)App Key
redirect_uri (Required)Page to redirect user to after authentication. User will return to this page with ?code= in the URL.Use this value to retrieve the access token for the shop. If this is value is omitted, the user will be returned to the page from which they were referred.
scope (Optional)Defaults to 'basic,products,orders'

Permissions (Scope)

basicBasic shop info
productsCan see product info
ordersCan see order info
promosCan see promo info
customersCan see customer info
customer_likesCan see customer likes
manage_productsAdd, edit and remove products
manage_promosAdd, edit and remove promo codes

Acquiring a Shop's Access Token

After being returned to the redirect_uri specified above, you will be able to access the code from the URL. Make another request with this code to obtain an access token for the shop.
https://api.voltcommerce.com/v1/access_token?appkey=XXXXX&appsecret=XXXXX&code=XXXXX

Store the access token and use it to take actions on behalf of the shop. Simply pass it along with your credentials in each request.
https://api.voltcommerce.com/v1/shop?appkey=XXXXX&appsecret=XXXXX&token=XXXXX

Responses

Responses from the API are delivered in JSON format.


GET /v1/shop

Get information about authenticated shop


https://api.voltcommerce.com/v1/shop

Request Parameters

appkey (Required)User's App Key
appsecret (Required)User's App Secret
token (Required)Shop Access Token

Response Parameters

idShop's Unique ID
user_idShop Owner ID
nameShop Name
slugShop URL-Friendly Name
date_createdDate shop was created
clicksTotal items ever added to cart
viewsTotal pages viewed
messageSystem Notifications for Shop
tax_percentageTax percentage

GET /v1/shop/products

Get products for authenticated shop


https://api.voltcommerce.com/v1/shop/products

Request Parameters

appkey (Required)User's App Key
appsecret (Required)User's App Secret
token (Required)Shop Access Token
limitNumber of products returned. Default 25. Maximum 250.
from_idReturn products with an id greater than from_id

Response Parameters

idProduct's Unique ID
prod_idProduct's Original Id (if imported)
typeProduct Source
categoryProduct Category
titleProduct Title
vendorProduct Vendor
tagsComma separated tags
imageUrl to product image
shop_idID of shop product is in
date_createdDate product was created
descriptionProduct HTML description
visible'Yes' if product is published
seo_titleTitle for search engines
seo_descriptionDescription for search engines
slugSEO Url name
priceAdvertised price
urlUrl to product page
variantsObject of product variants

GET /v1/shop/customers

Get customers for authenticated shop


https://api.voltcommerce.com/v1/shop/customers

Request Parameters

appkey (Required)User's App Key
appsecret (Required)User's App Secret
token (Required)Shop Access Token
limitNumber of customers returned. Default 25. Maximum 250.
from_idReturn customers with an id greater than from_id

Response Parameters

idCustomer's Unique ID
ipCustomer's IP when signing up
first_nameFirst Name
last_nameLast Name
emailEmail
phonePhone
addressStreet Address
cityCity
stateState
zipZip Code
metadataOther data
date_createdDate customer joined
shop_idID of shop customer belongs to
fbidCustomer's Facebook ID
birthdayCustomer's Birthday
genderCustomer's Gender

GET /v1/shop/promos

Get all promo codes for authenticated shop


https://api.voltcommerce.com/v1/shop/promos

Request Parameters

appkey (Required)User's App Key
appsecret (Required)User's App Secret
token (Required)Shop Access Token

Response Parameters

idPromo Code's Unique ID
shop_idShop ID
codeThe promo code
start_dateDate campaign begins
end_dateDate campaign expires
issuesThe number of uses left.
typePromo code type (percent, cash, etc)
date_createdDate promo code was created
percent_offIf type is 'percent', this is the percent off
cash_offIf type is 'cash', this is the cash off
metadataOther data

POST /v1/shop/promos/create

Create or Update a Promo Code


https://api.voltcommerce.com/v1/shop/promos/create

Request Parameters

appkey (Required)User's App Key
appsecret (Required)User's App Secret
token (Required)Shop Access Token
code (Required)The Promo Code to be created/updated
issues (Required)Number of times code can be used. Can be an integer or the string 'Unlimited'.
type (Required)'cash' or 'percent'
percent_off (Required if type is percent)% off order
cash_off (Required if type is cash)Dollar amount off order
start_dateDate to start allowing use of promo code. Defaults to today.
end_dateDate to stop allowing use of promo code. Defaults to 2 weeks from today.

Response Parameters

idPromo Code's Unique ID
status'success' or 'failure'
messageMessage accompanying response




No contracts, no obligations.