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 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:

ReportsCustomerOrderSummariesResponse

{"stats": [{
    "date": 5180,
    "orderAmount": 9427.421567137972,
    "orderProducts": 1208.5138178407663,
    "orderValue": 7001.128830021471
}]}

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:

ReportsAlcoholicSummary

{
    "totalVolume": 294.54583467077856,
    "taxCostVolume": 3642.9731224198035
}

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:

ReportsBeverageSalesAccountsResponse

{"vats": [{}]}

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:

ReportsArticleStockStatesResponse

{"states": [{
    "stockAmount": 8386.670829474739,
    "date": 844,
    "incoming": 5684.116767633605,
    "outgoing": 2619.824914661544,
    "articleId": "articleId"
}]}

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:

ReportsStockWorthResponse

{"stats": [{
    "stockValue": 4476.769009154726,
    "date": 1219,
    "stockValueFIFO": 8997.323084855554
}]}

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:

ReportsOrdersResponse

{
    "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:

ReportsCustomerOrdersResponse

{"stats": [{
    "orderCreated": 8675,
    "articleName": "articleName",
    "articleValue": 5084.855324806185,
    "orderId": 3543,
    "orderDisplayId": "orderDisplayId",
    "articleAmount": 1935.0297562644048,
    "articleDiscount": 6735.353809701046,
    "articleId": "articleId",
    "orderValue": 4109.500035242258,
    "articleDiscountType": "articleDiscountType",
    "customerName": "customerName",
    "orderState": "orderState",
    "customerId": 1285,
    "customerDisplayId": "customerDisplayId"
}]}

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:

ReportsCustomersResponse

{"stats": [{
    "customerId": 743,
    "orderValue": 1649.8274411031678,
    "customerName": "customerName"
}]}

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:

ReportsCustomersResponse

{"stats": [{
    "customerId": 5653,
    "orderValue": 1279.3443235668333,
    "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:

ReportsArticlesResponse

{"stats": [{
    "amount": 1268.174260464291,
    "articleName": "articleName",
    "articleId": "articleId",
    "value": 5983.38739873892
}]}

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:

ReportsArticlesResponse

{"stats": [{
    "amount": 5748.787089785038,
    "articleName": "articleName",
    "articleId": "articleId",
    "value": 8506.161286986513
}]}

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:

ReportsArticlesResponse

{"stats": [{
    "amount": 9242.15345316701,
    "articleName": "articleName",
    "articleId": "articleId",
    "value": 2958.2389947409747
}]}

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:

ReportsBeverageStatisticsResponse

{
    "pages": 1957,
    "stats": [{}],
    "pageSize": 8861,
    "page": 4465,
    "articlesCount": 7351
}

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:

ReportsBeverageSalesAccountsResponse

{"vats": [{}]}

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:

ReportsOrdersResponse

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

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:

ReportsTobaccoStatisticsResponse

{
    "pages": 9979,
    "stats": [{}],
    "pageSize": 3968,
    "page": 946,
    "articlesCount": 1063
}

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:

ReportsBeverageSalesAccountsResponse

{"vats": [{}]}

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:

TopArticle

{}

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:

CategoryRate

{}

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:

DataChartResponse

{}

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	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:

ArticlesForStockCountChangeResponse

{
    "pages": 8897,
    "pageSize": 9093,
    "page": 4236,
    "articlesCount": 415,
    "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:

DataChartResponse

{}

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:

DataChartResponse

{}

Classes:

ArticlesForStockCountChangeResponse

Field	Type	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	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	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	Access
page	int	R
pages	int	R
pageSize	int	R
articlesCount	int	R
stats	List	R

ReportsCustomer

Field	Type	Access
customerId	Long	R
customerName	String	R
orderValue	Double	R

ReportsCustomerOrder

Field	Type	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	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	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	Access
page	int	R
pages	int	R
pageSize	int	R
articlesCount	int	R
stats	List	R