Customers API
General:
Basics:
Base-URL: https://capi.lagerkoll.com/v1/customers/
					Parameters in the url should all be encoded and all data sent should be UTF-8
                    
                        MAX number of requests per minute is set to 200.
                        
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.
				When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.
Headers:
                        There are 2 ways to be authenticated when using this API. in both ways you add headers to the request.
1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made.
                    
					1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made.
store: <<STORE>> user_id: <<USER_ID>> user_token: <<USER_TOKEN>> api_key: <<API_KEY>> Accept: application/json Content-Type: application/json
Errors:
| Code | Description | 
|---|---|
| 900001 | Credentials don't match | 
| 900101 | Common error | 
| 900429 | Too many requests | 
| 900501 | Error when getting a single customer | 
| 900502 | Error when creating a customer | 
| 900503 | Error when updating a customer | 
| 900504 | Error when deleting a customer | 
| 900512 | Error when importing customers | 
| 900513 | Error when updating import customer template | 
| 900514 | Error when adding import customer template | 
| 900515 | Error when deleting import customer template | 
| 900521 | Error when exporting customers | 
{
  "errorCode" : 900101,
  "errorMessage" : "Something went wrong on the server",
  "errorField" : null,
  "errorData" : null
}
					Customers API:
Customers
Get customer (ext-id)
                GETUrl: /external/{customer_id}
            
            Headers:
                    Accept: application/json or application/xml
                Get a single customer based on customer external id
                Body:
            Successfull response:
            
{ "pages": 3901, "customersCount": 3655, "pageSize": 7135, "page": 5685, "customers": [{ "zipCode": "zipCode", "country": "country", "externalCustomerId": "externalCustomerId", "invoiceDiscount": "0", "visitingCountryName": "visitingCountryName", "phone2": "phone2", "language": "store´s language", "visitingZipCode": "visitingZipCode", "invoiceRemark": "invoiceRemark", "phone1": "phone1", "emailOffer": "emailOffer", "customerType": "PRIVATE", "discounts": [{ "articleTag": { "name": "name", "externalId": "externalId", "id": 8783, "desc": "desc" }, "discount": 8842.329810269424 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 8582, "desc": "desc" }], "emailStatus": {}, "webUrl": "webUrl", "name": "name", "countryName": "countryName", "visitingCountry": "visitingCountry", "deliveryName": "deliveryName", "paymentTerm": "If null, the first payment term is set", "vatNumber": "vatNumber", "city": "city", "pricelistName": "pricelistName", "ourReference": "ourReference", "showVAT": false, "customerId": 8964, "visitingAddress": "visitingAddress", "priceIncludeVAT": "false", "currency": "Sek", "deliveryCountryName": "deliveryCountryName", "email": "email", "deliveryCity": "deliveryCity", "deliveryPhone1": "deliveryPhone1", "comments": "comments", "pricelistId": "-1", "address2": "address2", "address1": "address1", "deliveryAddress2": "deliveryAddress2", "externalId": "externalId", "deliveryAddress1": "deliveryAddress1", "deliveryPhone2": "deliveryPhone2", "visitingCity": "visitingCity", "deliveryCountry": "deliveryCountry" }], "since": 9680 }
Get customer
                GETUrl: /{customer_id}
            
            Headers:
                    Accept: application/json or application/xml
                Get a single customer based on customer id
                Body:
            Successfull response:
            
{ "pages": 1524, "customersCount": 3699, "pageSize": 4047, "page": 9692, "customers": [{ "zipCode": "zipCode", "country": "country", "externalCustomerId": "externalCustomerId", "invoiceDiscount": "0", "visitingCountryName": "visitingCountryName", "phone2": "phone2", "language": "store´s language", "visitingZipCode": "visitingZipCode", "invoiceRemark": "invoiceRemark", "phone1": "phone1", "emailOffer": "emailOffer", "customerType": "PRIVATE", "discounts": [{ "articleTag": { "name": "name", "externalId": "externalId", "id": 2644, "desc": "desc" }, "discount": 8608.061581953323 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 1703, "desc": "desc" }], "emailStatus": {}, "webUrl": "webUrl", "name": "name", "countryName": "countryName", "visitingCountry": "visitingCountry", "deliveryName": "deliveryName", "paymentTerm": "If null, the first payment term is set", "vatNumber": "vatNumber", "city": "city", "pricelistName": "pricelistName", "ourReference": "ourReference", "showVAT": false, "customerId": 8286, "visitingAddress": "visitingAddress", "priceIncludeVAT": "false", "currency": "Sek", "deliveryCountryName": "deliveryCountryName", "email": "email", "deliveryCity": "deliveryCity", "deliveryPhone1": "deliveryPhone1", "comments": "comments", "pricelistId": "-1", "address2": "address2", "address1": "address1", "deliveryAddress2": "deliveryAddress2", "externalId": "externalId", "deliveryAddress1": "deliveryAddress1", "deliveryPhone2": "deliveryPhone2", "visitingCity": "visitingCity", "deliveryCountry": "deliveryCountry" }], "since": 2484 }
Get customer for user
                GETUrl: /user
            
            Headers:
                    Accept: application/json or application/xml
                Get customer for currently logged in user
                Body:
            Successfull response:
            
