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.
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.
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": 2490.551440027886, "date": 5539, "incoming": 4173.344824822884, "outgoing": 72.76039163550463, "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": 1792, "orderAmount": 4846.756220508375, "orderProducts": 6770.446478383166, "orderValue": 992.7105926310287 }]}
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": 8474.754054038944, "taxCostVolume": 9436.138900580036 }
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 |
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": 9077.578798089427, "date": 9584, "stockValueFIFO": 6986.685913406466 }]}
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 |
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": 5227, "articleName": "articleName", "articleValue": 5754.7196851278695, "orderId": 2381, "orderDisplayId": "orderDisplayId", "articleAmount": 1631.3010880003287, "articleDiscount": 2747.9230722782054, "articleId": "articleId", "orderValue": 6040.268919637511, "articleDiscountType": "articleDiscountType", "customerName": "customerName", "orderState": "orderState", "customerId": 9940, "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": 2801, "orderValue": 7043.316927688466, "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": 5797.118647705924, "articleName": "articleName", "articleId": "articleId", "value": 902.2379576994699 }]}
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": 5165.841297172184, "articleName": "articleName", "articleId": "articleId", "value": 8991.50823423516 }]}
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": 6735.401032650909, "articleName": "articleName", "articleId": "articleId", "value": 4914.634346779862 }]}
Get ordered articles
GETUrl: /ordered_articles
Headers:
Accept: application/json or application/xml
Get last ordered articles data for article for report
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 |
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": 1031, "stats": [{}], "pageSize": 9318, "page": 3825, "articlesCount": 7910 }
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": 6280, "stats": [{}], "pageSize": 387, "page": 6004, "articlesCount": 4529 }
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 |
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 |
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 |
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 |
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": 1558, "pageSize": 8011, "page": 2925, "articlesCount": 5187, "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 |
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 |
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": 2925, "orderValue": 425.46448820068525, "customerName": "customerName" }]}
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 |