API Docs

The SimpleConsign API can allow your web site or any third party application to access your SimpleConsign data.
What You Can Do with the API
​List and Search Inventory​
​CURL Examples​
​Node.js Examples​
​PHP Examples​
​Submit Online Transactions and Online Returns​
Generating Your API Key
Before you can use the API you have to create an API key inside your SimpleConsign account in your Location Settings.
Multiple Locations
If you have multiple locations, you must generate an API key for each individual location.
HTTP REST API
All requests are made by doing an HTTP POST to the appropriate URL. The request should contain the required HTTP parameters. The results of the request are returned in JSON format.
HTTP Response Codes
The API may return more HTTP response codes than these, but these are likely the ones you will run into.
Code
Meaning
What You Should Do
200
Success
Parse and use the data that was returned from SimpleConsign
400
Bad Request
There is something wrong with the parameters that you sent in. You need to adjust the request so that the SimpleConsign API can understand your request. This can also be caused by not setting the Accepts and Content-Type headers to application/json.
404
Resource not Found
It is likely that you have typed in an incorrect API endpoint.
500
Internal Server Error
Likely this is our fault, and you should email [email protected] to get the issue resolved.
503
Server at Capacity
Wait and make the request at a later time while we resolve our capacity issues.
API Limits
You are only allowed to make up to 100 API requests in a 10 minute period. If you need to make more requests, please contact us.

Clearing Your Cache (Chrome)

List and Search Inventory

Last modified 7mo ago

Code	Meaning	What You Should Do
200	Success	Parse and use the data that was returned from SimpleConsign
400	Bad Request	There is something wrong with the parameters that you sent in. You need to adjust the request so that the SimpleConsign API can understand your request. This can also be caused by not setting the Accepts and Content-Type headers to application/json.
404	Resource not Found	It is likely that you have typed in an incorrect API endpoint.
500	Internal Server Error	Likely this is our fault, and you should email [email protected] to get the issue resolved.
503	Server at Capacity	Wait and make the request at a later time while we resolve our capacity issues.