Goto APIs

Articles API

General:

Basics:

Base-URL: https://capi.lagerkoll.com/v1/articles/
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
900201 Error when getting an article
900202 Error when creating an article
900203 Error when updating an article
900204 Error when deleting an article
900211 Error when getting batches on article
900221 Error when getting serial number on article
900212 Error when creating a batch on article
900222 Error when creating a serialnumber on article
900213 Error when updating batch on article
900223 Error when updating serialnumber on article
900214 Error when deleting batch on article
900224 Error when deleting serialnumber on article
900803 Error when updating customfield template
900232 Error when importing articles
900233 Error when getting import template
900234 Error when adding import template
900235 Error when updating import template
900236 Error when deleting import template
900241 Error when exporting articles
900251 Error when getting an article units
900252 Error when creating an article unit
900253 Error when updating an article unit
900254 Error when deleting an article unit
{
  "errorCode" : 900101,
  "errorMessage" : "Something went wrong on the server",
  "errorField" : null,
  "errorData" : null
}

Articles API:

Article units

Get article units

GETUrl: /{id : .+}/article_units
Headers:
Accept: application/json or application/xml
Get article units for a specific article
Body:
Successfull response:

{"units": [{ "unit": { "name": "name", "externalId": "externalId", "id": 1671 }, "articleId": "articleId", "storegroupId": 4170, "convert": 7544.760992095971, "barcode": "barcode" }]}

Add article unit

POSTUrl: /{id : .+}/article_units
Headers:
Accept: application/json or application/xml
Add article unit for a specific article
Body:

{ "unit": { "name": "name", "id": 2832 }, "convert": 8951.49214255496, "barcode": "barcode" }
Successfull response:

Set article units

POSTUrl: /{id : .+}/article_units/list
Headers:
Accept: application/json or application/xml
Replace list of article units for a specific article
Body:
Successfull response:

Update article unit

PUTUrl: /{id : .+}/article_units/{unit_id}
Headers:
Accept: application/json or application/xml
Update existing article unit for a specific article
Body:

{ "unit": { "name": "name", "externalId": "externalId", "id": 5692 }, "articleId": "articleId", "storegroupId": 5793, "convert": 29.24480521920625, "barcode": "barcode" }
Successfull response:

Remove article unit

DELETEUrl: /{id : .+}/article_units/{unit_id}
Headers:
Accept: application/json or application/xml
Remove article unit from a specific article
Body:
Successfull response:

Articles

Get bundle products from part

GETUrl: /{id : .+}/bundle
Headers:
Accept: application/json or application/xml
Get all bundle products which includes a specific part

Valid parameters:

Parameter Description Default value Allowed values
page 0
limit 100

Body:
Successfull response:

{ "totalSerialNumbersReserved": 4346.782976791519, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 373.8846250463057, "bestBefore": 90, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 2485.5689823940097, "totalSerialNumbersInStock": 8286.872512845726, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 3784.434205741517, "bestBefore": 3766, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 4986.559457451771, "totalBatches": 6889, "totalSerialNumbers": 4619 }

Get article fifo

GETUrl: /{id : .+}/fifo
Headers:
Accept: application/json or application/xml
Get an article fifo based on article-id

Valid parameters:

Parameter Description Default value Allowed values
page 0
limit 25

Body:
Successfull response:

{ "pages": 2594, "pageSize": 4715, "fifos": [{ "date": 1708765825039, "supplierName": "supplierName", "amount": 4202.582194362724, "supplierOrderId": 7276, "supplierId": 8922, "poRef": "poRef", "description": "description", "purchasePrice": 5506.814901569034, "userName": "userName", "userId": 2121, "amountInStock": 2520.0946423673454, "purchaseRate": 3092.7702315973447, "id": 9236 }], "fifoCount": 5448, "page": 2783, "since": 5944 }

Get article tags

GETUrl: /tags
Headers:
Accept: application/json or application/xml
Get article tags for store group

Valid parameters:

Parameter Description Default value Allowed values
query
page 0
limit 50

Body:
Successfull response:

{ "pages": 858, "pageSize": 8268, "page": 8662, "projectsCount": 3925, "tags": [{ "name": "name", "externalId": "externalId", "id": 4711, "desc": "desc" }] }

Get other articles

GETUrl: /{article_id}/other_purchased
Headers:
Accept: application/json or application/xml
Based on an article a list of other interesting articles is returned

Valid parameters:

Parameter Description Default value Allowed values
amount 5

Body:
Successfull response:

