Getting Started

Getting Started...

To implement our APIs, you're going to need some programming experience.

Wait a second. What's an API? (You’re already ahead if you know the answer.)


API, an acronym for application program interface, is a set of routines, protocols, and tools for building software applications. A good API makes it easier to develop a program by providing all the building blocks. A programmer (or you) then puts the blocks together.


Shopatron provides APIs in a variety of formats:

  • XML-RPC*
  • REST
  • SOAP

Please visit our new site for all your OMS needs.

* We're actively converting these to either REST or SOAP.

What's next?

To make an API request, you’ll need to:

  • Know the resource you're looking to retrieve
  • Look at the API Toolbox section in the Support area for libraries or frameworks available for your particular platform
  • Read the documentation to find more details on how these APIs work (we have examples there too!)

Our XML-RPC requests require a username and password for testing and integration. Our REST APIs just require an API key. So, how do you get access? Read on.

Getting access

For some of our newer APIs, we provide a test key in the documentation (where applicable), which allows you to test the functionality prior to getting a production key for your site. For our XML-RPC APIs, please contact your Account Manager to obtain your username and password.

We will soon allow provisioning of developer keys, coupled with testing of APIs on this site, which will make this a one-stop-shop for every Shopatron API.