{ "pages": 4622, "customersCount": 2875, "pageSize": 2355, "page": 8487, "customers": [{ "zipCode": "zipCode", "country": "country", "externalCustomerId": "externalCustomerId", "invoiceDiscount": "0", "visitingCountryName": "visitingCountryName", "phone2": "phone2", "language": "store´s language", "visitingZipCode": "visitingZipCode", "invoiceRemark": "invoiceRemark", "phone1": "phone1", "emailOffer": "emailOffer", "customerType": "PRIVATE", "discounts": [{ "articleTag": { "name": "name", "externalId": "externalId", "id": 7572, "desc": "desc" }, "discount": 6605.890181268714 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 3127, "desc": "desc" }], "emailStatus": {}, "webUrl": "webUrl", "name": "name", "countryName": "countryName", "visitingCountry": "visitingCountry", "deliveryName": "deliveryName", "paymentTerm": "If null, the first payment term is set", "vatNumber": "vatNumber", "city": "city", "pricelistName": "pricelistName", "ourReference": "ourReference", "showVAT": true, "customerId": 4536, "visitingAddress": "visitingAddress", "priceIncludeVAT": "false", "currency": "Sek", "deliveryCountryName": "deliveryCountryName", "email": "email", "deliveryCity": "deliveryCity", "deliveryPhone1": "deliveryPhone1", "comments": "comments", "pricelistId": "-1", "address2": "address2", "address1": "address1", "deliveryAddress2": "deliveryAddress2", "externalId": "externalId", "deliveryAddress1": "deliveryAddress1", "deliveryPhone2": "deliveryPhone2", "visitingCity": "visitingCity", "deliveryCountry": "deliveryCountry" }], "since": 8155 }
Get customer tags
                GETUrl: /tags
            
            Headers:
                    Accept: application/json or application/xml
                Get customer tags for store group
                Valid parameters:
| Parameter | Description | Default value | Allowed values | 
|---|---|---|---|
| query | |||
| page | 0 | ||
| limit | 50 | 
Body:
            Successfull response:
            
{ "pages": 5062, "pageSize": 8446, "page": 2378, "projectsCount": 8668, "tags": [{ "name": "name", "externalId": "externalId", "id": 6402, "desc": "desc" }] }
Get customers
                GETUrl: 
            
            Headers:
                    Accept: application/json or application/xml
                Get a list of customers based on query
                Valid parameters:
| Parameter | Description | Default value | Allowed values | 
|---|---|---|---|
| query | |||
| type | UNDEFINED | ||
| since | 0 | ||
| page | 0 | ||
| limit | 100 | ||
| order | asc | ||
| sort_column | name | 
Body:
            Successfull response:
            
{ "pages": 1923, "customersCount": 9308, "pageSize": 8325, "page": 4388, "customers": [{ "zipCode": "zipCode", "country": "country", "externalCustomerId": "externalCustomerId", "invoiceDiscount": "0", "visitingCountryName": "visitingCountryName", "phone2": "phone2", "language": "store´s language", "visitingZipCode": "visitingZipCode", "invoiceRemark": "invoiceRemark", "phone1": "phone1", "emailOffer": "emailOffer", "customerType": "PRIVATE", "discounts": [{ "articleTag": { "name": "name", "externalId": "externalId", "id": 3372, "desc": "desc" }, "discount": 7383.675123517378 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 3198, "desc": "desc" }], "emailStatus": {}, "webUrl": "webUrl", "name": "name", "countryName": "countryName", "visitingCountry": "visitingCountry", "deliveryName": "deliveryName", "paymentTerm": "If null, the first payment term is set", "vatNumber": "vatNumber", "city": "city", "pricelistName": "pricelistName", "ourReference": "ourReference", "showVAT": false, "customerId": 8026, "visitingAddress": "visitingAddress", "priceIncludeVAT": "false", "currency": "Sek", "deliveryCountryName": "deliveryCountryName", "email": "email", "deliveryCity": "deliveryCity", "deliveryPhone1": "deliveryPhone1", "comments": "comments", "pricelistId": "-1", "address2": "address2", "address1": "address1", "deliveryAddress2": "deliveryAddress2", "externalId": "externalId", "deliveryAddress1": "deliveryAddress1", "deliveryPhone2": "deliveryPhone2", "visitingCity": "visitingCity", "deliveryCountry": "deliveryCountry" }], "since": 6521 }
Add customer
                POSTUrl: 
            
            Headers:
                    Accept: application/json or application/xml
Content-type: application/json or application/xml
                Content-type: application/json or application/xml
Add a new customer
                Body:
            
