Way of deliveries API

General:

Basics:

Base-URL: https://capi.lagerkoll.com/v1/wod/

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
900511	Error when getting way of delivery
900512	Error when create a way of delivery
900513	Error when updating a way of delivery
900514	Error when deleting a way of delivery

{
  "errorCode" : 900101,
  "errorMessage" : "Something went wrong on the server",
  "errorField" : null,
  "errorData" : null
}

Way of deliveries API:

Way of deliveries

Get way of delivery

GETUrl: /{way_of_delivery : .+}

Headers:

Accept: application/json or application/xml

Get a single list of way of delivery based on way of delivery code

Body:

Successfull response:

WayOfDeliveriesResponseDto

{
    "wayOfDeliveries": [{
        "code": "code",
        "description": "description"
    }],
    "since": 7353
}

Get way of deliveries

GETUrl:

Headers:

Accept: application/json or application/xml

Get a list of way of deliveries

Valid parameters:

Parameter	Description	Default value	Allowed values
since		0

Body:

Successfull response:

WayOfDeliveriesResponseDto

{
    "wayOfDeliveries": [{
        "code": "code",
        "description": "description"
    }],
    "since": 2117
}

Add way of delivery

POSTUrl:

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Add a new way of delivery

Body:

WayOfDeliveryDto

{
    "code": "code",
    "description": "description"
}

Successfull response:

WayOfDeliveryDto

{
    "code": "code",
    "description": "description"
}

Update way of delivery

PUTUrl: /{way_of_delivery : .+}

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update an existing new way of delivery

Body:

WayOfDeliveryDto

{
    "code": "code",
    "description": "description"
}

Successfull response:

WayOfDeliveryDto

{
    "code": "code",
    "description": "description"
}

Delete way of delivery

DELETEUrl: /{way_of_delivery : .+}

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Delete an existing way of delivery

Body:

Successfull response:

Classes:

WayOfDeliveriesResponseDto

Field	Type	Description	Default	Mandatory	Accepted values	Example values	Access
since	long						R
wayOfDeliveries	List						R

WayOfDeliveryDto

Field	Type	Description	Default	Mandatory	Accepted values	Example values	Access
code	String	Write only with POST		Post			R,W
description	String			Post			R,W