Customer delivery terms API
General:
Basics:
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 |
900521 | Error when getting customer delivery term |
900522 | Error when creating a customer delivery term |
900523 | Error when updating a customer delivery term |
900524 | Error when deleting a customer delivery term |
{ "errorCode" : 900101, "errorMessage" : "Something went wrong on the server", "errorField" : null, "errorData" : null }
Customer delivery terms API:
Delivery terms
Get delivery term
GETUrl: /{term_id : .+}
Headers:
Accept: application/json or application/xml
Get a single delivery term based of term id
Body:
Successfull response:
{ "since": 6115, "customerDeliveryTerms": [{ "code": "code", "description": "description" }] }
Get delivery terms
GETUrl:
Headers:
Accept: application/json or application/xml
Get a list of delivery terms for customer orders
Valid parameters:
Parameter | Description | Default value | Allowed values |
---|---|---|---|
since | 0 |
Body:
Successfull response:
{ "since": 2541, "customerDeliveryTerms": [{ "code": "code", "description": "description" }] }
Add delivery term
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 delivery term for customer orders
Body:
{ "code": "code", "description": "description" }
Successfull response:
{ "code": "code", "description": "description" }
Update delivery term
PUTUrl: /{term_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 delivery term for customer orders
Body:
{ "code": "code", "description": "description" }
Successfull response:
{ "code": "code", "description": "description" }
Delete delivery term
DELETEUrl: /{term_id : .+}
Headers:
Accept: application/json or application/xml
Content-type: application/json or application/xml
Content-type: application/json or application/xml
Delete an existing delivery term
Classes:
CustomerDeliveryTerm
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
code | String | Write only with POST | Post | R,W | |||
description | String | Post | R,W |
CustomerDeliveryTermsResponse
Field | Type | Description | Default | Mandatory | Accepted values | Example values | Access |
---|---|---|---|---|---|---|---|
since | long | R | |||||
customerDeliveryTerms | List | R |