{ "zipCode": "zipCode", "country": "country", "externalCustomerId": "externalCustomerId", "invoiceDiscount": "0", "city": "city", "phone2": "phone2", "language": "store´s language", "visitingZipCode": "visitingZipCode", "invoiceRemark": "invoiceRemark", "phone1": "phone1", "ourReference": "ourReference", "emailOffer": "emailOffer", "customerType": "PRIVATE", "showVAT": true, "discounts": [{ "articleTag": { "name": "name", "externalId": "externalId", "id": 4780, "desc": "desc" }, "discount": 7419.553518213558 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "visitingAddress": "visitingAddress", "priceIncludeVAT": "false", "currency": "Sek", "orgNumber": "orgNumber", "email": "email", "deliveryCity": "deliveryCity", "deliveryPhone1": "deliveryPhone1", "comments": "comments", "yourReference": "yourReference", "pricelistId": "-1", "address2": "address2", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "address1": "address1", "deliveryAddress2": "deliveryAddress2", "externalId": "externalId", "deliveryAddress1": "deliveryAddress1", "deliveryPhone2": "deliveryPhone2", "tags": [{ "name": "name", "externalId": "externalId", "id": 9381, "desc": "desc" }], "visitingCity": "visitingCity", "webUrl": "webUrl", "deliveryCountry": "deliveryCountry", "name": "name", "visitingCountry": "visitingCountry", "deliveryName": "deliveryName", "paymentTerm": "If null, the first payment term is set", "vatNumber": "vatNumber" }
Successfull response:
            
{ "zipCode": "zipCode", "country": "country", "externalCustomerId": "externalCustomerId", "invoiceDiscount": "0", "visitingCountryName": "visitingCountryName", "phone2": "phone2", "language": "store´s language", "visitingZipCode": "visitingZipCode", "invoiceRemark": "invoiceRemark", "phone1": "phone1", "emailOffer": "emailOffer", "customerType": "PRIVATE", "discounts": [{ "articleTag": { "name": "name", "externalId": "externalId", "id": 616, "desc": "desc" }, "discount": 8457.620086417779 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 4974, "desc": "desc" }], "emailStatus": {}, "webUrl": "webUrl", "name": "name", "countryName": "countryName", "visitingCountry": "visitingCountry", "deliveryName": "deliveryName", "paymentTerm": "If null, the first payment term is set", "vatNumber": "vatNumber", "city": "city", "pricelistName": "pricelistName", "ourReference": "ourReference", "showVAT": true, "customerId": 6423, "visitingAddress": "visitingAddress", "priceIncludeVAT": "false", "currency": "Sek", "deliveryCountryName": "deliveryCountryName", "email": "email", "deliveryCity": "deliveryCity", "deliveryPhone1": "deliveryPhone1", "comments": "comments", "pricelistId": "-1", "address2": "address2", "address1": "address1", "deliveryAddress2": "deliveryAddress2", "externalId": "externalId", "deliveryAddress1": "deliveryAddress1", "deliveryPhone2": "deliveryPhone2", "visitingCity": "visitingCity", "deliveryCountry": "deliveryCountry" }
Add customer tags
                POSTUrl: /tag
            
            Headers:
                    Accept: application/json or application/xml
Content-type: application/json or application/xml
                Content-type: application/json or application/xml
Add customer tags for store group
                Body:
            
{ "name": "name", "externalId": "externalId", "id": 443, "desc": "desc" }
Successfull response:
            
{ "name": "name", "externalId": "externalId", "id": 6410, "desc": "desc" }
Import customers
                POSTUrl: /import/{template_id}
            
            Headers:
                    Accept: application/json or application/xml
Content-type: multipart/form-data
                Content-type: multipart/form-data
Import customers from excel
                Valid parameters:
| Parameter | Description | Default value | Allowed values | 
|---|---|---|---|
| update_only | |||
| file | |||
| file | 
Body:
            Successfull response:
            Test import customers
                POSTUrl: /import/test/{template_id}
            
            Headers:
                    Accept: application/json or application/xml
Content-type: multipart/form-data
                Content-type: multipart/form-data
Test import customers from excel. 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
                Valid parameters:
| Parameter | Description | Default value | Allowed values | 
|---|---|---|---|
| file | |||
| file | 
Body:
            Successfull response:
            Invite customer
                POSTUrl: /{customer_id}/invite
            
            Headers:
                    Accept: application/json or application/xml
Other headers: user_id, user_token
                Other headers: user_id, user_token
Invite customer to customer portal. Customer can then login to the customer and place orders
                Body:
            
{ "notes": "notes", "role": { "loginServices": [{}], "paths": {}, "name": "name", "nativeFeatures": [{}], "fields": {}, "portal": "portal" }, "phone": "phone", "name": "name", "email": "email" }
Successfull response:
            
{ "systemAdmin": false, "bankID": false, "notes": "notes", "role": { "loginServices": [{}], "storeGroupId": 7090, "paths": {}, "name": "name", "id": 8781, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 5112 }, "phone": "phone", "name": "name", "emailInvalid": false, "admin": true, "lastLoggedIn": 6354, "id": 9472, "email": "email", "customer": true }
Update customer
                PUTUrl: /{id}
            
            Headers:
                    Accept: application/json or application/xml
Content-type: application/json or application/xml
                Content-type: application/json or application/xml
Update an existing customer
                Body:
            
{ "zipCode": "zipCode", "country": "country", "externalCustomerId": "externalCustomerId", "invoiceDiscount": "0", "visitingCountryName": "visitingCountryName", "phone2": "phone2", "language": "store´s language", "visitingZipCode": "visitingZipCode", "invoiceRemark": "invoiceRemark", "phone1": "phone1", "emailOffer": "emailOffer", "customerType": "PRIVATE", "discounts": [{ "articleTag": { "name": "name", "externalId": "externalId", "id": 975, "desc": "desc" }, "discount": 4612.652684608423 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 3773, "desc": "desc" }], "emailStatus": {}, "webUrl": "webUrl", "name": "name", "countryName": "countryName", "visitingCountry": "visitingCountry", "deliveryName": "deliveryName", "paymentTerm": "If null, the first payment term is set", "vatNumber": "vatNumber", "city": "city", "pricelistName": "pricelistName", "ourReference": "ourReference", "showVAT": false, "customerId": 8940, "visitingAddress": "visitingAddress", "priceIncludeVAT": "false", "currency": "Sek", "deliveryCountryName": "deliveryCountryName", "email": "email", "deliveryCity": "deliveryCity", "deliveryPhone1": "deliveryPhone1", "comments": "comments", "pricelistId": "-1", "address2": "address2", "address1": "address1", "deliveryAddress2": "deliveryAddress2", "externalId": "externalId", "deliveryAddress1": "deliveryAddress1", "deliveryPhone2": "deliveryPhone2", "visitingCity": "visitingCity", "deliveryCountry": "deliveryCountry" }
Successfull response:
            
{ "zipCode": "zipCode", "country": "country", "externalCustomerId": "externalCustomerId", "invoiceDiscount": "0", "visitingCountryName": "visitingCountryName", "phone2": "phone2", "language": "store´s language", "visitingZipCode": "visitingZipCode", "invoiceRemark": "invoiceRemark", "phone1": "phone1", "emailOffer": "emailOffer", "customerType": "PRIVATE", "discounts": [{ "articleTag": { "name": "name", "externalId": "externalId", "id": 1775, "desc": "desc" }, "discount": 4859.182347515461 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 5906, "desc": "desc" }], "emailStatus": {}, "webUrl": "webUrl", "name": "name", "countryName": "countryName", "visitingCountry": "visitingCountry", "deliveryName": "deliveryName", "paymentTerm": "If null, the first payment term is set", "vatNumber": "vatNumber", "city": "city", "pricelistName": "pricelistName", "ourReference": "ourReference", "showVAT": false, "customerId": 5869, "visitingAddress": "visitingAddress", "priceIncludeVAT": "false", "currency": "Sek", "deliveryCountryName": "deliveryCountryName", "email": "email", "deliveryCity": "deliveryCity", "deliveryPhone1": "deliveryPhone1", "comments": "comments", "pricelistId": "-1", "address2": "address2", "address1": "address1", "deliveryAddress2": "deliveryAddress2", "externalId": "externalId", "deliveryAddress1": "deliveryAddress1", "deliveryPhone2": "deliveryPhone2", "visitingCity": "visitingCity", "deliveryCountry": "deliveryCountry" }
Delete customer
                DELETEUrl: /{id}
            
            Headers:
                    Accept: application/json or application/xml
                Delete an existing customer
                Body:
            Successfull response:
            Export
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:
            Templates
Get customer import templates
                GETUrl: /import/templates
            
            Headers:
                    Accept: application/json or application/xml
                Get customer import templates
                Valid parameters:
| Parameter | Description | Default value | Allowed values | 
|---|---|---|---|
| query | |||
| page | 0 | ||
| limit | 50 | 
Body:
            Successfull response:
            
{ "importTemplates": [{ "data": { "rowFirst": 5444, "zipCode": { "defaultValue": "defaultValue", "column": 9088 }, "country": { "defaultValue": "defaultValue", "column": 387 }, "externalCustomerId": { "defaultValue": "defaultValue", "column": 8642 }, "deliveryPhoneTwo": { "defaultValue": "defaultValue", "column": 6475 }, "invoiceDiscount": { "defaultValue": "defaultValue", "column": 7047 }, "city": { "defaultValue": "defaultValue", "column": 802 }, "language": { "defaultValue": "defaultValue", "column": 7940 }, "visitingZipCode": { "defaultValue": "defaultValue", "column": 5027 }, "type": { "defaultValue": "defaultValue", "column": 8543 }, "phoneTwo": { "defaultValue": "defaultValue", "column": 9148 }, "deliveryAddressOne": { "defaultValue": "defaultValue", "column": 2438 }, "invoiceRemark": { "defaultValue": "defaultValue", "column": 2438 }, "ourReference": { "defaultValue": "defaultValue", "column": 6323 }, "emailOffer": { "defaultValue": "defaultValue", "column": 9328 }, "showVat": { "defaultValue": "defaultValue", "column": 4054 }, "addressTwo": { "defaultValue": "defaultValue", "column": 9426 }, "www": { "defaultValue": "defaultValue", "column": 8364 }, "deliveryZipCode": { "defaultValue": "defaultValue", "column": 9461 }, "wayOfDelivery": { "defaultValue": "defaultValue", "column": 6918 }, "customerId": 516, "emailInvoice": { "defaultValue": "defaultValue", "column": 1148 }, "visitingAddress": { "defaultValue": "defaultValue", "column": 8033 }, "priceIncludeVat": { "defaultValue": "defaultValue", "column": 9840 }, "currency": { "defaultValue": "defaultValue", "column": 6288 }, "orgNumber": { "defaultValue": "defaultValue", "column": 7565 }, "email": { "defaultValue": "defaultValue", "column": 359 }, "deliveryCity": { "defaultValue": "defaultValue", "column": 8072 }, "yourReference": { "defaultValue": "defaultValue", "column": 5292 }, "rowTitle": 3354, "emailOrder": { "defaultValue": "defaultValue", "column": 7638 }, "deliveryTerm": { "defaultValue": "defaultValue", "column": 5475 }, "deliveryAddressTwo": { "defaultValue": "defaultValue", "column": 9070 }, "vat": { "defaultValue": "defaultValue", "column": 4289 }, "externalId": { "defaultValue": "defaultValue", "column": 1396 }, "priceListId": { "defaultValue": "defaultValue", "column": 382 }, "phoneOne": { "defaultValue": "defaultValue", "column": 7596 }, "customerName": 2272, "tags": { "defaultValue": "defaultValue", "column": 9513 }, "visitingCity": { "defaultValue": "defaultValue", "column": 7112 }, "deliveryCountry": { "defaultValue": "defaultValue", "column": 3252 }, "comment": { "defaultValue": "defaultValue", "column": 3532 }, "visitingCountry": { "defaultValue": "defaultValue", "column": 4394 }, "addressOne": { "defaultValue": "defaultValue", "column": 8214 }, "deliveryName": { "defaultValue": "defaultValue", "column": 7319 }, "deliveryPhoneOne": { "defaultValue": "defaultValue", "column": 2042 }, "paymentTerm": { "defaultValue": "defaultValue", "column": 4436 } }, "name": "name", "storegroupId": 7341, "id": 8346, "type": "type" }], "pages": 1726, "pageSize": 82, "page": 2844, "importTemplateCount": 8769 }
Get customer import template
                GETUrl: /import/template/{id}
            
            Headers:
                    Accept: application/json or application/xml
                Get customer import template
                Body:
            Successfull response:
            
{ "data": { "rowFirst": 328, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 6166 }, "description": { "defaultValue": "defaultValue", "column": 2038 }, "stockPlace": { "defaultValue": "defaultValue", "column": 6645 }, "isActive": { "defaultValue": "defaultValue", "column": 6857 }, "type": { "defaultValue": "defaultValue", "column": 2425 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 2506 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 8761 }, "manufacturer": { "defaultValue": "defaultValue", "column": 9309 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 7583 }, "rate": { "defaultValue": "defaultValue", "column": 7283 }, "orderLevel": { "defaultValue": "defaultValue", "column": 5673 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 97 }, "supplier": { "defaultValue": "defaultValue", "column": 4069 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 8483 }, "vatAccount": { "defaultValue": "defaultValue", "column": 9008 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 4758 }, "barcode": { "defaultValue": "defaultValue", "column": 7676 }, "height": { "defaultValue": "defaultValue", "column": 449 }, "isBundled": { "defaultValue": "defaultValue", "column": 926 }, "buyPrice": { "defaultValue": "defaultValue", "column": 1169 }, "amount": { "defaultValue": "defaultValue", "column": 5817 }, "articleName": 1416, "rowTitle": 947, "articleId": 360, "vat": { "defaultValue": "defaultValue", "column": 1386 }, "weight": { "defaultValue": "defaultValue", "column": 5140 }, "tags": { "defaultValue": "defaultValue", "column": 5678 }, "unit": { "defaultValue": "defaultValue", "column": 1696 }, "depth": { "defaultValue": "defaultValue", "column": 7697 }, "priceLists": {}, "width": { "defaultValue": "defaultValue", "column": 770 }, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 7934 }, "category": { "defaultValue": "defaultValue", "column": 3486 }, "isStock": { "defaultValue": "defaultValue", "column": 4746 }, "stockWarning": { "defaultValue": "defaultValue", "column": 8662 } }, "name": "name", "storegroupId": 7101, "id": 6082, "type": "type" }
Add customer import template
                POSTUrl: /import/template
            
            Headers:
                    Accept: application/json or application/xml
