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
GETUrl: /{customer_id}
Headers:
Accept: application/json or application/xml
Get a single customer based on customer id
Body:
Successfull response:
{ "pages": 7169, "customersCount": 417, "pageSize": 544, "page": 9175, "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": 1206, "desc": "desc" }, "discount": 4016.396335023411 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 108, "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", "ourReference": "ourReference", "showVAT": false, "customerId": 3269, "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": 988 }
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": 6279, "customersCount": 1806, "pageSize": 1575, "page": 2866, "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": 8544, "desc": "desc" }, "discount": 813.797834226735 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 2243, "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", "ourReference": "ourReference", "showVAT": true, "customerId": 2868, "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": 7321 }
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": 5878, "customersCount": 8599, "pageSize": 5955, "page": 9900, "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": 4558, "desc": "desc" }, "discount": 196.70528299095213 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 2795, "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", "ourReference": "ourReference", "showVAT": true, "customerId": 9413, "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": 7158 }
Get customer for user
GETUrl: /user
Headers:
Accept: application/json or application/xml
Get customer for currently logged in user
Body:
Successfull response:
{ "pages": 6442, "customersCount": 8432, "pageSize": 2912, "page": 5829, "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": 3486, "desc": "desc" }, "discount": 7422.583345634266 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 7369, "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", "ourReference": "ourReference", "showVAT": true, "customerId": 69, "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": 605 }
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": 2922, "pageSize": 7363, "page": 4625, "projectsCount": 5579, "tags": [{ "name": "name", "externalId": "externalId", "id": 3609, "desc": "desc" }] }
Add customers
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": 6992, "desc": "desc" }, "discount": 6628.44086071315 }], "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": 9550, "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": 6295, "desc": "desc" }, "discount": 2523.5684708888607 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 9257, "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", "ourReference": "ourReference", "showVAT": true, "customerId": 78, "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": 1252, "desc": "desc" }
Successfull response:
{ "name": "name", "externalId": "externalId", "id": 6896, "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", "phone": "phone", "permissions": [{}], "name": "name", "email": "email" }
Successfull response:
{ "systemAdmin": true, "bankID": false, "notes": "notes", "phone": "phone", "permissions": [{}], "name": "name", "emailInvalid": false, "admin": false, "lastLoggedIn": 1567, "id": 950, "email": "email", "customer": false }
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": 5439, "desc": "desc" }, "discount": 880.2322914680649 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 6413, "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", "ourReference": "ourReference", "showVAT": true, "customerId": 123, "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": 5265, "desc": "desc" }, "discount": 6677.109921352305 }], "deliveryZipCode": "deliveryZipCode", "wayOfDelivery": "wayOfDelivery", "emailInvoice": "emailInvoice", "orgNumber": "orgNumber", "yourReference": "yourReference", "emailOrder": "emailOrder", "deliveryTerm": "deliveryTerm", "tags": [{ "name": "name", "externalId": "externalId", "id": 5840, "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", "ourReference": "ourReference", "showVAT": false, "customerId": 8260, "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 customers
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
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": 1385, "zipCode": { "defaultValue": "defaultValue", "column": 5243 }, "country": { "defaultValue": "defaultValue", "column": 4823 }, "externalCustomerId": { "defaultValue": "defaultValue", "column": 8887 }, "deliveryPhoneTwo": { "defaultValue": "defaultValue", "column": 552 }, "invoiceDiscount": { "defaultValue": "defaultValue", "column": 1738 }, "city": { "defaultValue": "defaultValue", "column": 3624 }, "language": { "defaultValue": "defaultValue", "column": 2634 }, "visitingZipCode": { "defaultValue": "defaultValue", "column": 5147 }, "type": { "defaultValue": "defaultValue", "column": 7300 }, "phoneTwo": { "defaultValue": "defaultValue", "column": 7705 }, "deliveryAddressOne": { "defaultValue": "defaultValue", "column": 7209 }, "invoiceRemark": { "defaultValue": "defaultValue", "column": 2634 }, "ourReference": { "defaultValue": "defaultValue", "column": 282 }, "emailOffer": { "defaultValue": "defaultValue", "column": 3306 }, "showVat": { "defaultValue": "defaultValue", "column": 5758 }, "addressTwo": { "defaultValue": "defaultValue", "column": 858 }, "www": { "defaultValue": "defaultValue", "column": 2040 }, "deliveryZipCode": { "defaultValue": "defaultValue", "column": 2305 }, "wayOfDelivery": { "defaultValue": "defaultValue", "column": 912 }, "customerId": 9283, "emailInvoice": { "defaultValue": "defaultValue", "column": 3347 }, "visitingAddress": { "defaultValue": "defaultValue", "column": 9628 }, "priceIncludeVat": { "defaultValue": "defaultValue", "column": 8654 }, "currency": { "defaultValue": "defaultValue", "column": 7772 }, "orgNumber": { "defaultValue": "defaultValue", "column": 3601 }, "email": { "defaultValue": "defaultValue", "column": 7201 }, "deliveryCity": { "defaultValue": "defaultValue", "column": 6713 }, "yourReference": { "defaultValue": "defaultValue", "column": 4368 }, "rowTitle": 9040, "emailOrder": { "defaultValue": "defaultValue", "column": 1785 }, "deliveryTerm": { "defaultValue": "defaultValue", "column": 3403 }, "deliveryAddressTwo": { "defaultValue": "defaultValue", "column": 6578 }, "vat": { "defaultValue": "defaultValue", "column": 8290 }, "externalId": { "defaultValue": "defaultValue", "column": 3361 }, "priceListId": { "defaultValue": "defaultValue", "column": 712 }, "phoneOne": { "defaultValue": "defaultValue", "column": 4259 }, "customerName": 5509, "tags": { "defaultValue": "defaultValue", "column": 1590 }, "visitingCity": { "defaultValue": "defaultValue", "column": 322 }, "deliveryCountry": { "defaultValue": "defaultValue", "column": 7955 }, "comment": { "defaultValue": "defaultValue", "column": 9469 }, "visitingCountry": { "defaultValue": "defaultValue", "column": 5207 }, "addressOne": { "defaultValue": "defaultValue", "column": 8581 }, "deliveryName": { "defaultValue": "defaultValue", "column": 9923 }, "deliveryPhoneOne": { "defaultValue": "defaultValue", "column": 1841 }, "paymentTerm": { "defaultValue": "defaultValue", "column": 5771 } }, "name": "name", "storegroupId": 4681, "id": 130, "type": "type" }], "pages": 6528, "pageSize": 835, "page": 4174, "importTemplateCount": 485 }
Get customer import template
GETUrl: /import/template/{id}
Headers:
Accept: application/json or application/xml
Get customer import template
Body:
Successfull response:
{ "data": { "rowFirst": 358, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 5563 }, "description": { "defaultValue": "defaultValue", "column": 2335 }, "stockPlace": { "defaultValue": "defaultValue", "column": 3902 }, "isActive": { "defaultValue": "defaultValue", "column": 1770 }, "type": { "defaultValue": "defaultValue", "column": 8135 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 8345 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 6733 }, "manufacturer": { "defaultValue": "defaultValue", "column": 8977 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 3431 }, "rate": { "defaultValue": "defaultValue", "column": 9059 }, "orderLevel": { "defaultValue": "defaultValue", "column": 6880 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 1847 }, "supplier": { "defaultValue": "defaultValue", "column": 5770 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 5409 }, "vatAccount": { "defaultValue": "defaultValue", "column": 875 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 6360 }, "barcode": { "defaultValue": "defaultValue", "column": 7946 }, "isBundled": { "defaultValue": "defaultValue", "column": 4081 }, "buyPrice": { "defaultValue": "defaultValue", "column": 3184 }, "amount": { "defaultValue": "defaultValue", "column": 2706 }, "articleName": 3076, "rowTitle": 4957, "articleId": 5846, "vat": { "defaultValue": "defaultValue", "column": 6578 }, "tags": { "defaultValue": "defaultValue", "column": 3515 }, "unit": { "defaultValue": "defaultValue", "column": 4293 }, "priceLists": {}, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 9040 }, "category": { "defaultValue": "defaultValue", "column": 4225 }, "isStock": { "defaultValue": "defaultValue", "column": 286 }, "stockWarning": { "defaultValue": "defaultValue", "column": 9209 } }, "name": "name", "storegroupId": 8029, "id": 8346, "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": 7084, "zipCode": { "defaultValue": "defaultValue", "column": 4956 }, "country": { "defaultValue": "defaultValue", "column": 3582 }, "externalCustomerId": { "defaultValue": "defaultValue", "column": 6362 }, "deliveryPhoneTwo": { "defaultValue": "defaultValue", "column": 7374 }, "invoiceDiscount": { "defaultValue": "defaultValue", "column": 9618 }, "city": { "defaultValue": "defaultValue", "column": 7951 }, "language": { "defaultValue": "defaultValue", "column": 6462 }, "visitingZipCode": { "defaultValue": "defaultValue", "column": 2214 }, "type": { "defaultValue": "defaultValue", "column": 153 }, "phoneTwo": { "defaultValue": "defaultValue", "column": 1442 }, "deliveryAddressOne": { "defaultValue": "defaultValue", "column": 4803 }, "invoiceRemark": { "defaultValue": "defaultValue", "column": 9593 }, "ourReference": { "defaultValue": "defaultValue", "column": 3389 }, "emailOffer": { "defaultValue": "defaultValue", "column": 1563 }, "showVat": { "defaultValue": "defaultValue", "column": 8086 }, "addressTwo": { "defaultValue": "defaultValue", "column": 2008 }, "www": { "defaultValue": "defaultValue", "column": 7784 }, "deliveryZipCode": { "defaultValue": "defaultValue", "column": 3118 }, "wayOfDelivery": { "defaultValue": "defaultValue", "column": 4939 }, "customerId": 2417, "emailInvoice": { "defaultValue": "defaultValue", "column": 8641 }, "visitingAddress": { "defaultValue": "defaultValue", "column": 6536 }, "priceIncludeVat": { "defaultValue": "defaultValue", "column": 2123 }, "currency": { "defaultValue": "defaultValue", "column": 4848 }, "orgNumber": { "defaultValue": "defaultValue", "column": 8573 }, "email": { "defaultValue": "defaultValue", "column": 3319 }, "deliveryCity": { "defaultValue": "defaultValue", "column": 5057 }, "yourReference": { "defaultValue": "defaultValue", "column": 8677 }, "rowTitle": 1154, "emailOrder": { "defaultValue": "defaultValue", "column": 3102 }, "deliveryTerm": { "defaultValue": "defaultValue", "column": 7804 }, "deliveryAddressTwo": { "defaultValue": "defaultValue", "column": 6797 }, "vat": { "defaultValue": "defaultValue", "column": 3448 }, "externalId": { "defaultValue": "defaultValue", "column": 5698 }, "priceListId": { "defaultValue": "defaultValue", "column": 6477 }, "phoneOne": { "defaultValue": "defaultValue", "column": 7945 }, "customerName": 6350, "tags": { "defaultValue": "defaultValue", "column": 421 }, "visitingCity": { "defaultValue": "defaultValue", "column": 3883 }, "deliveryCountry": { "defaultValue": "defaultValue", "column": 3720 }, "comment": { "defaultValue": "defaultValue", "column": 6696 }, "visitingCountry": { "defaultValue": "defaultValue", "column": 4845 }, "addressOne": { "defaultValue": "defaultValue", "column": 488 }, "deliveryName": { "defaultValue": "defaultValue", "column": 6340 }, "deliveryPhoneOne": { "defaultValue": "defaultValue", "column": 4199 }, "paymentTerm": { "defaultValue": "defaultValue", "column": 5584 } }, "name": "name", "storegroupId": 4503, "type": "type" }
Successfull response:
{ "data": { "rowFirst": 7303, "customFields": {}, "barcodeType": { "defaultValue": "defaultValue", "column": 11 }, "description": { "defaultValue": "defaultValue", "column": 9466 }, "stockPlace": { "defaultValue": "defaultValue", "column": 9537 }, "isActive": { "defaultValue": "defaultValue", "column": 1889 }, "type": { "defaultValue": "defaultValue", "column": 722 }, "criticalLevel": { "defaultValue": "defaultValue", "column": 8954 }, "buyPriceCurrency": { "defaultValue": "defaultValue", "column": 1021 }, "manufacturer": { "defaultValue": "defaultValue", "column": 3614 }, "buyPriceShipment": { "defaultValue": "defaultValue", "column": 5967 }, "rate": { "defaultValue": "defaultValue", "column": 8531 }, "orderLevel": { "defaultValue": "defaultValue", "column": 4106 }, "buyPriceMisc": { "defaultValue": "defaultValue", "column": 4459 }, "supplier": { "defaultValue": "defaultValue", "column": 3131 }, "supplierArticleId": { "defaultValue": "defaultValue", "column": 1162 }, "vatAccount": { "defaultValue": "defaultValue", "column": 945 }, "isWebshopArticle": { "defaultValue": "defaultValue", "column": 8589 }, "barcode": { "defaultValue": "defaultValue", "column": 6219 }, "isBundled": { "defaultValue": "defaultValue", "column": 7895 }, "buyPrice": { "defaultValue": "defaultValue", "column": 8420 }, "amount": { "defaultValue": "defaultValue", "column": 7708 }, "articleName": 2629, "rowTitle": 6199, "articleId": 7787, "vat": { "defaultValue": "defaultValue", "column": 8392 }, "tags": { "defaultValue": "defaultValue", "column": 455 }, "unit": { "defaultValue": "defaultValue", "column": 6179 }, "priceLists": {}, "manufacturerArticleId": { "defaultValue": "defaultValue", "column": 5978 }, "category": { "defaultValue": "defaultValue", "column": 5432 }, "isStock": { "defaultValue": "defaultValue", "column": 225 }, "stockWarning": { "defaultValue": "defaultValue", "column": 7635 } }, "name": "name", "storegroupId": 6905, "id": 6293, "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": 7026, "zipCode": { "defaultValue": "defaultValue", "column": 2904 }, "country": { "defaultValue": "defaultValue", "column": 267 }, "externalCustomerId": { "defaultValue": "defaultValue", "column": 8528 }, "deliveryPhoneTwo": { "defaultValue": "defaultValue", "column": 310 }, "invoiceDiscount": { "defaultValue": "defaultValue", "column": 4107 }, "city": { "defaultValue": "defaultValue", "column": 2431 }, "language": { "defaultValue": "defaultValue", "column": 9592 }, "visitingZipCode": { "defaultValue": "defaultValue", "column": 8115 }, "type": { "defaultValue": "defaultValue", "column": 2210 }, "phoneTwo": { "defaultValue": "defaultValue", "column": 7018 }, "deliveryAddressOne": { "defaultValue": "defaultValue", "column": 1643 }, "invoiceRemark": { "defaultValue": "defaultValue", "column": 8636 }, "ourReference": { "defaultValue": "defaultValue", "column": 678 }, "emailOffer": { "defaultValue": "defaultValue", "column": 9196 }, "showVat": { "defaultValue": "defaultValue", "column": 255 }, "addressTwo": { "defaultValue": "defaultValue", "column": 7671 }, "www": { "defaultValue": "defaultValue", "column": 4383 }, "deliveryZipCode": { "defaultValue": "defaultValue", "column": 1344 }, "wayOfDelivery": { "defaultValue": "defaultValue", "column": 3329 }, "customerId": 4735, "emailInvoice": { "defaultValue": "defaultValue", "column": 817 }, "visitingAddress": { "defaultValue": "defaultValue", "column": 7318 }, "priceIncludeVat": { "defaultValue": "defaultValue", "column": 5749 }, "currency": { "defaultValue": "defaultValue", "column": 6249 }, "orgNumber": { "defaultValue": "defaultValue", "column": 6565 }, "email": { "defaultValue": "defaultValue", "column": 3153 }, "deliveryCity": { "defaultValue": "defaultValue", "column": 9988 }, "yourReference": { "defaultValue": "defaultValue", "column": 6411 }, "rowTitle": 9186, "emailOrder": { "defaultValue": "defaultValue", "column": 7100 }, "deliveryTerm": { "defaultValue": "defaultValue", "column": 9848 }, "deliveryAddressTwo": { "defaultValue": "defaultValue", "column": 7846 }, "vat": { "defaultValue": "defaultValue", "column": 3470 }, "externalId": { "defaultValue": "defaultValue", "column": 5115 }, "priceListId": { "defaultValue": "defaultValue", "column": 7380 }, "phoneOne": { "defaultValue": "defaultValue", "column": 7873 }, "customerName": 4957, "tags": { "defaultValue": "defaultValue", "column": 6702 }, "visitingCity": { "defaultValue": "defaultValue", "column": 6385 }, "deliveryCountry": { "defaultValue": "defaultValue", "column": 6004 }, "comment": { "defaultValue": "defaultValue", "column": 1842 }, "visitingCountry": { "defaultValue": "defaultValue", "column": 9135 }, "addressOne": { "defaultValue": "defaultValue", "column": 6075 }, "deliveryName": { "defaultValue": "defaultValue", "column": 5688 }, "deliveryPhoneOne": { "defaultValue": "defaultValue", "column": 6216 }, "paymentTerm": { "defaultValue": "defaultValue", "column": 193 } }, "name": "name", "storegroupId": 8594, "id": 7918, "type": "type" }
Successfull response:
{ "name": "name", "externalId": "externalId", "id": 659, "desc": "desc" }
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:
ArticleImportTemplate
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
id | long | R | |||||
storegroupId | long | R,W | |||||
name | String | R,W | |||||
type | String | R,W | |||||
data | ImportTemplate | R,W |
ArticleTag
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
id | long | Write only with POST | Post | R,W | |||
externalId | String | R,W | |||||
name | String | Post | R,W | ||||
desc | String | Post | R,W |
Customer
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 | |||
tags | List | Make sure you provide tagId for existing tags, otherwise new ones will be created | R,W | ||||
discounts | List | R,W |
CustomerDiscount
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
articleTag | ArticleTag | Write only with POST | Post | R,W | |||
discount | double | Discount in percent | Post | 0 - 100 | R,W |
CustomerImportTemplate
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 | ImportTemplateCustomer | R,W |
CustomerImportTemplateResponse
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 |
CustomersResponse
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 |
CustomerTag
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
id | Long | Write only with POST | Post | R,W | |||
externalId | String | R,W | |||||
name | String | Post | R,W | ||||
desc | String | Post | R,W |
CustomerTagResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
page | int | R | |||||
pages | int | R | |||||
pageSize | int | R | |||||
projectsCount | int | R | |||||
tags | List | R |
ImportTemplate
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
rowTitle | Integer | R,W | |||||
rowFirst | Integer | R,W | |||||
articleName | Integer | R,W | |||||
articleId | Integer | R,W | |||||
description | ImportTemplateColumn | R,W | |||||
isActive | ImportTemplateColumn | R,W | |||||
isBundled | ImportTemplateColumn | R,W | |||||
category | ImportTemplateColumn | R,W | |||||
amount | ImportTemplateColumn | R,W | |||||
unit | ImportTemplateColumn | R,W | |||||
barcode | ImportTemplateColumn | R,W | |||||
barcodeType | ImportTemplateColumn | R,W | |||||
buyPrice | ImportTemplateColumn | R,W | |||||
buyPriceShipment | ImportTemplateColumn | R,W | |||||
buyPriceMisc | ImportTemplateColumn | R,W | |||||
rate | ImportTemplateColumn | R,W | |||||
buyPriceCurrency | ImportTemplateColumn | R,W | |||||
supplier | ImportTemplateColumn | R,W | |||||
supplierArticleId | ImportTemplateColumn | R,W | |||||
vat | ImportTemplateColumn | R,W | |||||
vatAccount | ImportTemplateColumn | R,W | |||||
isStock | ImportTemplateColumn | R,W | |||||
type | ImportTemplateColumn | R,W | |||||
stockPlace | ImportTemplateColumn | R,W | |||||
stockWarning | ImportTemplateColumn | R,W | |||||
criticalLevel | ImportTemplateColumn | R,W | |||||
orderLevel | ImportTemplateColumn | R,W | |||||
isWebshopArticle | ImportTemplateColumn | R,W | |||||
manufacturer | ImportTemplateColumn | R,W | |||||
manufacturerArticleId | ImportTemplateColumn | R,W | |||||
tags | ImportTemplateColumn | R,W | |||||
priceLists | HashMap | R,W | |||||
customFields | HashMap | R,W |
ImportTemplateColumn
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
column | Integer | R,W | |||||
defaultValue | String | R,W |
ImportTemplateCustomer
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 | ImportTemplateColumn | R,W | |||||
externalCustomerId | ImportTemplateColumn | R,W | |||||
type | ImportTemplateColumn | R,W | |||||
orgNumber | ImportTemplateColumn | R,W | |||||
vat | ImportTemplateColumn | R,W | |||||
ourReference | ImportTemplateColumn | R,W | |||||
yourReference | ImportTemplateColumn | R,W | |||||
comment | ImportTemplateColumn | R,W | |||||
phoneOne | ImportTemplateColumn | R,W | |||||
phoneTwo | ImportTemplateColumn | R,W | |||||
addressOne | ImportTemplateColumn | R,W | |||||
addressTwo | ImportTemplateColumn | R,W | |||||
zipCode | ImportTemplateColumn | R,W | |||||
city | ImportTemplateColumn | R,W | |||||
country | ImportTemplateColumn | R,W | |||||
language | ImportTemplateColumn | R,W | |||||
currency | ImportTemplateColumn | R,W | |||||
deliveryAddressOne | ImportTemplateColumn | R,W | |||||
deliveryAddressTwo | ImportTemplateColumn | R,W | |||||
deliveryCity | ImportTemplateColumn | R,W | |||||
deliveryZipCode | ImportTemplateColumn | R,W | |||||
deliveryCountry | ImportTemplateColumn | R,W | |||||
deliveryName | ImportTemplateColumn | R,W | |||||
deliveryPhoneOne | ImportTemplateColumn | R,W | |||||
deliveryPhoneTwo | ImportTemplateColumn | R,W | |||||
visitingAddress | ImportTemplateColumn | R,W | |||||
visitingCity | ImportTemplateColumn | R,W | |||||
visitingZipCode | ImportTemplateColumn | R,W | |||||
visitingCountry | ImportTemplateColumn | R,W | |||||
ImportTemplateColumn | R,W | ||||||
emailInvoice | ImportTemplateColumn | R,W | |||||
emailOffer | ImportTemplateColumn | R,W | |||||
emailOrder | ImportTemplateColumn | R,W | |||||
invoiceDiscount | ImportTemplateColumn | R,W | |||||
invoiceRemark | ImportTemplateColumn | R,W | |||||
priceIncludeVat | ImportTemplateColumn | R,W | |||||
showVat | ImportTemplateColumn | R,W | |||||
deliveryTerm | ImportTemplateColumn | R,W | |||||
paymentTerm | ImportTemplateColumn | R,W | |||||
wayOfDelivery | ImportTemplateColumn | R,W | |||||
www | ImportTemplateColumn | R,W | |||||
priceListId | ImportTemplateColumn | R,W | |||||
tags | ImportTemplateColumn | R,W |
User
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 | ||||
permissions | List | List of permissions current user has access to. Admins can update permissions on other users, but a user cannot update his own permissions | READ_ITEMS(1), UPDATE_ITEMS(2), DELETE_ITEMS(4), READ_STORES(8), UPDATE_STORES(16), DELETE_STORES(32), READ_ADMINS(64), UPDATE_ADMINS(128), DELETE_ADMINS(256), SYSTEM_ADMIN(512), READ_CUSTOMER_ORDERS(1024), UPDATE_CUSTOMER_ORDERS(2048), DELETE_CUSTOMER_ORDERS(4096), FILTER_OUT_PRICES(8192), READ_INVENTORY(16384), UPDATE_INVENTORY(32768), HANDLE_INVENTORY(65536), FINISH_INVENTORY(131072), READ_SUPPLIER_ORDERS(262144), UPDATE_SUPPLIER_ORDERS(524288), DELETE_SUPPLIER_ORDERS(1048576), HANDLE_DELIVERY(2097152), FINISH_DELIVERY(4194304), READ_PICKING_LISTS(8388608), PICK_PICKING_LIST(16777216), FINISH_PICKING_LIST(33554432), CHECKOUT(67108864) | R,W | |||
lastLoggedIn | Long | Timestamp when this user was last logged in | R | ||||
bankID | Boolean | If user has activated login with BankID | R |