Get an order

Download an order using GET and it's ID number.

Request

For every API request you make, you'll need to present the API access key in the HTTP Header as X-API-Key to be authenticated.

Example code in PHP

$request_url = 'https://www.kursguiden.no/api/v1/orders/27244';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 

curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'X-API-Key: {your-api-key}',
  'Accept: application/json',
));
$result = curl_exec($ch);
curl_close($ch);      

Response

If the method is successful it responds with an JSON structure, as it is shown below.

{
    "data": [
        {
            "id": 27244,
            "title": "Learn REST API #27244",
            "title_detailed": "04.01.2020 - 06.01.2020 - Sem",
            "is_paid": true,
            "customer": {
                "id": 32714,
                "title": "Beste Kunde AS",
                "orgnr": "85454545",
                "invoice_reference": "Per Pedersen",
                "invoice_address": {
                    "address": "Kundeveien 10",
                    "address_2": "",
                    "address_3": "",
                    "zipcode": "2130",
                    "city": "Oslo"
                },
                "post_address": {
                    "address": "",
                    "address_2": "",
                    "address_3": "",
                    "zipcode": "",
                    "city": ""
                },
                "visit_address": {
                    "address": "",
                    "address_2": "",
                    "address_3": "",
                    "zipcode": "",
                    "city": ""
                }
            },
            "first_user": {
                "id": 154420,
                "firstname": "Lars",
                "lastname": "Larsen",
                "date_of_birth": "12.05.1992 00:00:00",
                "email": "lars@eksemel.ek",
                "phone": "21212121",
                "company": "ABC AS",
                "position": "",
                "invoice_address": {
                    "address": "Veien 2",
                    "address_2": "",
                    "address_3": "",
                    "zipcode": "3120",
                    "city": "Oslo",
                    "phone": ""
                },
                "home_address": {
                    "address": "Veien 2",
                    "address_2": "",
                    "address_3": "",
                    "zipcode": "3120",
                    "city": "Oslo",
                    "phone": ""
                },
                "work_address": {
                    "address": "",
                    "address_2": "",
                    "address_3": "",
                    "zipcode": "",
                    "city": "",
                    "phone": ""
                }
            },
            "lines": [
                {
                    "id": 31400,
                    "currency": "NOK",
                    "price_at_order_per_item_vat_excluded": 1500.5,
                    "quantity": 1,
                    "product": {
                        "id": 8079,
                        "item_number": "8079",
                        "title": "Learn REST API",
                        "title_label": "",
                        "price": 1500,
                        "currency": "NOK",
                        "vat_percentage": 0
                    },
                    "users": [
                        {
                            "id": 154420,
                            "firstname": "Lars",
                            "lastname": "Larsen",
                            "date_of_birth": "12.05.1992 00:00:00",
                            "email": "lars@eksemel.ek",
                            "phone": "21212121",
                            "company": "ABC AS",
                            "position": "",
                            "invoice_address": {
                                "address": "Veien 2",
                                "address_2": "",
                                "address_3": "",
                                "zipcode": "3120",
                                "city": "Oslo",
                                "phone": ""
                            },
                            "home_address": {
                                "address": "Veien 2",
                                "address_2": "",
                                "address_3": "",
                                "zipcode": "3120",
                                "city": "Oslo",
                                "phone": ""
                            },
                            "work_address": {
                                "address": "",
                                "address_2": "",
                                "address_3": "",
                                "zipcode": "",
                                "city": "",
                                "phone": ""
                            },
                            "invoice_reference": ""
                        }
                    ]
                }
            ],
            "updated_at": "2024-05-04T15:45:50+02:00",
            "created_at": "2017-03-31T20:27:04+02:00"
        }
    ]
}

Unsuccessful response sample:

{
    "status": "failure",
    "message": "Wrong API Key"
}