Met deze resource is het mogelijk orderregels voor orders te beheren
HTTP Request Type | Resource Type | Vereisten Rechten |
---|---|---|
POST |
Collectie | Orders.write |
GET |
Element | Orders.read |
POST |
Element | Orders.write |
DELETE |
Element | Orders.write |
Depth | Resource |
---|---|
0 |
Geen containments |
1 |
|
2 |
Veld | Beschrijving | Zichbaar | Aanpasbaar | Vereist bij aanmaken |
---|---|---|---|---|
id |
Het indificatie nummer van de orderregel. | Ja | Nee | Nee |
name |
Ja | Ja | Ja | |
price |
Standaard waarde: 0 | Ja | Ja | Nee |
price_purchase |
Standaard waarde: 0 | Ja | Ja | Nee |
unit_type |
Standaard waarde: STK | Ja | Ja | Nee |
order_id |
Een geldig en bestaand order id. | Ja | Ja | Ja |
contact_id |
Ja | Ja | Ja | |
article_id |
Ja | Ja | Nee | |
amount |
Standaard waarde: 1 | Ja | Ja | Nee |
tax_rate_id |
Ja | Ja | Ja | |
discount |
Ja | Ja | Nee |
POST
POST
Collectie
Een POST request op de collectie zal resulteren in het aanmaken van een nieuw element.
Bij een POST Request via het HTTP protocol wordt de header Content-Type:
application/x-www-form-urlencoded
verwacht.
Errors
Action | HTTP Reponse Code | Message |
---|---|---|
POST |
400 Bad Request | Something went wrong while saving the data. |
GET
GET
Element
Een GET
request op het element zal resulteren op een enkele orderregel.
Parameters | |
---|---|
{id} |
Het indentificatie nummer van de orderregel in formaat (0-9) |
{
"response": {
"message": "success",
"exception": [],
"code": 200,
"data": {
"OrderLine": {
"id": "10621",
"name": "Orderregel test1",
"price": "0",
"price_purchase": "0",
"unit_type": "STK",
"order_id": "19",
"contact_id": "518",
"amount": "1",
"tax_rate_id": "4870",
"discount": null
}
}
}
}
POST
POST
Element
Een POST
request op het element zal resulteren in het aanpassen van het
element. Alleen specifieke velden zijn aanpasbaar.
Parameters | |
---|---|
{id} |
Het indentificatie nummer van de orderregel in formaat (0-9) |
Bij een POST Request via het HTTP protocol wordt de header Content-Type:
application/x-www-form-urlencoded
verwacht.
Errors
Action | HTTP Reponse Code | Message |
---|---|---|
POST |
400 Bad Request | Something went wrong while saving the data. |
POST |
404 Not Found | Orderline not found. |
DELETE
DELETE
Element
Een DELETE
request op het element zal resulteren in het verwijderen van het
element.
Parameters | |
---|---|
{id} |
Het indentificatie nummer van de orderregel in formaat (0-9) |
Errors
Action | HTTP Reponse Code | Message |
---|---|---|
DELETE |
404 Not Found | Orderline not found. |