Goto APIs

Reports API

General:

Basics:

Base-URL: https://capi.lagerkoll.com/v1/reports/
Parameters in the url should all be encoded and all data sent should be UTF-8

MAX number of requests per minute is set to 200.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.

Headers:

There are 2 ways to be authenticated when using this API. in both ways you add headers to the request.
1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made.
store: <<STORE>>
user_id: <<USER_ID>>
user_token: <<USER_TOKEN>>
api_key: <<API_KEY>>
Accept: application/json
Content-Type: application/json

Errors:

Code Description
900001 Credentials don't match
900101 Common error
900429 Too many requests
904001 Error when getting report data
{
  "errorCode" : 900101,
  "errorMessage" : "Something went wrong on the server",
  "errorField" : null,
  "errorData" : null
}

Reports API:

Reports

Get articles stock state

GETUrl: /articles_stockstate
Headers:
Accept: application/json or application/xml
Get articles stock state data for report

Valid parameters:

Parameter Description Default value Allowed values
article_id
end_date

Body:
Successfull response:

{"states": [{ "stockAmount": 7722.051546194726, "date": 6592, "incoming": 8013.63019966724, "outgoing": 2013.3917791726574, "articleId": "articleId" }]}

Get customer orders

GETUrl: /customerorders
Headers:
Accept: application/json or application/xml
Get customer orders data for report

Valid parameters:

Parameter Description Default value Allowed values
days 30
end_date

Body:
Successfull response:

{"stats": [{ "date": 9795, "orderAmount": 2589.866172209396, "orderProducts": 5277.055381643932, "orderValue": 2096.120851136386 }]}

Get summary alcoholic beverage

GETUrl: /alcoholic_beverage/summary
Headers:
Accept: application/json or application/xml
Get summary of volume, tax cost for volume for alcoholic beverage statistics during chosen period

Valid parameters:

Parameter Description Default value Allowed values
start_date
end_date
account -1

Body:
Successfull response:

{ "totalVolume": 4638.596760228456, "taxCostVolume": 2542.6510675499926 }

Get summary for tobacco and nicotine

GETUrl: /tobacco/summary
Headers:
Accept: application/json or application/xml
Get summary of weight, volume, tax cost for weight and tax cost for volume for tobacco and nicotine statistics during chosen period

Valid parameters:

Parameter Description Default value Allowed values
include_tobacco true
include_nicotine true
start_date
end_date
tag
account -1

Body:
Successfull response:

Get customers

GETUrl: /customers
Headers:
Accept: application/json or application/xml
Get customers data for report

Valid parameters:

Parameter Description Default value Allowed values
days 30
end_date
max_customers 10

Body:
Successfull response:

{"stats": [{ "customerId": 3707, "orderValue": 9795.910755571695, "customerName": "customerName" }]}

Get stockworth

GETUrl: /stockworth
Headers:
Accept: application/json or application/xml
Get stockworth data for report

Valid parameters:

Parameter Description Default value Allowed values
days 30
end_date

Body:
Successfull response:

{"stats": [{ "stockValue": 2204.321612789196, "date": 7646, "stockValueFIFO": 1675.4675691890786 }]}

Get orders for article

GETUrl: /orders/{id : .+}
Headers:
Accept: application/json or application/xml
Get customer and purchase orders data for article for report

Valid parameters:

Parameter Description Default value Allowed values
end_date

Body:
Successfull response:

{ "customerOrders": [{}], "purchaseOrders": [{}] }

Get customer orders for article

GETUrl: /customerorders/{id : .+}
Headers:
Accept: application/json or application/xml
Get customer orders data for article for report

Valid parameters:

Parameter Description Default value Allowed values
batch
serialnumber
days 30
end_date

Body:
Successfull response:

{"stats": [{ "orderCreated": 6982, "articleName": "articleName", "articleValue": 6849.49264643744, "orderId": 6019, "orderDisplayId": "orderDisplayId", "articleAmount": 2777.853615866398, "articleDiscount": 5284.415113905941, "articleId": "articleId", "orderValue": 358.4782227954397, "articleDiscountType": "articleDiscountType", "customerName": "customerName", "orderState": "orderState", "customerId": 5051, "customerDisplayId": "customerDisplayId" }]}

