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 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": 8464, "suppliers": [{ "country": "country", "city": "city", "supplierExternalId": "supplierExternalId", "language": "language", "rate": 6176.488367888044, "buyPriceShipment": 9332.0857846511, "street": "street", "buyPriceMisc": 2484.920403827435, "currency": "currency", "id": 2495, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 5077, "automaticOrder": true, "zip": "zip", "buyPrice": 7466.413868088, "comments": "comments", "includePricesInOrders": true, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 4696, "name": "name", "includeShipmentAndMiscInPrice": true, "countryName": "countryName", "contactPhone": "contactPhone", "vatNumber": "vatNumber" }], "pageSize": 5813, "page": 9734, "suppliersCount": 5489, "since": 1725 }
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": 7866, "suppliers": [{ "country": "country", "city": "city", "supplierExternalId": "supplierExternalId", "language": "language", "rate": 9258.398119645672, "buyPriceShipment": 6131.565630342907, "street": "street", "buyPriceMisc": 2634.22277994955, "currency": "currency", "id": 9222, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 5064, "automaticOrder": false, "zip": "zip", "buyPrice": 8529.504013275526, "comments": "comments", "includePricesInOrders": false, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 3744, "name": "name", "includeShipmentAndMiscInPrice": false, "countryName": "countryName", "contactPhone": "contactPhone", "vatNumber": "vatNumber" }], "pageSize": 7087, "page": 9320, "suppliersCount": 7614, "since": 2430 }
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": 1317.595497770141, "country": "country", "comments": "comments", "includePricesInOrders": true, "city": "city", "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "language": "language", "customerNumber": "customerNumber", "buyPriceShipment": 673.333459023261, "deliveryDays": 7901, "street": "street", "buyPriceMisc": 45.65322406887895, "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": 9408.015660079369, "buyPriceShipment": 3480.446453898509, "street": "street", "buyPriceMisc": 5482.505415464908, "currency": "currency", "id": 2280, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 4197, "automaticOrder": false, "zip": "zip", "buyPrice": 6036.415107260353, "comments": "comments", "includePricesInOrders": false, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 149, "name": "name", "includeShipmentAndMiscInPrice": false, "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": 6988.8875405879135, "buyPriceShipment": 9548.551467729372, "street": "street", "buyPriceMisc": 1385.9552815317122, "currency": "currency", "id": 9119, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 5905, "automaticOrder": true, "zip": "zip", "buyPrice": 4049.271458737327, "comments": "comments", "includePricesInOrders": false, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 3950, "name": "name", "includeShipmentAndMiscInPrice": false, "countryName": "countryName", "contactPhone": "contactPhone", "vatNumber": "vatNumber" }
Successfull response:
{ "country": "country", "city": "city", "supplierExternalId": "supplierExternalId", "language": "language", "rate": 454.2499621372809, "buyPriceShipment": 6495.430567704422, "street": "street", "buyPriceMisc": 863.8293744174707, "currency": "currency", "id": 3411, "orgNumber": "orgNumber", "paymentTerms": "paymentTerms", "openOrders": 8225, "automaticOrder": false, "zip": "zip", "buyPrice": 513.4369704018616, "comments": "comments", "includePricesInOrders": true, "contactEmail": "contactEmail", "contactName": "contactName", "externalId": "externalId", "customerNumber": "customerNumber", "emailStatus": {}, "deliveryDays": 1679, "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 |