@volusion/volt-api

volt api client for nodejs

Easily integrate with the Volt by Volusion API. This is the core ecommerce data of a store such as Products, Categories, Orders. See Volt API Documentation.

If you're developing a theme, check out the Element Docs instead.

Install

Use this package in your project by doing:

npm install @volusion/volt-api

Get Started

// instantiate the client 
const voltClient = require('@volusion/volt-api');
const volt = new voltClient({
    apiKey: "9fduAnbishA0N9BXlNQ6zC:9kaub81gaVl1oJfXiIbal8" // replace with your key
});

// call an endpoint
const data = await volt.getOrders();

// use the data
const order = data.items[0]; // for this sample, let's look at the first order in the array

Security Tip

We recommend setting an environment variable in your project called VOLT_API_KEY.

You probably already know how to do this using popular packages like dotenv or similar to manage environment variables. But if not, you can quickly set your environment variables locally by simply running the following command which sets the environment variable for the duration of your terminal session: export VOLT_API_KEY="yourkeyhere" So just run that before you run npm start or similar. You can check the value of your environment variable in that specific terminal session by doing echo "$VOLT_API_KEY".

// when you instantiate the client, get the key from an environment variable
const voltClient = require('@volusion/volt-api');
const volt = new voltClient({
    apiKey: process.env.VOLT_API_KEY // 👈 best practice ✨
});

Future

• more examples

Contributing

Run tests

npm run test