AruKer API v1.0

How to send API Keys

You can pass in the API Key to our API either by using the HTTP header or by sending an apikey parameter via the query string.

curl -X GET 'https://classxapi.aruker.hu/endpoint' -H 'apikey:12345678901234567890123'
curl -X GET 'https://classxapi.aruker.hu/endpoint?apikey=12345678901234567890123'

A PHP sample using CURL

$ch = curl_init(); 
curl_setopt($ch, CURLOPT_URL, 'https://classxapi.aruker.hu/endpoint');
curl_setopt($ch, CURLOPT_HTTPHEADER, array('apikey:12345678901234567890123'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);

Utils

Get Public place character

Endpoint

GET /public_place_character

Response 200 (application/json)

{
    "status": true,
    "items": 2,
    "data": [
        {
            "id": 1,
            "name": "utca"
        },
        {
            "id": 2,
            "name": "út"
        }
    ]
}

Get Payment Types

Endpoint

GET /payment

Response 200 (application/json)

{
    "status": true,
    "items": 4,
    "data": [
        {
            "id": "3",
            "type": "Cash"
        },
        {
            "id": "4",
            "type": "Bank transfer"
        },
        {
            "id": "8",
            "type": "Payment on delivery"
        },
        {
            "id": "X",
            "type": "Credit card"
        }
    ]
}

Articles

Get Article Groups

Endpoint

GET /articles/groups

Response 200 (application/json)

{
    "status": true,
    "items": 2,
    "data": [
        {
            "articleId": "001",
            "articleName": "Háziállatoknak"
        },
        {
            "articleId": "001001",
            "articleName": "Állateledel"
        }
    ]
}

Get Articles

Endpoint

GET /articles

Parameters

• groupId (optional)
• priceType (optional)
• articleId (optional)
• lastChanged (optional)

Response 200 (application/json)

{
    "status": true,
    "items": 2,
    "data": [
        {
            "articleId": "000000002237",
            "articleName": "120 literes hulladékgyűjtő kuka",
            "articleGroupId": "019002",
            "articleGroup": "Egyéb műa.termékek",
            "pcsCarton": 0,
            "cartPal": 0,
            "weightNet": ".000",
            "weightBrut": ".000",
            "cartLen": 0,
            "cartHeight": 0,
            "cartWidth": 0,
            "cartWeightNet": ".000",
            "cartWeightBr": ".000",
            "createdDate": "2019.08.13",
            "modifiedDate": "2019.10.22",
            "stock": ".000",
            "priceNet": "11417.32",
            "price": "14500.00",
            "VAT": "27"
        },
        {
            "articleId": "vl0001",
            "articleName": "22 Carats croissant 55 g csoki&vanilia            ",
            "articleGroupId": "026002",
            "articleGroup": "Műzliszeletek, műzlik",
            "pcsCarton": 30,
            "cartPal": 30,
            "weightNet": ".000",
            "weightBrut": ".000",
            "cartLen": 0,
            "cartHeight": 0,
            "cartWidth": 0,
            "cartWeightNet": ".000",
            "cartWeightBr": ".000",
            "createdDate": "2019.03.20",
            "modifiedDate": "2019.03.22",
            "stock": ".000",
            "priceNet": "55.08",
            "price": "65.00",
            "VAT": "18"
        }
    ]
}

Prices

Get Prices

Endpoint

GET /prices

Parameters

• priceType (required)

Response 200 (application/json)

{
    "status": true,
    "items": 3,
    "data": [
        {
            "priceType": 1,
            "articleId": "Uni370",
            "priceNet": "1259.06",
            "priceBr": "1599.00",
            "VAT": "27"
        },
        {
            "priceType": 1,
            "articleId": "Uni368",
            "priceNet": "786.61",
            "priceBr": "999.00",
            "VAT": "27"
        },
        {
            "priceType": 1,
            "articleId": "000000004514",
            "priceNet": "227.56",
            "priceBr": "289.00",
            "VAT": "27"
        }
    ]
}

Stock

Get Stock

Endpoint

GET /stock

Parameters

• articleId (required)

Response 200 (application/json)

{
    "status": true,
    "items": 1,
    "data": [
        {
            "articleId": "000000000001",
            "warehouseId": 1,
            "qty": "1140.000"
        },
        {
            "articleId": "000000000001",
            "warehouseId": 23,
            "qty": "12.000"
        }
    ]
}

Pictures

Get Pictures

Endpoint

GET /pictures

Parameters

• warehouseId (optional)

Response 200 (application/json)

{
    "status": true,
    "items": 1,
    "data": [
        {
            "articleId": "000000002237",
            "filename": "1.jpg",
            "image": "data:image\/jpeg;base64,\/9j\/4Q9oRXhpZgAASUkqA..."
        }
    ]
}

Customers

Get Customers

Endpoint

GET /customers

Parameters

• customerId (optional)

Response 200 (application/json)

{
    "status": true,
    "items": 1,
    "data": [
        {
            "customerId": 1000059,
            "name": "Customer Name",
            "country": "HU",
            "postalCode": "1164",
            "locality": "Budapest",
            "publicPlaceName": "Bóbitás",
            "publicPlaceCharacter": "út",
            "number": "54",
            "building": "",
            "stairway": "",
            "floor": "",
            "door": "",
            "contactName": "",
            "contactEmail": "customer@email.com",
            "contactPhone": "06-20-555-5555",
            "taxId": "123456798",
            "priceType": "1"
        }
    ]
}

Add New Customer

Endpoint

POST /customers

Request (application/json)

{
    "name": "Company Name",
    "country": "HU",
    "postalCode": "1051",
    "locality": "Budapest",
    "publicPlaceName": "Sas",
    "publicPlaceCharacter": "utca",
    "number": "4",
    "building": "",
    "stairway": "",
    "floor": "",
    "door": "",
    "contactName": "Contact person Name",
    "contactEmail": "email@email.com",
    "contactPhone": "06-20-555-555",
    "taxId": "123456798"
}

Response 200 (application/json)

{
    "status": true,
    "customerId": 1000060,
    "data": {
        "customerId": 1000060,
        "name": "Cég Neve Bt",
        "country": "HU",
        "postalCode": "1051",
        "locality": "Budapest",
        "publicPlaceName": "Sas",
        "publicPlaceCharacter": "utca",
        "number": "4",
        "building": "",
        "stairway": "",
        "floor": "",
        "door": "",
        "contactName": "",
        "contactEmail": "email@email.com",
        "contactPhone": "06-20-555-555",
        "taxId": "123456798"
    }
}

Update Customer

Endpoint

POST /customers

Request (application/json)

{
    "customerId": 1000059,
    "name": "Customer Name",
    "contactEmail": "customer@email.com",
    "contactPhone": "06-20-555-6666"
}

Response 200 (application/json)

{
    "status": true,
    "customerId": 1000059,
    "data": {
        "customerId": 1000059,
        "name": "Customer Name",
        "country": "HU",
        "postalCode": "1164",
        "locality": "Budapest",
        "publicPlaceName": "Bóbitás",
        "publicPlaceCharacter": "út",
        "number": "54",
        "building": "",
        "stairway": "",
        "floor": "",
        "door": "",
        "contactName": "",
        "contactEmail": "customer@email.com",
        "contactPhone": "06-20-555-6666",
        "taxId": "123456798"
    }
}

Shipping

Get Shipping Address

Endpoint

GET /shipping

Parameters

• customerId (required)
• shippingAddrId (optional)

Response 200 (application/json)

{
    "status": true,
    "items": 1,
    "data": [
        {
            "customerId": 1000059,
            "shippingAddrId": "1",
            "name": "Customer Name",
            "country": "HU",
            "postalCode": "1164",
            "locality": "Budapest",
            "publicPlaceName": "Jules Verne",
            "publicPlaceCharacter": "út",
            "number": "10b",
            "building": "",
            "stairway": "",
            "floor": "4",
            "door": "5",
            "contactName": "",
            "contactEmail": "email@dot.net",
            "contactPhone": "+36-1-454-877"
        }
    ]
}

Add Shipping Address

Endpoint

POST /shipping

Request (application/json)

{
    "customerId": 1000059,
    "name": "Delivery Site",
    "country": "HU",
    "postalCode": "1112",
    "locality": "Budapest",
    "publicPlaceName": "Paprika",
    "publicPlaceCharacter": "út",
    "number": "12",
    "building": "",
    "stairway": "2",
    "floor": "1",
    "door": "25",
    "contactName": "Contact Person Name",
    "contactEmail": "email@email.net",
    "contactPhone": "+36-1-111-1111"
}

Response 200 (application/json)

{
    "status": true,
    "shippingAddrId": "7",
    "data": {
        "customerId": 1000059,
        "shippingAddrId": "7",
        "name": "Delivery Site",
        "country": "HU",
        "postalCode": "1112",
        "locality": "Budapest",
        "publicPlaceName": "Paprika",
        "publicPlaceCharacter": "út",
        "number": "12",
        "building": "",
        "stairway": "2",
        "floor": "1",
        "door": "25",
        "contactName": "Contact Person Name",
        "contactEmail": "email@email.net",
        "contactPhone": "+36-1-111-1111"
    }
}

Update Shipping Address

Endpoint

POST /shipping

Request (application/json)

{
    "customerId": 1000059,
    "shippingAddrId": 7,
    "contactName": "Contact Name",
    "contactEmail": "contact_name@email.net",
    "contactPhone": "+36-21-222-3333"
}

Response 200 (application/json)

{
    "status": true,
    "shippingAddrId": "7",
    "data": {
        "customerId": 1000059,
        "shippingAddrId": "7",
        "name": "Delivery Site",
        "country": "HU",
        "postalCode": "1112",
        "locality": "Budapest",
        "publicPlaceName": "Paprika",
        "publicPlaceCharacter": "út",
        "number": "12",
        "building": "",
        "stairway": "2",
        "floor": "1",
        "door": "25",
        "contactName": "Contact Name",
        "contactEmail": "contact_name@email.net",
        "contactPhone": "+36-21-222-3333"
    }
}

Orders

Get Orders

Endpoint

GET /order

Parameters

• customerId (required)
• orderId (optional, gets specific order including items)

Response 200 (application/json)

{
    "status": true,
    "items": 2,
    "data": [
        {
            "orderId": "2020000017",
            "customerId": 1000059,
            "shippingAddrId": "7",
            "customerName": "Customer Name",
            "date": "2020.03.06",
            "commments": "This is a comment",
            "netTotal": "15205.000000",
            "total": "19301.350000"
        },
        {
            "orderId": "2020000016",
            "customerId": 1000059,
            "shippingAddrId": "7",
            "customerName": "Customer Name",
            "date": "2020.03.06",
            "commments": "This is a comment",
            "netTotal": "15205.000000",
            "total": "19301.350000"
        }
    ]
}

Response 200 (application/json)

{
    "status": true,
    "items": 1,
    "data": {
        "orderId": "2020000016",
        "customerId": 1000059,
        "shippingAddrId": "7",
        "customerName": "Customer Name",
        "date": "2020.03.06",
        "commments": "This is a comment",
        "netTotal": "15205.000000",
        "total": "19301.350000",
        "items": [
            {
                "itemNo": 1,
                "articleId": "000000086830",
                "articleName": "#Wella Pro Series sampon 500ml+ Wellaflex hajlakk 75ml Extra tartós",
                "quantity": "10.000",
                "netUnitPrice": "1500.00",
                "VAT": "27"
            },
            {
                "itemNo": 2,
                "articleId": "000000071359",
                "articleName": "**Astor szájceruza automata RougeCout 003@",
                "quantity": "10.000",
                "netUnitPrice": "10.50",
                "VAT": "27"
            },
            {
                "itemNo": 3,
                "articleId": "000000084156",
                "articleName": "**Korona szelet többféle",
                "quantity": "10.000",
                "netUnitPrice": "10.00",
                "VAT": "18"
            }
        ]
    }
}

Add Order

Endpoint

POST /order

Request (application/json)

{
    "header": {
        "customerId": 1000059,
        "shippingAddrId": 1,
        "comments": "This is a comment",
        "paymentId": "X",
        "discount": 10
    },
    "items": [
        {
            "articleId": "000000086830",
            "quantity": 10,
            "netUnitPrice": 1500,
            "discount": 0
        },
        {
            "articleId": "000000071359",
            "quantity": 10,
            "netUnitPrice": 10.5,
            "discount": 0
        },
        {
            "articleId": "000000084156",
            "quantity": 10,
            "netUnitPrice": 10,
            "discount": 0
        }
    ]
}

Response 200 (application/json)

{
    "status": true,
    "orderId": "2022015428",
    "data": {
        "orderId": "2022015428",
        "customerId": 1001794,
        "shippingAddrId": "1",
        "customerName": "Kesz-Team Kft.",
        "date": "2022.09.20",
        "commments": "This is a comment",
        "netTotal": "15205.000000",
        "total": "19310.350000",
        "items": [
            {
                "itemNo": 1,
                "articleId": "GB4531",
                "articleName": "ACÉL RUTIL ELEKTRÓDÁK 2.0MM 350MM 25 DARAB",
                "quantity": "10.000",
                "netUnitPrice": "1500.00",
                "VAT": "27"
            },
            {
                "itemNo": 2,
                "articleId": "GB4533",
                "articleName": "ACÉL RUTIL ELEKTRÓDÁK 2.5MM 350MM 14 DARAB",
                "quantity": "10.000",
                "netUnitPrice": "10.50",
                "VAT": "27"
            },
            {
                "itemNo": 3,
                "articleId": "GB4535",
                "articleName": "ACÉL RUTIL ELEKTRÓDÁK 3.2MM 350MM 9 DARAB",
                "quantity": "10.000",
                "netUnitPrice": "10.00",
                "VAT": "27"
            }
        ]
    }
}

Invoices

Get Invoice

Endpoint

GET /invoice

Parameters

• customerId (required)
• invoiceId (optional, gets specific invoice including items)

Response 200 (application/json)

{
    "status": true,
    "items": 6,
    "data": [
        {
            "invoiceId": "15887\/2022",
            "customerId": 1001794,
            "customerName": "Kesz-Team Kft.",
            "date": "2022.09.14",
            "commments": "This is a comment",
            "netTotal": "2320467.800000",
            "total": "2946994.000000"
        },
        {
            "invoiceId": "15886\/2022",
            "customerId": 1001794,
            "customerName": "Kesz-Team Kft.",
            "date": "2022.09.14",
            "commments": "This is a comment",
            "netTotal": "2320467.800000",
            "total": "2946994.000000"
        },
        {
            "invoiceId": "15885\/2022",
            "customerId": 1001794,
            "customerName": "Kesz-Team Kft.",
            "date": "2022.09.14",
            "commments": "This is a comment",
            "netTotal": "2320467.800000",
            "total": "2946994.000000"
        },
        {
            "invoiceId": "15884\/2022",
            "customerId": 1001794,
            "customerName": "Kesz-Team Kft.",
            "date": "2022.09.14",
            "commments": "This is a comment",
            "netTotal": "2320467.800000",
            "total": "2946994.000000"
        },
        {
            "invoiceId": "15883\/2022",
            "customerId": 1001794,
            "customerName": "Kesz-Team Kft.",
            "date": "2022.09.14",
            "commments": "This is a comment",
            "netTotal": "2320467.800000",
            "total": "2946994.000000"
        }
    ]
}

Response 200 (application/json)

{
    "status": true,
    "items": 1,
    "data": {
        "invoiceId": "15882\/2022",
        "customerId": 1001794,
        "customerName": "Kesz-Team Kft.",
        "date": "2022.09.14",
        "commments": "This is a comment",
        "netTotal": "2320467.800000",
        "total": "2946994.000000",
        "items": [
            {
                "itemNo": 1,
                "articleId": "GB4531",
                "articleName": "ACÉL RUTIL ELEKTRÓDÁK 2.0MM 350MM 25 DARAB",
                "quantity": "1000.000",
                "netUnitPrice": "2283.46",
                "VAT": "27"
            },
            {
                "itemNo": 2,
                "articleId": "GB4533",
                "articleName": "ACÉL RUTIL ELEKTRÓDÁK 2.5MM 350MM 14 DARAB",
                "quantity": "10.000",
                "netUnitPrice": "1968.50",
                "VAT": "27"
            },
            {
                "itemNo": 3,
                "articleId": "GB4535",
                "articleName": "ACÉL RUTIL ELEKTRÓDÁK 3.2MM 350MM 9 DARAB",
                "quantity": "10.000",
                "netUnitPrice": "1732.28",
                "VAT": "27"
            }
        ]
    }
}

Add Invoice

Endpoint

POST /invoice

Request (application/json)

{
    "header": {
        "customerId": 1001794,
        "shippingAddrId": 1,
        "comments": "This is a comment",
        "paymentId": "X",
        "discount": 10
    },
    "items": [
        {
            "articleId": "GB4531",
            "quantity": 1000,
            "netUnitPrice": 2283.46,
            "discount": 0
        },
        {
            "articleId": "GB4533",
            "quantity": 10,
            "netUnitPrice": 1968.5,
            "discount": 0
        },
        {
            "articleId": "GB4535",
            "quantity": 10,
            "netUnitPrice": 1732.28,
            "discount": 0
        }
    ]
}

Response 200 (application/json)

{
    "status": true,
    "invoiceId": "15892\/2022",
    "data": {
        "invoiceId": "15892\/2022",
        "customerId": 1001794,
        "shippingAddrId": 0,
        "customerName": "Kesz-Team Kft.",
        "date": "2022.09.20",
        "commments": "This is a comment",
        "netTotal": "1856374.240000",
        "total": "2357595.000000",
        "items": [
            {
                "itemNo": 1,
                "articleId": "GB4531",
                "articleName": "ACÉL RUTIL ELEKTRÓDÁK 2.0MM 350MM 25 DARAB",
                "quantity": "1000.000",
                "netUnitPrice": "2283.46",
                "VAT": "27"
            },
            {
                "itemNo": 2,
                "articleId": "GB4533",
                "articleName": "ACÉL RUTIL ELEKTRÓDÁK 2.5MM 350MM 14 DARAB",
                "quantity": "10.000",
                "netUnitPrice": "1968.50",
                "VAT": "27"
            },
            {
                "itemNo": 3,
                "articleId": "GB4535",
                "articleName": "ACÉL RUTIL ELEKTRÓDÁK 3.2MM 350MM 9 DARAB",
                "quantity": "10.000",
                "netUnitPrice": "1732.28",
                "VAT": "27"
            }
        ]
    }
}

Suppliers

Get Suppliers

Endpoint

GET /suppliers

Response 200 (application/json)

{
    "status": true,
    "items": 2,
    "data": [
        {
            "supplierId": 3,
            "name": "COLIBRI 90 KFT",
            "country": "HU",
            "locality": "Szeged",
            "postalCode": "6724",
            "address": "Vásárhelyi Pál út 3-5.",
            "phone": "62-542-060",
            "contact": "Contact Person Name"
        },
        {
            "supplierId": 1177,
            "name": "Complex 2006 kft.",
            "country": "HU",
            "locality": "Budapest",
            "postalCode": "1144",
            "address": "Vievet u.29",
            "phone": "",
            "contact": ""
        }
    ]
}

Get Supplier Orders

Endpoint

GET /suppliers/orders

Parameters

• supplierId (optional)
• orderId (optional, gets specific order including items)
• dateFrom (optional, format: YYYY-MM-DD or YYYY.MM.DD)

Response 200 (application/json)

{
    "status": true,
    "items": 3,
    "data": [
        {
            "orderId": "2017000015",
            "supplierId": 3,
            "supplierName": "COLIBRI 90 KFT",
            "date": "2017.10.12",
            "items": 4
        },
        {
            "orderId": "2017000014",
            "supplierId": 3,
            "supplierName": "COLIBRI 90 KFT",
            "date": "2017.10.12",
            "items": 4
        },
        {
            "orderId": "2010000020",
            "supplierId": 3,
            "supplierName": "COLIBRI 90 KFT",
            "date": "2010.03.15",
            "items": 1
        }
    ]
}

Response 200 (application/json)

{
    "status": true,
    "items": 1,
    "data": {
        "orderId": "2007000008",
        "supplierId": 3,
        "supplierName": "COLIBRI 90 KFT",
        "date": "2007.03.06",
        "items": [
            {
                "itemNo": 1,
                "articleId": "000000000014",
                "articleName": "xVillars mini bar bricelet 20x50g -2012",
                "quantity": "500.000",
                "netUnitPrice": "100.00",
                "VAT": "20"
            },
            {
                "itemNo": 2,
                "articleId": "000000000023",
                "articleName": "Villars milk 16x100g -275",
                "quantity": "500.000",
                "netUnitPrice": "100.00",
                "VAT": "20"
            },
            {
                "itemNo": 3,
                "articleId": "000000000024",
                "articleName": "Villars dark 16x100g -273",
                "quantity": "10.000",
                "netUnitPrice": "10000.00",
                "VAT": "20"
            }
        ]
    }
}