REST interface
Complete API documentation for integration with Shoporama
Please note
The documentation has been moved to the new Swagger UI. This page is no longer maintained and may contain outdated information.
Endpoints
About the REST interface
Our REST interface is designed to enable our customers to develop integrations with warehouse and accounting systems themselves. It is therefore only methods that support what we support.
We use the HTTP protocol over SSL/TLS and all data is sent and received in JSON format.
Authorization works at the shop level and each shop has the option to create the tokensthey want. By default, each token allows 1,000 daily calls. This limit can be increased if you contact us and explain why. To set the token, an Authorization header like the one below must be specified:
Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb
Note that the method in the above must be Shoporama.
Pagination
In calls that contain lists - e.g. products or orders, there is a maximum number of results we return. Therefore, the result will contain a paging element that shows which part of the dataset you are looking at:
{
"paging": {
"offset": 30,
"limit": 10,
"count": 10,
"total": 1000
},
"products": [
[...]
]
}
To choose which part of the dataset to look at, you can specify the arguments limit=100 and offset=30 in the URL you call.
Example of API call
A complete example of how to pull products that have changed since January 1, 2020:
Request:
GET /REST/product?last_modified=2020-01-01T00:00:00&limit=100 HTTP/1.1
Host: www.shoporama.dk
Accept: */*
Authorization: Shoporama ade0fe8617b0825996baa9c8a9324ddb
User-Agent: Min Shoporama integrationResponse:
HTTP/1.1 200 OK
Content-Type: application/json
{
"paging": {
"offset": 30,
"limit": 10,
"count": 10,
"total": 1000
},
"products": [
[...]
]
}