Get in touch

Get in touch

Prefer using email? Say hi at hello@moveshelf.com

This section walks you through the steps you need to execute the first time you want to use the Moveshelf API.
Installation
You can install the Moveshelf API directly via PyPI. To install the newest version available, run the following command in the terminal:
  • pip install -U moveshelf-api
Creating an access key
Before you can use the Moveshelf API, you need to create an access key:
  • Go to your profile page on Moveshelf (top-right corner)
  • Follow instructions to generate an API key (enter ID for the new key), and click 'Generate API Key'
  • Download the API key file and save 'mvshlf-api-key.json' in the root folder of your Git folder
Setting up 'mvshlf-config.json'
Additionally, you need a file called 'mvshlf-config.json', saved in the same folder as 'mvshlf-api-key.json', with the following content:
{
	"apiKeyFileName":"mvshlf-api-key.json",
	"apiUrl":"",
	"application":"None"
}
where the field "apiUrl" should have one of the following values:
  • EU region: "https://api.moveshelf.com/graphql"
  • US region: "https://api.us.moveshelf.com/graphql"

Your root folder should look similar to the folder below, where your processing scripts are inside a folder, e.g., 'scripts':