Documentation

 

SolidShops API

 

API console

The SolidShops API is quite RESTful and JSON only. If you want to check it out for your store without writing some code, please use the API console below. Just get the credentials from your SolidShops backend and start testing!

If you want to explore our API functionality using your own tools( such as soapUI) or if you want a more technical document you can make use of our WADL (Web Application Description Language).


back to top

 

How we implemented REST

The following table shows how each CRUD functionality is classified in a RESTfull way. Each {entity} represents a resource from your SolidShops store(eg products,pages,orders,...).

API function HTTP Verb HTTP Endpoint HTTP StatusCode header Extra HTTP headers Attr: status_code Attr: success Attr: data Attr: errors
create one POST /{entity} 201 Created Location 201 true created object
get list GET /{entity} 200 OK 200 true list of objects
get one GET /{entity}/{id} 200 OK 200 true requested object
update one PUT /{entity}/{id} 200 OK 200 true updated object
delete one DELETE /{entity}/{id} 200 OK 200 true

We use the exact same data structures both in our API and in our template language. So if you are already familiar with the field & filter parameters used in products, pages, orders, etc you should feel very familiar with our API, otherwise you can always take a look at the documentation of our template language

back to top

 

Requests

Authentication:

The SolidShops API currently only uses Basic Authentication, you can obtain the credentials for your store here.

Methods & Uri's:

If you are looking for a list of supported API functions for each resource, you should take a look at our API Console at the top of this page. If you are looking for a more technical document, please take a look at our WADL (Web Application Description Language).

Filters:

If you need more information about a specific filter parameter, you can find more information in our template language documentation.

back to top

 

Response

Response object schema:

As stated before, all the responses(success and error) from our API use the same response structures.

A list of possible errors:

If an error occured, the "success" attribute will always be "false" and you will receive one of the follwing HTTP StatusCodes and Error Messages.

HTTP StatusCode Code Description
401 401 Unauthorized
404 404 Not Found
405 405 The specified HTTP verb is not allowed for this uri
429 429 Too Many Requests (API rate limiting)
400 A0001 An undefined error occured while creating/updating/deleting the resource
400 A0002 XML is not supported in the current version of our API. Please add HTTP Header "Accept: application/json" or add .json to the current uri.
400 A0050 A field provided in the payload is not supported (%s)
400 A0051 A required field is missing in the payload (%s)

An example of a successful response:

If no error occured, you will receive "true" in the "success" attribute, a 2XX StatusCode and the latest version of the object in the "data" attribute of your response message.

An example of an error response:

If an error occured, you will receive "false" in the "success" attribute, a 4XX/5XX StatusCode and a list of error messages in the "errors" attribute of your response message.

back to top

 

Library

More information about the SolidShops API client for PHP(Composer) can be found on github.

back to top