Content-type: application/json or application/xml
                Content-type: application/json or application/xml
Add a customer import template
                Body:
            
{ "data": { "rowFirst": 55, "zipCode": { "defaultValue": "defaultValue", "column": 1007 }, "country": { "defaultValue": "defaultValue", "column": 4546 }, "externalCustomerId": { "defaultValue": "defaultValue", "column": 8574 }, "deliveryPhoneTwo": { "defaultValue": "defaultValue", "column": 6354 }, "invoiceDiscount": { "defaultValue": "defaultValue", "column": 2462 }, "city": { "defaultValue": "defaultValue", "column": 5468 }, "language": { "defaultValue": "defaultValue", "column": 1908 }, "visitingZipCode": { "defaultValue": "defaultValue", "column": 7837 }, "type": { "defaultValue": "defaultValue", "column": 5028 }, "phoneTwo": { "defaultValue": "defaultValue", "column": 2822 }, "deliveryAddressOne": { "defaultValue": "defaultValue", "column": 5996 }, "invoiceRemark": { "defaultValue": "defaultValue", "column": 6292 }, "ourReference": { "defaultValue": "defaultValue", "column": 5764 }, "emailOffer": { "defaultValue": "defaultValue", "column": 4479 }, "showVat": { "defaultValue": "defaultValue", "column": 6393 }, "addressTwo": { "defaultValue": "defaultValue", "column": 1260 }, "www": { "defaultValue": "defaultValue", "column": 3969 }, "deliveryZipCode": { "defaultValue": "defaultValue", "column": 6025 }, "wayOfDelivery": { "defaultValue": "defaultValue", "column": 5581 }, "customerId": 3696, "emailInvoice": { "defaultValue": "defaultValue", "column": 6922 }, "visitingAddress": { "defaultValue": "defaultValue", "column": 1434 }, "priceIncludeVat": { "defaultValue": "defaultValue", "column": 7874 }, "currency": { "defaultValue": "defaultValue", "column": 4244 }, "orgNumber": { "defaultValue": "defaultValue", "column": 964 }, "email": { "defaultValue": "defaultValue", "column": 4489 }, "deliveryCity": { "defaultValue": "defaultValue", "column": 7782 }, "yourReference": { "defaultValue": "defaultValue", "column": 3810 }, "rowTitle": 3422, "emailOrder": { "defaultValue": "defaultValue", "column": 2030 }, "deliveryTerm": { "defaultValue": "defaultValue", "column": 4071 }, "deliveryAddressTwo": { "defaultValue": "defaultValue", "column": 7498 }, "vat": { "defaultValue": "defaultValue", "column": 3649 }, "externalId": { "defaultValue": "defaultValue", "column": 4321 }, "priceListId": { "defaultValue": "defaultValue", "column": 2486 }, "phoneOne": { "defaultValue": "defaultValue", "column": 6022 }, "customerName": 8576, "tags": { "defaultValue": "defaultValue", "column": 2949 }, "visitingCity": { "defaultValue": "defaultValue", "column": 489 }, "deliveryCountry": { "defaultValue": "defaultValue", "column": 1373 }, "comment": { "defaultValue": "defaultValue", "column": 6238 }, "visitingCountry": { "defaultValue": "defaultValue", "column": 3723 }, "addressOne": { "defaultValue": "defaultValue", "column": 3794 }, "deliveryName": { "defaultValue": "defaultValue", "column": 2949 }, "deliveryPhoneOne": { "defaultValue": "defaultValue", "column": 7615 }, "paymentTerm": { "defaultValue": "defaultValue", "column": 1159 } }, "name": "name", "storegroupId": 1890, "type": "type" }
Successfull response:
            
