GoPlanogram Web API

GoPlanogram offers an extensive Web API that allows you to automate a wide variety of common tasks, including:

Streaming catalog and image data from external sources, or your own computer
Generating reports in all supported file formats (CSV, XLSX, PDF), or as raw JSON
Uploading and modifying Store Data sets
Replacing SKUs in a planogram or set of planograms
Automatically applying Templates to a planogram or set of planograms

Obtaining an API Password

In order to obtain an API password, your account must first be authorized for API access by the GoPlanogram team.

If your account does not have API access, or you are not sure, contact [email protected] to upgrade your account.

Once your account is authorized for API access, to obtain an API password click on your username in the top right corner to open your User Profile. Click "View" next to "API credentials" to open the API Credentials dialog. Click "Generate API Password" to create your API password.

Important: Ensure you copy your password immediately - it will only be shown once! If you lose your API password, you can always generate a new one via the same dialog. Be careful, as doing so will invalidate your previous API password.

Detailed Documentation

Detailed documentation, including data models and sample requests for each endpoint, can be found at our API reference. You can find this page here.