Get customers for article

GETUrl: /customers_for_article/{id : .+}
Headers:
Accept: application/json or application/xml
Get customers data for article for report

Valid parameters:

Parameter Description Default value Allowed values
start
end
batch_id
serial_nr
delivered true
not_delivered true

Body:
Successfull response:

{"stats": [{ "customerId": 9112, "orderValue": 153.90570927433566, "customerName": "customerName" }]}

Get customer products

GETUrl: /customers/{customer_id}/products
Headers:
Accept: application/json or application/xml
Get customer products data for report

Valid parameters:

Parameter Description Default value Allowed values
days 30
end_date

Body:
Successfull response:

{"stats": [{ "amount": 5785.0252163785935, "articleName": "articleName", "articleId": "articleId", "value": 4766.817091254886 }]}

Get articles most sold

GETUrl: /articles_most_sold
Headers:
Accept: application/json or application/xml
Get articles most sold data for report

Valid parameters:

Parameter Description Default value Allowed values
days 30
end_date
max_articles 10
type amount

Body:
Successfull response:

{"stats": [{ "amount": 9316.606294940717, "articleName": "articleName", "articleId": "articleId", "value": 7470.369874858457 }]}

Get articles per account

GETUrl: /articles_per_account
Headers:
Accept: application/json or application/xml
Get articles data sold per account for report

Valid parameters:

Parameter Description Default value Allowed values
days 30
end_date
max_accounts 0

Body:
Successfull response:

{"stats": [{ "amount": 4850.406333987593, "articleName": "articleName", "articleId": "articleId", "value": 4842.328535509198 }]}

Get alcoholic beverage statistics

GETUrl: /alcoholic_beverage
Headers:
Accept: application/json or application/xml
Get alcoholic beverage statistics for chosen period

Valid parameters:

Parameter Description Default value Allowed values
page 0
limit 50
start_date
end_date
account -1

Body:
Successfull response:

{ "pages": 9117, "stats": [{}], "pageSize": 1922, "page": 2418, "articlesCount": 6353 }

Get ordered articles

GETUrl: /ordered_articles
Headers:
Accept: application/json or application/xml
Get last ordered articles data for article for report
Body:
Successfull response:

{ "customerOrders": [{}], "purchaseOrders": [{}] }

Get alcoholic beverage sales accounts

GETUrl: /alcoholic_beverage_sales_account
Headers:
Accept: application/json or application/xml
Get sales accounts for alcoholic beverage statistics for chosen period

Valid parameters:

Parameter Description Default value Allowed values
start_date
end_date

Body:
Successfull response:

Get tobacco and nicotine statistics

GETUrl: /tobacco
Headers:
Accept: application/json or application/xml
Get tobacco and nicotine statistics for chosen period

Valid parameters:

Parameter Description Default value Allowed values
page 0
limit 50
include_tobacco true
include_nicotine true
start_date
end_date
tag
account -1

Body:
Successfull response:

{ "pages": 9987, "stats": [{}], "pageSize": 2375, "page": 7586, "articlesCount": 8972 }

Get tobacco and nicotine sales accounts

GETUrl: /tobacco_sales_account
Headers:
Accept: application/json or application/xml
Get sales accounts for tobacco and nicotine statistics for chosen period

Valid parameters:

Parameter Description Default value Allowed values
include_tobacco true
include_nicotine true
start_date
end_date
tag

Body:
Successfull response:

Get bestseller article

GETUrl: /category/{id}/bestseller_article
Headers:
Accept: application/json or application/xml
Get the bestseller article of a category

Valid parameters:

Parameter Description Default value Allowed values
start
end

Body:
Successfull response:

Get category rate

GETUrl: /category/{id}/category_rate
Headers:
Accept: application/json or application/xml
Get the rate of a category

Valid parameters:

Parameter Description Default value Allowed values
start
end

Body:
Successfull response:

Get articles to chart