{ "pages": 8512, "pageSize": 54, "page": 7168, "articlesCount": 7810, "articles": [{ "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 3419.794240113033, "supplierExternalId": "supplierExternalId", "type": "type", "price": 3653.5479794213197, "supplier": 992, "supplierArticleId": "supplierArticleId", "vatAccount": 1311, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 1508.9873563138578, "bundled": "false", "vat": 4696.213029383116, "nextDeliveryDate": 49, "active": "true", "weight": 9291.010557184609, "tags": [{ "name": "name", "externalId": "externalId", "id": 8561, "desc": "desc" }], "supplierBuyRate": 5020.552568502656, "unit": "st", "reserved": 3713.577910149598, "name": "name", "parts": [{ "buyPrice": 7811.391347480357, "supplierName": "supplierName", "amount": 8618.007303902616, "articleName": "articleName", "supplierId": 9125, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 8180.639016949017, "buyPriceShipment": 4811.200593227608, "buyPriceMisc": 5340.595278267591, "supplierArticleId": "supplierArticleId", "stock": 5952.39900929162, "isStock": false, "stockWarning": 9894.167546368055 }], "supplierBuyPriceShipment": 364.2454805585249, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 6281, "orderedAmount": 6903.483630094469, "stockWarning": 7135.815310879729, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 2462.306065350093, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 8869.31243844905, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 4186.097131293403, "bestBefore": 4612, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 942.7809873342862, "totalSerialNumbersInStock": 5516.35148594102, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 4041.3177285335155, "bestBefore": 6742, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 1498.6179173580417, "totalBatches": 6935, "totalSerialNumbers": 2156 }, "webshopArticle": "false", "availableAmount": 5528.830500950065, "orderLevel": 8202.851127801143, "prices": [{ "listId": 1851, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 7530.437105426337, "supplierBuyRate": "1.0", "supplierBuyPrice": 8767.632455704332, "supplier": 2790, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 7602.012619692434 }], "automaticOrder": false, "supplierName": "supplierName", "deliveredAmount": 7200.615357116464, "amount": 1925.970571600032, "articleId": "articleId", "externalId": "externalId", "depth": 3031.562642192411, "supplierBuyPrice": 8257.25174564494, "supplierBuyCurrency": "supplierBuyCurrency", "width": 5988.116738970124, "category": "övrigt" }], "since": 9219 }

Get articles

GETUrl:
Headers:
Accept: application/json or application/xml
Get a list of articles based on parameters

Valid parameters:

Parameter Description Default value Allowed values
query
since Default value is current time. To get all articles you must set the since-parameter
page 0
limit 25
order desc asc,desc
sort_column query query,art,name,bundled,cat,unit,stock_place,stock_place_article,desc,price,order,warning_order,stock,reserved,available,supplier,is_stock,type,status,active
details true
tags true
prices false
include_purchase_prices false
filter_outof_stock false
filter_stock_warning false
filter_non_stock false
filter_non_active false
filter_regardless_bundled true
include_image_last_updated false
include_bundle false
include_next_delivery false
include_batches false
supplier_id

Body:
Successfull response:

{ "pages": 2827, "pageSize": 3004, "page": 7208, "articlesCount": 7136, "articles": [{ "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 2451.127109513358, "supplierExternalId": "supplierExternalId", "type": "type", "price": 6632.202130143511, "supplier": 3084, "supplierArticleId": "supplierArticleId", "vatAccount": 4025, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 9456.993019599951, "bundled": "false", "vat": 6001.7116016235905, "nextDeliveryDate": 2512, "active": "true", "weight": 4349.758725892619, "tags": [{ "name": "name", "externalId": "externalId", "id": 6067, "desc": "desc" }], "supplierBuyRate": 9832.830605567651, "unit": "st", "reserved": 87.70839145127218, "name": "name", "parts": [{ "buyPrice": 7903.683186672279, "supplierName": "supplierName", "amount": 3845.9019369172242, "articleName": "articleName", "supplierId": 44, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 3445.227825665791, "buyPriceShipment": 2946.415076041754, "buyPriceMisc": 4235.5115750252535, "supplierArticleId": "supplierArticleId", "stock": 1769.2791664637987, "isStock": true, "stockWarning": 4191.455164196114 }], "supplierBuyPriceShipment": 7733.932152939929, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 3193, "orderedAmount": 9472.389798812508, "stockWarning": 1771.8882497211684, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 2716.7910465392965, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 5983.807347630182, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 1807.2383156827054, "bestBefore": 1335, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 7684.5746161826455, "totalSerialNumbersInStock": 732.0553187700829, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 4515.788117757058, "bestBefore": 2611, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 2245.1364107739923, "totalBatches": 363, "totalSerialNumbers": 242 }, "webshopArticle": "false", "availableAmount": 2393.7696997701787, "orderLevel": 5490.484955675324, "prices": [{ "listId": 9103, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 9992.09156977139, "supplierBuyRate": "1.0", "supplierBuyPrice": 8019.2530614909265, "supplier": 761, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 6867.802788105692 }], "automaticOrder": true, "supplierName": "supplierName", "deliveredAmount": 1124.2696316871882, "amount": 7379.088861656585, "articleId": "articleId", "externalId": "externalId", "depth": 5535.873337828587, "supplierBuyPrice": 7284.280651910378, "supplierBuyCurrency": "supplierBuyCurrency", "width": 5687.9158284440355, "category": "övrigt" }], "since": 8046 }

Get storegroup articles

GETUrl: /group
Headers:
Accept: application/json or application/xml
Search for articles across all stores in a storegroup

Valid parameters:

Parameter Description Default value Allowed values
query
page 0
limit 25
order asc asc,desc
sort_column art query,art,name,store

Body:
Successfull response:

{ "pages": 3449, "pageSize": 3388, "page": 1645, "articlesCount": 1717, "articles": [{ "availableAmount": 2593.566881671633, "articleId": "articleId", "name": "name", "storeName": "storeName", "storeId": 3199 }], "since": 7374 }

Get articles for supplier

GETUrl: /supplier/{supplier_id}
Headers:
Accept: application/json or application/xml
Get a list of articles connected to a supplier

Valid parameters:

Parameter Description Default value Allowed values
page 0
limit 25
order asc asc,desc
sort_column name art,name,bundled,cat,unit,stock_place,stock_place_article,desc,price,order,warning_order,stock,reserved,supplier,is_stock,type,status,active

Body:
Successfull response:

{ "pages": 3261, "pageSize": 8900, "page": 3123, "articlesCount": 1014, "articles": [{ "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 6544.356347174566, "supplierExternalId": "supplierExternalId", "type": "type", "price": 9807.68527833108, "supplier": 3073, "supplierArticleId": "supplierArticleId", "vatAccount": 7057, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 434.6037038273942, "bundled": "false", "vat": 1434.7824126622866, "nextDeliveryDate": 9433, "active": "true", "weight": 6583.762379238119, "tags": [{ "name": "name", "externalId": "externalId", "id": 2073, "desc": "desc" }], "supplierBuyRate": 7498.8005069851115, "unit": "st", "reserved": 4529.048824415263, "name": "name", "parts": [{ "buyPrice": 2433.79843410392, "supplierName": "supplierName", "amount": 2038.5077773531934, "articleName": "articleName", "supplierId": 2512, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 7458.419445712646, "buyPriceShipment": 937.3371204387748, "buyPriceMisc": 6000.261468132408, "supplierArticleId": "supplierArticleId", "stock": 7467.248947606755, "isStock": true, "stockWarning": 5449.377621268091 }], "supplierBuyPriceShipment": 2782.7081898697184, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 3206, "orderedAmount": 7081.951434496251, "stockWarning": 5627.688021757208, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 3676.4601298380617, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 7939.455629977927, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 8300.683028140546, "bestBefore": 6519, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 4548.770535600786, "totalSerialNumbersInStock": 595.5037231377913, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 7541.331914533589, "bestBefore": 3696, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 9047.495127200114, "totalBatches": 3071, "totalSerialNumbers": 4536 }, "webshopArticle": "false", "availableAmount": 1737.5638641508106, "orderLevel": 4142.983227289176, "prices": [{ "listId": 6998, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 4977.903083820491, "supplierBuyRate": "1.0", "supplierBuyPrice": 1584.4490141490676, "supplier": 2981, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 5091.36112923765 }], "automaticOrder": true, "supplierName": "supplierName", "deliveredAmount": 7303.003094769807, "amount": 8732.86554191149, "articleId": "articleId", "externalId": "externalId", "depth": 4304.5389631511425, "supplierBuyPrice": 8561.962459134116, "supplierBuyCurrency": "supplierBuyCurrency", "width": 1330.5198085836078, "category": "övrigt" }], "since": 835 }

Get articles for category

GETUrl: /category/{category_id}
Headers:
Accept: application/json or application/xml
Get a list of articles connected to a category

Valid parameters:

Parameter Description Default value Allowed values
query
page 0
limit 25
order asc asc,desc
sort_column name art,name,bundled,cat,unit,stock_place,stock_place_article,desc,price,order,warning_order,stock,reserved,supplier,is_stock,type,status,active
details true
prices false
include_purchase_prices false
include_image_last_updated false
include_bundle false
include_next_delivery false
include_batches false

Body:
Successfull response:

{ "pages": 8563, "pageSize": 4139, "page": 9297, "articlesCount": 2674, "articles": [{ "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 1922.6366787799598, "supplierExternalId": "supplierExternalId", "type": "type", "price": 6059.276964340664, "supplier": 1737, "supplierArticleId": "supplierArticleId", "vatAccount": 1534, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 4527.811801819548, "bundled": "false", "vat": 3648.1969856075457, "nextDeliveryDate": 9257, "active": "true", "weight": 9062.48579399369, "tags": [{ "name": "name", "externalId": "externalId", "id": 7219, "desc": "desc" }], "supplierBuyRate": 9409.045211299866, "unit": "st", "reserved": 213.97369414978385, "name": "name", "parts": [{ "buyPrice": 2600.186317569869, "supplierName": "supplierName", "amount": 2265.8427584596443, "articleName": "articleName", "supplierId": 155, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 7685.779401417913, "buyPriceShipment": 3317.4593977258114, "buyPriceMisc": 2887.77699526772, "supplierArticleId": "supplierArticleId", "stock": 8053.280975954912, "isStock": true, "stockWarning": 8051.458782512623 }], "supplierBuyPriceShipment": 9289.499925880986, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 8799, "orderedAmount": 377.48713582463125, "stockWarning": 2643.0644201108257, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 83.75564688783976, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 9343.897086064491, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 2994.2279254789228, "bestBefore": 5800, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 8184.45408034061, "totalSerialNumbersInStock": 2748.6966894647035, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 2640.808123964701, "bestBefore": 9887, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 9547.476894164472, "totalBatches": 1301, "totalSerialNumbers": 3204 }, "webshopArticle": "false", "availableAmount": 8272.550205598325, "orderLevel": 5865.6782198896735, "prices": [{ "listId": 55, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 2794.4302939899403, "supplierBuyRate": "1.0", "supplierBuyPrice": 1359.3048896046434, "supplier": 1713, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 8357.42065267023 }], "automaticOrder": true, "supplierName": "supplierName", "deliveredAmount": 6322.272669955563, "amount": 7769.123072215646, "articleId": "articleId", "externalId": "externalId", "depth": 9493.42283415401, "supplierBuyPrice": 5229.845709623142, "supplierBuyCurrency": "supplierBuyCurrency", "width": 9602.616852106594, "category": "övrigt" }], "since": 1441 }

Get stockplaces

GETUrl: /stockplaces
Headers:
Accept: application/json or application/xml
Get list of stockplaces used in articles
Body:
Successfull response:

{"stockplaces": [{ "articles": 7186, "stockplace": "stockplace" }]}

Get history articles

GETUrl: /history
Headers:
Accept: application/json or application/xml
Get a list of articles for a specific date

Valid parameters:

Parameter Description Default value Allowed values
page 0
limit 25
date
category Include a category-id to only include articles for this category
include_paging_info true

Body:
Successfull response:

{ "pages": 2535, "pageSize": 6677, "page": 411, "articlesCount": 5990, "articles": [{ "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 7159.751358134739, "supplierExternalId": "supplierExternalId", "type": "type", "price": 4671.2503004061955, "supplier": 262, "supplierArticleId": "supplierArticleId", "vatAccount": 1405, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 3727.328774640668, "bundled": "false", "vat": 828.6035667808655, "nextDeliveryDate": 9066, "active": "true", "weight": 2773.8473392556793, "tags": [{ "name": "name", "externalId": "externalId", "id": 7296, "desc": "desc" }], "supplierBuyRate": 5113.840390701824, "unit": "st", "reserved": 9159.167982262295, "name": "name", "parts": [{ "buyPrice": 1072.6591482240267, "supplierName": "supplierName", "amount": 8075.644420375865, "articleName": "articleName", "supplierId": 7347, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 7239.463603510024, "buyPriceShipment": 4083.5676234000807, "buyPriceMisc": 4839.563929665379, "supplierArticleId": "supplierArticleId", "stock": 7209.417285086956, "isStock": false, "stockWarning": 2117.102900191242 }], "supplierBuyPriceShipment": 3576.6025902313013, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 7142, "orderedAmount": 6123.642903942717, "stockWarning": 8452.994889041676, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 8651.522196225962, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 9242.623375568746, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 5327.711329618102, "bestBefore": 2712, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 7836.641695279081, "totalSerialNumbersInStock": 1726.9889711083142, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 5782.968399781824, "bestBefore": 5897, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 9275.391908029209, "totalBatches": 5127, "totalSerialNumbers": 9298 }, "webshopArticle": "false", "availableAmount": 159.98742915344312, "orderLevel": 6741.438133433837, "prices": [{ "listId": 7086, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 1209.82625218093, "supplierBuyRate": "1.0", "supplierBuyPrice": 5316.177155008881, "supplier": 9645, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 9767.978000971907 }], "automaticOrder": false, "supplierName": "supplierName", "deliveredAmount": 1174.9068440885092, "amount": 3812.8779392158185, "articleId": "articleId", "externalId": "externalId", "depth": 629.6053166285998, "supplierBuyPrice": 484.4582049503743, "supplierBuyCurrency": "supplierBuyCurrency", "width": 1328.013995223941, "category": "övrigt" }], "since": 3142 }

Get history articles info

GETUrl: /history/info
Headers:
Accept: application/json or application/xml
Get info on number of articles and pages exists in stock for given date

Valid parameters:

Parameter Description Default value Allowed values
limit 25
date
category Include a category-id to only include articles for this category

Body:
Successfull response:

{ "pages": 8851, "pageSize": 2657, "page": 4153, "articlesCount": 9707, "articles": [{ "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 7847.704831167827, "supplierExternalId": "supplierExternalId", "type": "type", "price": 8947.84376046591, "supplier": 1342, "supplierArticleId": "supplierArticleId", "vatAccount": 8350, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 3473.67521709284, "bundled": "false", "vat": 9448.086524412169, "nextDeliveryDate": 9259, "active": "true", "weight": 1562.4459962632031, "tags": [{ "name": "name", "externalId": "externalId", "id": 1321, "desc": "desc" }], "supplierBuyRate": 7134.238513864622, "unit": "st", "reserved": 7713.578691345982, "name": "name", "parts": [{ "buyPrice": 4249.147962774974, "supplierName": "supplierName", "amount": 4577.053391644359, "articleName": "articleName", "supplierId": 2567, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 9438.831413776596, "buyPriceShipment": 8725.393672148191, "buyPriceMisc": 4661.776891164915, "supplierArticleId": "supplierArticleId", "stock": 3248.303968317787, "isStock": true, "stockWarning": 1113.331581678334 }], "supplierBuyPriceShipment": 6504.3533486770575, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 1603, "orderedAmount": 4995.869432924343, "stockWarning": 2559.682111792795, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 153.88399399562823, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 2645.8963159476943, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 9378.81665006625, "bestBefore": 9542, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 1644.6012408977163, "totalSerialNumbersInStock": 7254.99284117779, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 5251.15284204551, "bestBefore": 805, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 5132.50863659236, "totalBatches": 9555, "totalSerialNumbers": 4121 }, "webshopArticle": "false", "availableAmount": 5218.289921799951, "orderLevel": 2464.8338569884977, "prices": [{ "listId": 873, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 3322.059802796261, "supplierBuyRate": "1.0", "supplierBuyPrice": 5189.168419160269, "supplier": 5319, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 8563.551514461546 }], "automaticOrder": false, "supplierName": "supplierName", "deliveredAmount": 3912.817194537671, "amount": 3667.0774276905495, "articleId": "articleId", "externalId": "externalId", "depth": 9436.773353035542, "supplierBuyPrice": 6994.014974730776, "supplierBuyCurrency": "supplierBuyCurrency", "width": 8085.131023295663, "category": "övrigt" }], "since": 3379 }

Get articles for autocomplete

GETUrl: /autocomplete
Headers:
Accept: application/json or application/xml
Get a list of articles with bare minimum of fields to use for autocomplete fields

Valid parameters:

Parameter Description Default value Allowed values
light true
query
pricelist_id -1
supplier_id -1
page 0
limit 20

Body:
Successfull response:

{ "pages": 2168, "pageSize": 5780, "page": 9285, "articlesCount": 8, "articles": [{ "supplierBuyPriceMisc": 1136.4111688008727, "amount": 2489.8774941157253, "bundled": true, "barcodeType": "EAN", "articleId": "articleId", "vat": 8302.097864575608, "active": false, "type": "type", "supplierBuyRate": 46.66617050347321, "unit": "unit", "reserved": 5899.150516551835, "price": 8995.679291575752, "supplierBuyPrice": 7780.1639707507975, "name": "name", "supplierBuyCurrency": "supplierBuyCurrency", "supplierBuyPriceShipment": 5568.239615426074, "stock": false, "barcode": "barcode" }] }

Get articles low in stock

GETUrl: /stockwarning
Headers:
Accept: application/json or application/xml
Get a list of articles below stock warning

Valid parameters:

Parameter Description Default value Allowed values
filter_warning_flag false
set_articles_warned false

Body:
Successfull response:

{ "pages": 277, "pageSize": 7090, "page": 8162, "articlesCount": 8270, "articles": [{ "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 1045.974955099057, "supplierExternalId": "supplierExternalId", "type": "type", "price": 6693.986395750784, "supplier": 9234, "supplierArticleId": "supplierArticleId", "vatAccount": 6437, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 3679.103411446777, "bundled": "false", "vat": 3287.521502560239, "nextDeliveryDate": 4872, "active": "true", "weight": 176.57494714368283, "tags": [{ "name": "name", "externalId": "externalId", "id": 6647, "desc": "desc" }], "supplierBuyRate": 437.0689726359489, "unit": "st", "reserved": 9276.730465931025, "name": "name", "parts": [{ "buyPrice": 9104.523973198498, "supplierName": "supplierName", "amount": 8509.02854169333, "articleName": "articleName", "supplierId": 9830, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 2900.058808787985, "buyPriceShipment": 6434.7126994728205, "buyPriceMisc": 2121.6747138527494, "supplierArticleId": "supplierArticleId", "stock": 7647.984668681628, "isStock": false, "stockWarning": 8671.761694114639 }], "supplierBuyPriceShipment": 6275.221930239455, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 5395, "orderedAmount": 5361.812585704825, "stockWarning": 4393.5441743317615, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 1847.0864225796756, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 9657.68851881097, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 6267.101276484067, "bestBefore": 6633, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 1760.59233140597, "totalSerialNumbersInStock": 186.86149736082848, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 6189.413633683648, "bestBefore": 4972, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 5818.94330556773, "totalBatches": 583, "totalSerialNumbers": 9283 }, "webshopArticle": "false", "availableAmount": 8633.02502346824, "orderLevel": 738.6114346516692, "prices": [{ "listId": 6765, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 8263.804448483204, "supplierBuyRate": "1.0", "supplierBuyPrice": 4869.932083307389, "supplier": 6510, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 6857.473593598029 }], "automaticOrder": true, "supplierName": "supplierName", "deliveredAmount": 5596.594001179345, "amount": 4157.463682691922, "articleId": "articleId", "externalId": "externalId", "depth": 4327.304878818202, "supplierBuyPrice": 785.5417649989382, "supplierBuyCurrency": "supplierBuyCurrency", "width": 7011.886132960975, "category": "övrigt" }], "since": 5886 }

Count articles low in stock

GETUrl: /stockwarning/count
Headers:
Accept: application/json or application/xml
Get the number of articles below stock warning

Valid parameters:

Parameter Description Default value Allowed values
include_ordered true

Body:
Successfull response:

{"count": 3047}

Get article (external)

GETUrl: /external/{id : .+}
Headers:
Accept: application/json or application/xml
Get an article based on external article-id

Valid parameters:

Parameter Description Default value Allowed values
prices false
include_bundle false
include_next_delivery false
include_purchase_prices false
include_batches false
sort_column batch_id batch_id,serie_nr,amount,best_before
order desc asc,desc

Body:
Successfull response:

{ "pages": 2211, "pageSize": 2852, "page": 7373, "articlesCount": 4501, "articles": [{ "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 6769.837591572003, "supplierExternalId": "supplierExternalId", "type": "type", "price": 7057.6665929840965, "supplier": 8563, "supplierArticleId": "supplierArticleId", "vatAccount": 5137, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 4930.447181444697, "bundled": "false", "vat": 4605.513990597899, "nextDeliveryDate": 2904, "active": "true", "weight": 8953.835019026872, "tags": [{ "name": "name", "externalId": "externalId", "id": 9520, "desc": "desc" }], "supplierBuyRate": 1128.2840188838238, "unit": "st", "reserved": 9677.114342193525, "name": "name", "parts": [{ "buyPrice": 7936.565949850215, "supplierName": "supplierName", "amount": 57.77435313415013, "articleName": "articleName", "supplierId": 7182, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 1205.3956789124643, "buyPriceShipment": 7539.735879308367, "buyPriceMisc": 9827.694185349403, "supplierArticleId": "supplierArticleId", "stock": 4587.605206775774, "isStock": true, "stockWarning": 5118.004676350762 }], "supplierBuyPriceShipment": 7636.926686518079, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 4833, "orderedAmount": 9868.341885168946, "stockWarning": 8237.321469985976, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 827.0472918051686, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 3647.8679529478263, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 6495.715103779411, "bestBefore": 9198, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 1630.083649890738, "totalSerialNumbersInStock": 3945.2912472074563, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 8618.225064955657, "bestBefore": 6756, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 6827.157742143929, "totalBatches": 8684, "totalSerialNumbers": 7857 }, "webshopArticle": "false", "availableAmount": 8787.403197914815, "orderLevel": 9479.696034425484, "prices": [{ "listId": 6243, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 8882.673117515697, "supplierBuyRate": "1.0", "supplierBuyPrice": 699.3185398243529, "supplier": 5223, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 5007.37036480319 }], "automaticOrder": false, "supplierName": "supplierName", "deliveredAmount": 3798.7731313902264, "amount": 6045.867922443965, "articleId": "articleId", "externalId": "externalId", "depth": 5842.535052524034, "supplierBuyPrice": 5351.614564648846, "supplierBuyCurrency": "supplierBuyCurrency", "width": 3222.79127937791, "category": "övrigt" }], "since": 3870 }

Get article

GETUrl: /{id : .+}
Headers:
Accept: application/json or application/xml
Get an article based on article-id

Valid parameters:

Parameter Description Default value Allowed values
prices false
include_bundle false
include_next_delivery false
include_purchase_prices false
include_batches false
sort_column batch_id batch_id,serie_nr,amount,best_before
order desc asc,desc

Body:
Successfull response:

{ "pages": 8371, "pageSize": 8127, "page": 2201, "articlesCount": 4642, "articles": [{ "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 7447.851238103148, "supplierExternalId": "supplierExternalId", "type": "type", "price": 1899.1333089527473, "supplier": 2960, "supplierArticleId": "supplierArticleId", "vatAccount": 9030, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 5640.537915021693, "bundled": "false", "vat": 8712.96318237631, "nextDeliveryDate": 434, "active": "true", "weight": 8079.817590630193, "tags": [{ "name": "name", "externalId": "externalId", "id": 13, "desc": "desc" }], "supplierBuyRate": 877.1532727679465, "unit": "st", "reserved": 3335.961166827551, "name": "name", "parts": [{ "buyPrice": 7997.005558290626, "supplierName": "supplierName", "amount": 3085.299762174808, "articleName": "articleName", "supplierId": 3857, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 8696.597182928841, "buyPriceShipment": 8846.736350133948, "buyPriceMisc": 5421.731917995086, "supplierArticleId": "supplierArticleId", "stock": 3088.6126655474786, "isStock": true, "stockWarning": 6220.669625116889 }], "supplierBuyPriceShipment": 9160.118311151999, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 9824, "orderedAmount": 2181.374167576664, "stockWarning": 2025.4628749190817, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 4684.9101765594205, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 2268.5122453749227, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 9050.631561820244, "bestBefore": 6845, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 2011.543474620071, "totalSerialNumbersInStock": 2893.751049968153, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 1393.606908301379, "bestBefore": 8477, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 5326.727179960129, "totalBatches": 2730, "totalSerialNumbers": 6601 }, "webshopArticle": "false", "availableAmount": 3145.1264307339434, "orderLevel": 980.5546508847185, "prices": [{ "listId": 5182, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 2179.56292486983, "supplierBuyRate": "1.0", "supplierBuyPrice": 9032.661637295423, "supplier": 3199, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 8040.374012643705 }], "automaticOrder": true, "supplierName": "supplierName", "deliveredAmount": 7097.25535521803, "amount": 4215.839488536867, "articleId": "articleId", "externalId": "externalId", "depth": 2929.665705629179, "supplierBuyPrice": 6730.807000369748, "supplierBuyCurrency": "supplierBuyCurrency", "width": 3094.1669396748684, "category": "övrigt" }], "since": 7250 }

Get article history

GETUrl: /{id : .+}/history
Headers:
Accept: application/json or application/xml
Get an article history based on article-id

Valid parameters:

Parameter Description Default value Allowed values
page 0
limit 25

Body:
Successfull response:

{ "pages": 7430, "pageSize": 1838, "page": 2913, "historyCount": 2763, "history": [{ "supplierName": "supplierName", "reason": "reason", "supplierId": 2796, "newSalesPrice": 1845.3977092384844, "oldCount": 3261.9838524582533, "newCount": 7258.591786914537, "pricelistId": 5908, "pricelistName": "pricelistName", "created": 1708765825065, "oldSalesPrice": 2939.4950613566452, "articleId": "articleId", "userName": "userName", "newReserved": 9420.707046609576, "userId": 3059, "newPurchasePrice": 147.6978552292063, "oldPurchasePrice": 2663.074503841666, "oldReserved": 409.81175210522804 }], "since": 255 }

Get next article id

GETUrl: /next_id
Headers:
Accept: application/json or application/xml
Get next available unique article id
Body:
Successfull response:

{"id": "id"}

Add article tags

POSTUrl: /tag
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Add article tags for store group
Body:

{ "name": "name", "externalId": "externalId", "id": 3351, "desc": "desc" }
Successfull response:

{ "name": "name", "externalId": "externalId", "id": 2841, "desc": "desc" }

Add new article

POSTUrl:
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Add a new article
Body:

{ "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 9648.847836313773, "customFields": [{ "name": "name", "type": "type", "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "type": "type", "criticalLevel": 4331.690083849517, "manufacturer": "manufacturer", "webshopArticle": "false", "orderLevel": 4791.086503074117, "price": 1945.2910801917756, "supplier": 2661, "supplierArticleId": "supplierArticleId", "vatAccount": 4851, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "supplierArticles": [{ "supplierName": "supplierName", "supplierBuyPriceMisc": 1428.930800031425, "supplierBuyRate": "1.0", "supplierBuyPrice": 4192.79912325636, "supplier": 2621, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 4453.444477542067 }], "height": 3036.6691934816636, "automaticOrder": false, "supplierName": "supplierName", "amount": 147.87765868982007, "bundled": "false", "articleId": "articleId", "vat": 72.63832140221416, "externalId": "externalId", "active": "true", "weight": 1745.9949130373175, "tags": [{ "name": "name", "externalId": "externalId", "id": 6138, "desc": "desc" }], "unit": "st", "depth": 1795.3695532630943, "supplierBuyPrice": 5355.135929900278, "name": "name", "parts": [{ "amount": 3924.391506959899, "articleId": "articleId", "type": "type" }], "width": 2209.4238394757235, "supplierBuyPriceShipment": 9748.76637762231, "manufacturerArticleId": "manufacturerArticleId", "category": "övrigt", "stockWarning": 7247.606425379264 }
Successfull response:

{ "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 2249.339578059234, "supplierExternalId": "supplierExternalId", "type": "type", "price": 9757.196625575922, "supplier": 8362, "supplierArticleId": "supplierArticleId", "vatAccount": 3556, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 2634.6633258238317, "bundled": "false", "vat": 7602.101902717698, "nextDeliveryDate": 3584, "active": "true", "weight": 9629.12726899809, "tags": [{ "name": "name", "externalId": "externalId", "id": 965, "desc": "desc" }], "supplierBuyRate": 393.924245041356, "unit": "st", "reserved": 7942.412949191839, "name": "name", "parts": [{ "buyPrice": 5330.575002749991, "supplierName": "supplierName", "amount": 431.6767224426299, "articleName": "articleName", "supplierId": 9932, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 1395.5174930917024, "buyPriceShipment": 2878.4697874729945, "buyPriceMisc": 7662.499835607069, "supplierArticleId": "supplierArticleId", "stock": 5074.164442518587, "isStock": true, "stockWarning": 7188.265171006978 }], "supplierBuyPriceShipment": 9354.422124068447, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 8356, "orderedAmount": 1913.7461821999213, "stockWarning": 2132.415164360637, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 1600.580473079848, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 1056.386679779866, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 4088.1488805797594, "bestBefore": 4625, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 3738.315392090287, "totalSerialNumbersInStock": 8938.737230272684, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 2943.487636785643, "bestBefore": 3368, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 208.49418063170532, "totalBatches": 4329, "totalSerialNumbers": 7428 }, "webshopArticle": "false", "availableAmount": 60.739608399119625, "orderLevel": 4178.96326828605, "prices": [{ "listId": 6713, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 8851.942566533018, "supplierBuyRate": "1.0", "supplierBuyPrice": 5114.9755331867245, "supplier": 7404, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 6637.833121054164 }], "automaticOrder": true, "supplierName": "supplierName", "deliveredAmount": 7964.813665650952, "amount": 4053.87659265824, "articleId": "articleId", "externalId": "externalId", "depth": 6531.050178106317, "supplierBuyPrice": 6206.21448644063, "supplierBuyCurrency": "supplierBuyCurrency", "width": 7040.021157470528, "category": "övrigt" }

Add articles

POSTUrl: /list
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Add a list of articles
Body:
Successfull response:

Import articles

POSTUrl: /import/{template_id}
Headers:
Accept: application/json or application/xml
Content-type: multipart/form-data
Import articles from excel or tsv

Valid parameters:

Parameter Description Default value Allowed values
update_only
register_delivery false
file
file

Body:
Successfull response:

Test import articles

POSTUrl: /import/test/{template_id}
Headers:
Accept: application/json or application/xml
Content-type: multipart/form-data
Test import articles from excel or tsv. This will read the first data-row from the uploaded file and return the result. Can be used to verify that the template being used is mapped correctly. No actual changed will be saved.

Valid parameters:

Parameter Description Default value Allowed values
file
file

Body:
Successfull response:

Import bundled articles

POSTUrl: /import/bundle
Headers:
Accept: application/json or application/xml
Content-type: multipart/form-data
Import structure for bundled articles from excel or tsv

Valid parameters:

Parameter Description Default value Allowed values
file_type tsv
file
file

Body:
Successfull response:

Test import bundled articles

POSTUrl: /import/bundle/test
Headers:
Accept: application/json or application/xml
Content-type: multipart/form-data
Test import structure for bundled articles from excel or tsv. No actual changed will be saved.

Valid parameters:

Parameter Description Default value Allowed values
file_type tsv
file
file

Body:
Successfull response:

Update articles

PUTUrl: /list
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update a list of existing articles (Max 100 articles per request)
Body:

{ "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 7869.539385117571, "supplierExternalId": "supplierExternalId", "type": "type", "price": 1670.0635390501461, "supplier": 3404, "supplierArticleId": "supplierArticleId", "vatAccount": 8682, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 1853.6482688159683, "bundled": "false", "vat": 6505.259445277716, "nextDeliveryDate": 62, "active": "true", "weight": 4917.3278550138975, "tags": [{ "name": "name", "externalId": "externalId", "id": 64, "desc": "desc" }], "supplierBuyRate": 1691.8634676359322, "unit": "st", "reserved": 6638.721756369236, "name": "name", "parts": [{ "buyPrice": 9879.22114785485, "supplierName": "supplierName", "amount": 4175.455269445276, "articleName": "articleName", "supplierId": 7504, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 7381.326038065892, "buyPriceShipment": 2116.5747142969917, "buyPriceMisc": 6683.9637811876555, "supplierArticleId": "supplierArticleId", "stock": 1752.7923838829852, "isStock": true, "stockWarning": 673.1073892137929 }], "supplierBuyPriceShipment": 2290.370700209787, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 7457, "orderedAmount": 4152.3829887417005, "stockWarning": 3567.0972813835556, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 6406.993880013455, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 9531.25878137094, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 5213.224715155394, "bestBefore": 425, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 1653.325858375152, "totalSerialNumbersInStock": 4826.257652454802, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 6153.672359353202, "bestBefore": 9496, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 2676.4453200879248, "totalBatches": 3665, "totalSerialNumbers": 635 }, "webshopArticle": "false", "availableAmount": 5518.372222607321, "orderLevel": 276.8718870314602, "prices": [{ "listId": 4964, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 2404.7238066731, "supplierBuyRate": "1.0", "supplierBuyPrice": 5676.63692386544, "supplier": 4826, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 5782.604637952404 }], "automaticOrder": true, "supplierName": "supplierName", "deliveredAmount": 268.4986516786447, "amount": 9517.827230333536, "articleId": "articleId", "externalId": "externalId", "depth": 3576.3870569133273, "supplierBuyPrice": 7592.077179290777, "supplierBuyCurrency": "supplierBuyCurrency", "width": 3844.547079962103, "category": "övrigt" }
Successfull response:

Update article

PUTUrl: /{id : .+}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update an existing article

Valid parameters:

Parameter Description Default value Allowed values
reason
sort_column batch_id batch_id,serie_nr,amount,best_before
order desc asc,desc

Body:

{ "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 8313.524680070801, "supplierExternalId": "supplierExternalId", "type": "type", "price": 9632.33182758806, "supplier": 5270, "supplierArticleId": "supplierArticleId", "vatAccount": 8846, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 2404.730861669213, "bundled": "false", "vat": 473.3351917100559, "nextDeliveryDate": 627, "active": "true", "weight": 376.2681002391355, "tags": [{ "name": "name", "externalId": "externalId", "id": 1579, "desc": "desc" }], "supplierBuyRate": 9266.949820018064, "unit": "st", "reserved": 5902.715906694444, "name": "name", "parts": [{ "buyPrice": 6463.60087120746, "supplierName": "supplierName", "amount": 8130.889921151079, "articleName": "articleName", "supplierId": 623, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 1441.384412321658, "buyPriceShipment": 1152.037834933265, "buyPriceMisc": 7097.087642186158, "supplierArticleId": "supplierArticleId", "stock": 2041.3161818959402, "isStock": false, "stockWarning": 5408.186495701996 }], "supplierBuyPriceShipment": 2333.7314361440917, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 6338, "orderedAmount": 6094.628940207363, "stockWarning": 5767.786751754234, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 2961.2835815431836, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 3994.4236381460764, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 5494.736024567975, "bestBefore": 9490, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 4945.233865253406, "totalSerialNumbersInStock": 9615.223121201125, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 1181.483967158281, "bestBefore": 8591, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 6627.192267949491, "totalBatches": 6522, "totalSerialNumbers": 3835 }, "webshopArticle": "false", "availableAmount": 1987.9447896719926, "orderLevel": 5987.335242704454, "prices": [{ "listId": 6233, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 1256.9633703462691, "supplierBuyRate": "1.0", "supplierBuyPrice": 9826.074798005133, "supplier": 3767, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 6786.680770053203 }], "automaticOrder": false, "supplierName": "supplierName", "deliveredAmount": 4721.926425337401, "amount": 5076.570883147648, "articleId": "articleId", "externalId": "externalId", "depth": 4368.0865991581495, "supplierBuyPrice": 8083.040277740182, "supplierBuyCurrency": "supplierBuyCurrency", "width": 4094.5278467960975, "category": "övrigt" }
Successfull response:

{ "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 1445.601853946945, "supplierExternalId": "supplierExternalId", "type": "type", "price": 4113.948785843067, "supplier": 8726, "supplierArticleId": "supplierArticleId", "vatAccount": 5769, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 5801.059408464044, "bundled": "false", "vat": 4921.0884137583425, "nextDeliveryDate": 4618, "active": "true", "weight": 8029.910878857569, "tags": [{ "name": "name", "externalId": "externalId", "id": 6428, "desc": "desc" }], "supplierBuyRate": 1878.093076477263, "unit": "st", "reserved": 2204.1863767452487, "name": "name", "parts": [{ "buyPrice": 2822.7001544871864, "supplierName": "supplierName", "amount": 7502.075626693942, "articleName": "articleName", "supplierId": 6987, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 4034.722854391225, "buyPriceShipment": 5307.485996039589, "buyPriceMisc": 9404.948371180562, "supplierArticleId": "supplierArticleId", "stock": 9456.73948335733, "isStock": true, "stockWarning": 7261.906381911016 }], "supplierBuyPriceShipment": 5699.260640005659, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 6500, "orderedAmount": 7349.077948574817, "stockWarning": 7346.812807290236, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 4270.450002646884, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 6979.301556768051, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 4475.047483581842, "bestBefore": 7453, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 8944.460077577516, "totalSerialNumbersInStock": 1462.93744356383, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 9050.150279856027, "bestBefore": 1404, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 5602.344192223349, "totalBatches": 1936, "totalSerialNumbers": 8880 }, "webshopArticle": "false", "availableAmount": 2504.8653019233234, "orderLevel": 7627.908110047635, "prices": [{ "listId": 4392, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": false, "supplierBuyPriceMisc": 6031.133420414898, "supplierBuyRate": "1.0", "supplierBuyPrice": 143.4110444640757, "supplier": 368, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 9437.883241277683 }], "automaticOrder": false, "supplierName": "supplierName", "deliveredAmount": 6958.600573991132, "amount": 723.308422929655, "articleId": "articleId", "externalId": "externalId", "depth": 456.0737401604431, "supplierBuyPrice": 5416.603998010857, "supplierBuyCurrency": "supplierBuyCurrency", "width": 5889.125959641972, "category": "övrigt" }

Update article reserved

PUTUrl: /{id : .+}/reserved
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update an article´s reserved value
Body:
Successfull response:

{"reserved": 2921.2019247713038}

Update article fifo rate

PUTUrl: /{id : .+}/fifo/rate
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update an existing article fifo purchase rate for a specific timestamp
Body:

{ "date": 1708765825075, "rate": 4805.8523090545 }
Successfull response:

Update article fifo purchase price

PUTUrl: /{id : .+}/fifo/purchase_price
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update an existing article fifo purchase price for a specific timestamp
Body:

{ "date": 1708765825076, "price": 8537.20080505966 }
Successfull response:

Move article

PUTUrl: /{id : .+}/move
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Move article to another store
Body:

{ "batches": { "totalSerialNumbersReserved": 4249.226497793888, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 3023.5067851360063, "bestBefore": 2986, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 8004.862570589381, "totalSerialNumbersInStock": 1691.7821234147234, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 1277.3840575711781, "bestBefore": 5091, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 9359.587872749767, "totalBatches": 8851, "totalSerialNumbers": 4439 }, "amount": 4151.083153259403, "articleId": "articleId", "toStoreId": 9083 }
Successfull response:

Bulk update articles

PUTUrl: /bulk
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update a field for a list of existing articles (Max 100 articles per request)
Body:

{ "field": "field", "pricelistId": 4257, "type": "SET", "articles": [{}], "value": "value" }
Successfull response:

{ "field": "field", "pricelistId": 5440, "articles": [{ "articleId": "articleId", "value": "value" }] }

Delete list of articles

PUTUrl: /bulk/delete
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Delete list of existing articles (Max 100 articles per request)
Body:

{"articles": [{}]}
Successfull response:

Create bundles for article

PUTUrl: /{id : .+}/bundles
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Create bundles for article
Body:

{ "amount": 4005.900225265463, "articleName": "articleName", "articleId": "articleId" }
Successfull response:

{ "pages": 4964, "pageSize": 897, "page": 7677, "articlesCount": 9225, "articles": [{ "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 6721.597919743839, "supplierExternalId": "supplierExternalId", "type": "type", "price": 478.37242454441764, "supplier": 3797, "supplierArticleId": "supplierArticleId", "vatAccount": 4191, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 6994.172446825108, "bundled": "false", "vat": 3857.555216708084, "nextDeliveryDate": 8531, "active": "true", "weight": 9295.05553361188, "tags": [{ "name": "name", "externalId": "externalId", "id": 9534, "desc": "desc" }], "supplierBuyRate": 9229.942892018362, "unit": "st", "reserved": 144.76336210411444, "name": "name", "parts": [{ "buyPrice": 2277.7462253696012, "supplierName": "supplierName", "amount": 4390.856098126291, "articleName": "articleName", "supplierId": 9275, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 7606.020434220626, "buyPriceShipment": 7038.823558111312, "buyPriceMisc": 1352.6542911029571, "supplierArticleId": "supplierArticleId", "stock": 5228.950176338003, "isStock": true, "stockWarning": 78.24512719936338 }], "supplierBuyPriceShipment": 9079.361147041158, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 5835, "orderedAmount": 2673.8944181873826, "stockWarning": 2024.2125536827837, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 387.81788881291135, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 7837.185211119075, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 5908.946192375365, "bestBefore": 2144, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 9171.004678386844, "totalSerialNumbersInStock": 2588.682043847891, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 8698.86665605091, "bestBefore": 4268, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 8183.937237580784, "totalBatches": 3736, "totalSerialNumbers": 1287 }, "webshopArticle": "false", "availableAmount": 2852.806025825002, "orderLevel": 9156.938124286238, "prices": [{ "listId": 8057, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 2140.00026878748, "supplierBuyRate": "1.0", "supplierBuyPrice": 8308.836103961019, "supplier": 2199, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 5706.90530309792 }], "automaticOrder": false, "supplierName": "supplierName", "deliveredAmount": 1983.2712981739153, "amount": 9214.988196040063, "articleId": "articleId", "externalId": "externalId", "depth": 7725.517433668188, "supplierBuyPrice": 8975.25114843719, "supplierBuyCurrency": "supplierBuyCurrency", "width": 1611.6414161431192, "category": "övrigt" }], "since": 117 }

Split bundles for article

PUTUrl: /{id : .+}/split
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Split bundles for article
Body:

{ "amount": 3.3522776517946884, "articleName": "articleName", "articleId": "articleId" }
Successfull response:

{ "pages": 2723, "pageSize": 6163, "page": 6420, "articlesCount": 5279, "articles": [{ "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 3072.915182040804, "supplierExternalId": "supplierExternalId", "type": "type", "price": 6631.45815016314, "supplier": 5778, "supplierArticleId": "supplierArticleId", "vatAccount": 6659, "links": [{ "name": "name", "type": "type", "url": "url" }], "stock": "true", "barcode": "barcode", "height": 5150.62877496974, "bundled": "false", "vat": 5203.621787370889, "nextDeliveryDate": 6540, "active": "true", "weight": 7268.565529162301, "tags": [{ "name": "name", "externalId": "externalId", "id": 1950, "desc": "desc" }], "supplierBuyRate": 5381.579714848558, "unit": "st", "reserved": 6773.546521055103, "name": "name", "parts": [{ "buyPrice": 2920.567121702897, "supplierName": "supplierName", "amount": 8935.95537552618, "articleName": "articleName", "supplierId": 2414, "unitName": "unitName", "articleId": "articleId", "externalId": "externalId", "stockPlace": "stockPlace", "type": "type", "buyPriceCurrency": "buyPriceCurrency", "reserved": 5566.095692762157, "buyPriceShipment": 5397.457414662436, "buyPriceMisc": 1608.5395762394505, "supplierArticleId": "supplierArticleId", "stock": 3857.788824208871, "isStock": true, "stockWarning": 6368.617826608417 }], "supplierBuyPriceShipment": 2763.824248967891, "manufacturerArticleId": "manufacturerArticleId", "imageLastUpdated": 3913, "orderedAmount": 3865.5697568743362, "stockWarning": 4312.131272448308, "customFields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }], "barcodeType": "EAN", "description": "description", "stockPlace": "stockPlace", "criticalLevel": 411.373990263304, "manufacturer": "manufacturer", "batches": { "totalSerialNumbersReserved": 4288.910909304169, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 2878.4807884187767, "bestBefore": 9020, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 6743.891218504148, "totalSerialNumbersInStock": 2550.556095423131, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 8592.505818282661, "bestBefore": 3879, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 8903.659350390857, "totalBatches": 5127, "totalSerialNumbers": 3339 }, "webshopArticle": "false", "availableAmount": 4820.4335101327215, "orderLevel": 7432.721914225069, "prices": [{ "listId": 1527, "price": "0", "articleId": "articleId", "fromQuantity": "0", "listExternalId": "listExternalId" }], "supplierArticles": [{ "supplierName": "supplierName", "supplierAutomaticOrder": true, "supplierBuyPriceMisc": 6484.25489155481, "supplierBuyRate": "1.0", "supplierBuyPrice": 9630.762651042232, "supplier": 9255, "supplierArticleId": "supplierArticleId", "supplierBuyCurrency": "Store currency", "supplierBuyPriceShipment": 8999.047711825797 }], "automaticOrder": true, "supplierName": "supplierName", "deliveredAmount": 7916.024620556508, "amount": 3750.92620222234, "articleId": "articleId", "externalId": "externalId", "depth": 1381.8987712961373, "supplierBuyPrice": 6166.791551496872, "supplierBuyCurrency": "supplierBuyCurrency", "width": 5121.50312634386, "category": "övrigt" }], "since": 4438 }

Delete article fifo

DELETEUrl: /fifo/{id}
Headers:
Accept: application/json or application/xml
Delete a specific fifo row
Body:
Successfull response:

Delete article

DELETEUrl: /{id : .+}
Headers:
Accept: application/json or application/xml
Delete article based on article-id
Body:
Successfull response:

Delete fifo

DELETEUrl: /{id : .+}/fifo
Headers:
Accept: application/json or application/xml
Delete all article fifos based on article-id
Body:
Successfull response:

Batches

Get batches

GETUrl: /batch
Headers:
Accept: application/json or application/xml
Get batches based on query

Valid parameters:

Parameter Description Default value Allowed values
query
include_all_batches true
page 0
limit 100

Body:
Successfull response:

{ "totalSerialNumbersReserved": 3233.4689129860903, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 3157.3080104972273, "bestBefore": 1549, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 1580.121779770155, "totalSerialNumbersInStock": 4000.7131481891643, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 8279.125160441657, "bestBefore": 3275, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 105.00799837276031, "totalBatches": 6722, "totalSerialNumbers": 8908 }

Get serial numbers

GETUrl: /serialnumber
Headers:
Accept: application/json or application/xml
Get serial numbers based on query

Valid parameters:

Parameter Description Default value Allowed values
query
page 0
limit 100

Body:
Successfull response:

{ "totalSerialNumbersReserved": 3130.9828971244224, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 8917.39567892588, "bestBefore": 7267, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 4851.954264931727, "totalSerialNumbersInStock": 5792.238064972383, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 7365.494664619914, "bestBefore": 7834, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 8397.148768342715, "totalBatches": 6674, "totalSerialNumbers": 8212 }

Get batches for article

GETUrl: /{id : .+}/batch
Headers:
Accept: application/json or application/xml
Get batches for a specific article based on article-id

Valid parameters:

Parameter Description Default value Allowed values
query
page 0
limit 100
sort_column batch_id batch_id,serie_nr,amount,best_before
order_by asc asc,desc

Body:
Successfull response:

{ "totalSerialNumbersReserved": 277.94322854826305, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 6064.044417080268, "bestBefore": 9386, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 3667.77698157681, "totalSerialNumbersInStock": 5357.232994477581, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 9341.95333250794, "bestBefore": 1935, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 997.627521380805, "totalBatches": 3424, "totalSerialNumbers": 7356 }

Get serial numbers for article

GETUrl: /{id : .+}/serialnumber
Headers:
Accept: application/json or application/xml
Get serial numbers for a specific article based on article-id

Valid parameters:

Parameter Description Default value Allowed values
query
include_all_serial_numbers true
page 0
limit 100
sort_column batch_id batch_id,serie_nr,amount,best_before
order_by asc asc,desc

Body:
Successfull response:

{ "totalSerialNumbersReserved": 9789.012415942783, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 3570.7103833899414, "bestBefore": 8461, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 242.54239913065413, "totalSerialNumbersInStock": 5360.122181118432, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 4810.322689539837, "bestBefore": 217, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 3877.199224218304, "totalBatches": 5379, "totalSerialNumbers": 9783 }

Get batches and serial numbers for article

GETUrl: /{id : .+}/batch/serialnumber
Headers:
Accept: application/json or application/xml
Get batches and serial numbers for a specific article based on article-id

Valid parameters:

Parameter Description Default value Allowed values
query
filter_all_batches true
page 0
limit 100
sort_column batch_id batch_id,serie_nr,amount,best_before
order desc asc,desc

Body:
Successfull response:

{ "totalSerialNumbersReserved": 6709.221156872528, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 9780.549879676666, "bestBefore": 9126, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 9637.399967974068, "totalSerialNumbersInStock": 3005.154481250728, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 9971.801845242358, "bestBefore": 370, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 8031.767865798912, "totalBatches": 4851, "totalSerialNumbers": 4348 }

Get batches and serial numbers

GETUrl: /batch/serialnumber
Headers:
Accept: application/json or application/xml
Get batches and serial numbers

Valid parameters:

Parameter Description Default value Allowed values
query
batch true
serial true
filter_all_batches true
page 0
limit 100

Body:
Successfull response:

{ "totalSerialNumbersReserved": 4988.86568018806, "batches": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 5304.5215590800635, "bestBefore": 8121, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesInStock": 9775.057584751756, "totalSerialNumbersInStock": 5730.29728910938, "serialNumbers": [{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 3870.407984427838, "bestBefore": 4782, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }], "totalBatchesReserved": 9231.276200155686, "totalBatches": 6711, "totalSerialNumbers": 1943 }

Add batch

POSTUrl: /{id : .+}/batch
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Add batch to an existing article
Body:

{ "serialNr": "serialNr", "amount": "1", "bestBefore": 4824, "batchId": "batchId", "barcode": "barcode" }
Successfull response:

Import batches and serial numbers

POSTUrl: /import/batch_serial
Headers:
Accept: application/json or application/xml
Content-type: multipart/form-data
Import batches and serial numbers for articles from excel or tsv

Valid parameters:

Parameter Description Default value Allowed values
file_type tsv
file
file

Body:
Successfull response:

Test import batches and serial numbers

POSTUrl: /import/batch_serial/test
Headers:
Accept: application/json or application/xml
Content-type: multipart/form-data
Test import batches and serial numbers for articles from excel or tsv. No actual changed will be saved.

Valid parameters:

Parameter Description Default value Allowed values
file_type tsv
file
file

Body:
Successfull response:

Add serial number

POSTUrl: /{id : .+}/serialnumber
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Add serial number to an existing article
Body:

{ "serialNr": "serialNr", "amount": "1", "bestBefore": 7306, "batchId": "batchId", "barcode": "barcode" }
Successfull response:

Add serial numbers sequence

POSTUrl: /{id : .+}/serialnumber/list
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Create a sequence of serial numbers to an existing article

Valid parameters:

Parameter Description Default value Allowed values
prefix
start 1
length 0
amount 1
suffix
set_barcode_from_serialnumber false

Body:
Successfull response:

Update batch

PUTUrl: /{id : .+}/batch/{batch_id : .+}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update batch for a specific article
Body:

{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 1374.9617991220853, "bestBefore": 2698, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }
Successfull response:

Update serial number

PUTUrl: /{id : .+}/serialnumber/{serialnumber : .+}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update serial number for a specific article
Body:

{ "serialNr": "serialNr", "amount": "1", "articleName": "articleName", "reserved": 8499.649678621734, "bestBefore": 7371, "articleId": "articleId", "batchId": "batchId", "barcode": "barcode" }
Successfull response:

Delete batch

DELETEUrl: /{id : .+}/batch/{batch_id : .+}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Delete a batch for a specific article
Body:
Successfull response:

Delete serial number

DELETEUrl: /{id : .+}/serialnumber/{serialnumber : .+}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Delete serial number for a specific article
Body:
Successfull response:

Custom fields

Get custom fields template

GETUrl: /customfields_template
Headers:
Accept: application/json or application/xml
The template contains fields that will automatically be added to new articles

Valid parameters:

Parameter Description Default value Allowed values
query

Body:
Successfull response:

{"fields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }]}

Get custom fields not in template

GETUrl: /customfields
Headers:
Accept: application/json or application/xml
Get custom fields which exists on articles but is not in the template

Valid parameters:

Parameter Description Default value Allowed values
query
page 0
limit 50

Body:
Successfull response:

{"fields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }]}

Update custom fields template

PUTUrl: /customfields_template
Headers:
Accept: application/json or application/xml
The template contains fields that will automatically be added to new articles

Valid parameters:

Parameter Description Default value Allowed values
update_articles false

Body:

{"fields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }]}
Successfull response:

{"fields": [{ "name": "name", "type": "type", "validValues": [{ "description": "description", "value": "value" }], "value": "value" }]}

Export

Get export dates

GETUrl: export
Headers:
Accept: application/json or application/xml
Get a list of existing export dates. Each date corresponds to an article export file
Body:
Successfull response:

{ "pages": 2836, "datesCount": 4092, "pageSize": 9104, "dates": [{ "date": 1708765825097, "stockValue": 5367.3149007642, "stockValueFIFO": 1295.7533434945867, "id": "id", "type": "type" }], "page": 9817 }

Get export for date

GETUrl: /export/{date}
Headers:
Accept: application/json or application/xml
Get existing export file for specific date
Body:
Successfull response:

Get export by id

GETUrl: /export/file/{id}
Headers:
Accept: application/json or application/xml
Get existing export file based on id
Body:
Successfull response:

Create export

POSTUrl: /export/{template_id}
Headers:
Accept: application/json or application/xml
Create export file for today´s date for specific template
Body:
Successfull response:

Create export for date

POSTUrl: /export/{template_id}/date/{date}
Headers:
Accept: application/json or application/xml
Create export file for specific date and template
Body:
Successfull response:

Create export for stock changes

POSTUrl: /export/{template_id}/stock_changes
Headers:
Accept: application/json or application/xml
Create export file for specific period and template that lists stock changes

Valid parameters:

Parameter Description Default value Allowed values
start_date Start date of export period. Format is yyyy-MM-dd and defaults to 1 month prior end date
end_date End date of export period. Format is yyyy-MM-dd and defaults to today´s date

Body:
Successfull response:

Export bundled articles

POSTUrl: /export/bundle
Headers:
Accept: application/json or application/xml
Create export file for today´s date for bundled articles
Body:
Successfull response:

Field list

Get field list for settings

GETUrl: /fields/{articleFields}
Headers:
Accept: application/json or application/xml
Get field list for delivery note and order confirmation settings
Body:
Successfull response:

{"fields": [{}]}

Print

Print labels

GETUrl: /{id : .+}/labels/print
Headers:
Accept: application/pdf or application/json
Print labels for article

Valid parameters:

Parameter Description Default value Allowed values
count 1
label_width 110
label_height 28
label_margin_width 2
label_margin_height 2
paper_width 210
paper_height 297
paper_margin_width 0
paper_margin_height 0

Body:
Successfull response:

Print labels

GETUrl: /labels/print
Headers:
Accept: application/pdf or application/json
Print labels for article

Valid parameters:

Parameter Description Default value Allowed values
articles
count 1
label_width 110
label_height 28
label_margin_width 2
label_margin_height 2
paper_width 210
paper_height 297
paper_margin_width 0
paper_margin_height 0

Body:
Successfull response:

Print bundled article

GETUrl: /{id : .+}/bundle/print
Headers:
Accept: application/pdf or application/json
Print bundle article as PDF

Valid parameters:

Parameter Description Default value Allowed values
amount 1

Body:
Successfull response:

Print supplier articles

GETUrl: /supplier/{supplier_id}/print
Headers:
Accept: application/pdf or application/json
Print articles connected to a supplier as PDF
Body:
Successfull response:

Stock

Get stock value

GETUrl: /stockvalue
Headers:
Accept: application/json or application/xml
Get stock value for selected store

Valid parameters:

Parameter Description Default value Allowed values
date

Body:
Successfull response:

{ "stockValue": 2571.0207314651147, "stockValueFIFO": 1670.7371904902047 }

Templates

Get import templates

GETUrl: /import/templates
Headers:
Accept: application/json or application/xml
Get article import templates

Valid parameters:

Parameter Description Default value Allowed values
query
page 0
limit 50

Body:
Successfull response:

{ "importTemplates": [{ "data": { "rowFirst": 7647, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 2009 }, "description": { "defaultValue": "defaultValue", "column": 6347 }, "stockPlace": { "defaultValue": "defaultValue", "column": 7565 }, "isActive": { "defaultValue": "defaultValue", "column": 4808 }, "type": { "defaultValue": "defaultValue", "column": 3589 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 966 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 2918 }, "manufacturer": { "defaultValue": "defaultValue", "column": 1464 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 8936 }, "rate": { "defaultValue": "defaultValue", "column": 5317 }, "orderLevel": { "defaultValue": "defaultValue", "column": 5459 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 1906 }, "supplier": { "defaultValue": "defaultValue", "column": 7047 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 2280 }, "vatAccount": { "defaultValue": "defaultValue", "column": 3084 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 8719 }, "barcode": { "defaultValue": "defaultValue", "column": 7829 }, "isBundled": { "defaultValue": "defaultValue", "column": 2287 }, "buyPrice": { "defaultValue": "defaultValue", "column": 6346 }, "amount": { "defaultValue": "defaultValue", "column": 7153 }, "articleName": 311, "rowTitle": 6765, "articleId": 1519, "vat": { "defaultValue": "defaultValue", "column": 9484 }, "tags": { "defaultValue": "defaultValue", "column": 5273 }, "unit": { "defaultValue": "defaultValue", "column": 1693 }, "priceLists": {}, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 5818 }, "category": { "defaultValue": "defaultValue", "column": 6285 }, "isStock": { "defaultValue": "defaultValue", "column": 4606 }, "stockWarning": { "defaultValue": "defaultValue", "column": 5891 } }, "name": "name", "storegroupId": 2098, "id": 6343, "type": "type" }], "pages": 8510, "pageSize": 760, "page": 3963, "importTemplateCount": 3176 }

Get article import template

GETUrl: /import/template/{id}
Headers:
Accept: application/json or application/xml
Get article import template
Body:
Successfull response:

{ "data": { "rowFirst": 5127, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 8913 }, "description": { "defaultValue": "defaultValue", "column": 3727 }, "stockPlace": { "defaultValue": "defaultValue", "column": 2885 }, "isActive": { "defaultValue": "defaultValue", "column": 2929 }, "type": { "defaultValue": "defaultValue", "column": 6811 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 2941 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 4632 }, "manufacturer": { "defaultValue": "defaultValue", "column": 8462 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 7854 }, "rate": { "defaultValue": "defaultValue", "column": 4629 }, "orderLevel": { "defaultValue": "defaultValue", "column": 1994 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 9035 }, "supplier": { "defaultValue": "defaultValue", "column": 3378 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 5167 }, "vatAccount": { "defaultValue": "defaultValue", "column": 9155 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 9021 }, "barcode": { "defaultValue": "defaultValue", "column": 326 }, "isBundled": { "defaultValue": "defaultValue", "column": 8111 }, "buyPrice": { "defaultValue": "defaultValue", "column": 7562 }, "amount": { "defaultValue": "defaultValue", "column": 6662 }, "articleName": 4627, "rowTitle": 6738, "articleId": 7103, "vat": { "defaultValue": "defaultValue", "column": 5727 }, "tags": { "defaultValue": "defaultValue", "column": 9347 }, "unit": { "defaultValue": "defaultValue", "column": 9591 }, "priceLists": {}, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 759 }, "category": { "defaultValue": "defaultValue", "column": 4365 }, "isStock": { "defaultValue": "defaultValue", "column": 5458 }, "stockWarning": { "defaultValue": "defaultValue", "column": 9459 } }, "name": "name", "storegroupId": 6130, "id": 6455, "type": "type" }

Add article import template

POSTUrl: /import/template
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Add an article import template
Body:

{ "data": { "rowFirst": 3860, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 2267 }, "description": { "defaultValue": "defaultValue", "column": 9949 }, "stockPlace": { "defaultValue": "defaultValue", "column": 1324 }, "isActive": { "defaultValue": "defaultValue", "column": 8261 }, "type": { "defaultValue": "defaultValue", "column": 3425 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 4427 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 459 }, "manufacturer": { "defaultValue": "defaultValue", "column": 6746 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 6426 }, "rate": { "defaultValue": "defaultValue", "column": 5606 }, "orderLevel": { "defaultValue": "defaultValue", "column": 2526 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 3744 }, "supplier": { "defaultValue": "defaultValue", "column": 5274 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 1524 }, "vatAccount": { "defaultValue": "defaultValue", "column": 5905 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 4901 }, "barcode": { "defaultValue": "defaultValue", "column": 5077 }, "isBundled": { "defaultValue": "defaultValue", "column": 665 }, "buyPrice": { "defaultValue": "defaultValue", "column": 2242 }, "amount": { "defaultValue": "defaultValue", "column": 6114 }, "articleName": 5376, "rowTitle": 2552, "articleId": 6306, "vat": { "defaultValue": "defaultValue", "column": 7211 }, "tags": { "defaultValue": "defaultValue", "column": 4882 }, "unit": { "defaultValue": "defaultValue", "column": 3452 }, "priceLists": {}, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 1379 }, "category": { "defaultValue": "defaultValue", "column": 9758 }, "isStock": { "defaultValue": "defaultValue", "column": 9427 }, "stockWarning": { "defaultValue": "defaultValue", "column": 1606 } }, "name": "name", "storegroupId": 9981, "type": "type" }
Successfull response:

{ "data": { "rowFirst": 3006, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 9450 }, "description": { "defaultValue": "defaultValue", "column": 747 }, "stockPlace": { "defaultValue": "defaultValue", "column": 9972 }, "isActive": { "defaultValue": "defaultValue", "column": 5678 }, "type": { "defaultValue": "defaultValue", "column": 1545 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 1650 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 9135 }, "manufacturer": { "defaultValue": "defaultValue", "column": 161 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 1900 }, "rate": { "defaultValue": "defaultValue", "column": 1684 }, "orderLevel": { "defaultValue": "defaultValue", "column": 7028 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 1623 }, "supplier": { "defaultValue": "defaultValue", "column": 3672 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 8138 }, "vatAccount": { "defaultValue": "defaultValue", "column": 9053 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 8791 }, "barcode": { "defaultValue": "defaultValue", "column": 2585 }, "isBundled": { "defaultValue": "defaultValue", "column": 3745 }, "buyPrice": { "defaultValue": "defaultValue", "column": 5121 }, "amount": { "defaultValue": "defaultValue", "column": 4548 }, "articleName": 4341, "rowTitle": 5140, "articleId": 4527, "vat": { "defaultValue": "defaultValue", "column": 1327 }, "tags": { "defaultValue": "defaultValue", "column": 4502 }, "unit": { "defaultValue": "defaultValue", "column": 1998 }, "priceLists": {}, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 9558 }, "category": { "defaultValue": "defaultValue", "column": 5848 }, "isStock": { "defaultValue": "defaultValue", "column": 1387 }, "stockWarning": { "defaultValue": "defaultValue", "column": 2772 } }, "name": "name", "storegroupId": 2762, "id": 4570, "type": "type" }

Update article import template

PUTUrl: /import/template/{id}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update an article import template
Body:

{ "data": { "rowFirst": 6105, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 8174 }, "description": { "defaultValue": "defaultValue", "column": 5859 }, "stockPlace": { "defaultValue": "defaultValue", "column": 4307 }, "isActive": { "defaultValue": "defaultValue", "column": 7922 }, "type": { "defaultValue": "defaultValue", "column": 3170 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 4206 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 9555 }, "manufacturer": { "defaultValue": "defaultValue", "column": 1304 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 9489 }, "rate": { "defaultValue": "defaultValue", "column": 5650 }, "orderLevel": { "defaultValue": "defaultValue", "column": 4694 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 7105 }, "supplier": { "defaultValue": "defaultValue", "column": 5837 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 6576 }, "vatAccount": { "defaultValue": "defaultValue", "column": 174 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 7291 }, "barcode": { "defaultValue": "defaultValue", "column": 6325 }, "isBundled": { "defaultValue": "defaultValue", "column": 7180 }, "buyPrice": { "defaultValue": "defaultValue", "column": 1306 }, "amount": { "defaultValue": "defaultValue", "column": 3639 }, "articleName": 8444, "rowTitle": 8349, "articleId": 1181, "vat": { "defaultValue": "defaultValue", "column": 7576 }, "tags": { "defaultValue": "defaultValue", "column": 6481 }, "unit": { "defaultValue": "defaultValue", "column": 645 }, "priceLists": {}, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 6226 }, "category": { "defaultValue": "defaultValue", "column": 3112 }, "isStock": { "defaultValue": "defaultValue", "column": 1805 }, "stockWarning": { "defaultValue": "defaultValue", "column": 313 } }, "name": "name", "storegroupId": 7801, "id": 2712, "type": "type" }
Successfull response:

{ "data": { "rowFirst": 5244, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 394 }, "description": { "defaultValue": "defaultValue", "column": 6677 }, "stockPlace": { "defaultValue": "defaultValue", "column": 4048 }, "isActive": { "defaultValue": "defaultValue", "column": 1128 }, "type": { "defaultValue": "defaultValue", "column": 9986 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 8536 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 3162 }, "manufacturer": { "defaultValue": "defaultValue", "column": 4017 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 4472 }, "rate": { "defaultValue": "defaultValue", "column": 1782 }, "orderLevel": { "defaultValue": "defaultValue", "column": 5314 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 8045 }, "supplier": { "defaultValue": "defaultValue", "column": 6365 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 5000 }, "vatAccount": { "defaultValue": "defaultValue", "column": 6149 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 1005 }, "barcode": { "defaultValue": "defaultValue", "column": 5521 }, "isBundled": { "defaultValue": "defaultValue", "column": 9363 }, "buyPrice": { "defaultValue": "defaultValue", "column": 6788 }, "amount": { "defaultValue": "defaultValue", "column": 2506 }, "articleName": 9520, "rowTitle": 3557, "articleId": 7053, "vat": { "defaultValue": "defaultValue", "column": 3169 }, "tags": { "defaultValue": "defaultValue", "column": 6692 }, "unit": { "defaultValue": "defaultValue", "column": 6425 }, "priceLists": {}, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 445 }, "category": { "defaultValue": "defaultValue", "column": 8090 }, "isStock": { "defaultValue": "defaultValue", "column": 6295 }, "stockWarning": { "defaultValue": "defaultValue", "column": 3039 } }, "name": "name", "storegroupId": 9418, "id": 7641, "type": "type" }

Update article to bundle or simple

PUTUrl: /{id : .+}/bundle
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update an article to bundle or simple

Valid parameters:

Parameter Description Default value Allowed values
bundle

Body:
Successfull response:

{ "name": "name", "externalId": "externalId", "id": 9510, "desc": "desc" }

Delete custom field

DELETEUrl: customfields/{name}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Delete custom field and remove it from articles
Body:
Successfull response:

Delete import template

DELETEUrl: import/template/{id}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Delete import template for articles
Body:
Successfull response:

Traceability

Traceability for a bundled article

GETUrl: /{article_id}/batch/{batch_id}/traceability
Headers:
Accept: application/json or application/xml
Get bundled parts with batch and serial numbers for a batch
Body:
Successfull response:

{ "modifiedStructure": false, "traceability": [{ "amount": 770.7826565740705, "articleName": "articleName", "serial": [{ "serialNr": "serialNr", "amount": 1299.2358642006307, "reserved": 5102.1985507731115, "bestBefore": 1708765825109, "batchId": "batchId", "barcode": "barcode" }], "producedAmount": 6156.367113823974, "articleId": "articleId", "batch": { "serialNr": "serialNr", "amount": 8208.401806263173, "reserved": 2905.984342501936, "bestBefore": 1708765825109, "batchId": "batchId", "barcode": "barcode" } }] }

Traceability for a bundled article

GETUrl: /{article_id}/serial/{serial_nr}/traceability
Headers:
Accept: application/json or application/xml
Get bundled parts with batch and serial numbers for a serial number
Body:
Successfull response:

{ "modifiedStructure": false, "traceability": [{ "amount": 195.29036685854817, "articleName": "articleName", "serial": [{ "serialNr": "serialNr", "amount": 6013.349556091883, "reserved": 4111.5338971234005, "bestBefore": 1708765825109, "batchId": "batchId", "barcode": "barcode" }], "producedAmount": 2677.94137956748, "articleId": "articleId", "batch": { "serialNr": "serialNr", "amount": 7979.072725542348, "reserved": 4247.164582998888, "bestBefore": 1708765825109, "batchId": "batchId", "barcode": "barcode" } }] }

Classes:

Article

Field Type Description Default Mandatory Accepted values Example values Access
articleId String Write only with POST Post R,W
externalId String External article id R,W
active Boolean true R,W
name String Post R,W
bundled Boolean Write only with POST false R,W
parts List If article is bundled this is the parts contained in the article. When updating an existing bundled article this list will replace old list. If list is null, no replacement will be made. If list is empty, all parts will be removed R,W
batches ArticleBatches Returns the first 20 batches and the first 20 serial numbers connected to this article R
description String R,W
category String övrigt R,W
amount Double Available amount. This means stock amount reduced by reserved amount R,W
reserved Double Reserved amount R
barcode String R,W
barcodeType String EAN EAN, CODE128, QR, UPC R,W
price Double R,W
prices List R
supplier Long If article is bundled, supplier information will be ignored if not null, must point to an existing supplier R,W
supplierExternalId String external id of Supplier R
supplierName String If article is bundled, supplier information will be ignored if not null, must point to an existing supplier R,W
supplierArticleId String If article is bundled, supplier information will be ignored R,W
supplierAutomaticOrder Boolean If article is bundled, supplier information will be ignored R,W
supplierBuyPrice Double Total buy price including shipment and misc costs. If article is bundled, supplier information will be ignored R,W
supplierBuyPriceShipment Double If article is bundled, supplier information will be ignored R,W
supplierArticles List If article is bundled, supplier information will be ignored R,W
supplierBuyPriceMisc Double If article is bundled, supplier information will be ignored R,W
supplierBuyCurrency String R
supplierBuyRate Double R
unit String st R,W
vat Double Vat in percentage. If both vat-account and vat is submitted, vat-account takes precedence Post R,W
vatAccount Integer If both vat-account and vat is submitted, vat-account takes precedence R,W
imageLastUpdated Long R
type String Stock means it's a physical product and service means it's work and lacks stock-amount Post Stock, Service R,W
stock Boolean True means it's a physical article in stock and false means it's an article that needs to be ordered from supplier true R,W
webshopArticle Boolean false R,W
manufacturer String R,W
manufacturerArticleId String R,W
customFields List if you have need for other type of fields then what lagerkoll offers you can use this key-value list. When creating / updating an article the content of this list will replace the list of fields in the existing article R,W
links List R,W
tags List Make sure you provide tagId for existing tags, otherwise new ones will be created R,W
width Double R,W
height Double R,W
depth Double R,W
weight Double R,W
stockPlace String R,W
stockWarning Double R,W
criticalLevel Double When amount reaches the critical level it is automatically added to a purchase order, with amount set to order level R,W
orderLevel Double When amount reaches the critical level it is automatically added to a purchase order, with amount set to order level R,W
automaticOrder Boolean Set flag to true if the article should be automatically added to a purchase order when stock level reaches the critical level R,W
nextDeliveryDate Long If there is a purchase order for this article, this would be the delivery date for that order R
orderedAmount Double If there is a purchase order for this article, this would be the ordered amount for that order R
deliveredAmount Double If there is a purchase order for this article, this would be the delivered amount for that order R
availableAmount Double Amount available for given deliveryDate R

ArticleAutoComplete

Field Type Description Default Mandatory Accepted values Example values Access
articleId String R
active Boolean R
name String R
bundled Boolean R
amount Double R
reserved Double R
barcode String R,W
barcodeType String EAN EAN, CODE128, QR, UPC R,W
price Double R
supplierBuyPrice Double R
supplierBuyPriceShipment Double R
supplierBuyPriceMisc Double R
supplierBuyCurrency String R
supplierBuyRate Double R
unit String R
type String Stock means it's a physical product and service means it's work and lacks stock-amount Stock, Service R
stock Boolean True means it's a physical article in stock and false means it's an article that needs to be ordered from supplier R
vat Double VAT for article R

ArticleBatch

Field Type Description Default Mandatory Accepted values Example values Access
articleId String Id of article the batch/serialnumber is connected to R
articleName String Name of article R
batchId String batch-id or serial-nr must be set, Write only with POST Post R,W
serialNr String batch-id or serial-nr must be set, Write only with POST Post R,W
amount double 1 R,W
reserved double Reserved is set automatically when part of a customer order that has not yet been invoiced R
barcode String Write only with POST R,W
bestBefore Long ms since 1970, Write only with POST R,W

ArticleBatches

Field Type Description Default Mandatory Accepted values Example values Access
totalBatches Integer Total number of batches for an article R
batches List Current page of batches for an article R
totalSerialNumbers Integer Total number of serial numbers for an article R
serialNumbers List Current page of serial numbers for an article R
totalBatchesInStock Double Total batches in stock R
totalBatchesReserved Double Total batches reserved R
totalSerialNumbersInStock Double Total serial numbers in stock R
totalSerialNumbersReserved Double Total serial numbers reserved R

ArticleField

Field Type Description Default Mandatory Accepted values Example values Access
articleId String R,W
value String R,W

ArticleFIFOsResponse

Field Type Description Default Mandatory Accepted values Example values Access
page int R
pages int R
pageSize int R
fifoCount int R
since long R
fifos List R

ArticleHistory

Field Type Description Default Mandatory Accepted values Example values Access
articleId String R
supplierId Long R
supplierName String R
oldCount Double R
newCount Double R
oldReserved Double R
newReserved Double R
pricelistId Long R
pricelistName String R
oldSalesPrice Double R
newSalesPrice Double R
oldPurchasePrice Double R
newPurchasePrice Double R
userId Long R
userName String R
reason String R
created Date R

ArticleHistoryResponse

Field Type Description Default Mandatory Accepted values Example values Access
page int R
pages int R
pageSize int R
historyCount int R
since long R
history List R

ArticleId

Field Type Description Default Mandatory Accepted values Example values Access
id String R,W

ArticleIds

Field Type Description Default Mandatory Accepted values Example values Access
articles List List of article ids R,W

ArticleImportTemplate

Field Type Description Default Mandatory Accepted values Example values Access
id long R
storegroupId long R,W
name String R,W
type String R,W
data ImportTemplate R,W

ArticleImportTemplateResponse

Field Type Description Default Mandatory Accepted values Example values Access
page int R
pages int R
pageSize int R
importTemplateCount int R
importTemplates List R

ArticleLink

Field Type Description Default Mandatory Accepted values Example values Access
name String Post R,W
url String Post R,W
type String Post unknown, webpage, image, document, lagerkoll_document R,W

ArticleMove

Field Type Description Default Mandatory Accepted values Example values Access
articleId String PUT R,W
amount Double PUT R,W
toStoreId Long Id of stock that article is moved to PUT R,W
batches ArticleBatches PUT R,W

ArticleReserved

Field Type Description Default Mandatory Accepted values Example values Access
reserved double R

ArticlesAutoCompleteResponse

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

ArticlesResponse

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

ArticleStockplace

Field Type Description Default Mandatory Accepted values Example values Access
stockplace String R
articles Integer Number of articles in this stockplace R

ArticleStockplacesResponse

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

ArticleTag

Field Type Description Default Mandatory Accepted values Example values Access
id long Write only with POST Post R,W
externalId String R,W
name String Post R,W
desc String Post R,W

ArticleTraceabilityBatch

Field Type Description Default Mandatory Accepted values Example values Access
batchId String R,W
serialNr String R,W
amount double R,W
reserved double R,W
barcode String R,W
bestBefore Date R,W

ArticleUnit

Field Type Description Default Mandatory Accepted values Example values Access
storegroupId long R
articleId String Article id R
unit Unit Unit id true R,W
convert Double Conversion coefficient between unit and the article base unit true R,W
barcode String Barcode conected to unit R,W

ArticleUnitsResponse

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

BulkArticle

Field Type Description Default Mandatory Accepted values Example values Access
articles List List of article ids R,W
field String Field to update R,W
pricelistId Long When updating sales price the pricelist should be given R,W
type BulkArticle$BulkType Describe how the updated value should be applied. SET will set the value, PERCENTAGE will add to existing value, PROFIT will calculate sales price taking purchase price into account. PERCENTAGE and PROFIT is only valid for sales prices SET SET, PERCENTAGE, PROFIT R,W
value String Value for field that will be applied to all articles in the list R,W

BulkArticleResponse

Field Type Description Default Mandatory Accepted values Example values Access
articles List List of articles with the updated field value R,W
field String Updated field R,W
pricelistId Long Pricelist when sales price has been updated R,W

BundleArticleForPart

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

BundledArticle

Field Type Description Default Mandatory Accepted values Example values Access
articleId String R,W
articleName String R
externalId String External article id R
amount Double Amount of this article for a single bundled article Post/Put R,W
isStock Boolean Is article is of type stock R
stockWarning Double Warning for low stock level R
stock Double Number of articles in stock R
reserved Double Number of articles reserved. Number of available = stock - reserved R
type String Stock means it's a physical product and service means it's work and lacks stock-amount Post Stock, Service R,W
unitName String R
stockPlace String R
buyPrice Double R
buyPriceShipment Double R
buyPriceMisc Double R
buyPriceCurrency String R
supplierId Long R
supplierName String R
supplierArticleId String R

Count

Field Type Description Default Mandatory Accepted values Example values Access
count int R

CustomerTag

Field Type Description Default Mandatory Accepted values Example values Access
id Long Write only with POST Post R,W
externalId String R,W
name String Post R,W
desc String Post R,W

CustomerTagResponse

Field Type Description Default Mandatory Accepted values Example values Access
page int R
pages int R
pageSize int R
projectsCount int R
tags List R

CustomField

Field Type Description Default Mandatory Accepted values Example values Access
name String Post R,W
type String Post String, Number, Int, Long, Float, Double Boolean, Date, Json, JsonArray, Email R,W
value String Post R,W
validValues List R

CustomFieldsTemplate

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

CustomFieldValidValue

Field Type Description Default Mandatory Accepted values Example values Access
value String R
description String R

ExportDate

Field Type Description Default Mandatory Accepted values Example values Access
id String Id of export file R
type String Type of export daily, weekly, monthly, inventory, other R
date Date Date of export R
stockValue Double Stockvalue for specified date R
stockValueFIFO Double Stockvalue FIFO for specified date R

ExportDatesResponse

Field Type Description Default Mandatory Accepted values Example values Access
page int R
pages int R
pageSize int R
datesCount int R
dates List List of export dates R

FieldsResponse

Field Type Description Default Mandatory Accepted values Example values Access
fields List Returns list of field names R

FIFO

Field Type Description Default Mandatory Accepted values Example values Access
id long R
date Date R
amount double R
amountInStock double R
supplierId long R
supplierName String R
purchasePrice double R
purchaseRate double R
supplierOrderId long R
poRef String R
description String R
userId long R
userName String R

FIFOPrice

Field Type Description Default Mandatory Accepted values Example values Access
date Date R
price Double R

FIFORate

Field Type Description Default Mandatory Accepted values Example values Access
date Date R
rate Double R

ImportTemplate

Field Type Description Default Mandatory Accepted values Example values Access
rowTitle Integer R,W
rowFirst Integer R,W
articleName Integer R,W
articleId Integer R,W
description ImportTemplateColumn R,W
isActive ImportTemplateColumn R,W
isBundled ImportTemplateColumn R,W
category ImportTemplateColumn R,W
amount ImportTemplateColumn R,W
unit ImportTemplateColumn R,W
barcode ImportTemplateColumn R,W
barcodeType ImportTemplateColumn R,W
buyPrice ImportTemplateColumn R,W
buyPriceShipment ImportTemplateColumn R,W
buyPriceMisc ImportTemplateColumn R,W
rate ImportTemplateColumn R,W
buyPriceCurrency ImportTemplateColumn R,W
supplier ImportTemplateColumn R,W
supplierArticleId ImportTemplateColumn R,W
vat ImportTemplateColumn R,W
vatAccount ImportTemplateColumn R,W
isStock ImportTemplateColumn R,W
type ImportTemplateColumn R,W
stockPlace ImportTemplateColumn R,W
stockWarning ImportTemplateColumn R,W
criticalLevel ImportTemplateColumn R,W
orderLevel ImportTemplateColumn R,W
isWebshopArticle ImportTemplateColumn R,W
manufacturer ImportTemplateColumn R,W
manufacturerArticleId ImportTemplateColumn R,W
tags ImportTemplateColumn R,W
priceLists HashMap R,W
customFields HashMap R,W

ImportTemplateColumn

Field Type Description Default Mandatory Accepted values Example values Access
column Integer R,W
defaultValue String R,W

PartTraceabilityExtended

Field Type Description Default Mandatory Accepted values Example values Access
articleId String R,W
articleName String R,W
amount double Amount of parts to create one bundled R,W
producedAmount double Total amount that has been produced (with regards to overproduction and waste) multiplied with amount needed to create a bundled R,W
batch ArticleTraceabilityBatch R,W
serial List R,W

PartTraceabilityResponse

Field Type Description Default Mandatory Accepted values Example values Access
traceability List R,W
modifiedStructure boolean Check if the bundle article structure have changed e.g. articles have been added/removed R,W

Price

Field Type Description Default Mandatory Accepted values Example values Access
listId Long Write only with POST Post R,W
listExternalId String External id of pricelist R
articleId String Write only with POST Post R,W
fromQuantity double Write only with POST 0 R,W
price Double To remove a price, send null to server 0 R,W

StockValue

Field Type Description Default Mandatory Accepted values Example values Access
stockValue double R
stockValueFIFO double R

StoreArticle

Field Type Description Default Mandatory Accepted values Example values Access
articleId String Article id R
name String Article name R
storeId long Store where article belongs R
storeName String Name of store R
availableAmount Double Available stock amount of article R

StoreArticlesResponse

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

SupplierArticle

Field Type Description Default Mandatory Accepted values Example values Access
supplier Long if not null, must point to an existing supplier R,W
supplierName String if not null, must point to an existing supplier R,W
supplierArticleId String R,W
supplierAutomaticOrder boolean R
supplierBuyPrice Double Total buy price including shipment and misc costs R,W
supplierBuyPriceShipment Double R,W
supplierBuyPriceMisc Double R,W
supplierBuyCurrency String If omitted, supplier's currency is used. If supplier is missing, it defaults to store's currency Store currency R,W
supplierBuyRate Double If supplier's currency differ from store's currency, provide an exchange rate. If rate is omitted, the supplier's rate is used. If supplier is missing, it defaults to 1.0 1.0 R,W

Unit

Field Type Description Default Mandatory Accepted values Example values Access
id Long R,W
externalId String R
name String Name of unit R,W