{ "data": { "rowFirst": 1892, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 8425 }, "description": { "defaultValue": "defaultValue", "column": 607 }, "stockPlace": { "defaultValue": "defaultValue", "column": 6824 }, "isActive": { "defaultValue": "defaultValue", "column": 3838 }, "type": { "defaultValue": "defaultValue", "column": 2574 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 6475 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 8173 }, "manufacturer": { "defaultValue": "defaultValue", "column": 2259 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 7003 }, "rate": { "defaultValue": "defaultValue", "column": 6394 }, "orderLevel": { "defaultValue": "defaultValue", "column": 2279 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 2422 }, "supplier": { "defaultValue": "defaultValue", "column": 6125 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 9189 }, "vatAccount": { "defaultValue": "defaultValue", "column": 2487 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 3510 }, "barcode": { "defaultValue": "defaultValue", "column": 4391 }, "height": { "defaultValue": "defaultValue", "column": 9167 }, "isBundled": { "defaultValue": "defaultValue", "column": 1310 }, "buyPrice": { "defaultValue": "defaultValue", "column": 5465 }, "amount": { "defaultValue": "defaultValue", "column": 8459 }, "articleName": 7379, "rowTitle": 3412, "articleId": 5273, "vat": { "defaultValue": "defaultValue", "column": 3216 }, "weight": { "defaultValue": "defaultValue", "column": 5341 }, "tags": { "defaultValue": "defaultValue", "column": 8958 }, "unit": { "defaultValue": "defaultValue", "column": 2050 }, "depth": { "defaultValue": "defaultValue", "column": 1083 }, "priceLists": {}, "width": { "defaultValue": "defaultValue", "column": 3071 }, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 7674 }, "category": { "defaultValue": "defaultValue", "column": 5034 }, "isStock": { "defaultValue": "defaultValue", "column": 8486 }, "stockWarning": { "defaultValue": "defaultValue", "column": 8099 } }, "name": "name", "storegroupId": 311, "id": 1400, "type": "type" }
Update customer import template
                PUTUrl: /import/template/{id}
            
            Headers:
                    Accept: application/json or application/xml
