Customers API
Customers API provides methods for handling customers
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 |
| 902901 | Error when importing customers |
| 902902 | Error when updating import customer template |
| 902903 | Error when adding import customer template |
| 902904 | Error when deleting import customer template |
| 902911 | Error when exporting customers |
{
"errorCode" : 900101,
"errorMessage" : "Something went wrong on the server",
"errorField" : null,
"errorData" : null
}
Customers API:
Customers
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": 8861, "customersCount": 239, "pageSize": 7743, "page": 3359, "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": 574, "desc": "desc" }, "discount": 5582.763743573748 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 1206, "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": 1238, "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": 326 }
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": 2624, "pageSize": 1262, "page": 3341, "projectsCount": 6632, "tags": [{ "name": "name", "externalId": "externalId", "id": 6565, "desc": "desc" }] }
Get customer for user
GETUrl: /user
Headers:
Accept: application/json or application/xml
Get customer for currently logged in user
Body:
Successfull response:
{ "pages": 5936, "customersCount": 8136, "pageSize": 6255, "page": 7487, "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": 3184, "desc": "desc" }, "discount": 7940.531258234755 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 5899, "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": 1739, "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": 9522 }
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": 7638, "customersCount": 8577, "pageSize": 3222, "page": 9878, "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": 4199, "desc": "desc" }, "discount": 1783.3069229350685 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 5291, "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": 5650, "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": 1260 }
Get customer
GETUrl: /{customer_id}
Headers:
Accept: application/json or application/xml
Get a single customer based on customer id
Body:
Successfull response:
{ "pages": 1213, "customersCount": 1180, "pageSize": 5013, "page": 2274, "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": 4335, "desc": "desc" }, "discount": 7383.182610008513 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 8898, "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": 3170, "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": 1393 }
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": false, "discounts": [{ "articleTag": { "name": "name", "externalId": "externalId", "id": 2309, "desc": "desc" }, "discount": 3374.187592754705 }], "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": 6007, "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": 1821, "desc": "desc" }, "discount": 1286.7770687553714 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 3212, "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": 3886, "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" }
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": true, "notes": "notes", "role": { "loginServices": [{}], "storeGroupId": 688, "paths": {}, "name": "name", "id": 4982, "nativeFeatures": [{}], "fields": {}, "portal": "portal", "users": 1381 }, "phone": "phone", "name": "name", "emailInvalid": true, "admin": false, "lastLoggedIn": 4849, "id": 6594, "email": "email", "customer": false }
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": 2940, "desc": "desc" }
Successfull response:
{ "name": "name", "externalId": "externalId", "id": 4008, "desc": "desc" }
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": 5106, "desc": "desc" }, "discount": 6681.773248456388 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 6909, "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": 2307, "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": 4807, "desc": "desc" }, "discount": 4652.216536786415 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 7840, "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": 845, "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": 3322, "zipCode": { "defaultValue": "defaultValue", "column": 7589 }, "country": { "defaultValue": "defaultValue", "column": 2572 }, "externalCustomerId": { "defaultValue": "defaultValue", "column": 5969 }, "deliveryPhoneTwo": { "defaultValue": "defaultValue", "column": 5524 }, "invoiceDiscount": { "defaultValue": "defaultValue", "column": 2299 }, "city": { "defaultValue": "defaultValue", "column": 4255 }, "language": { "defaultValue": "defaultValue", "column": 5415 }, "visitingZipCode": { "defaultValue": "defaultValue", "column": 4094 }, "type": { "defaultValue": "defaultValue", "column": 3287 }, "phoneTwo": { "defaultValue": "defaultValue", "column": 1192 }, "deliveryAddressOne": { "defaultValue": "defaultValue", "column": 7339 }, "invoiceRemark": { "defaultValue": "defaultValue", "column": 4566 }, "ourReference": { "defaultValue": "defaultValue", "column": 5315 }, "emailOffer": { "defaultValue": "defaultValue", "column": 3929 }, "showVat": { "defaultValue": "defaultValue", "column": 9385 }, "addressTwo": { "defaultValue": "defaultValue", "column": 4473 }, "www": { "defaultValue": "defaultValue", "column": 4054 }, "deliveryZipCode": { "defaultValue": "defaultValue", "column": 7538 }, "wayOfDelivery": { "defaultValue": "defaultValue", "column": 1025 }, "customerId": 9507, "emailInvoice": { "defaultValue": "defaultValue", "column": 6120 }, "visitingAddress": { "defaultValue": "defaultValue", "column": 1152 }, "priceIncludeVat": { "defaultValue": "defaultValue", "column": 21 }, "currency": { "defaultValue": "defaultValue", "column": 5146 }, "orgNumber": { "defaultValue": "defaultValue", "column": 9966 }, "email": { "defaultValue": "defaultValue", "column": 3818 }, "deliveryCity": { "defaultValue": "defaultValue", "column": 5812 }, "yourReference": { "defaultValue": "defaultValue", "column": 7755 }, "rowTitle": 4700, "emailOrder": { "defaultValue": "defaultValue", "column": 775 }, "deliveryTerm": { "defaultValue": "defaultValue", "column": 5264 }, "deliveryAddressTwo": { "defaultValue": "defaultValue", "column": 1300 }, "vat": { "defaultValue": "defaultValue", "column": 9704 }, "externalId": { "defaultValue": "defaultValue", "column": 7350 }, "priceListId": { "defaultValue": "defaultValue", "column": 2677 }, "phoneOne": { "defaultValue": "defaultValue", "column": 3443 }, "customerName": 9456, "tags": { "defaultValue": "defaultValue", "column": 3134 }, "visitingCity": { "defaultValue": "defaultValue", "column": 4502 }, "deliveryCountry": { "defaultValue": "defaultValue", "column": 1763 }, "comment": { "defaultValue": "defaultValue", "column": 5819 }, "visitingCountry": { "defaultValue": "defaultValue", "column": 9255 }, "addressOne": { "defaultValue": "defaultValue", "column": 9350 }, "deliveryName": { "defaultValue": "defaultValue", "column": 1501 }, "deliveryPhoneOne": { "defaultValue": "defaultValue", "column": 8030 }, "paymentTerm": { "defaultValue": "defaultValue", "column": 9217 } }, "name": "name", "storegroupId": 8084, "id": 3032, "type": "type" }], "pages": 208, "pageSize": 7407, "page": 4126, "importTemplateCount": 8814 }
Get customer import template
GETUrl: /import/template/{id}
Headers:
Accept: application/json or application/xml
Get customer import template
Body:
Successfull response:
{ "data": { "rowFirst": 4483, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 4061 }, "description": { "defaultValue": "defaultValue", "column": 9629 }, "stockPlace": { "defaultValue": "defaultValue", "column": 4355 }, "isActive": { "defaultValue": "defaultValue", "column": 5916 }, "type": { "defaultValue": "defaultValue", "column": 8389 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 8744 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 7960 }, "manufacturer": { "defaultValue": "defaultValue", "column": 7325 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 6951 }, "rate": { "defaultValue": "defaultValue", "column": 7323 }, "orderLevel": { "defaultValue": "defaultValue", "column": 4762 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 9631 }, "supplier": { "defaultValue": "defaultValue", "column": 450 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 5472 }, "vatAccount": { "defaultValue": "defaultValue", "column": 7920 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 4613 }, "barcode": { "defaultValue": "defaultValue", "column": 8443 }, "automaticOrder": { "defaultValue": "defaultValue", "column": 4912 }, "height": { "defaultValue": "defaultValue", "column": 248 }, "isBundled": { "defaultValue": "defaultValue", "column": 9228 }, "buyPrice": { "defaultValue": "defaultValue", "column": 9174 }, "amount": { "defaultValue": "defaultValue", "column": 5537 }, "articleName": 7573, "rowTitle": 9825, "articleId": 1894, "vat": { "defaultValue": "defaultValue", "column": 149 }, "weight": { "defaultValue": "defaultValue", "column": 7477 }, "tags": { "defaultValue": "defaultValue", "column": 6016 }, "unit": { "defaultValue": "defaultValue", "column": 6394 }, "useStockWarning": { "defaultValue": "defaultValue", "column": 6054 }, "depth": { "defaultValue": "defaultValue", "column": 7483 }, "priceLists": {}, "width": { "defaultValue": "defaultValue", "column": 8117 }, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 4476 }, "category": { "defaultValue": "defaultValue", "column": 4905 }, "isStock": { "defaultValue": "defaultValue", "column": 5511 }, "stockWarning": { "defaultValue": "defaultValue", "column": 6488 } }, "name": "name", "storegroupId": 7309, "id": 828, "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": 6109, "zipCode": { "defaultValue": "defaultValue", "column": 7333 }, "country": { "defaultValue": "defaultValue", "column": 5468 }, "externalCustomerId": { "defaultValue": "defaultValue", "column": 4778 }, "deliveryPhoneTwo": { "defaultValue": "defaultValue", "column": 4349 }, "invoiceDiscount": { "defaultValue": "defaultValue", "column": 9100 }, "city": { "defaultValue": "defaultValue", "column": 4686 }, "language": { "defaultValue": "defaultValue", "column": 7544 }, "visitingZipCode": { "defaultValue": "defaultValue", "column": 3109 }, "type": { "defaultValue": "defaultValue", "column": 120 }, "phoneTwo": { "defaultValue": "defaultValue", "column": 6664 }, "deliveryAddressOne": { "defaultValue": "defaultValue", "column": 4374 }, "invoiceRemark": { "defaultValue": "defaultValue", "column": 2808 }, "ourReference": { "defaultValue": "defaultValue", "column": 3204 }, "emailOffer": { "defaultValue": "defaultValue", "column": 3133 }, "showVat": { "defaultValue": "defaultValue", "column": 2321 }, "addressTwo": { "defaultValue": "defaultValue", "column": 9435 }, "www": { "defaultValue": "defaultValue", "column": 4992 }, "deliveryZipCode": { "defaultValue": "defaultValue", "column": 9703 }, "wayOfDelivery": { "defaultValue": "defaultValue", "column": 3687 }, "customerId": 895, "emailInvoice": { "defaultValue": "defaultValue", "column": 4210 }, "visitingAddress": { "defaultValue": "defaultValue", "column": 1163 }, "priceIncludeVat": { "defaultValue": "defaultValue", "column": 6200 }, "currency": { "defaultValue": "defaultValue", "column": 2766 }, "orgNumber": { "defaultValue": "defaultValue", "column": 1517 }, "email": { "defaultValue": "defaultValue", "column": 4289 }, "deliveryCity": { "defaultValue": "defaultValue", "column": 4463 }, "yourReference": { "defaultValue": "defaultValue", "column": 1545 }, "rowTitle": 2303, "emailOrder": { "defaultValue": "defaultValue", "column": 2371 }, "deliveryTerm": { "defaultValue": "defaultValue", "column": 3355 }, "deliveryAddressTwo": { "defaultValue": "defaultValue", "column": 7919 }, "vat": { "defaultValue": "defaultValue", "column": 1101 }, "externalId": { "defaultValue": "defaultValue", "column": 9026 }, "priceListId": { "defaultValue": "defaultValue", "column": 9162 }, "phoneOne": { "defaultValue": "defaultValue", "column": 2277 }, "customerName": 7650, "tags": { "defaultValue": "defaultValue", "column": 8634 }, "visitingCity": { "defaultValue": "defaultValue", "column": 5410 }, "deliveryCountry": { "defaultValue": "defaultValue", "column": 9854 }, "comment": { "defaultValue": "defaultValue", "column": 4698 }, "visitingCountry": { "defaultValue": "defaultValue", "column": 8315 }, "addressOne": { "defaultValue": "defaultValue", "column": 526 }, "deliveryName": { "defaultValue": "defaultValue", "column": 3827 }, "deliveryPhoneOne": { "defaultValue": "defaultValue", "column": 1505 }, "paymentTerm": { "defaultValue": "defaultValue", "column": 8667 } }, "name": "name", "storegroupId": 2565, "type": "type" }
Successfull response:
{ "data": { "rowFirst": 6723, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 2207 }, "description": { "defaultValue": "defaultValue", "column": 461 }, "stockPlace": { "defaultValue": "defaultValue", "column": 5743 }, "isActive": { "defaultValue": "defaultValue", "column": 984 }, "type": { "defaultValue": "defaultValue", "column": 3255 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 4555 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 1572 }, "manufacturer": { "defaultValue": "defaultValue", "column": 2053 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 894 }, "rate": { "defaultValue": "defaultValue", "column": 7693 }, "orderLevel": { "defaultValue": "defaultValue", "column": 6365 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 2517 }, "supplier": { "defaultValue": "defaultValue", "column": 888 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 598 }, "vatAccount": { "defaultValue": "defaultValue", "column": 2231 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 1409 }, "barcode": { "defaultValue": "defaultValue", "column": 9128 }, "automaticOrder": { "defaultValue": "defaultValue", "column": 6269 }, "height": { "defaultValue": "defaultValue", "column": 9848 }, "isBundled": { "defaultValue": "defaultValue", "column": 4857 }, "buyPrice": { "defaultValue": "defaultValue", "column": 6922 }, "amount": { "defaultValue": "defaultValue", "column": 8885 }, "articleName": 3995, "rowTitle": 2848, "articleId": 5651, "vat": { "defaultValue": "defaultValue", "column": 743 }, "weight": { "defaultValue": "defaultValue", "column": 1320 }, "tags": { "defaultValue": "defaultValue", "column": 9547 }, "unit": { "defaultValue": "defaultValue", "column": 7509 }, "useStockWarning": { "defaultValue": "defaultValue", "column": 9558 }, "depth": { "defaultValue": "defaultValue", "column": 673 }, "priceLists": {}, "width": { "defaultValue": "defaultValue", "column": 5011 }, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 3088 }, "category": { "defaultValue": "defaultValue", "column": 164 }, "isStock": { "defaultValue": "defaultValue", "column": 4325 }, "stockWarning": { "defaultValue": "defaultValue", "column": 9965 } }, "name": "name", "storegroupId": 5666, "id": 9064, "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": 1110, "zipCode": { "defaultValue": "defaultValue", "column": 6168 }, "country": { "defaultValue": "defaultValue", "column": 3374 }, "externalCustomerId": { "defaultValue": "defaultValue", "column": 1917 }, "deliveryPhoneTwo": { "defaultValue": "defaultValue", "column": 7620 }, "invoiceDiscount": { "defaultValue": "defaultValue", "column": 7483 }, "city": { "defaultValue": "defaultValue", "column": 4597 }, "language": { "defaultValue": "defaultValue", "column": 9276 }, "visitingZipCode": { "defaultValue": "defaultValue", "column": 7795 }, "type": { "defaultValue": "defaultValue", "column": 5791 }, "phoneTwo": { "defaultValue": "defaultValue", "column": 9763 }, "deliveryAddressOne": { "defaultValue": "defaultValue", "column": 1618 }, "invoiceRemark": { "defaultValue": "defaultValue", "column": 2224 }, "ourReference": { "defaultValue": "defaultValue", "column": 6619 }, "emailOffer": { "defaultValue": "defaultValue", "column": 1881 }, "showVat": { "defaultValue": "defaultValue", "column": 129 }, "addressTwo": { "defaultValue": "defaultValue", "column": 9082 }, "www": { "defaultValue": "defaultValue", "column": 5427 }, "deliveryZipCode": { "defaultValue": "defaultValue", "column": 7037 }, "wayOfDelivery": { "defaultValue": "defaultValue", "column": 5494 }, "customerId": 933, "emailInvoice": { "defaultValue": "defaultValue", "column": 9795 }, "visitingAddress": { "defaultValue": "defaultValue", "column": 54 }, "priceIncludeVat": { "defaultValue": "defaultValue", "column": 6462 }, "currency": { "defaultValue": "defaultValue", "column": 2474 }, "orgNumber": { "defaultValue": "defaultValue", "column": 637 }, "email": { "defaultValue": "defaultValue", "column": 2099 }, "deliveryCity": { "defaultValue": "defaultValue", "column": 9009 }, "yourReference": { "defaultValue": "defaultValue", "column": 541 }, "rowTitle": 4838, "emailOrder": { "defaultValue": "defaultValue", "column": 7928 }, "deliveryTerm": { "defaultValue": "defaultValue", "column": 4676 }, "deliveryAddressTwo": { "defaultValue": "defaultValue", "column": 973 }, "vat": { "defaultValue": "defaultValue", "column": 8622 }, "externalId": { "defaultValue": "defaultValue", "column": 3964 }, "priceListId": { "defaultValue": "defaultValue", "column": 6790 }, "phoneOne": { "defaultValue": "defaultValue", "column": 3235 }, "customerName": 74, "tags": { "defaultValue": "defaultValue", "column": 1165 }, "visitingCity": { "defaultValue": "defaultValue", "column": 4119 }, "deliveryCountry": { "defaultValue": "defaultValue", "column": 4839 }, "comment": { "defaultValue": "defaultValue", "column": 5981 }, "visitingCountry": { "defaultValue": "defaultValue", "column": 3755 }, "addressOne": { "defaultValue": "defaultValue", "column": 9213 }, "deliveryName": { "defaultValue": "defaultValue", "column": 5562 }, "deliveryPhoneOne": { "defaultValue": "defaultValue", "column": 7707 }, "paymentTerm": { "defaultValue": "defaultValue", "column": 3342 } }, "name": "name", "storegroupId": 3104, "id": 4093, "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 | |||||
| useStockWarning | ImportTemplateColumnDto | R,W | |||||
| stockWarning | ImportTemplateColumnDto | R,W | |||||
| automaticOrder | 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 |