Goto APIs

Basics:
API:

Suppliers API

Suppliers API provides methods for handling suppliers

General:

Basics:

Base-URL: https://capi.lagerkoll.com/v1/suppliers/
Parameters in the url should all be encoded and all data sent should be UTF-8

MAX number of requests per minute is set to 200.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.

Headers:

There are 2 ways to be authenticated when using this API. in both ways you add headers to the request.
1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made. 
store: <<STORE>>
user_id: <<USER_ID>>
user_token: <<USER_TOKEN>>
api_key: <<API_KEY>>
Accept: application/json
Content-Type: application/json

Errors:

Code Description
900001 Credentials don't match
900101 Common error
900429 Too many requests
900601 Error when getting supplier
900602 Error when creating supplier
900603 Error when updating supplier
900604 Error when deleting supplier
900624 Error when importing suppliers 
{
  "errorCode" : 900101,
  "errorMessage" : "Something went wrong on the server",
  "errorField" : null,
  "errorData" : null
}

Suppliers API:

Suppliers

Get supplier

GETUrl: /{id}
Headers:
Accept: application/json or application/xml
Get a single supplier based on supplier id

Valid parameters:

Parameter Description Default value Allowed values
open_orders false
article
Body:
Successfull response:

{
    "pages": 2936,
    "suppliers": [{
        "country": "country",
        "city": "city",
        "supplierExternalId": "supplierExternalId",
        "language": "language",
        "rate": 827.749337657071,
        "buyPriceShipment": 708.2236735545177,
        "street": "street",
        "buyPriceMisc": 8302.336824388285,
        "currency": "currency",
        "id": 318,
        "orgNumber": "orgNumber",
        "paymentTerms": "paymentTerms",
        "openOrders": 5488,
        "automaticOrder": true,
        "zip": "zip",
        "buyPrice": 9140.943519663748,
        "comments": "comments",
        "includePricesInOrders": false,
        "contactEmail": "contactEmail",
        "contactName": "contactName",
        "externalId": "externalId",
        "customerNumber": "customerNumber",
        "emailStatus": {},
        "deliveryDays": 8659,
        "name": "name",
        "includeShipmentAndMiscInPrice": false,
        "countryName": "countryName",
        "contactPhone": "contactPhone",
        "vatNumber": "vatNumber"
    }],
    "pageSize": 8638,
    "page": 799,
    "suppliersCount": 5026,
    "since": 4483
}

Get suppliers

GETUrl:
Headers:
Accept: application/json or application/xml
Get a list of suppliers based on query

Valid parameters:

Parameter Description Default value Allowed values
query
since 0
page 0
limit 100
order asc
sort_column name
open_orders false
article
Body:
Successfull response:

{
    "pages": 3040,
    "suppliers": [{
        "country": "country",
        "city": "city",
        "supplierExternalId": "supplierExternalId",
        "language": "language",
        "rate": 6483.153012750136,
        "buyPriceShipment": 6692.456331610559,
        "street": "street",
        "buyPriceMisc": 8703.079523213955,
        "currency": "currency",
        "id": 5288,
        "orgNumber": "orgNumber",
        "paymentTerms": "paymentTerms",
        "openOrders": 1880,
        "automaticOrder": false,
        "zip": "zip",
        "buyPrice": 2434.8888017719128,
        "comments": "comments",
        "includePricesInOrders": false,
        "contactEmail": "contactEmail",
        "contactName": "contactName",
        "externalId": "externalId",
        "customerNumber": "customerNumber",
        "emailStatus": {},
        "deliveryDays": 3345,
        "name": "name",
        "includeShipmentAndMiscInPrice": false,
        "countryName": "countryName",
        "contactPhone": "contactPhone",
        "vatNumber": "vatNumber"
    }],
    "pageSize": 2472,
    "page": 737,
    "suppliersCount": 7196,
    "since": 1902
}

Add supplier

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

{
    "zip": "zip",
    "buyPrice": 8357.299824205806,
    "country": "country",
    "comments": "comments",
    "includePricesInOrders": true,
    "city": "city",
    "contactEmail": "contactEmail",
    "contactName": "contactName",
    "externalId": "externalId",
    "language": "language",
    "customerNumber": "customerNumber",
    "buyPriceShipment": 8163.748655353446,
    "deliveryDays": 3356,
    "street": "street",
    "buyPriceMisc": 8463.050766755017,
    "name": "name",
    "includeShipmentAndMiscInPrice": false,
    "currency": "currency",
    "orgNumber": "orgNumber",
    "contactPhone": "contactPhone",
    "paymentTerms": "paymentTerms",
    "vatNumber": "vatNumber",
    "automaticOrder": true
}
Successfull response:

{
    "country": "country",
    "city": "city",
    "supplierExternalId": "supplierExternalId",
    "language": "language",
    "rate": 4687.982034745749,
    "buyPriceShipment": 1148.3136916795866,
    "street": "street",
    "buyPriceMisc": 2680.403338176537,
    "currency": "currency",
    "id": 8744,
    "orgNumber": "orgNumber",
    "paymentTerms": "paymentTerms",
    "openOrders": 7882,
    "automaticOrder": true,
    "zip": "zip",
    "buyPrice": 9707.803966693411,
    "comments": "comments",
    "includePricesInOrders": false,
    "contactEmail": "contactEmail",
    "contactName": "contactName",
    "externalId": "externalId",
    "customerNumber": "customerNumber",
    "emailStatus": {},
    "deliveryDays": 7487,
    "name": "name",
    "includeShipmentAndMiscInPrice": true,
    "countryName": "countryName",
    "contactPhone": "contactPhone",
    "vatNumber": "vatNumber"
}

Update supplier

PUTUrl: /{id}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Update an existing supplier
Body:

{
    "country": "country",
    "city": "city",
    "supplierExternalId": "supplierExternalId",
    "language": "language",
    "rate": 1590.5058688390527,
    "buyPriceShipment": 4671.59298933667,
    "street": "street",
    "buyPriceMisc": 4366.837205200909,
    "currency": "currency",
    "id": 1384,
    "orgNumber": "orgNumber",
    "paymentTerms": "paymentTerms",
    "openOrders": 5263,
    "automaticOrder": true,
    "zip": "zip",
    "buyPrice": 7152.12261024328,
    "comments": "comments",
    "includePricesInOrders": false,
    "contactEmail": "contactEmail",
    "contactName": "contactName",
    "externalId": "externalId",
    "customerNumber": "customerNumber",
    "emailStatus": {},
    "deliveryDays": 6445,
    "name": "name",
    "includeShipmentAndMiscInPrice": false,
    "countryName": "countryName",
    "contactPhone": "contactPhone",
    "vatNumber": "vatNumber"
}
Successfull response:

{
    "country": "country",
    "city": "city",
    "supplierExternalId": "supplierExternalId",
    "language": "language",
    "rate": 6178.399847146417,
    "buyPriceShipment": 2699.131609109159,
    "street": "street",
    "buyPriceMisc": 7200.829381375857,
    "currency": "currency",
    "id": 5257,
    "orgNumber": "orgNumber",
    "paymentTerms": "paymentTerms",
    "openOrders": 5526,
    "automaticOrder": true,
    "zip": "zip",
    "buyPrice": 3682.998821221163,
    "comments": "comments",
    "includePricesInOrders": false,
    "contactEmail": "contactEmail",
    "contactName": "contactName",
    "externalId": "externalId",
    "customerNumber": "customerNumber",
    "emailStatus": {},
    "deliveryDays": 1843,
    "name": "name",
    "includeShipmentAndMiscInPrice": false,
    "countryName": "countryName",
    "contactPhone": "contactPhone",
    "vatNumber": "vatNumber"
}

Delete supplier

DELETEUrl: /{id}
Headers:
Accept: application/json or application/xml
Delete an existing supplier
Body:
Successfull response:

Classes:

SupplierDto

Field Type Description Default Mandatory Accepted values Example values Access
id long R
externalId String Write only with POST R,W
supplierExternalId String R
name String POST R,W
orgNumber String If omitted, vatNumber is used. If vatNumber begins with SE and ends with 01 (SE551234567801) orgNumber is set to 5512345678 R,W
vatNumber String R,W
comments String R,W
street String POST R,W
zip String POST R,W
city String POST R,W
country String POST if not null, must point to an existing country R,W
countryName String R
contactName String R,W
contactPhone String R,W
contactEmail String POST R,W
customerNumber String R,W
includePricesInOrders Boolean R,W
includeShipmentAndMiscInPrice Boolean R,W
currency String POST if not null, must point to an existing currency R,W
rate double R
buyPrice Double Total buy price including shipment and misc costs R,W
buyPriceShipment Double R,W
buyPriceMisc Double R,W
language String POST sv, en R,W
automaticOrder Boolean R,W
paymentTerms String if not null, must point to an existing payment-term R,W
deliveryDays Integer number of days for supplier to make delivery R,W
emailStatus HashMap R
openOrders Integer R

SuppliersResponseDto

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