GET
Description
Retrieves a list of way of deliveries or a single way of delivery.
URL structure
https://api.fortnox.se/3/wayofdeliveries/{Code}
Method
GET
Version
3
Response
The way of delivery register can return a list of records or a single record. By specifying a Code in the URL, a single record will be returned. Not specifying a Code will return a list of records.
<?xml version="1.0" encoding="UTF-8"?> <WayOfDeliveries TotalResources="5" TotalPages="1" CurrentPage="1"> <WayOfDeliverySubset url="https://api.fortnox.se/3/wayofdeliveries/H%C3%84M"> <Code>HÄM</Code> <Description>Hämtas</Description> </WayOfDeliverySubset> [...] <WayOfDeliverySubset url="https://api.fortnox.se/3/wayofdeliveries/P"> <Code>P</Code> <Description>Posten</Description> </WayOfDeliverySubset> </WayOfDeliveries>
<?xml version="1.0" encoding="UTF-8"?> <WayOfDelivery url="https://api.fortnox.se/3/wayofdeliveries/P"> <Code>P</Code> <Description>Posten</Description> </WayOfDelivery>
{ "MetaInformation": { "@TotalResources": 5, "@TotalPages": 1, "@CurrentPage": 1 }, "WayOfDeliveries": [ { "@url": "https://api.fortnox.se/3/wayofdeliveries/H%C3%84M", "Code": "HÄM", "Description": "Hämtas" }, [...] { "@url": "https://api.fortnox.se/3/wayofdeliveries/P", "Code": "P", "Description": "Posten" } ] }
{ "WayOfDelivery": { "@url": "https://api.fortnox.se/3/wayofdeliveries/P", "Code": "P", "Description": "Posten" } }
POST
Description
Creates a way of delivery.
URL structure
https://api.fortnox.se/3/wayofdeliveries
Method
POST
Version
3
Request
The request body should contain a structure of a way of delivery, either in JSON or XML.
Response
The response should contain the created way of delivery in either JSON or XML.
PUT
Description
Updates a way of delivery.
URL structure
https://api.fortnox.se/3/wayofdeliveries/{Code}
Method
PUT
Version
3
Request
The request body should contain a structure of a way of delivery, either in JSON or XML.
Response
The response should contain the updated way of delivery in either JSON or XML.
<?xml version="1.0" encoding="UTF-8"?> <WayOfDelivery url="https://api.fortnox.se/3/wayofdeliveries/DHL"> <Code>DHL</Code> <Description>DHL Paket</Description> </WayOfDelivery>
{ "WayOfDelivery": { "@url": "https://api.fortnox.se/3/wayofdeliveries/DHL", "Code": "DHL", "Description": "DHL Paket" } }
DELETE
Description
Removes a way of delivery.
URL structure
https://api.fortnox.se/3/wayofdeliveries/{Code}
Method
DELETE
Version
3
Request
The request body should be empty.
Response
The response body should be empty.
Fields
Field | Description | Limits | Type | Searchable | Sortable | Required | R/W |
Url | Direct URL to the record | – | String | – | – | – | R |
Code | The code of the way of delivery | – | String | – | Yes | – | R/W* |
Description | The description of the way of delivery | – | String | – | – | – | R/W |