GETUrl: /category/{id}/articles_chart
Headers:
Accept: application/json or application/xml
Get a list of articles for a category to display in the chart. If an article is missing value for specific day it means it has a value of 0

Valid parameters:

Parameter Description Default value Allowed values
start
end
limiter quarter

Body:
Successfull response:

Get stock count change

GETUrl: /stock_count_change
Headers:
Accept: application/json or application/xml
Get a list of articles where stock has changed during a spcified period

Valid parameters:

Parameter Description Default value Allowed values
start_date
end_date
page 0
limit 25
order desc asc,desc
sort_column article_id article_id,name,category,count,in_delivery,out_delivery

Body:
Successfull response:

{ "pages": 4793, "pageSize": 8729, "page": 5358, "articlesCount": 6161, "articles": [{}] }

Get annual sales to category chart

GETUrl: /category/{id}/category_chart
Headers:
Accept: application/json or application/xml
Get a list of annual sales to display in the chart. If a category is missing value for specific year it means it has a value of 0

Valid parameters:

Parameter Description Default value Allowed values
start
end
limiter quarter

Body:
Successfull response:

Get sales to categories chart

GETUrl: /categories_chart
Headers:
Accept: application/json or application/xml
Get a list of sales to display in the chart. If a category is missing value for specific day, week, month, quarter or year it means it has a value of 0

Valid parameters:

Parameter Description Default value Allowed values
start
end
limiter quarter

Body:
Successfull response:

Classes:

ArticlesForStockCountChangeResponse

Field Type Description Default Mandatory Accepted values Example values Access
page int R
pages int R
pageSize int R
articlesCount int R
articles List R

ReportsAlcoholicSummary

Field Type Description Default Mandatory Accepted values Example values Access
totalVolume double R
taxCostVolume double R

ReportsArticle

Field Type Description Default Mandatory Accepted values Example values Access
articleId String R
articleName String R
amount double R
value double R

ReportsArticlesResponse

Field Type Description Default Mandatory Accepted values Example values Access
stats List R

ReportsArticleStockState

Field Type Description Default Mandatory Accepted values Example values Access
articleId String R
stockAmount double R
incoming double R
outgoing double R
date long R

ReportsArticleStockStatesResponse

Field Type Description Default Mandatory Accepted values Example values Access
states List R

ReportsBeverageSalesAccountsResponse

Field Type Description Default Mandatory Accepted values Example values Access
vats List R

ReportsBeverageStatisticsResponse

Field Type Description Default Mandatory Accepted values Example values Access
page int R
pages int R
pageSize int R
articlesCount int R
stats List R

ReportsCustomer

Field Type Description Default Mandatory Accepted values Example values Access
customerId Long R
customerName String R
orderValue Double R

ReportsCustomerOrder

Field Type Description Default Mandatory Accepted values Example values Access
orderId Long R
orderDisplayId String R
orderCreated Long R
orderValue Double R
orderState String R
articleId String R
articleName String R
articleAmount Double R
articleValue Double R
articleDiscount Double R
articleDiscountType String R
customerId Long R
customerDisplayId String R
customerName String R

ReportsCustomerOrdersResponse

Field Type Description Default Mandatory Accepted values Example values Access
stats List R

ReportsCustomerOrderSummariesResponse

Field Type Description Default Mandatory Accepted values Example values Access
stats List R

ReportsCustomerOrderSummary

Field Type Description Default Mandatory Accepted values Example values Access
orderValue Double R
orderAmount Double R
orderProducts Double R
date Long R

ReportsCustomersResponse

Field Type Description Default Mandatory Accepted values Example values Access
stats List R

ReportsOrdersResponse

Field Type Description Default Mandatory Accepted values Example values Access
customerOrders List R
purchaseOrders List R

ReportsStockWorth

Field Type Description Default Mandatory Accepted values Example values Access
stockValue Double R
stockValueFIFO Double R
date Long R

ReportsStockWorthResponse

Field Type Description Default Mandatory Accepted values Example values Access
stats List R

ReportsTobaccoStatisticsResponse

Field Type Description Default Mandatory Accepted values Example values Access
page int R
pages int R
pageSize int R
articlesCount int R
stats List R