Content-type: application/json or application/xml
                Content-type: application/json or application/xml
Update a customer import template
                Body:
            
{ "data": { "rowFirst": 1823, "zipCode": { "defaultValue": "defaultValue", "column": 4987 }, "country": { "defaultValue": "defaultValue", "column": 2441 }, "externalCustomerId": { "defaultValue": "defaultValue", "column": 2685 }, "deliveryPhoneTwo": { "defaultValue": "defaultValue", "column": 2172 }, "invoiceDiscount": { "defaultValue": "defaultValue", "column": 1809 }, "city": { "defaultValue": "defaultValue", "column": 5409 }, "language": { "defaultValue": "defaultValue", "column": 5889 }, "visitingZipCode": { "defaultValue": "defaultValue", "column": 8224 }, "type": { "defaultValue": "defaultValue", "column": 503 }, "phoneTwo": { "defaultValue": "defaultValue", "column": 7065 }, "deliveryAddressOne": { "defaultValue": "defaultValue", "column": 999 }, "invoiceRemark": { "defaultValue": "defaultValue", "column": 5638 }, "ourReference": { "defaultValue": "defaultValue", "column": 4982 }, "emailOffer": { "defaultValue": "defaultValue", "column": 2348 }, "showVat": { "defaultValue": "defaultValue", "column": 9695 }, "addressTwo": { "defaultValue": "defaultValue", "column": 7597 }, "www": { "defaultValue": "defaultValue", "column": 1387 }, "deliveryZipCode": { "defaultValue": "defaultValue", "column": 8389 }, "wayOfDelivery": { "defaultValue": "defaultValue", "column": 5641 }, "customerId": 1569, "emailInvoice": { "defaultValue": "defaultValue", "column": 6418 }, "visitingAddress": { "defaultValue": "defaultValue", "column": 4083 }, "priceIncludeVat": { "defaultValue": "defaultValue", "column": 4948 }, "currency": { "defaultValue": "defaultValue", "column": 1513 }, "orgNumber": { "defaultValue": "defaultValue", "column": 208 }, "email": { "defaultValue": "defaultValue", "column": 650 }, "deliveryCity": { "defaultValue": "defaultValue", "column": 8792 }, "yourReference": { "defaultValue": "defaultValue", "column": 1645 }, "rowTitle": 5167, "emailOrder": { "defaultValue": "defaultValue", "column": 2180 }, "deliveryTerm": { "defaultValue": "defaultValue", "column": 342 }, "deliveryAddressTwo": { "defaultValue": "defaultValue", "column": 9763 }, "vat": { "defaultValue": "defaultValue", "column": 6181 }, "externalId": { "defaultValue": "defaultValue", "column": 9323 }, "priceListId": { "defaultValue": "defaultValue", "column": 2661 }, "phoneOne": { "defaultValue": "defaultValue", "column": 5581 }, "customerName": 2573, "tags": { "defaultValue": "defaultValue", "column": 2629 }, "visitingCity": { "defaultValue": "defaultValue", "column": 6330 }, "deliveryCountry": { "defaultValue": "defaultValue", "column": 8777 }, "comment": { "defaultValue": "defaultValue", "column": 2450 }, "visitingCountry": { "defaultValue": "defaultValue", "column": 8772 }, "addressOne": { "defaultValue": "defaultValue", "column": 5154 }, "deliveryName": { "defaultValue": "defaultValue", "column": 1487 }, "deliveryPhoneOne": { "defaultValue": "defaultValue", "column": 2076 }, "paymentTerm": { "defaultValue": "defaultValue", "column": 9388 } }, "name": "name", "storegroupId": 193, "id": 5239, "type": "type" }
Successfull response:
            Delete import template
                DELETEUrl: import/template/{id}
            
            Headers:
                    Accept: application/json or application/xml
