Artikelen

Authenticatie vereist

Met deze resource kunnen artikelen van u opgehaald en aangemaakt worden.

Resource mogelijkheden

HTTP Request Type Resource Type Vereisten Rechten
GET Collectie Articles
GET Element

Resource Containments

Depth Resource
0 Geen containments
1
2

Velden

Veld Beschrijving Zichbaar Aanpasbaar Vereist bij aanmaken
id Het indificatie nummer van het artikel record. Ja Nee Nee

Collectie GET

GET Collectie

Een GET request op de collectie zal resulteren in een volledige lijst van uw artikelen.

https://api.workspace.nl/api/v1/articles.json?article_group_id={article_group_id}
Query Parameters
{article_group_id} Het indentificatie nummer van de artikelgroep in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "count": 2,
            "Articles": [
                {
                    "Article": {
                        "id": "7563",
                        "code": "000008",
                        "client_code": "1337",
                        "name": "Cola light",
                        "category": "Algemeen",
                        "description": "",
                        "article_group_id": "148",
                        "default_price": "[[1,-1,70000]]",
                        "tax_rate_id": "4870",
                        "unit_name": "Stuk",
                        "unit_abbreviation": "STK",
                        "created": "2015-03-13 14:09:50",
                        "modified": "2015-05-06 09:32:22",
                        "trashed": false,
                        "webshop": "1"
                    },
                    "TaxRate": {
                        "id": "4870",
                        "percentage": "21",
                        "display": true,
                        "name": "21% BTW",
                        "type": "invoice",
                        "sort": "1"
                    },
                    "ArticleUpload": []
                },
                {
                    "Article": {
                        "...": "..."
                    },
                    "TaxRate": [],
                    "ArticleUpload": []
                }
            ]
        }
    }
}

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
GET 400 Bad Request Please provide the article_group_id as Query Parameter
GET 404 Not Found Articles not found.

ELEMENT GET

GET Element

Een GET request op het element zal resulteren op een enkel artikel.

https://api.workspace.nl/api/v1/articles/{id}.json
Parameters
{id} Het indentificatie nummer van het artikel in formaat (0-9)
Voorbeeld reactie(JSON):
{
    "response": {
        "message": "success",
        "exception": [],
        "code": 200,
        "data": {
            "Article": {
                "id": "7563",
                "code": "000008",
                "client_code": "1337",
                "name": "Cola light",
                "category": "Algemeen",
                "description": "",
                "article_group_id": "148",
                "default_price": "[[1,-1,70000]]",
                "tax_rate_id": "4870",
                "unit_name": "Stuk",
                "unit_abbreviation": "STK",
                "created": "2015-03-13 14:09:50",
                "modified": "2015-05-06 09:32:22",
                "trashed": false,
                "webshop": "1"
            },
            "TaxRate": {
                "id": "4870",
                "percentage": "21",
                "display": true,
                "name": "21% BTW",
                "type": "invoice",
                "sort": "1"
            },
            "ArticleUpload": []
        }
    }
}

Mogelijke fout meldingen Errors

Action HTTP Reponse Code Message
GET 404 Not Found Artikel not found.