Suppliers API
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.
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 |
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 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": 8438, "suppliers": [{ "country": "country", "city": "city", "supplierExternalId": "supplierExternalId", "language": "language", "rate": 5926.295832230091, "buyPriceShipment": 6121.947155158103, "street": "street", "buyPriceMisc": 2947.6857242921483, "currency": "currency", "id": 5953, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 6259, "automaticOrder": true, "zip": "zip", "buyPrice": 7002.680398740192, "comments": "comments", "includePricesInOrders": false, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 9098, "name": "name", "includeShipmentAndMiscInPrice": false, "countryName": "countryName", "contactPhone": "contactPhone", "vatNumber": "vatNumber" }], "pageSize": 2163, "page": 334, "suppliersCount": 859, "since": 882 }
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": 1135, "suppliers": [{ "country": "country", "city": "city", "supplierExternalId": "supplierExternalId", "language": "language", "rate": 8268.13154160581, "buyPriceShipment": 1234.249217158635, "street": "street", "buyPriceMisc": 3413.775572041342, "currency": "currency", "id": 210, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 4469, "automaticOrder": true, "zip": "zip", "buyPrice": 5941.994106521035, "comments": "comments", "includePricesInOrders": true, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 392, "name": "name", "includeShipmentAndMiscInPrice": false, "countryName": "countryName", "contactPhone": "contactPhone", "vatNumber": "vatNumber" }], "pageSize": 1009, "page": 8864, "suppliersCount": 9429, "since": 9936 }
Add supplier
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 supplier
Body:
{ "zip": "zip", "buyPrice": 8088.883998066693, "country": "country", "comments": "comments", "includePricesInOrders": false, "city": "city", "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "language": "language", "customerNumber": "customerNumber", "buyPriceShipment": 6689.3781313957215, "deliveryDays": 6512, "street": "street", "buyPriceMisc": 6688.790115798364, "name": "name", "includeShipmentAndMiscInPrice": false, "currency": "currency", "orgNumber": "orgNumber", "contactPhone": "contactPhone", "paymentTerms": "paymentTerms", "vatNumber": "vatNumber", "automaticOrder": false }
Successfull response:
{ "country": "country", "city": "city", "supplierExternalId": "supplierExternalId", "language": "language", "rate": 1287.8112480579307, "buyPriceShipment": 3529.61761566978, "street": "street", "buyPriceMisc": 1967.6522936629137, "currency": "currency", "id": 163, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 7189, "automaticOrder": false, "zip": "zip", "buyPrice": 7056.210610324316, "comments": "comments", "includePricesInOrders": false, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 2915, "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
Content-type: application/json or application/xml
Update an existing supplier
Body:
{ "country": "country", "city": "city", "supplierExternalId": "supplierExternalId", "language": "language", "rate": 1031.056786674087, "buyPriceShipment": 6810.511909524474, "street": "street", "buyPriceMisc": 5667.97545346541, "currency": "currency", "id": 1713, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 6778, "automaticOrder": false, "zip": "zip", "buyPrice": 5740.842991058657, "comments": "comments", "includePricesInOrders": false, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 32, "name": "name", "includeShipmentAndMiscInPrice": true, "countryName": "countryName", "contactPhone": "contactPhone", "vatNumber": "vatNumber" }
Successfull response:
{ "country": "country", "city": "city", "supplierExternalId": "supplierExternalId", "language": "language", "rate": 9694.413658459714, "buyPriceShipment": 6690.222741649389, "street": "street", "buyPriceMisc": 1611.8989383347682, "currency": "currency", "id": 6282, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 3934, "automaticOrder": true, "zip": "zip", "buyPrice": 5342.0360993926415, "comments": "comments", "includePricesInOrders": false, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 8443, "name": "name", "includeShipmentAndMiscInPrice": true, "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:
Supplier
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 |
SuppliersResponse
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 |