Content-type: application/json or application/xml
                Content-type: application/json or application/xml
Delete a customer import template
                Body:
            Successfull response:
            Classes:
ArticleImportTemplateDto
| 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 | ImportTemplateDto | R,W | 
ArticleTagDto
| 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 | 
CustomerDiscountDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access | 
|---|---|---|---|---|---|---|---|
| articleTag | ArticleTagDto | Write only with POST | Post | R,W | |||
| discount | double | Discount in percent | Post | 0 - 100 | R,W | 
CustomerDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access | 
|---|---|---|---|---|---|---|---|
| customerId | Long | Internal id created by Lagerkoll | R | ||||
| externalCustomerId | String | Already existing customer id | R,W | ||||
| externalId | String | This id belongs to any external system; Fortnox, Visma or other | R,W | ||||
| name | String | Post | R,W | ||||
| orgNumber | String | R,W | |||||
| ourReference | String | R,W | |||||
| phone1 | String | R,W | |||||
| phone2 | String | R,W | |||||
| address1 | String | R,W | |||||
| address2 | String | R,W | |||||
| zipCode | String | Post | R,W | ||||
| city | String | Post | R,W | ||||
| country | String | Post | must point to an existing country | R,W | |||
| countryName | String | R | |||||
| language | String | store´s language | sv, en | R,W | |||
| comments | String | R,W | |||||
| currency | String | Sek | if not null, must point to an existing currency | R,W | |||
| deliveryAddress1 | String | R,W | |||||
| deliveryAddress2 | String | R,W | |||||
| deliveryCity | String | R,W | |||||
| deliveryZipCode | String | R,W | |||||
| deliveryCountry | String | if not null, must point to an existing country | R,W | ||||
| deliveryCountryName | String | R | |||||
| deliveryName | String | R,W | |||||
| deliveryPhone1 | String | R,W | |||||
| deliveryPhone2 | String | R,W | |||||
| visitingAddress | String | R,W | |||||
| visitingCity | String | R,W | |||||
| visitingZipCode | String | R,W | |||||
| visitingCountry | String | if not null, must point to an existing country | R,W | ||||
| visitingCountryName | String | R | |||||
| String | R,W | ||||||
| emailInvoice | String | R,W | |||||
| emailOffer | String | R,W | |||||
| emailOrder | String | R,W | |||||
| emailStatus | HashMap | R | |||||
| invoiceDiscount | Float | 0 | R,W | ||||
| invoiceRemark | String | R,W | |||||
| priceIncludeVAT | Boolean | false | R,W | ||||
| showVAT | Boolean | If VAT should be shown in customer order confirmation and preview | R,W | ||||
| deliveryTerm | String | If not null, must point to an existing delivery term | R,W | ||||
| paymentTerm | String | If null, the first payment term is set | If not null, must point to an existing payment term | R,W | |||
| customerType | String | PRIVATE | PRIVATE, COMPANY, UNDEFINED | R,W | |||
| vatNumber | String | R,W | |||||
| webUrl | String | R,W | |||||
| wayOfDelivery | String | If not null, must point to an existing way of delivery term | R,W | ||||
| yourReference | String | R,W | |||||
| pricelistId | Long | -1 | If not -1, must point to an existing pricelist | R,W | |||
| pricelistName | String | R | |||||
| tags | List | Make sure you provide tagId for existing tags, otherwise new ones will be created | R,W | ||||
| discounts | List | R,W | 
CustomerImportTemplateDto
| 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 | ImportTemplateCustomerDto | R,W | 
CustomerImportTemplateResponseDto
| 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 | 
CustomersResponseDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access | 
|---|---|---|---|---|---|---|---|
| page | int | R | |||||
| pages | int | R | |||||
| pageSize | int | R | |||||
| customersCount | int | R | |||||
| since | long | R | |||||
| customers | List | R | 
CustomerTagDto
| 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 | 
CustomerTagResponseDto
| 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 | 
ImportTemplateColumnDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access | 
|---|---|---|---|---|---|---|---|
| column | Integer | R,W | |||||
| defaultValue | String | R,W | 
ImportTemplateCustomerDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access | 
|---|---|---|---|---|---|---|---|
| rowTitle | Integer | R,W | |||||
| rowFirst | Integer | R,W | |||||
| customerName | Integer | R,W | |||||
| customerId | Integer | R,W | |||||
| externalId | ImportTemplateColumnDto | R,W | |||||
| externalCustomerId | ImportTemplateColumnDto | R,W | |||||
| type | ImportTemplateColumnDto | R,W | |||||
| orgNumber | ImportTemplateColumnDto | R,W | |||||
| vat | ImportTemplateColumnDto | R,W | |||||
| ourReference | ImportTemplateColumnDto | R,W | |||||
| yourReference | ImportTemplateColumnDto | R,W | |||||
| comment | ImportTemplateColumnDto | R,W | |||||
| phoneOne | ImportTemplateColumnDto | R,W | |||||
| phoneTwo | ImportTemplateColumnDto | R,W | |||||
| addressOne | ImportTemplateColumnDto | R,W | |||||
| addressTwo | ImportTemplateColumnDto | R,W | |||||
| zipCode | ImportTemplateColumnDto | R,W | |||||
| city | ImportTemplateColumnDto | R,W | |||||
| country | ImportTemplateColumnDto | R,W | |||||
| language | ImportTemplateColumnDto | R,W | |||||
| currency | ImportTemplateColumnDto | R,W | |||||
| deliveryAddressOne | ImportTemplateColumnDto | R,W | |||||
| deliveryAddressTwo | ImportTemplateColumnDto | R,W | |||||
| deliveryCity | ImportTemplateColumnDto | R,W | |||||
| deliveryZipCode | ImportTemplateColumnDto | R,W | |||||
| deliveryCountry | ImportTemplateColumnDto | R,W | |||||
| deliveryName | ImportTemplateColumnDto | R,W | |||||
| deliveryPhoneOne | ImportTemplateColumnDto | R,W | |||||
| deliveryPhoneTwo | ImportTemplateColumnDto | R,W | |||||
| visitingAddress | ImportTemplateColumnDto | R,W | |||||
| visitingCity | ImportTemplateColumnDto | R,W | |||||
| visitingZipCode | ImportTemplateColumnDto | R,W | |||||
| visitingCountry | ImportTemplateColumnDto | R,W | |||||
| ImportTemplateColumnDto | R,W | ||||||
| emailInvoice | ImportTemplateColumnDto | R,W | |||||
| emailOffer | ImportTemplateColumnDto | R,W | |||||
| emailOrder | ImportTemplateColumnDto | R,W | |||||
| invoiceDiscount | ImportTemplateColumnDto | R,W | |||||
| invoiceRemark | ImportTemplateColumnDto | R,W | |||||
| priceIncludeVat | ImportTemplateColumnDto | R,W | |||||
| showVat | ImportTemplateColumnDto | R,W | |||||
| deliveryTerm | ImportTemplateColumnDto | R,W | |||||
| paymentTerm | ImportTemplateColumnDto | R,W | |||||
| wayOfDelivery | ImportTemplateColumnDto | R,W | |||||
| www | ImportTemplateColumnDto | R,W | |||||
| priceListId | ImportTemplateColumnDto | R,W | |||||
| tags | ImportTemplateColumnDto | R,W | 
ImportTemplateDto
| 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 | ImportTemplateColumnDto | R,W | |||||
| isActive | ImportTemplateColumnDto | R,W | |||||
| isBundled | ImportTemplateColumnDto | R,W | |||||
| category | ImportTemplateColumnDto | R,W | |||||
| amount | ImportTemplateColumnDto | R,W | |||||
| unit | ImportTemplateColumnDto | R,W | |||||
| barcode | ImportTemplateColumnDto | R,W | |||||
| barcodeType | ImportTemplateColumnDto | R,W | |||||
| buyPrice | ImportTemplateColumnDto | R,W | |||||
| buyPriceShipment | ImportTemplateColumnDto | R,W | |||||
| buyPriceMisc | ImportTemplateColumnDto | R,W | |||||
| rate | ImportTemplateColumnDto | R,W | |||||
| buyPriceCurrency | ImportTemplateColumnDto | R,W | |||||
| supplier | ImportTemplateColumnDto | R,W | |||||
| supplierArticleId | ImportTemplateColumnDto | R,W | |||||
| vat | ImportTemplateColumnDto | R,W | |||||
| vatAccount | ImportTemplateColumnDto | R,W | |||||
| isStock | ImportTemplateColumnDto | R,W | |||||
| type | ImportTemplateColumnDto | R,W | |||||
| stockPlace | ImportTemplateColumnDto | R,W | |||||
| stockWarning | ImportTemplateColumnDto | R,W | |||||
| criticalLevel | ImportTemplateColumnDto | R,W | |||||
| orderLevel | ImportTemplateColumnDto | R,W | |||||
| isWebshopArticle | ImportTemplateColumnDto | R,W | |||||
| manufacturer | ImportTemplateColumnDto | R,W | |||||
| manufacturerArticleId | ImportTemplateColumnDto | R,W | |||||
| width | ImportTemplateColumnDto | R,W | |||||
| height | ImportTemplateColumnDto | R,W | |||||
| depth | ImportTemplateColumnDto | R,W | |||||
| weight | ImportTemplateColumnDto | R,W | |||||
| tags | ImportTemplateColumnDto | R,W | |||||
| priceLists | HashMap | R,W | |||||
| customFields | HashMap | R,W | 
RoleDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access | 
|---|---|---|---|---|---|---|---|
| id | Long | R | |||||
| storeGroupId | Long | R | |||||
| name | String | R,W | |||||
| paths | ArrayList | List of paths role has access to | R,W | ||||
| fields | HashMap | List of objects and fields that is filtered out when sending data to api and request data from api | R,W | ||||
| portal | String | What part of Lagerkoll is the role used | ADMIN, SHOP | R,W | |||
| users | int | Number of users connected to role | R | ||||
| loginServices | List | List of login services role has access to | R,W | ||||
| nativeFeatures | List | List of native features in mobile application role has access to | R,W | 
UserDto
| Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access | 
|---|---|---|---|---|---|---|---|
| id | Long | R | |||||
| customer | boolean | flag to indicate if user has customer privileges | R | ||||
| admin | boolean | flag to indicate if user has admin privileges | R | ||||
| systemAdmin | boolean | flag to indicate if user has system admin privileges | R | ||||
| name | String | R,W | |||||
| String | R,W | ||||||
| phone | String | R,W | |||||
| notes | String | R,W | |||||
| emailInvalid | boolean | If this flag is set to true, Lagerkoll has detected on multiple occassions that it cannot send emails to this address | R | ||||
| role | RoleDto | Role of the current user. Admins can update permissions on other users, but a user cannot update his own permissions | R,W | ||||
| lastLoggedIn | Long | Timestamp when this user was last logged in | R | ||||
| bankID | Boolean | If user has activated login with BankID | R |